一、介绍
- ContentProvider 内容提供者,是 Android 四大组件之一，被设计用于 不同应用或进程间 数据共享与交互。
- ContentProvider是 Android 中一种数据访问的接口，数据形式可以是数据库、xml、文件等。
- 底层原理是 Binder 机制。
二、具体使用
系统默认实现了很多 ContentProvider 如 联系人、通话记录、媒体信息。开发者可通过相应 Uri 直接访问，本文为加深理解介绍自定义 ContentProvider。
1、Uri
Uniform Resource Identifier 统一资源定位符，在 Android 中是一种常用的资源访问方式。外界进程通过 Uri 查找对应 的 ContentProvider 与其中的数据。
Uri 标准格式：
<srandard_prefix>://<authority>/<data_path>/<id>
- srandard_prefix：ContentProvider的srandard_prefix始终是content://
- <authority>：为ContentProvider 的Authority（唯一标识符，清单文件注册时需要填写）。
- data_path：表名（数据为 数据库形式）、文件名（数据为文件形式）
- id： 具体的某条数据，若无指定 则返回全部。
举例 一个自定义Uri:
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 中的数据
- 也支持文件数据
@Override
public ParcelFileDescriptor openFile(Uri uri, String mode)
throws FileNotFoundException
其他方法：
<-- 2个其他方法 -->
public boolean onCreate()
// ContentProvider创建后 或 打开系统后其它进程第一次访问该ContentProvider时 由系统进行调用
// 注：运行在ContentProvider进程的主线程，故不能做耗时操作
public String getType(Uri uri)
// 得到数据类型，即返回当前 Url 所代表数据的MIME类型
3、ContentResolver
用于统一管理不同 ContentProvider间 操作即：
- 通过 Uri 操作 ContentProvider 中的数据
- 外部进程通过 ContentResolver 类与 ContentProvider 进行交互
Android 系统 或 应用中 会有很多 ContentProvider ，若要直接通过 ContentProvider 进行交互，需了解每一个 相应的ContentProvider，操作成本高，难度大。
故设计ContentResolver 类对所有的 ContentProvider 进行统一管理。
4、ContentObserver
用于 ContentProvider 中数据发生变化时通知观察类
// 步骤1：注册内容观察者ContentObserver
getContentResolver().registerContentObserver（uri,notifyForDescendents,contentObserver）；
// 通过ContentResolver类进行注册，并指定需要观察的URI
// 步骤2：当该URI的ContentProvider数据发生变化时，通知外界（即访问该ContentProvider数据的访问者）
public class UserContentProvider extends ContentProvider {
public Uri insert(Uri uri, ContentValues values) {
db.insert("user", "userid", values);
getContext().getContentResolver().notifyChange(uri, null);
// 通知访问者
}
}
// 步骤3：解除观察者
getContentResolver().unregisterContentObserver（contentObserver）；
// 同样需要通过ContentResolver类进行解除
registerContentObserver 时有一个 notifyForDescendents参数 ：
false 表示精确匹配，即只匹配该Uri，为true 表示可以同时匹配其派生的Uri。比如：
假设UriMatcher 里注册的Uri共有一下类型：
1 、content://com.qin.cb/student (学生)
2 、content://com.qin.cb/student/#
3、 content://com.qin.cb/student/schoolchild(小学生，派生的Uri)
假设我们当前需要观察的Uri为content://com.qin.cb/student，如果发生数据变化的 Uri 为
content://com.qin.cb/student/schoolchild ，当notifyForDescendents为 false，那么该ContentObserver会监听不到， 但是当notifyForDescendents 为ture，能捕捉该Uri的数据库变化。
ContentObserver 类我们一般重写其：
@Override
public void onChange(boolean selfChange, Uri uri) {
super.onChange(selfChange, uri);
}
5、辅助类UriMatcher与ContentUris
- UriMatcher
向 ContentProvider 中注册 Uri。
根据 Uri 返回ContentProvider 中 的数据类型
// 步骤1：初始化UriMatcher对象
UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);
//常量UriMatcher.NO_MATCH = 不匹配任何路径的返回码
// 即初始化时不匹配任何东西
// 步骤2：在ContentProvider 中注册URI（addURI（））
int URI_CODE_a = 1；
int URI_CODE_b = 2；
matcher.addURI("myprovider", "user1", URI_CODE_a);
matcher.addURI("myprovider", "user2", URI_CODE_b);
// 若URI资源路径 = content://cn.scu.myprovider/user1 ，则返回注册码URI_CODE_a
// 若URI资源路径 = content://cn.scu.myprovider/user2 ，则返回注册码URI_CODE_b
// 步骤3：根据URI 匹配 URI_CODE，从而匹配ContentProvider中相应的资源（match（））
@Override
public String getType(Uri uri) {
Uri uri = Uri.parse(" content://myprovider/user1");
switch(matcher.match(uri)){
// 根据URI匹配的返回码是URI_CODE_a
// 即matcher.match(uri) == URI_CODE_a
case URI_CODE_a:
return tableNameUser1;
// 如果根据URI匹配的返回码是URI_CODE_a，则返回ContentProvider中的名为tableNameUser1的表
case URI_CODE_b:
return tableNameUser2;
// 如果根据URI匹配的返回码是URI_CODE_b，则返回ContentProvider中的名为tableNameUser2的表
}
}
- ContentUris
操作 Uri
// withAppendedId（）作用：向URI追加一个id
Uri uri = Uri.parse("content://myprovider/user")
Uri resultUri = ContentUris.withAppendedId(uri, 7);
// 最终生成后的Uri为：content://myprovider/user/7
// parseId（）作用：从URL中获取ID
Uri uri = Uri.parse("content://myprovider/user/7")
long personid = ContentUris.parseId(uri);
//获取的结果为:7
三、代码实现
1、创建数据库
public class DBHelper extends SQLiteOpenHelper {
public static final String DATABASE_NAME = "keke.db";
public static final String USER_TABLE_NAME = "user";
public static final int database_version = 1;
public DBHelper(Context context) {
super(context, DATABASE_NAME, null, database_version);
}
@Override
public void onCreate(SQLiteDatabase db) {
// 创建表格:用户表
db.execSQL("CREATE TABLE IF NOT EXISTS " + USER_TABLE_NAME + "(_id INTEGER PRIMARY KEY AUTOINCREMENT," + " name TEXT)");
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
}
}
2、自定义 ContentProvider
public class MyContentProvider extends ContentProvider {
private Context context;
private SQLiteDatabase db;
public static final String AUTOHORITY = "kekeProvider";
// 设置ContentProvider的唯一标识
public static final int User_Code = 1;
// UriMatcher类使用:在ContentProvider 中注册URI
private static final UriMatcher mMatcher;
static{
mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
// 初始化
mMatcher.addURI(AUTOHORITY,"user", User_Code);
// 若URI资源路径 = content://cn.scu.myprovider/user ，则返回注册码User_Code
}
public MyContentProvider() {
}
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
return 0;
}
@Override
public String getType(Uri uri) {
return null;
}
@Override
public Uri insert(Uri uri, ContentValues values) {
// 根据URI匹配 URI_CODE，从而匹配ContentProvider中相应的表名
// 该方法在最下面
String table = getTableName(uri);
// 向该表添加数据
db.insert(table, null, values);
// 当该URI的ContentProvider数据发生变化时，通知外界（即访问该ContentProvider数据的访问者）
context.getContentResolver().notifyChange(uri, null);
return uri;
}
@Override
public boolean onCreate() {
context = getContext();
DBHelper dbHelper = new DBHelper(context);
// 此处不应做耗时操作 只为快速展示， 请无视
db = dbHelper.getWritableDatabase();
db.execSQL("delete from user");
db.execSQL("insert into user values(1,'Carson');");
db.execSQL("insert into user values(2,'Kobe');");
return true;
}
@Override
public Cursor query(Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder) {
String tableName = getTableName(uri);
return db.query(tableName,projection,selection,selectionArgs,null,null,sortOrder,null);
}
@Override
public int update(Uri uri, ContentValues values, String selection,
String[] selectionArgs) {
return 0;
}
/**
* 根据URI匹配 URI_CODE，从而匹配ContentProvider中相应的表名
*/
private String getTableName(Uri uri){
String tableName = null;
switch (mMatcher.match(uri)) {
case User_Code:
tableName = DBHelper.USER_TABLE_NAME;
break;
}
return tableName;
}
}
清单文件：
<provider
android:name=".MyContentProvider"
android:authorities="kekeProvider"
android:enabled="true"
android:exported="true"></provider>
同进程测试：
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Uri uri = Uri.parse("content://kekeProvider/user");
ContentResolver contentResolver = getContentResolver();
ContentValues values = new ContentValues();
values.put("_id",3);
values.put("name","version");
contentResolver.insert(uri,values);
Cursor cursor = contentResolver.query(uri, new String[]{"_id", "name"}, null, null, null);
while (cursor.moveToNext()) {
Log.d("TestProvider","query book:" + cursor.getInt(0) + " " + cursor.getString(1));
}
cursor.close();
}
}
输出：
D/TestProvider: query book:1 Carson
D/TestProvider: query book:2 Kobe
D/TestProvider: query book:3 version
跨进程测试：
新建一个应用
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Uri uri = Uri.parse("content://kekeProvider/user");
ContentResolver contentResolver = getContentResolver();
ContentValues values = new ContentValues();
values.put("_id",4);
values.put("name","new app test");
contentResolver.insert(uri,values);
Cursor cursor = contentResolver.query(uri, new String[]{"_id", "name"}, null, null, null);
while (cursor.moveToNext()) {
Log.d("TestProvider","query book:" + cursor.getInt(0) + " " + cursor.getString(1));
}
cursor.close();
}
}
输出：
D/TestProvider: query book:1 Carson
D/TestProvider: query book:2 Kobe
D/TestProvider: query book:3 version
D/TestProvider: query book:4 new app test
不同应用之间可自定义permission。不再演示。
四、总结
- 定义 ：内容提供者，Android 四大组件之一
- 作用： 进程间数据共享与交互
- 优点：
1. 安全,为应用间数据交互提供了一个安全的环境，允许把自己的应用数据根据需求 开放给其他应用 增删改查，不用担心开放数据库带来的安全问题。
2. 访问简单 高效，解耦了数据底层的存储方式，使得底层无论如何存储访问方式都是不变的。 - 原理： Binder 机制。
