Android四大组件之ContentProvider知多少
前言：文中全面讲解了ContentProvider，从说明、用法讲解到原理分析，如果各位码友发现问题欢迎指正。
目录结构：
1.简介。
Android的数据存储方式总共有五种，分别是：SharedPreferences、网络存储、文件存储、外储存储、SQLite,但是一般这些存储都只是在同一个应用程序中数据的共享，如果需要操作其他应用程序的一些数据，例如媒体库、通讯录等，该怎么办呢？实现数据和文件在不同应用程序之间的共享是比较复杂的，因此Android提供了ContentProvider来进行进程之间的通信。
ContentProvider是应用程序之间共享数据的的一种机制，是Android向我们提供存储和获取数据的统一的访问方式Content-Provider对数据进行封装，不用关心数据存储的细节。Android为常见的一些数据提供了默认的ContentProvider（包括音频、视频、图片和通讯录等）。
定义：
ContentProvider即内容提供者，是Android四大组件之一。
作用：
跨进程通信，可用于进程间或者不同的App进行数据交互共享,当然也可以只用于一个App内部。常与各种数据库配合使用。
2.原理。
基于Binder机制。
这里先推荐一个网址，后边有机会再补充。
3.使用说明。
3.1 URI（统一资源标识符）。
定义：
Uniform Resource Identifier，即统一资源标识符。
作用：
唯一标识ContentProvider以及其中的数据，进程通过URI找到对应的ContentProvider以及其中的数据，再进行数据操作。
使用：
URI分为系统预置（如通讯录、日程表等）和自定义（一般是自定义数据库）
1)、关于系统预置URI此处不作过多讲解，需要的同学可自行查看。
2)、此处主要讲解自定义URI
Uri uri = Uri.parse("content://com.leisure.provider/user/123")
URI指向的资源是名称是“com.leisure.provider”的“ContentProvider”中表名是“user”的并且“id”是123的数据
另外需要注意URI模式是存在匹配通配符*和#的。
前者*表示匹配任意长度的有效字符的字符串
content://com.leisure.provider/* 表示匹配provider的任何内容。
后者#表示匹配任意长度的数字字符的字符串
content://com.leisure.provider/user/# 匹配provider中的user表的所有行
3.2 MIME类型数据
说明:
MIME类型是一个包含两部分的字符串。
作用:
指定某个扩展名的文件用某种应用程序来打开,如指定.html文件采用text应用程序打开、指定.pdf文件采用flash应用程序打开
构成：
MIME数据 = 类型 + 子类型
text/html // text对应类型，html对应子类型。
text/xml
类型说明：
形式1:单条记录
vnd.android.cursor.item/自定义
形式2:多条记录（集合）
vnd.android.cursor.dir/自定义
注意:
1.vnd:表示父类型和子类型具有非标准的、特定的形式。
2.父类型不能更改,只能区别是单条还是多条记录。
3.子类型可自定义。
使用：
若一个Uri是content://com.leisure.provider/table/111
1).ContentProvider.geType(uri) ，ContentProvider根据URI返回MIME类型
2).单条记录的MIME类型。
若一个Uri是content://com.leisure.provider/table/111
假如是vnd.android.cursor.item/vnd.leisure.content.someone
则ContentProvider会通过ContentProvider.geType(url)返回以下MIME类型
vnd.android.cursor.item/vnd.leisure.content.type
3).多条记录的MIME类型。
若一个Uri是content://com.leisure.provider/table
假如是vnd.android.cursor.dir/vnd.leisure.content.more
则ContentProvider会通过ContentProvider.geType(url)返回以下MIME类型
vnd.android.cursor.dir/vnd.leisure.content.more
3.3工具类。
3.3.1 ContentResolver。
作用:统一管理不同的ContentProvider的操作。
1)通过URI操作不同的ContentProvider中的数据
2)其他应用通过ContentResolver与ContentProvider类进行交互。
四个方法：
//向ContentProvider中添加数据
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)
使用：
// 可通过在所有继承Context的类中通过调用getContentResolver()来获得ContentResolver
ContentResolver resolver = getContentResolver();
// 设置ContentProvider的URI
Uri uri = Uri.parse("content://com.leisure.provider/user");
// 根据URI 操作 ContentProvider中的数据
// 此处是获取ContentProvider中 user表的所有记录
Cursor cursor = resolver.query(uri, null, null, null, "userid desc");
3.3.2 ContentUris类。
作用：操作URI。
使用：关注两个方法withAppendedId()和parseId()
//前者是向URI追加一个id
Uri uri = Uri.parse("content://com.leisure.provider/user")
Uri newUri = ContentUris.withAppendedId(uri, 2);
//最终生成后的Uri为：content://com.leisure.provider/user/2
// 后者是从URL中获取Id
Uri uri = Uri.parse("content://com.leisure.provider/user/2")
long userId = ContentUris.parseId(uri); //即为2
3.3.3 UriMatcher类
作用：1、在ContentProvider中注册URI。2、根据URI匹配ContentProvider中对应的数据表。
使用：
1).初始化UriMatcher。
//new出UriMatcher。
private static final UriMatcher URI_MATCHER = new UriMatcher(
UriMatcher.NO_MATCH);
初始化UriMatcher对象
//常量UriMatcher.NO_MATCH = 不匹配任何路径的返回码
//即初始化时不匹配任何东西
2).在ContentProvider中注册URI。
//这里使用静态代码块，也可以采用其他的形式。
static {
URI_MATCHER.addURI(UbaDBConstants.AUTHORITY, UbaDBConstants.TABLE_UBA,
UBAS);//"com.leisure.provider"（授权信息）,"uba"（Path,表名）,"1"(id,记录)
URI_MATCHER.addURI(UbaDBConstants.AUTHORITY, UbaDBConstants.TABLE_UBA
+ "/#", UBA_ID);//"com.leisure.provider"（授权信息）,"uba"（Path,表名）,"2"(id,记录)
}
3).重写getType方法。
//根据URI匹配TABLE_UBA，从而匹配ContentProvider中相应的资源
@Override
public String getType(Uri uri) {
int matchCode = URI_MATCHER.match(uri);//根据uri获取id,记录。
switch (matchCode) {
case UBAS://1,
return UbaDBConstants.UBA_TYPE;//vnd.android.cursor.dir/ubas
case UBA_ID://2
return UbaDBConstants.UBA_ITEM_TYPE;//vnd.android.cursor.item/uba
default:
L.e(TAG, "getType illegal uri=%s,matchCode=%d", uri, matchCode);
return null;
}
}
3.3.4 ContentObserver类
作用：观察ContentProvider中的数据, 当数据发生变化（增、删、改）时，就会触发该ContentObserver
使用：
1).注册内容观察者ContentObserver
getContentResolver().registerContentObserver（uri）；
// 通过ContentResolver类进行注册，并指定需要观察的URI
2).当该URI的ContentProvider数据发生变化时，通知外界（即访问该ContentProvider数据的访问者）
public Uri insert(Uri uri, ContentValues values) {
db.insert("user", "userid", values);
getContext().getContentResolver().notifyChange(uri, null);
// 通知访问者
}
3).解除观察者
getContentResolver().unregisterContentObserver（uri）;
4.具体事例。
由于ContentProvider不仅常用于进程间通信，同时也适用于进程内通信,所以本节分为两个部分：进程内通信与进程间通信。
4.0关于ContentProvider。
进程间共享数据的本质是添加、删除、获取 、更新数据,所以ContentProvider的核心方法也主要是这几种。
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中的数据
注意：1).述4个方法由进程调用，并运行在ContentProvider进程的Binder线程池中（非主线程）
2).存在多线程并发访问，需要实现线程同步。
若ContentProvider的数据存储方式是使用一个SQLite，则不需要，因为SQLite内部实现好了线程同步，若是多个SQLite则需要，因为SQLite对象之间无法进行线程同步。
若ContentProvider的数据存储方式是内存，则需要自己实现线程同步。
public boolean onCreate()
//ContentProvider创建后或打开系统后其它进程第一次访问该ContentProvider时由系统进行调用
//运行在该ContentProvider进程的主线程，故不能做耗时操作
public String getType(Uri uri)
//得到数据类型，即返回当前 Url 所代表数据的MIME类型
Android为常见的数据（如通讯录、日程表等）提供了内置了默认的ContentProvider，这里不再叙述,下边主要讲自定义的。
4.1进程内通信。
4.1.1创建数据库类
/**
*用户行为分析数据库操作帮助类
*
*/
public final class UbaDBHelper extends SQLiteOpenHelper {
/* 类标记 */
private static final String TAG = "UbaDBHelper";
/* 当前数据库版本常量 */
private static final int DB_VERSION = 3;
private static final int DB_NAME = uba.db;
/**
* 用户行为分析数据库操作帮助类构造函数
*
* @param context
* 上下文
*/
public UbaDBHelper(Context context) {
super(context, DB_NAME, null, DB_VERSION,
new DefaultDatabaseErrorHandler());
}
@Override
public void onCreate(SQLiteDatabase db) {
L.d(TAG, "onCreate db=%s", db);
db.execSQL(UbaDBConstants.CREATE_UBA);//创建数据
//CREATE TABLE IF NOT EXISTS uba (_id INTEGER PRIMARY KEY AUTOINCREMENT,type INTEGER
//time INTERGER, status INTERGER,data text not null)
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
L.d(TAG, "onUpgrade db=%s,oldVersion=%d,newVersion=%d", db, oldVersion,
newVersion);
db.execSQL(UbaDBConstants.DELETE_UBA);//删除数据 ，DROP TABLE IF EXISTS uba
onCreate(db);
}
}
4.1.2自定义ContentProvider类
/**
*
* 用户行为分析数据库，主要用于存储用户行为数据并且方便进行数据添加、上报、同步等操作
*/
public final class UbaProvider extends ContentProvider {
/* 类标记 */
private static final String TAG = "UbaProvider";
/* 定位符匹配器常量 */
private static final UriMatcher URI_MATCHER = new UriMatcher(
UriMatcher.NO_MATCH);
/* 匹配常量码-用户行为分析数据集合 */
private static final int UBAS = 1;
/* 匹配常量码-用户行为分析数据条目 */
private static final int UBA_ID = 2;
/* 数据库操作辅助 */
private UbaDBHelper mHelper = null;
static {
URI_MATCHER.addURI(UbaDBConstants.AUTHORITY, UbaDBConstants.TABLE_UBA,
UBAS);
URI_MATCHER.addURI(UbaDBConstants.AUTHORITY, UbaDBConstants.TABLE_UBA
+ "/#", UBA_ID);
}
@Override
public boolean onCreate() {
mHelper = new UbaDBHelper(getContext());
return true;
}
@Override
public Cursor query(Uri uri, String[] projectionIn, String selection,
String[] selectionArgs, String sortOrder) {
SQLiteQueryBuilder qBuilder = new SQLiteQueryBuilder();
int matchCode = URI_MATCHER.match(uri);
String tableName = getTableName(matchCode);
if (StringUtil.isEmpty(tableName)) {
L.e(TAG, "query illegal uri=%s,matchCode=%d", uri, matchCode);
return null;
}
qBuilder.setTables(tableName);
if (isID(matchCode)) {
qBuilder.appendWhere( "id=");
qBuilder.appendWhere(uri.getPathSegments().get(1));
}
Cursor ret = qBuilder.query(mHelper.getReadableDatabase(),
projectionIn, selection, selectionArgs, null, null, null);
if (ret != null) {
ret.setNotificationUri(getContext().getContentResolver(), uri);
} else {
L.e(TAG, "query uri=%s fail", uri);
}
return ret;
}
@Override
public int update(Uri uri, ContentValues values, String where,
String[] whereArgs) {
return 0;
}
@Override
public Uri insert(Uri uri, ContentValues initialValues) {
int matchCode = URI_MATCHER.match(uri);
if (isID(matchCode)) {
L.e(TAG, "insert illegal uri=%s,matchCode=%d", uri, matchCode);
return null;
}
String tableName = getTableName(matchCode);
if (StringUtil.isEmpty(tableName)) {
L.e(TAG, "insert illegal uri=%s,matchCode=%d", uri, matchCode);
return null;
}
Uri noteUri = getNoteUri(matchCode);
ContentValues values = (initialValues != null) ? new ContentValues(
initialValues) : new ContentValues();
L.d(TAG, "insert uri=%s,values=%s", uri, values);
long rowId = mHelper.getWritableDatabase().insert(tableName,
null, values);
if (rowId >= 0) {
noteUri = ContentUris.withAppendedId(noteUri, rowId);
// getContext().getContentResolver().notifyChange(noteUri, null);
sendChangeMsg();
} else {
L.e(TAG, "insert failed,rowId=%d,uri=%s", rowId, uri);
}
return noteUri;
}
@Override
public int delete(Uri uri, String where, String[] whereArgs) {
return 0;
}
@Override
public String getType(Uri uri) {
int matchCode = URI_MATCHER.match(uri);
switch (matchCode) {
case UBAS:
return UbaDBConstants.UBA_TYPE;//type
case UBA_ID:
return UbaDBConstants.UBA_ITEM_TYPE;//vnd.android.cursor.item/uba
default:
L.e(TAG, "getType illegal uri=%s,matchCode=%d", uri, matchCode);
return null;
}
}
/**
* 发送数据库变化消息
*/
private void sendChangeMsg() {
getContext().getContentResolver().notifyChange(UbaDBConstants.UBA_URI,
null);
}
/**
* 根据匹配规则获取指定表名称
*
* @param matchCode
* 匹配码
* @return 对应的数据库表名称
*/
private String getTableName(int matchCode) {
switch (matchCode) {
case UBAS:
case UBA_ID:
return UbaDBConstants.TABLE_UBA;//uba
default:
L.e(TAG, "getTableName illegal matchCode=%d", matchCode);
return null;
}
}
/**
* 判断匹配规则是否是带有id号
*
* @param matchCode
* 匹配码
* @return 判断结果
*/
private boolean isID(int matchCode) {
switch (matchCode) {
case UBAS:
return false;
case UBA_ID:
return true;
default:
L.e(TAG, "isID illegal matchCode=%d", matchCode);
return false;
}
}
/**
* 获取通知的资源定位符
*
* @param matchCode
* 匹配码
* @return 资源定位符
*/
private Uri getNoteUri(int matchCode) {
switch (matchCode) {
case UBAS:
case UBA_ID:
return Uri.parse("content://com.leisure.provider/uba");
default:
L.e(TAG, "getNoteUri illegal matchCode=%d", matchCode);
return null;
}
}
}
4.1.3注册创建的ContentProvider类
AndroidManifest.xml
<provider android:name=".UbaProvider"
android:authorities="com.leisure.provider"
/>
4.1.4进程内访问ContentProvider的数据
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
// 设置URI
Uri uri_uba = Uri.parse("content://com.leisure.provider/uba");
// 插入表中数据
ContentValues values = new ContentValues();
values.put("_id", 3);
values.put("name", "3user");
// 获取ContentResolver
ContentResolver resolver = getContentResolver();
// 通过ContentResolver 根据URI 向ContentProvider中插入数据
resolver.insert(uri_uba,values);
//通过ContentResolver向ContentProvider中查询数据
Cursor cursor = resolver.query(uri_uba, new String[]{"_id","name"}, null, null, null);
cursor.close();
// 关闭游标
ContentValues values_insert = new ContentValues();
values_insert.put("type", "1");
values_insert.put("status", "0");
values_insert.put("time", "11111");
JSONObject jObj = new JSONObject();
try {
//addSpecificAttrs(jObj);//这里理解为一个json字符串
} catch (JSONException e) {
e.printStackTrace();
}
values_insert.put("data", jObj.toString());
Uri uri = resolver.insert(uri_uba,values_insert);//插入表中数据
}
}
4.2进程间共享数据.
4.2.1进程一
整体步骤同4.1，但是在清单文件注册ContentProvider需要注意：
AndroidManifest.xml
<provider
android:name=".UbaProvider"
android:authorities="com.leisure.provider"
// 声明外界进程可访问该Provider的权限（读 & 写）
android:permission="com.leisure.all.uba"
// 权限可细分为读和写的权限
// 外部需要声明同样的读写的权限才可进行相应操作，否则会报错
// android:readPermisson = "com.leisure.read.uba"
// android:writePermisson = "com.leisure.write.uba"
// 设置此provider是否可以被其他进程使用
android:exported="true"
/>
// 声明应用允许通信的权限
<permission android:name="com.leisure.all.uba" android:protectionLevel="normal"/>
// <permission android:name="com.leisure.read.uba" android:protectionLevel="normal"/>
// <permission android:name="com.leisure.write.uba" android:protectionLevel="normal"/>
4.2.2进程二
1)清单文件声明权限。
AndroidManifest.xml
// 声明本应用允许通信的权限
<uses-permission android:name="com.leisure.all.uba"/>
// <uses-permission android:name="com.leisure.read.uba"/>
// <uses-permission android:name="com.leisure.write.uba"/>
//声明的权限必须与进程一中设置的权限对应
2)使用步骤同4.1.4
5.总结
ContentProvider为应用间的数据交互提供了一个安全的环境，允许把自己的应用数据根据需求开放给其他应用进行增、删、改、查，而不用担心因为直接开放数据库权限而带来的安全问题。
采用文件方式对外共享数据，需要进行文件操作读写数据，如果采用SharedPreferences共享数据，需要使用其API读写数据，这使得访问数据变得复杂而且有难度。而采用ContentProvider方式，解耦了底层数据的存储方式，使得无论底层数据存储采用何种方式，外界对数据的访问方式都是统一的，这使得访问简单、高效。即使底层数据库从SQLite换成其他的如MongoDB，也不会对上层数据ContentProvider使用的代码产生影响。