Android ContentProvider详解
Android提供了5种方式来让用户保存持久化应用程序数据。根据自己的需求来做选择,比如数据是否是应用程序私有的,是否能被其他程序访问,需要多少数据存储空间等,分别是:
- 使用SharedPreferences存储数据
- 文件存储数据
- SQLite数据库存储数据
- 使用ContentProvider存储数据
- 网络存储数据
咱们今天就来学习一下ContentProvider。作为Android四大巨头之一的他有点名不副实,因为在一般的开发过程中,使用的次数比较少。大部分应用的数据缓存用SharedPreferences就能搞定了。
ContentProvider(数据提供者)是应用程序之间共享数据的一种接口机制,是一种更为高级的数据共享方法。
ContentProvider可以指定需要共享的数据,而其他应用程序则可以在不知道数据来源、路径的情况下,对共享数据进行增删改查等操作。
在Android系统中,许多Android系统内置的数据也是通过ContentProvider提供给用户使用,例如通讯录、音视频文件和图像文件等。
image
什么是ContentProvider
- ContentProvider是Android的四大组件之一,以标准化的方式在Android 应用间共享数据。
- ContentProvider封装的数据存储以及增删改查等,并且必须实现一个对外统一的接口(Uri)。
什么是Uri
Uri(通用资源标识符 Universal Resource Identifer),代表数据操作的地址,每一个ContentProvider都会有唯一的地址。
ContentProvider使用的Uri语法结构如下:
content://authority/data_path/id
- content:// 是通用前缀,表示该Uri用于ContentProvider定位资源。
- authority 是授权者名称,用来确定具体由哪一个ContentProvider提供资源。因此一般authority都由类的小写全称组成,以保证唯一性。
- data_path 是数据路径,用来确定请求的是哪个数据集。
- id 是数据编号,用来请求单条数据。如果是多条这个字段忽略。
样例:
content://com.scc.userprovider/user多条
content://com.scc.userprovider/user/10单条
什么是ContentResolver
- ContentResolver是数据调用者,ContentProvider将数据发布出来,通过ContentResolver对象结合Uri进行调用。
- 一般来说ContentProvider是单例模式,多个应用可通过ContentResolver调用ContentProvider的增删改查操作数据,ContentResolver调用的数据操作会让同一个ContentProvider处理。
创建ContentProvider
-
创建一个类让其继承ContentProvider,并重载6个函数
image
需要实现的主要方法是:
- insert()、delete()、update()、query():用于对数据集的增删改查操作。
- onCreate():一般用来初始化底层数据集和建立数据连接等工作
-
getType():用来返回指定Uri的MIME数据类型,
- 若Uri是单条数据,则返回的MIME数据类型以vnd.Android.cursor.item开头;
- 若Uri是多条数据,则返回的MIME数据类型以vnd.android.cursor.dir/开头。
数据访问方法如insert(Uri,ContentValues)和update(Uri,ContentValues,Bundle) 可以同时从多个线程调用,并且必须是线程安全的。其他方法如onCreate() 仅从应用程序主线程调用,并且必须避免执行冗长的操作。请参阅其预期线程行为的方法描述。
- 声明Uri规则,实现UriMatcher
咱先来看看UriMatcher是干嘛的,UriMatcher本质上是一个文本过滤器,有助于解析Uri,用在ContentProvider中帮助我们过滤,分辨出查询者想要查询哪个数据表。
UriMatcher的构造函数中,UriMatcher.NO_MATCH是Uri无匹配时的返回代码,值为-1。addUri()方法用来添加新的匹配项,语法为:
public void addUri(String authority, String path, int code)
- authority表示匹配的授权者名称;
- path表示数据路径;
- code表示返回代码。
下面咱搞个实例:
//这里的名称必须与AndroidManifest.xml中android:authorities保持一致
public static final String AUTHORITY = "com.scc.userprovider";
//数据路径
public static final String PATH_USERS = "user";
//访问ContentProvider的URL
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/" + PATH_USERS);
//返回代码
public static final int USER_INFO = 1;
//创建UriMatcher对象
private static UriMatcher uriMatcher;
//创建静态代码块
static {
//实例化UriMatcher对象
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
//参数1:authority;参数2:路径;参数3:自定义代码
uriMatcher.addURI(UserInfoContent.AUTHORITY, UserInfoContent.PATH_USERS, USER_INFO);
}
- 注册ContentProvider
在AndroidManifest.xml文件中的 application节点下使用标签注册。样例:
<!--
android:name指定ContentProvider实现的类名
android:authorities指定ContentProvider对应Uri(相当于ContentProvider分配一个域名)
android:exported指定ContentProvider是否允许其他应用调用。
如果将该属性设置为true,则允许其他应用调用-->
<android:authorities="com.scc.userprovider"
android:name=".UserProvider"
android:exported="true"/>
使用ContentProvider
- 通过insert()方法添加单条数据
ContentValues cv = new ContentValues();
cv.put(UserInfoContent._ID, bean.get_id());
cv.put(UserInfoContent.USER_NAME, bean.getName());
cv.put(UserInfoContent.USER_AGE, bean.getAge());
cv.put(UserInfoContent.USER_UPDATE_TIME, bean.getUpdate_time());
Uri uri = getContentResolver().insert(UserInfoContent.CONTENT_URI, cv);
Log.e(getClass().getName(), "insert:" + uri);
- 通过bulkInsert()方法添加多条数据
ContentValues[] arrayValues = new ContentValues[10];
//实例化每一个ContentValues...
int count = getContentResolver().bulkInsert(UserInfoContent.CONTENT_URI, arrayValues);
image
- 指定ID删除单条数据
int delete = getContentResolver().delete(UserInfoContent.CONTENT_URI, "_id=12", null);
Log.e(getClass().getName(), "delete(失败返回-1):" + delete);
- 通过selection语句删除多条数据
String selection = UserInfoContent._ID + ">12";
int result = getContentResolver().delete(UserInfoContent.CONTENT_URI, selection, null);
image
- 修改数据
UserInfoBean bean = new UserInfoBean("蚩尤", 32, "12:00");
ContentValues cv = new ContentValues();
cv.put(UserInfoContent.USER_NAME, bean.getName());
cv.put(UserInfoContent.USER_AGE, bean.getAge());
cv.put(UserInfoContent.USER_UPDATE_TIME, bean.getUpdate_time());
getContentResolver().update(UserInfoContent.CONTENT_URI, cv, "_id=18", null);
image
- 查询数据
Cursor cursor = getContentResolver().query(UserInfoContent.CONTENT_URI, null, selection, null, null);
//循环取出游标指向的每条用户记录
while (cursor.moveToNext()) {
UserInfoBean user = new UserInfoBean();
user.name = cursor.getString(cursor.getColumnIndex(UserInfoContent.USER_NAME));
user.age = cursor.getInt(cursor.getColumnIndex(UserInfoContent.USER_AGE));
user._id = cursor.getString(cursor.getColumnIndex(UserInfoContent._ID));
user.update_time = cursor.getString(cursor.getColumnIndex(UserInfoContent.USER_UPDATE_TIME));
userList.add(user); //添加到用户信息列表
}
cursor.close(); //关闭数据库游标
Log.e(getClass().getName(), "Query用户:" + String.format("当前共找到%d个用户", userList.size()));
image
跨应用使用ContentProvider
跨应用和本应用使用ContentProvider一样的方法,这边就不做复制了。
例5的Uri是拼接字段,但是拼接后的结果
content://com.scc.userprovider/user。
跨平台使用getContentResolver().方法 的第一个参数:
Uri uricontent = Uri.parse("content://com.scc.userprovider/user");
ContentValues cv = new ContentValues();
cv.put(UserInfoContent._ID, bean.get_id());
cv.put(UserInfoContent.USER_NAME, bean.getName());
cv.put(UserInfoContent.USER_AGE, bean.getAge());
cv.put(UserInfoContent.USER_UPDATE_TIME, bean.getUpdate_time());
Uri uri = getContentResolver().insert(uricontent, cv);
Log.e(getClass().getName(), "insert:" + uri);
-
新增数据+查找数据
image -
修改数据+删除数据
image
java.lang.SecurityException: Permission Denial: opening provider com.scc.cp.UserProvider from ProcessRecord
解决方案:
在AndroidManifest.xml文件中的 application节点下使用<provider>标签注册时android:exported="false"时,不允许其他应用调用。所以其他和应用使用ContentProvider会崩溃报错。将exported改为:android:exported="true"即可。