Android应用开发中核心的四大组件是整体应用的骨架,利用好四大组件才能搭建出一个合理高效的APP。ContentProvider是四大组件的最后一位,放在最后介绍自然是有原因的,它的使用频率远没有另外三者高。ContentProvider一般为存储和获取数据提供统一的接口,可以在不同的应用程序之间共享数据。
本文已收录至☞Android学习路线_梳理
上一篇☞Android学习路线_入门篇(六)四大组件之BroadcastReceiver
下一篇☞Android学习路线_入门篇(八)数据持久化之SharedPreferences
1. 基本介绍
1.1 ContentProvider机制
ContentProvider可以理解为一个Android应用对外开放的接口,只要是符合它所定义的Uri格式的请求,均可以正常访问执行操作。它也可以在不同进程间进行数据交互与共享,即常说的跨进程通信。
其他的Android应用可以使用ContentResolver对象通过与ContentProvider同名的方法请求执行,被执行的就是ContentProvider中的同名方法。
ContentProvider的底层是采用 Android中的Binder机制,Binder机制也是我们跨进程通信的基石,以后有机会将会详细介绍Binder机制。
1.2 Uri简介
前面提到ContentProvider处理的是Uri格式的请求,那么Uri是什么呢?
- Uri全称统一资源标识符(Uniform Resource Identifier),是一个用于标识某一互联网资源名称的字符串,该种标识允许用户对任何(包括本地和互联网)的资源通过特定的协议进行交互操作。在Android中,Uri是一种比较常见的资源访问方式。
明白了Uri的含义,那么我们该怎么用它呢?当然是满足一定的格式就好啦,对于ContentProvider而言,支持的Uri的固定格式为**<srandard_prefix>://<authority>/<data_path>/<id>
**,各部分详细介绍如下:
<srandard_prefix>
:ContentProvider的srandard_prefix始终是content://。<authority>
:ContentProvider的名称。<data_path>
:请求的数据类型。<id>
:指定请求的特定数据。
2. ContentProvider
在Android中,如果要创建自己的内容提供者的时候,需要扩展抽象类ContentProvider,并重写其中定义的各种方法。然后在AndroidManifest.xml文件中注册该ContentProvider即可。ContentProvider是内容提供者,实现Android应用之间的数据交互,对于数据操作,无非也就是CRUD而已。
2.1 注册
在AndroidManifest.xml文件中对ContentProvider进行配置,使用一个<provider>
标签,一般只需要设置两个属性即可访问,其他一些额外的属性就是为了设置访问权限而存在的:
name
:provider的响应类。authorities
:Provider的唯一标识,用于Uri匹配,一般为ContentProvider类的全名。
<provider
android:name=".SimpleProvider"
android:authorities="com.example.myapplication.SimpleProvider" >
</provider>
2.2 实现
我们知道ContentProvider是在不同进程间进行数据交互与共享的组件,那么它的核心作用自然是对数据的添加、删除、更新、查询四大操作。
4个核心方法:
-
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 中的数据
- 上述4个方法由外部进程回调,并运行在ContentProvider进程的Binder线程池中(不是主线程)。
- 存在多线程并发访问,需要实现线程同步。
- 若ContentProvider的数据存储方式是使用SQLite且只使用一个,则不需要实现线程同步,因为SQLite内部实现好了线程同步;若是多个SQLite则需要实现线程同步,因为SQL对象之间无法进行线程同步。
- 若ContentProvider的数据存储方式是内存,则需要自己实现线程同步。
2个其他方法:
-
public boolean onCreate()
ContentProvider创建后或打开系统后其它进程第一次访问该ContentProvider时,由系统进行调用,运行在ContentProvider进程的主线程,故不能做耗时操作。 -
public String getType(Uri uri)
得到ContentProvider提供的数据类型,即返回当前Uri所代表数据的MIME类型。
2.3 代码示例
import android.content.ContentProvider
import android.content.ContentUris
import android.content.ContentValues
import android.content.UriMatcher
import android.database.Cursor
import android.net.Uri
import android.os.Bundle
import android.util.Log
class SimpleProvider : ContentProvider() {
private val TAG = "SimpleProvider"
companion object {
private val URI_MATCHER = UriMatcher(
UriMatcher.NO_MATCH)
private const val DATA = 1
init {
// 添加URI筛选,使用通配符#,匹配任意数字作为id
URI_MATCHER.addURI("com.example.myapplication.SimpleProvider",
"data/#", DATA)
}
}
override fun onCreate(): Boolean {
Log.i(TAG, "onCreate()被调用")
return true
}
override fun insert(uri: Uri, values: ContentValues?): Uri? {
var resultUri: Uri? = null
//解析Uri,返回Code
val flag = URI_MATCHER.match(uri)
if (flag == DATA) {
// TODO 执行插入操作,获取id,此处模拟返回id为123456的长整型
val id = 123456L
Log.i(TAG, "插入成功, id=$id")
resultUri = ContentUris.withAppendedId(uri, id)
}
return resultUri
}
override fun delete(uri: Uri, selection: String?, selectionArgs: Array<String>?): Int {
var count = -1
try {
val flag = URI_MATCHER.match(uri)
if (flag == DATA) {
//单条数据,使用ContentUris工具类解析出结尾的Id
val id = ContentUris.parseId(uri)
// TODO 执行删除操作,获取被删除的数据数,此处模拟返回1
count = 1
}
} catch (e: Exception) {
e.printStackTrace()
}
Log.i(TAG, "删除成功,count=$count")
return count
}
override fun update(uri: Uri, values: ContentValues?, selection: String?,
selectionArgs: Array<String>?): Int {
var count = -1
try {
val flag = URI_MATCHER.match(uri)
if (flag == DATA) {
val id = ContentUris.parseId(uri)
// TODO 执行更新操作,获取被更新的数据数,此处模拟返回1
count = 1
}
} catch (e: Exception) {
e.printStackTrace()
}
Log.i(TAG, "更新成功,count=$count")
return count
}
override fun query(uri: Uri, projection: Array<String>?, selection: String?,
selectionArgs: Array<String>?, sortOrder: String?): Cursor? {
var cursor: Cursor? = null
try {
val flag = URI_MATCHER.match(uri)
if (flag == DATA) {
val id = ContentUris.parseId(uri)
cursor = // TODO 执行查询操作,获取查询结果
}
} catch (e: Exception) {
e.printStackTrace()
}
Log.i(TAG, "查询成功,Count=" + (cursor?.count?:0))
return cursor
}
override fun getType(uri: Uri): String? {
val flag = URI_MATCHER.match(uri)
var type: String? = null
when (flag) {
DATA -> {
type = "vnd.android.cursor.item/data"
Log.i(TAG, "getType return item")
}
}
return type
}
override fun call(method: String, arg: String?, extras: Bundle?): Bundle? {
Log.i(TAG, method)
val bundle = Bundle()
bundle.putString("returnCall", "call被执行了")
return bundle
}
}
3. ContentResolver
ContentResolver用于统一管理不同 ContentProvider 间的操作,即通过 URI 即可操作不同的ContentProvider 中的数据,外部进程通过 ContentResolver类从而与目标ContentProvider类进行交互。
3.1 实现
ContentResolver 类提供了与ContentProvider类相同名字和作用的4个方法:
-
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 中的数据
3.2 代码示例
// 使用ContentResolver前,需要先获取ContentResolver
// 可通过在所有继承Context的类中 通过调用getContentResolver()来获得ContentResolver
val resolver = getContentResolver()
// 设置ContentProvider的URI,根据URI 操作 ContentProvider中的数据
val uri = Uri.parse("content://com.example.myapplication.SimpleProvider/data")
// 进行增加数据操作,创建一个ContentValues对象设定需要增加的数据
var values = ContentValues()
values.put("name", "Demo")
val resultUri = resolver.insert(uri, values)
// 进行删除数据操作
resolver.delete(uri, null, null)
// 进行数据修改操作,创建一个ContentValues对象设定更新后的数据,通过匹配条件确定被更新的源数据
values = ContentValues()
values.put("name", "DemoNew")
resolver.update(uri, values, "name=?", listOf("Demo").toTypedArray())
// 进行数据查询操作
val resultCursor = resolver.query(uri, null, "name=?", listOf("Demo").toTypedArray(), null)
完毕
今天的分享就到这里,文章多有不足,各位小伙伴有什么想法可以直接评论或是私信,要是对你有所帮助就给我一个赞吧,喜欢我的小伙伴可以关注我哦~
本文已收录至☞Android学习路线_梳理
上一篇☞Android学习路线_入门篇(六)四大组件之BroadcastReceiver
下一篇☞Android学习路线_入门篇(八)数据持久化之SharedPreferences
支持我的小伙伴们可以微信搜索“Android思维库”,或者微信扫描下方二维码,关注我的公众号,每天都会推送新知识~