关于ContentProvider

1,673 阅读5分钟

前言

内容提供者(ContentProvider),跨进程共享数据(aidl是跨进程共享功能)。

内容提供程序管理对中央数据存储区的访问。提供程序是 Android 应用的一部分,通常提供自己的 UI 来使用数据。 但是,内容提供程序主要旨在供其他应用使用,这些应用使用提供程序客户端对象来访问提供程序。 提供程序与提供程序客户端共同提供一致的标准数据界面,该界面还可处理跨进程通信并保护数据访问的安全性

内容提供程序管理对结构化数据集的访问。它们封装数据,并提供用于定义数据安全性的机制。 内容提供程序是连接一个进程中的数据与另一个进程中运行的代码的标准接口。可以将应用中的数据对外进行共享。数据访问方式统一,不必针对不同数据类型采取不同的策略。将数据封装,只暴露出我们希望提供给其他程序的数据。数据更新可被监听。

如果您不打算与其他应用共享数据,则无需开发自己的提供程序。 不过,您需要通过自己的提供程序在您自己的应用中提供自定义搜索建议。 如果您想将复杂的数据或文件从您的应用复制并粘贴到其他应用中,也需要创建您自己的提供程序。 Android 本身包括的内容提供程序可管理音频、视频、图像和个人联系信息等数据。 android.provider 软件包参考文档中列出了部分提供程序。 任何 Android 应用都可以访问这些提供程序,但会受到某些限制。

注:提供程序无需具有主键,也无需将 _ID 用作其主键的列名称(如果存在主键)。 但是,如果您要将来自提供程序的数据与 ListView 绑定,则其中一个列名称必须是 _ID。 显示查询结果部分详细说明了此要求。

一、Content URI

格式:content://authorities/path/id
实例:content://com.hdib.provider/user/4

content://:协议名,表示这是一个Content URI,用于访问 ContentProvider。
authorities:是提供程序的授权,相当于域名,指定某个 ContentProvider。
path:表示路径,通常用表名表示。
id:具体数字(long),用于指定访问具体哪一行数据。ContentUris.withAppendedId(CONTENT_URI,4);

以下内容在自定义ContentProvider内部使用,用于配置匹配信息,方便URI识别。

UriMatcher uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);//URI匹配器
uriMatcher.addURI(Common.AUTHORITY, path, uriValue);//添加URI匹配规则
int uriValue = uriMatcher.match(uri);//根据URI获取上面配置的匹配值。

二、权限

如果Provider应用未指定任何权限,则访问者应用将无权访问Provider应用的数据。 但是,无论指定权限为何或者不指定,Provider应用中的组件始终具有完整的读取和写入访问权限。

//provider应用中provider组件配置
<provider
    android:name=".MyContentProvider"
    android:authorities="${applicationId};com.hdib"
    android:exported="true"
    android:grantUriPermissions="true"
    android:permission="com.hdib"
    android:readPermission="com.hdib.READ"
    android:writePermission="com.hdib.WRITE" />

//访问者应用中权限配置,非系统提供的权限,必须先定义后使用。
<permission android:name="com.hdib"/>
<permission android:name="com.hdib.READ"/>
<permission android:name="com.hdib.WRITE"/>

<uses-permission android:name="com.hdib" />
<uses-permission android:name="com.hdib.READ" />
<uses-permission android:name="com.hdib.WRITE" /> 
  • exported="true":允许跨进程访问
  • grantUriPermissions="true":允许临时权限访问,意味着允许跨进程访问的情况下,其他应用可以访问该Provider。
  • authorities="${applicationId};com.hdib:表示可以访问该Provider的URI有两个${applicationId}com.hdib
  • permission="com.hdib":指定访问权限,访问者应用要想通过URI直接访问该Provider,那么必须有此权限,如果provider应用只配置这一个权限,那么访问者应用具备此权限时,就可以读写provider应用的数据。
  • readPermission="com.hdib.READ":如果provider配置了该权限,由于优先级高于permission,后者配置失效,如果访问者应用具备该权限,那么该配置允许访问者应用读取provider的数据。
  • writePermission="com.hdib.WRITE":如果provider配置了该权限,由于优先级高于permission,后者配置失效,如果访问者应用具备该权限,那么该配置允许访问者应用写入数据到provider中。

三、ContentResolver CRUD

所有操作都依赖Uri,关于Uri的常用操作如下:

Uri baseUri = Uri.parse(content://com.hdib.provider);
Uri uri = Uri.withAppendedPath(baseUri, "user");
Uri uriNew = ContentUris.withAppendedId(uri, id);
long id = ContentUris.parseId(uri);
String table = uri.getPathSegments().get(0);

增(C)

添加数据,可以添加一条或多条数据。需要注意的是不管哪种情况最后都是一条一条的插入,执行的是provider的public Uri insert(Uri uri, ContentValues values)方法。

ContentValues values = new ContentValues();
values.put("name","大枣");
values.put("color","红色");
Uri uri = getContentResolver().insert(uri,values);//values是ContentValues对象

int rows = getContentResolver().insert(uri,valuess);//valuess是ContentValues数组

//小知识
//ContentValues实现方式是一个HashMap,特点是key都是String
//BaseNameValuePair的key和value都是String

删(D)

删除的是满足条件的行,可能删除多行。对应执行的是provider的public int delete(Uri uri, String selection, String[] selectionArgs)方法。

int rows = getContentResolver().delete(uri,"name=?",new String[]{"大枣"});

改(U)

修改的是满足条件的行,可能修改多行。对应执行的是provider的public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)方法。

ContentValues values = new ContentValues();
values.put("color","绿色");
getContentResolver().update(uri,values,"name=? and color=?",new String[]{"大枣","红色"});

查(R)

查询的是满足条件的行,一般会返回不止一条数据。对应执行的是provider的 public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)方法。

Cursor cursor = getContentResolver().query(
					uri,
					projection,
					selection,
					selectionArgs,
					sortOrder);

事务

使用事务处理数据。对应执行的是provider的 public ContentProviderResult[] applyBatch(ArrayList<ContentProviderOperation> operations) throws OperationApplicationException方法。

ArrayList<ContentProviderOperation>ops = new ArrayList<ContentProviderOperation>();  
//添加一个删除User表的操作 
ops.add(ContentProviderOperation.newDelete(User.CONTENT_URI).build());
//添加一条记录到Home表
ops.add(ContentProviderOperation.newInsert(Home.CONTENT_URI).withValues(values).build());
//处理事务 
getContentResolver().applyBatch(PROVIDER.AUTHORITY,ops);

四、读取联系人信息案例

运行时权限:Manifest.permission.READ_CONTACTS

Cursor cursor = getContentResolver().query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI,null,null,null,null);

if(cursor==null){return ;}

while(cursor.moveToNext()){
	String name = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
	String number = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
	FastToast.show(context,name+":"+number);
}

五、自定义ContentProvider

这里不多说了,比较杂,直接看Demo,你想知道的自定义ContentProvider的一切都在这了。
包括数据库内容(增删改查、数据库加密),数据表管理、数据库升级管理等。

六、注册监听器监听Provider数据改变

getContentResolver().registerContentObserver(uri, true, new ContentObserver(new Handler()) {
    public void onChange(boolean selfChange) {                              
        //TODO收到数据改变,在此做出相应处理。
    }
});

要使监听生效,自定义Provider中,每个操作成功后都需要调用如下方法进行通知:getContext().getContentResolver().notifyChange(uri, null);

附:参考

官方文档