ContentProvider的用法一般有两种,一种是使用现有的ContentProvider来读取和操作相应程序中的数据,另一种是创建自己的ContentProvider给我们程序的数据提供外部访问接口。那么接下来我们就一个一个开始学习吧,首先从使用现有的ContentProvider开始。
如果一个应用程序通过ContentProvider对其数据提供了外部访问接口,那么任何其他的应用程序就都可以对这部分数据进行访问。Android系统中自带的电话簿、短信、媒体库等程序都提供了类似的访问接口,这就使得第三方应用程序可以充分地利用这部分数据来实现更好的功能。下面我们就来看一看,ContentProvider到底是如何使用的。
8.3.1 ContentResolver 的基本用法
对于每一个应用程序来说,如果想要访问ContentProvider 中共享的数据,就一定要借助ContentResolve 类,可以通过Context 中的getContentResolve() 方法获取该类的实例。 ContentResolver中提供了一系列的方法用于对数据进行CRUD操作,其中insert()方法用于添加数据,update()方法用于更新数据,delete()方法用于删除数据,query()方法用于查询数据。有没有似曾相识的感觉?没错,SQLiteDatabase中也是使用这几个方法来进行CRUD操作的,只不过它们在方法参数上稍微有一些区别。
不同于SQLiteDatabase ,ContentResolver 中的增删改查方法都是不接收表名参数的,而是使用一个Uri 参数代替,这个参数被称为内容URI。内容URI 给ContentProvider 中的数据建立了为一标识符,它主要由两个部分组成:anthority 和 path 。anthority 是用于对不同的应用程序做区分的,一般为了避免冲突,会采用应用包名的方式进行命名。比如某个应用包名是com.example.app,那么该应用对应的anthority 就可以命名为 com.example.app.provider。path 这是用于对同一应用程序中不同的表做区分,通常会添加到anthority 的后面。比如某个应用的数据库里存在两张表table1 和table2 ,这时就可以将path 分别命名为/table1 和 /table2 ,然后把anthority 和 path 进行组合,内容URI 就变成了com.example.app.provider/table1 和 com.example.app.provider/table2 。不过目前还很难辨认出这两个字符串就是内容URI,我们还需要在字符串的头部加上协议声明。因此,内容URI 最标准的格式如下:”
content://com.example.app.provider/table1
content://com.example.app.provider/table2
有没有发现,内容URI可以非常清楚地表达出我们想要访问哪个程序中哪张表里的数据。
也正是因此,ContentResolver中的增删改查方法才都接收Uri对象作为参数,因为如果使用表名的话,系统将无法得知我们期望访问的是哪个应用程序里的表。
在得到了内容URI字符串之后,我们还需要将它解析成Uri对象才可以作为参数传入。解析的方法也相当简单,代码如下所示:
Uri uri=Uri.parse("content://com.example.app.provider/tablel")
只需要调用Uri.parse()方法,就可以将内容URI字符串解析成Uri对象了。
这些参数和SQLiteDatabase中query()方法里的参数很像,但总体来说要简单一些,毕竟这是在访问其他程序中的数据,没必要构建过于复杂的查询语句。下表对使用到的这部分参数进行了详细的解释。
查询完成后返回的仍然是一个Cursor对象,这时我们就可以将数据从Cursor对象中逐读取出来了。读取的思路仍然是通过移动游标的位置来遍历Cursor的所有行,然后再取出每行中相应列的数据,代码如下所示:
val column1 = cursor.getString(cursor.getColumnIndex("column1"))
val column2 = cursor.getInt(cursor.getColumnIndex("column2"))
掌握了最难的查询操作,剩下的增加、修改、删除操作就更不在话下了。我们先来看看如何向table1表中添加一条数据,代码如下所示:
// 这个contentValuesOf 方法我们在前一章的Kotlin 课堂已经写过,所以直接用
val value = contentValuesOf("column1" to "text","column2" to 1)
contentResolver.insert(uri,value)
可以看到,仍然是将待添加的数据组装到ContentValues中,然后调用ContentResolver的insert()方法,将Uri和ContentValues作为参数传入即可。
现在如果我们想要更新这条新添加的数据,把column1的值清空,可以借助ContentResolver的update()方法实现,代码如下所示:
val value = contentValuesOf("column1" to "")
contentResolver.update(uri,value,"column1=? and column2=?", arrayOf("text","1"))
注意上述代码使用了selection和selectionArgs参数来对想要更新的数据进行约束,以防止所有的行都会受影响。
最后,可以调用ContentResolver的delete()方法将这条数据删除掉,代码如下所示:
val value = contentValuesOf("column1" to "")
contentResolver.delete(uri,"column2=?", arrayOf("1"))
到这里为止,我们就把ContentResolver中的增删改查方法全部学完了。是不是感觉一看就懂?因为这些知识早在上一章中学习SQLiteDatabase的时候你就已经掌握了,所需特别注意的就只有uri这个参数而已。那么接下来,我们就利用目前所学的知识,看一看如何读取系统电话簿中的联系人信息。
8.3.2 读取系统联系人
由于我们之前一直使用的都是模拟器,电话簿里面并没有联系人存在,所以现在需要自己手动添加几个,以便稍后进行读取。
这样准备工作就做好了,现在新建一个ContactsTest项目,让我们开始动手吧。
首先还是来编写一下布局文件,这里我们希望读取出来的联系人信息能够在ListView 或 RecyclerView中显示,因此,修改activity_main.xml中的代码,如下所示:
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">
<ListView
android:id="@+id/listView"
android:layout_width="match_parent"
android:layout_height="match_parent"
/>
</LinearLayout>
简单起见,LinearLayout里就只放置了一个ListView。这里使用ListView而不是RecyclerView,是因为我们要将关注的重点放在读取系统联系人上面,如果使用RecyclerView的话,代码偏多,会容易让我们找不着重点。
接着修改MainActivity中的代码,如下所示:
class MainActivity : AppCompatActivity() {
private val contactsList = ArrayList<String>()
private lateinit var adapter: ArrayAdapter<String>
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
adapter = ArrayAdapter<String>(this,android.R.layout.simple_list_item_1,contactsList);
listView.adapter = adapter
if (ContextCompat.checkSelfPermission(this,Manifest.permission.READ_CONTACTS) !=
PackageManager.PERMISSION_GRANTED){
ActivityCompat.requestPermissions(this, arrayOf(Manifest.permission.READ_CONTACTS),1)
}else{
readContacts()
}
}
override fun onRequestPermissionsResult(
requestCode: Int,
permissions: Array<out String>,
grantResults: IntArray
) {
super.onRequestPermissionsResult(requestCode, permissions, grantResults)
when(requestCode){
1 -> {
if (grantResults.isNotEmpty() && grantResults[0] == PackageManager.PERMISSION_GRANTED){
readContacts()
}else{
Toast.makeText(this,"You denied the permission",Toast.LENGTH_LONG).show()
}
}
}
}
private fun readContacts(){
// 查询联系人数据
contentResolver.query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI, null,null, null,null)?.apply {
while (moveToNext()){
// 获取联系人姓名
val displayName = getString(getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME))
// 获取联系人手机号
val number = getString(getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER))
contactsList.add("联系人:$displayName\n手机号:$number")
}
adapter.notifyDataSetChanged()
close()
}
}
}
在onCreate()方法中,我们首先获取了ListView控件的实例,并给它设置好了适配器,然后开始调用运行时权限的处理逻辑,因为READCONTACTS权限是属于危险权限的。关于运行时权限的处理流程相信你已经熟练掌握了,这里我们在用户授权之后调用readContacts()方法来读取系统联系人信息。
下面重点看一下readContacts()方法,可以看到,这里使用了ContentResolver的query()方法来查询系统的联系人数据。不过传入的Uri参数怎么有些奇怪啊?为什么没有调用Uri.parse()方法去解析一个内容URI字符串呢?这是因为ContactsContract.CommonData-Kinds.Phone类已经帮我们做好了封装,提供了一个CONTENT URI常量,而这个常量就是使用Uri.parse()方法解析出来的结果。接着我们对Cursor对象进行遍历,将联系人姓名和手机号这些数据逐个取出,联系人姓名这一列对应的常量是ContactsContract.CommonDatakinds.Phone.DISPLAY NAME,联系人手机号这一列对应的常量是ContactsContract.CommonData-Kinds.Phone.NUMBER。两个数据都取出之后,将它们进行拼接,并且在中间加上换行符,然后将拼接后的数据添加到ListView的数据源里,并通知刷新一下ListView。最后千万不要忘记将Cursor对象关闭掉。
这样就结束了吗?还差一点点,读取系统联系人的权限千万不能忘记声明。修改AndroidManifest.xml中的代码,如下所示:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.contactstest">
<uses-permission android:name="android.permission.READ_CONTACTS"/>
...
</manifest>
加入了android.permission.READCONTACTS权限,这样我们的程序就可以访问到系统的联系人数据了。现在才算是大功告成了,让我们来运行一下程序吧。