0x00 前言
这篇关于 ContentProvider 的总结文章,早在四月份就想写了,但是一直没有时间和精力去写,而且我也不想随便写一下,还是希望能保证一定的文章质量。恰巧昨天为自己定了一个目标,就是每周学习一个主题,并输出相关总结文章或例程。所以,第一周的主题就定为ContentProvider。下面看下本文会涉及到的几点内容:
- 什么是 ContentProvider;
- 使用 ContentProvider 的优点;
- 一个使用系统 ContentProvider 的例程。
0x01 ContentProvider简介
关于 ContentProvider,搞 Android 的人都不会陌生,它是 Andriod 中的四大组件之一,但或许是存在感最低的一个组件。为什么这么说呢?因为一般来说我们开发应用很少会去自定义这种组件,但是其实它非常重要和有用。我们先来看下它的作用:
一看到它的名字——内容提供者,就能大概猜到它与数据是相关的,它的作用就是实现数据共享,这个共享不仅仅限于本应用内部,还包括系统中的其他应用(即跨进程的数据共享)。为此,它实现了一套标准的接口方法用于存取(增、删、改、查,这些操作其实和标准的 SQL 操作是类似的)它管理的数据,而底层的数据如何存储(存储于文件系统或者 SQLite 数据库等),调用者根本不用去关心:
// 查询记录
Cursor query (Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
// 插入记录
Uri insert (Uri uri, ContentValues values)
// 更新记录
int update (Uri uri, ContentValues values, String selection, String[] selectionArgs)
// 删除记录
int delete (Uri uri, String selection, String[] selectionArgs)
虽然 ContentProvider 定义了一系列的方法,但是我们的应用并不直接调用这些方法,而是使用一个ContentResolver对象,通过调用它的方法(与 ContentProvider 中的方法一一对应)作为替代,如图1所示。
图 1:图片来自 Udacity 学院课程截图
说到这里大家肯定会奇怪,ContentResolver 是如何定位到我们想要的那个的ContentProvider 的呢?你要知道Android系统已经为我们提供了很多的 ContentProvider,例如日历、联系人、多媒体(音频、视频以及图像)等数据。
其实,答案就是各个方法参数中的 Uri,就像你在浏览器的地址栏中输入一个网址 (URL),按下回车后,浏览器就会向服务器发起请求,而对应的服务器会返回相应的结果给浏览器。类似地,当ContentResolver
也是通过一个给定的 URI (UR L是 URI 的一个子集)发起请求,Android 系统会根据给定URI中的authority(URI 的组成部分找到那个 ContentProvider ,并将该请求传递给该 ContentProvider。每个 ContentProvider 的 authority 都是唯一的,而且都会在 Android 系统注册。ContentProvider 收到请求后,会解析 URI 剩余的部分(通过辅助类UriMatcher实现),然后返回相应数据。
通过以上内容,我想大家对 ContentProvider 应该有了一个大概的了解了吧,下面我将通过用户词典(user dictionary:用于存储一些用户想保存的非标准单词的拼写)这个系统内置的 ContentProvider来向大家说明如何使用它。
0x02 如何使用 ContentProvider
我们要知道 ContentProvider 提供的数据的形式与一般关系型的数据库是一样的,都是通过一张或多张的数据库表来实现的,例如用户词典的数据表是这样的,其中每一行代码一个单词实例,每一列代表每个单词的属性:
表1:用户词典数据表样例引用
word | app id | frequency | locale | _ID |
---|---|---|---|---|
mapreduce | user12 | 100 | en_US | 1 |
applet | user2 | 200 | pt_BR | 2 |
const | user1 | 255 | en_UK | 3 |
上面这个表跟我们平时操作的数据表没有什么区别嘛,说下本节我们要实现的功能就是通过一个ListView
来显示表1中的数据,就这么简单,具体步骤如下:
(1) 获取相应 ContentProvider 的权限
Android 系统中内置了很多的 ContentProvider,当我们访问它们时,需要在AndroidManifest.xml
文件中声明相应的读/写权限,如果你声明了写权限,应该不需要再申请读权限,用户词典的具体权限声明如下所示:
<uses-permission android:name="android.permission.READ_USER_DICTIONARY"/>
<uses-permission android:name="android.permission.WRITE_USER_DICTIONARY" />
(2) 访问正确的 ContentProvider
如前面所述,我们的应用不会直接访问 ContentProvider,我们需要通过 ContentResolver 以及正确的 URI,如图2所示,同时调用相应的方法:
query
、insert
、update
和delete
。
图 2:图片来自 Udacity 学院课程截图
我们这个例子只是简单地查询数据,具体示例代码如下所示:
// 获取 ContentResolver 用于向 ContentProvider 发送数据请求
ContentResolver resolver = getContentResolver();
// 获取 Cursor,它包含了Words数据表的所有行
Cursor cursor = resolver.query(UserDictionary.Words.CONTENT_URI, // Uri
null, // projection
null, // selection
null, // selectionArgs
null // sortOrder
);
Content URI
上述代码中query
方法第一个参数UserDictionary.Words.CONTENT_URI
,即之前我们提到的 URI,它一般由三部分组成content://authority/path
,它用于标识 ContentProvider 中的数据记录,详细请参考Content URIs。
(3) 在 UI 上展现数据
我们的目标是在 ListView 中显示这些单词,在第(2)个步骤得到的cursor
其实就相当于一个数据源,所以只要实现相应的 Adapter 即可,具体代码如下所示:
// 使用系统提供的 SimpleCursorAdapter
SimpleCursorAdapter adapter = new SimpleCursorAdapter(this,
android.R.layout.two_line_list_item,
cursor,
COLUMNS_TO_BE_BOUND,
LAYOUT_ITEMS_TO_FILL,
0
);
dictListView.setAdapter(adapter);
0x03 总结
根据以上这些的内容,我们稍微总结一下使用 ContentProvider 的两个优点:
- 底层的数据源对上层是透明的,可以非常方便地替换;
- 允许系统中的多个应用对同一个数据源进行(安全的)访问和修改,而相应的修改对于多个应用来说都是可见的。
看到这里我想很多人会想:如果我们并不想与其他应用共享我们的应用的数据,那么我们应该是不需要开发这种类型的组件。以前我也是这么想的,既然 ContentProvider 底层数据的存储还是通过 SQLite 数据库,为什么要用它呢?其实不然,首先我们使用 SQLite 数据库存储我们的数据,我们还是需要在 SQLite 数据库之上封装一层类似 ContentProvider 提供的那套接口方法;其次,我们还可以利用 Android 系统提供的一些相关功能类与 ContentProvider 配合起来使用。 例如,SyncAdaters
, Loaders
, CursorAdapter
。说到这里我推荐大家一个视频吧,来自2010年 Google IO 大会,讲的是 Android 应用的设计模式(架构),其中一共提出了三种设计模式,而 ContentProvider 在其中扮演了非常重要的角色: