Android初试--Android中的ContentProvider(1)

古城微笑少年丶 2022-07-27 14:44 211阅读 0赞

ContentProvider(内容提供者、数据共享)  
  
一、使用ContentProvider  
当应用继承ContentProvider类并重写该类用于提供数据和存储数据的方法时，就可以向其他应用共享其数据。前面我们学习过文件的操作模式，通过指定文件的操作模式为Context.MODE\_WORLD\_READABLE或Context.MODE\_WORLD\_WRITEABLE就可以对外共享数据，但数据的访问方式会因数据存储的方式而不同，如：采用xml文件对外共享数据，需要进行xml解析来读写数据；采用SharedPreferences共享数据，需要使用SharedPreferences API读写数据；而使用ContentProvider共享数据的好处是统一了数据访问方式。  
当应用需要通过ContentProvider对外共享数据时，  
第一步需要继承ContentProvider类并重写如下方法：  
public class PersonContentProvider extends ContentProvider\{  
public boolean onCreate();  
public Uri insert(Uri uri, ContentValues values);  
public int delete(Uri uri, String selection, String\[\] selectionArgs);  
public int update(Uri uri, ContentValues values, String selection, String\[\] selectionArgs);  
public Cursor query(Uri uri, String\[\] projection, String selection, String\[\] selectionArgs, String sortOrder);  
public String getType(Uri uri);  
\}  
ContentProvider类中一些主要方法的作用：  
public boolean onCreate();  
该方法在ContentProvider创建后就会被调用，Android开机后，ContentProvider在其它应用第一次访问它时才会被创建。  
public Uri insert(Uri uri, ContentValues values);  
该方法用于供外部应用往ContentProvider添加数据。  
public int delete(Uri uri, String selection, String\[\] selectionArgs);  
该方法用于供外部应用从ContentProvider删除数据。  
public int update(Uri uri, ContentValues values, String selection, String\[\] selectionArgs);  
该方法用于供外部应用更新ContentProvider中的数据。  
public Cursor query(Uri uri, String\[\] projection, String selection, String\[\] selectionArgs, String sortOrder);  
该方法用于供外部应用从ContentProvider中获取数据。  
public String getType(Uri uri);  
该方法返回当前Uri所代表数据的MIME类型。如果要操作的数据属于集合类型，那么MIME类型字符串应该以vnd.android.cursor.dir/开头，例如：要获取所有person记录的Uri为"content://com.rxr.providers.personprovider/person"，则返回的MIME类型字符串应该为："vnd.android.cursor.dir/person"。如果要操作的数据属于非集合类型数据，那么MIME类型字符串应该以vnd.android.cursor.item/开头，例如：要获取id为10的person记录，Uri为"content://com.rxr.providers.personprovider/person/10"，则返回的MIME类型字符串应该为："vnd.android.cursor.item/person"。  
  
第二步需要在AndroidManifest.xml使用<provider>节点对自己的ContentProvider进行配置，为了能让其他应用找到该ContentProvider，ContentProvider采用了authorities（主机名/域名）对它进行唯一标识，你可以把ContentProvider看作是一个网站，authorities就是它的域名。  
<manifest .... >  
<application android:icon="@drawable/icon" android:label="@string/app\_name">  
...................  
<provider android:name=".PersonContentProvider" android:authorities="com.rxr.providers.personprovider"/>  
</application>  
</manifest>  
注意：一旦应用继承了ContentProvider类，我们就会把这个应用称为ContentProvider（内容提供者）。  
  
二、Uri介绍  
Uri代表了要操作的数据，主要包含两部分信息：  
1、需要操作的ContentProvider。  
2、对ContentProvider中的什么数据进行操作。  
  
一个Uri由以下几部分组成：  
content://com.rxr.providers.personprovider/person/10  
|———|—————————————————|—————|  
schema 主机名或域名 路径  
  
①ContentProvider的schema由Android规定，schema为content://。  
②主机名或域名用于唯一标识这个ContentProvider，外部调用者可以根据这个标识来找到它。  
③路径（path）用于表示我们要操作的数据，路径的构建应根据业务而定，如下所示:  
要操作person表中id为10的记录，可以构建这样的路径: /person/10  
要操作person表中id为10的记录的name字段，可以构建这样的路径: /person/10/name  
要操作person表中的所有记录，可以构建这样的路径: /person  
要操作xxx表中的所有记录，可以构建这样的路径: /xxx  
当然要操作的数据不一定来自数据库，也可能是文件、xml或网络等其他存储方式，如下:  
要操作xml文件中person节点下的name节点，可以构建这样的路径：/person/name  
如果要把一个字符串转换成Uri，可以使用Uri类中的parse()方法，如下：  
Uri uri = Uri.parse("content://com.rxr.providers.personprovider/person");  
  
三、UriMatcher类使用介绍  
因为Uri代表了要操作的数据，所以我们经常需要解析Uri，并从Uri中获取数据。Android系统提供了两个用于操作Uri的工具类，分别为UriMatcher和ContentUris。  
UriMatcher类用于匹配Uri，用法如下：  
首先添加需要匹配的Uri路径，如下示例：  
//常量UriMatcher.NO\_MATCH表示不匹配任何路径时的返回码  
private static final UriMatcher URI\_MATCHER = new UriMatcher(UriMatcher.NO\_MATCH);  
//如果UriMatcher.match()方法匹配content://com.rxr.providers.personprovider/person路径，返回匹配码为1  
URI\_MATCHER.addURI("com.rxr.providers.personprovider", "person", 1);//添加需要匹配uri，如果匹配就会返回匹配码  
//如果UriMatcher.match()方法匹配content://com.rxr.providers.personprovider/person/20路径，返回匹配码为2  
URI\_MATCHER.addURI("com.rxr.providers.personprovider", "person/\#", 2);//\#号为通配符  
  
注册完需要匹配的Uri后，就可以使用URI\_MATCHER.match(uri)方法对输入的Uri进行匹配，如果匹配就返回匹配码，匹配码是调用addURI()方法时传入的第三个参数，假如匹配content://com.rxr.providers.personprovider/person路径，返回的匹配码为1。  
switch (URI\_MATCHER.match(Uri.parse("content://com.rxr.providers.personprovider/person/10"))) \{  
case 1  
break;  
case 2  
break;  
default://不匹配  
break;  
\}  
  
四、ContentUris类使用介绍  
ContentUris类用于操作Uri路径后面的ID部分，它有两个比较实用的方法：  
withAppendedId(uri, id)用于为路径加上ID部分：  
Uri uri = Uri.parse("content://com.rxr.providers.personprovider/person");  
Uri resultUri = ContentUris.withAppendedId(uri, 10);  
//生成后的Uri为：content://com.rxr.providers.personprovider/person/10  
parseId(uri)方法用于从路径中获取ID部分：  
Uri uri = Uri.parse("content://com.rxr.providers.personprovider/person/10");  
long personid = ContentUris.parseId(uri);//获取的结果为:10  
  
public class PersonContentProvider extends ContentProvider \{  
private DBOpenHelper dbOpenHelper;  
//常量UriMatcher.NO\_MATCH表示不匹配任何路径时的返回码  
private static final UriMatcher URI\_MATCHER = new UriMatcher(UriMatcher.NO\_MATCH);  
private static final int PERSONS = 1;  
private static final int PERSON = 2;  
static\{  
//添加需要匹配的uri，如果匹配就会返回匹配码  
URI\_MATCHER.addURI("com.rxr.providers.personprovider", "person", PERSONS);  
URI\_MATCHER.addURI("com.rxr.providers.personprovider", "person/\#", PERSON);  
\}  
@Override  
public boolean onCreate() \{  
this.dbOpenHelper = new DBOpenHelper(this.getContext());  
return true;  
\}  
//返回当前操作的数据的MimeType  
@Override  
public String getType(Uri uri) \{  
switch (URI\_MATCHER.match(uri)) \{  
case PERSONS:  
return "vnd.android.cursor.dir/person";//自定义MimeType(内容类型)  
case PERSON:  
return "vnd.android.cursor.item/person";  
default:  
throw new IllegalArgumentException("unkown uri:" + uri);  
\}  
\}  
@Override  
public Uri insert(Uri uri, ContentValues values) \{  
SQLiteDatabase db = dbOpenHelper.getWritableDatabase();  
switch (URI\_MATCHER.match(uri)) \{  
case PERSONS:  
long rowid = db.insert("person", "name", values);//相当于insert into person(name) values(null);  
//获取表示新增数据库记录的Uri  
Uri insertUri = ContentUris.withAppendedId(uri, rowid);  
//发出通知：数据变化时通知访问此ContentProvider内容的访问者  
//notifyChange第一个参数是方法参数中的uri  
this.getContext().getContentResolver().notifyChange(uri, null);  
return insertUri;   
default:  
throw new IllegalArgumentException("unkown uri:" + uri);  
\}  
\}  
//删除person表中的所有记录 /person  
//删除person表中指定id的记录 /person/10  
@Override  
public int delete(Uri uri, String selection, String\[\] selectionArgs) \{  
SQLiteDatabase db = dbOpenHelper.getWritableDatabase();  
int count = 0;  
switch (URI\_MATCHER.match(uri)) \{  
case PERSONS:  
count = db.delete("person", selection, selectionArgs);  
return count;  
case PERSON:  
long id = ContentUris.parseId(uri);  
String whereString = "personid=" + id;  
if(selection != null && !"".equals(selection))\{  
whereString = selection + " and " + whereString;  
\}  
count = db.delete("person", whereString, selectionArgs);  
return count;  
default:  
throw new IllegalArgumentException("unkown uri:" + uri);  
\}  
\}  
//更新person表中的所有记录 /person  
//更新person表中指定id的记录 /person/10  
@Override  
public int update(Uri uri, ContentValues values, String selection, String\[\] selectionArgs) \{  
SQLiteDatabase db = dbOpenHelper.getWritableDatabase();  
int count = 0;  
switch (URI\_MATCHER.match(uri)) \{  
case PERSONS:  
//count表示被更新的记录行数  
count = db.update("person", values, selection, selectionArgs);  
return count;  
case PERSON:  
long id = ContentUris.parseId(uri);  
String whereString = "personid=" + id;  
if(selection != null && !"".equals(selection))\{  
whereString = selection + " and " + whereString;  
\}  
count = db.update("person", values, whereString, selectionArgs);  
return count;  
default:  
throw new IllegalArgumentException("unkown uri:" + uri);  
\}  
\}  
//查询person表中的所有记录 /person  
//查询person表中指定id的记录 /person/10  
@Override  
public Cursor query(Uri uri, String\[\] projection, String selection,  
String\[\] selectionArgs, String sortOrder) \{  
SQLiteDatabase db = dbOpenHelper.getWritableDatabase();  
switch (URI\_MATCHER.match(uri)) \{  
case PERSONS:  
return db.query("person", projection, selection, selectionArgs, null, null, sortOrder);  
case PERSON:  
long id = ContentUris.parseId(uri);  
String whereString = "personid=" + id;  
if(selection != null && !"".equals(selection))\{  
whereString = selection + "and" + whereString;  
\}  
return db.query("person", projection, whereString, selectionArgs, null, null, sortOrder);  
default:  
throw new IllegalArgumentException("unkown uri:" + uri);  
\}  
\}   
\}  
  
五、使用ContentResolver类操作ContentProvider中的数据  
当外部应用需要对ContentProvider中的数据进行添加、删除、修改和查询操作时，ContentResolver类可以帮助我们来完成。使用Activity提供的getContentResolver()方法获取ContentResolver对象。ContentResolver类提供了与ContentProvider类相同签名的四个方法：  
public Uri insert(Uri uri, ContentValues values)  
该方法用于往ContentProvider添加数据。  
public int delete(Uri uri, String selection, String\[\] selectionArgs)  
该方法用于从ContentProvider删除数据。  
public int update(Uri uri, ContentValues values, String selection, String\[\] selectionArgs)  
该方法用于更新ContentProvider中的数据。  
public Cursor query(Uri uri, String\[\] projection, String selection, String\[\] selectionArgs, String sortOrder)  
该方法用于从ContentProvider中获取数据。  
这些方法的第一个参数为Uri，代表要操作的ContentProvider和对其中的什么数据进行操作，假设给定的是：Uri.parse("content://com.rxr.providers.personprovider/person/10")，那么将会对主机名为com.rxr.providers.personprovider的ContentProvider进行操作，操作的数据为person表中id为10的记录。  
  
六、监听ContentProvider中数据的变化  
如果ContentProvider的访问者需要知道ContentProvider中的数据是否发生了变化，则发生数据变化时在ContentProvider中调用getContentResolver().notifyChange(Uri uri, ContentObserver observer)方法通知注册在此Uri上的访问者，示例如下：  
public class PersonContentProvider extends ContentProvider \{  
.........  
public Uri insert(Uri uri, ContentValues values) \{  
db.insert("person", "personid", values);  
...........  
getContext().getContentResolver().notifyChange(uri, null);  
\}  
.........  
\}  
如果ContentProvider的访问者需要得到数据变化通知，必须使用ContentObserver类对数据（数据采用uri描述）进行监听，当监听到数据变化通知时，系统就会调用ContentObserver的onChange()方法：  
getContentResolver().registerContentObserver(Uri.parse("content://com.rxr.providers.personprovider/person"), true, new PersonObserver(new Handler()));  
public class PersonObserver extends ContentObserver\{  
public PersonObserver(Handler handler) \{  
super(handler);  
\}  
public void onChange(boolean selfChange) \{  
 //此处可以进行相应的业务处理  
\}  
\}