Android(安卓)ContentProvider和Uri详解

文章来源于博客园Ruthless

一、使用ContentProvider（内容提供者）共享数据

ContentProvider在android中的作用是对外共享数据，也就是说你可以通过ContentProvider把应用中的数据共享给其他应用访问，其他应用可以通过ContentProvider对你应用中的数据进行添删改查。关于数据共享，以前我们学习过文件操作模式，知道通过指定文件的操作模式为Context.MODE_WORLD_READABLE或Context.MODE_WORLD_WRITEABLE同样也可以对外共享数据。那么，这里为何要使用ContentProvider对外共享数据呢？是这样的，如果采用文件操作模式对外共享数据，数据的访问方式会因数据存储的方式而不同，导致数据的访问方式无法统一，如：采用xml文件对外共享数据，需要进行xml解析才能读取数据；采用sharedpreferences共享数据，需要使用sharedpreferences API读取数据。
使用ContentProvider对外共享数据的好处是统一了数据的访问方式。
当应用需要通过ContentProvider对外共享数据时，第一步需要继承ContentProvider并重写下面方法：

publicclassPersonContentProviderextendsContentProvider{publicbooleanonCreate()publicUriinsert(Uriuri,ContentValuesvalues)publicintdelete(Uriuri,Stringselection,String[]selectionArgs)publicintupdate(Uriuri,ContentValuesvalues,Stringselection,String[]selectionArgs)publicCursorquery(Uriuri,String[]projection,Stringselection,String[]selectionArgs,StringsortOrder)publicStringgetType(Uriuri)}

第二步需要在AndroidManifest.xml使用<provider>对该ContentProvider进行配置，为了能让其他应用找到该ContentProvider ，ContentProvider采用了authorities（主机名/域名）对它进行唯一标识，你可以把ContentProvider看作是一个网站（想想，网站也是提供数据者），authorities 就是他的域名：

<manifest....><applicationandroid:icon="@drawable/icon"android:label="@string/app_name"><providerandroid:name=".PersonContentProvider"android:authorities="com.ljq.providers.personprovider"/></application></manifest>

二、Uri介绍

Uri代表了要操作的数据，Uri主要包含了两部分信息：1》需要操作的ContentProvider ，2》对ContentProvider中的什么数据进行操作，一个Uri由以下几部分组成：

ContentProvider（内容提供者）的scheme已经由Android所规定， scheme为：content://
主机名（或叫Authority）用于唯一标识这个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.ljq.provider.personprovider/person")

三、UriMatcher类使用介绍

因为Uri代表了要操作的数据，所以我们经常需要解析Uri，并从Uri中获取数据。Android系统提供了两个用于操作Uri的工具类，分别为UriMatcher和ContentUris 。掌握它们的使用，会便于我们的开发工作。
UriMatcher类用于匹配Uri，它的用法如下：
首先第一步把你需要匹配Uri路径全部给注册上，如下：

//常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码UriMatchersMatcher=newUriMatcher(UriMatcher.NO_MATCH);//如果match()方法匹配content://com.ljq.provider.personprovider/person路径，返回匹配码为1sMatcher.addURI("com.ljq.provider.personprovider","person",1);//添加需要匹配uri，如果匹配就会返回匹配码//如果match()方法匹配content://com.ljq.provider.personprovider/person/230路径，返回匹配码为2sMatcher.addURI("com.ljq.provider.personprovider","person/#",2);//#号为通配符switch(sMatcher.match(Uri.parse("content://com.ljq.provider.personprovider/person/10"))){case1break;case2break;default://不匹配break;}

注册完需要匹配的Uri后，就可以使用sMatcher.match(uri)方法对输入的Uri进行匹配，如果匹配就返回匹配码，匹配码是调用addURI()方法传入的第三个参数，假设匹配content://com.ljq.provider.personprovider/person路径，返回的匹配码为1

四、ContentUris类使用介绍

ContentUris类用于操作Uri路径后面的ID部分，它有两个比较实用的方法：
withAppendedId(uri, id)用于为路径加上ID部分：

Uriuri=Uri.parse("content://com.ljq.provider.personprovider/person")UriresultUri=ContentUris.withAppendedId(uri,10);//生成后的Uri为：content://com.ljq.provider.personprovider/person/10

parseId(uri)方法用于从路径中获取ID部分：

Uriuri=Uri.parse("content://com.ljq.provider.personprovider/person/10")longpersonid=ContentUris.parseId(uri);//获取的结果为:10

五、使用ContentProvider共享数据

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)：该方法用于返回当前Url所代表数据的MIME类型。

如果操作的数据属于集合类型，那么MIME类型字符串应该以vnd.android.cursor.dir/开头，

例如：要得到所有person记录的Uri为content://com.ljq.provider.personprovider/person，那么返回的MIME类型字符串应该为："vnd.android.cursor.dir/person"。

如果要操作的数据属于非集合类型数据，那么MIME类型字符串应该以vnd.android.cursor.item/开头，

例如：得到id为10的person记录，Uri为content://com.ljq.provider.personprovider/person/10，那么返回的MIME类型字符串为："vnd.android.cursor.item/person"。

六、使用ContentResolver操作ContentProvider中的数据

当外部应用需要对ContentProvider中的数据进行添加、删除、修改和查询操作时，可以使用ContentResolver 类来完成，要获取ContentResolver 对象，可以使用Activity提供的getContentResolver()方法。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.ljq.providers.personprovider/person/10")，那么将会对主机名为com.ljq.providers.personprovider的ContentProvider进行操作，操作的数据为person表中id为10的记录。

使用ContentResolver对ContentProvider中的数据进行添加、删除、修改和查询操作：

ContentResolverresolver=getContentResolver();Uriuri=Uri.parse("content://com.ljq.provider.personprovider/person");//添加一条记录ContentValuesvalues=newContentValues();values.put("name","linjiqin");values.put("age",25);resolver.insert(uri,values);//获取person表中所有记录Cursorcursor=resolver.query(uri,null,null,null,"personiddesc");while(cursor.moveToNext()){Log.i("ContentTest","personid="+cursor.getInt(0)+",name="+cursor.getString(1));}//把id为1的记录的name字段值更改新为zhangsanContentValuesupdateValues=newContentValues();updateValues.put("name","zhangsan");UriupdateIdUri=ContentUris.withAppendedId(uri,2);resolver.update(updateIdUri,updateValues,null,null);//删除id为2的记录UrideleteIdUri=ContentUris.withAppendedId(uri,2);resolver.delete(deleteIdUri,null,null);

七、监听ContentProvider中数据的变化

如果ContentProvider的访问者需要知道ContentProvider中的数据发生变化，可以在ContentProvider发生数据变化时调用getContentResolver().notifyChange(uri, null)来通知注册在此URI上的访问者，例子如下：

publicclassPersonContentProviderextendsContentProvider{publicUriinsert(Uriuri,ContentValuesvalues){db.insert("person","personid",values);getContext().getContentResolver().notifyChange(uri,null);}}

如果ContentProvider的访问者需要得到数据变化通知，必须使用ContentObserver对数据（数据采用uri描述）进行监听，当监听到数据变化通知时，系统就会调用ContentObserver的onChange()方法：

getContentResolver().registerContentObserver(Uri.parse("content://com.ljq.providers.personprovider/person"),true,newPersonObserver(newHandler()));publicclassPersonObserverextendsContentObserver{publicPersonObserver(Handlerhandler){super(handler);}publicvoidonChange(booleanselfChange){//此处可以进行相应的业务处理}}

八、案例参考

PersonContentProvider内容提供者类

packagecom.ljq.db;importandroid.content.ContentProvider;importandroid.content.ContentUris;importandroid.content.ContentValues;importandroid.content.UriMatcher;importandroid.database.Cursor;importandroid.database.sqlite.SQLiteDatabase;importandroid.net.Uri;importandroid.text.TextUtils;/***内容提供者**作用：统一数据访问方式，方便外部调用**@authorjiqinlin**/publicclassPersonContentProviderextendsContentProvider{//数据集的MIME类型字符串则应该以vnd.android.cursor.dir/开头publicstaticfinalStringPERSONS_TYPE="vnd.android.cursor.dir/person";//单一数据的MIME类型字符串应该以vnd.android.cursor.item/开头publicstaticfinalStringPERSONS_ITEM_TYPE="vnd.android.cursor.item/person";publicstaticfinalStringAUTHORITY="com.ljq.provider.personprovider";//主机名/*自定义匹配码*/publicstaticfinalintPERSONS=1;/*自定义匹配码*/publicstaticfinalintPERSON=2;publicstaticfinalUriPERSONS_URI=Uri.parse("content://"+AUTHORITY+"/person");privateDBOpenHelperdbOpenHelper=null;//UriMatcher类用来匹配Uri，使用match()方法匹配路径时返回匹配码privatestaticfinalUriMatcheruriMatcher;static{//常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码uriMatcher=newUriMatcher(UriMatcher.NO_MATCH);//如果match()方法匹配content://com.ljq.provider.personprovider/person路径，返回匹配码为PERSONSuriMatcher.addURI(AUTHORITY,"person",PERSONS);//如果match()方法匹配content://com.ljq.provider.personprovider/person/230路径，返回匹配码为PERSONuriMatcher.addURI(AUTHORITY,"person/#",PERSON);}@OverridepublicbooleanonCreate(){dbOpenHelper=newDBOpenHelper(this.getContext());returntrue;}@OverridepublicUriinsert(Uriuri,ContentValuesvalues){SQLiteDatabasedb=dbOpenHelper.getWritableDatabase();longid=0;switch(uriMatcher.match(uri)){casePERSONS:id=db.insert("person","name",values);//返回的是记录的行号，主键为int，实际上就是主键值returnContentUris.withAppendedId(uri,id);casePERSON:id=db.insert("person","name",values);Stringpath=uri.toString();returnUri.parse(path.substring(0,path.lastIndexOf("/"))+id);//替换掉iddefault:thrownewIllegalArgumentException("UnknownURI"+uri);}}@Overridepublicintdelete(Uriuri,Stringselection,String[]selectionArgs){SQLiteDatabasedb=dbOpenHelper.getWritableDatabase();intcount=0;switch(uriMatcher.match(uri)){casePERSONS:count=db.delete("person",selection,selectionArgs);break;casePERSON://下面的方法用于从URI中解析出id，对这样的路径content://com.ljq.provider.personprovider/person/10//进行解析，返回值为10longpersonid=ContentUris.parseId(uri);Stringwhere="id="+personid;//删除指定id的记录where+=!TextUtils.isEmpty(selection)?"and("+selection+")":"";//把其它条件附加上count=db.delete("person",where,selectionArgs);break;default:thrownewIllegalArgumentException("UnknownURI"+uri);}db.close();returncount;}@Overridepublicintupdate(Uriuri,ContentValuesvalues,Stringselection,String[]selectionArgs){SQLiteDatabasedb=dbOpenHelper.getWritableDatabase();intcount=0;switch(uriMatcher.match(uri)){casePERSONS:count=db.update("person",values,selection,selectionArgs);break;casePERSON://下面的方法用于从URI中解析出id，对这样的路径content://com.ljq.provider.personprovider/person/10//进行解析，返回值为10longpersonid=ContentUris.parseId(uri);Stringwhere="id="+personid;//获取指定id的记录where+=!TextUtils.isEmpty(selection)?"and("+selection+")":"";//把其它条件附加上count=db.update("person",values,where,selectionArgs);break;default:thrownewIllegalArgumentException("UnknownURI"+uri);}db.close();returncount;}@OverridepublicStringgetType(Uriuri){switch(uriMatcher.match(uri)){casePERSONS:returnPERSONS_TYPE;casePERSON:returnPERSONS_ITEM_TYPE;default:thrownewIllegalArgumentException("UnknownURI"+uri);}}@OverridepublicCursorquery(Uriuri,String[]projection,Stringselection,String[]selectionArgs,StringsortOrder){SQLiteDatabasedb=dbOpenHelper.getReadableDatabase();switch(uriMatcher.match(uri)){casePERSONS:returndb.query("person",projection,selection,selectionArgs,null,null,sortOrder);casePERSON://下面的方法用于从URI中解析出id，对这样的路径content://com.ljq.provider.personprovider/person/10//进行解析，返回值为10longpersonid=ContentUris.parseId(uri);Stringwhere="id="+personid;//获取指定id的记录where+=!TextUtils.isEmpty(selection)?"and("+selection+")":"";//把其它条件附加上returndb.query("person",projection,where,selectionArgs,null,null,sortOrder);default:thrownewIllegalArgumentException("UnknownURI"+uri);}}}

文件清单

<?xmlversion="1.0"encoding="utf-8"?><manifestxmlns:android="http://schemas.android.com/apk/res/android"package="com.ljq.sql"android:versionCode="1"android:versionName="1.0"><applicationandroid:icon="@drawable/icon"android:label="@string/app_name"><uses-libraryandroid:name="android.test.runner"/><activityandroid:name=".SqlActivity"android:label="@string/app_name"><intent-filter><actionandroid:name="android.intent.action.MAIN"/><categoryandroid:name="android.intent.category.LAUNCHER"/></intent-filter></activity><providerandroid:name="com.ljq.db.PersonContentProvider"android:authorities="com.ljq.provider.personprovider"/></application><uses-sdkandroid:minSdkVersion="7"/><instrumentationandroid:name="android.test.InstrumentationTestRunner"android:targetPackage="com.ljq.sql"android:label="TestsforMyApp"/></manifest>

PersonContentProviderTest内容提供者测试类

packagecom.ljq.test;importandroid.content.ContentResolver;importandroid.content.ContentValues;importandroid.database.Cursor;importandroid.net.Uri;importandroid.test.AndroidTestCase;importandroid.util.Log;/***外部访问内容提供者**@authorjiqinlin**/publicclassPersonContentProviderTestextendsAndroidTestCase{privatestaticfinalStringTAG="PersonContentProviderTest";publicvoidtestSave()throwsThrowable{ContentResolvercontentResolver=this.getContext().getContentResolver();UriinsertUri=Uri.parse("content://com.ljq.provider.personprovider/person");ContentValuesvalues=newContentValues();values.put("name","ljq");values.put("phone","1350000009");Uriuri=contentResolver.insert(insertUri,values);Log.i(TAG,uri.toString());}publicvoidtestUpdate()throwsThrowable{ContentResolvercontentResolver=this.getContext().getContentResolver();UriupdateUri=Uri.parse("content://com.ljq.provider.personprovider/person/1");ContentValuesvalues=newContentValues();values.put("name","linjiqin");contentResolver.update(updateUri,values,null,null);}publicvoidtestFind()throwsThrowable{ContentResolvercontentResolver=this.getContext().getContentResolver();//Uriuri=Uri.parse("content://com.ljq.provider.personprovider/person");Uriuri=Uri.parse("content://com.ljq.provider.personprovider/person");Cursorcursor=contentResolver.query(uri,null,null,null,"idasc");while(cursor.moveToNext()){intpersonid=cursor.getInt(cursor.getColumnIndex("id"));Stringname=cursor.getString(cursor.getColumnIndex("name"));Stringphone=cursor.getString(cursor.getColumnIndex("phone"));Log.i(TAG,"personid="+personid+",name="+name+",phone="+phone);}cursor.close();}publicvoidtestDelete()throwsThrowable{ContentResolvercontentResolver=this.getContext().getContentResolver();Uriuri=Uri.parse("content://com.ljq.provider.personprovider/person/1");contentResolver.delete(uri,null,null);}}

更多相关文章

随机推荐