ContentProvider是Android的四大组件之一,主要用于跨进程通信。今天我们就来聊聊ContentProvider的相关内容。
本文的要点如下:
- 概述
- 统一资源标识符(URI)
- 使用现有的ContentProvider
- 自定义ContentProvider
- 总结
概述
ContentProvider是Android的四大组件之一,主要用于在不同的应用程序之间实现数据共享的功能,它提供了一套完整的机制,允许一个应用程序访问另一个应用程序中的数据,同时还能保证被访问数据的安全性。是目前Android实现跨程序共享数据的标准方式。
ContentProvider的底层实现是Android中的Binder机制。
ContentProvider的用法大致可分为两种形式:
- 使用现有的内容提供者来读取和操作相应程序中的数据
- 创建自己的内容提供者给自己程序的数据提供外部访问接口。
统一资源标识符(URI)
就像访问网站需要域名一样,Android中用内容URI给内容提供者中的数据建立了唯一标识符。它主要由三部分组成:协议声明、authority和path。
Android中规定URI以“content:”开头,代表协议声明。
authority表示授权信息,用于对不同应用程序进行区分,为了避免冲突,一般都采用程序包名的方式来命名。
path表示表名,用于对同一应用程序中不同的表进行区分,通常会添加到authority后面。
内容URI的标准格式写法如下:
content://com.example.app.provider/table1
另外,URI模式存在匹配通配符*和#。具体使用如下:
// *:匹配任意长度的任何有效字符的字符串
// 以下的URI 表示匹配provider的任何内容
content://com.example.app.provider/*
// #:匹配任意长度的数字字符的字符串
// 以下的URI 表示匹配provider中的table表的所有行
content://com.example.app.provider/table/#
使用现有的ContentProvider
以获取通讯录为例:
private void readcontract(){
Cursor cursor = null;
try {
//获取通讯录信息
cursor = getContentResolver().query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI,
null, null, null, null);
if (cursor != null) {
while (cursor.moveToNext()) {
//联系人姓名
String name = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
//联系人电话
String phonenumber = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
contactList.add(name + "\n" + phonenumber);
}
adapter.notifyDataSetChanged();
}
}catch (Exception e){
e.printStackTrace();
}finally {
if(cursor != null){
cursor.close();
}
}
}
其实,关键点就是使用ContentResolver的query()方法来查询系统的联系人数据,之后遍历取出信息就好。(最后记得要关掉cursor防止内存泄露)
因此,其实使用现有的ContentProvider主要是ContentResolver类的工作。
ContentResolver类
首先说一个问题,为什么要使用通过ContentResolver类从而与ContentProvider类进行交互,而不直接访问ContentProvider类呢?
理由也很简单,一般来说,一个APP可能会有多个ContentProvider,若需要了解每个ContentProvider的不同实现从而再完成数据交互,那整个操作过程也太复杂了,耦合高不利于扩展。因此Android单独设计了一个 ContentResolver类对所有的ContentProvider进行统一管理。
ContentResolver类里常用的就四大方法:增、删、改、查,emmm有种数据库的感觉。其实确实和数据库操作很像。
// 向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.创建数据库助手类
public class MyDatabaseHelper extends SQLiteOpenHelper {
public static final String CREATE_BOOK = "create table Book (" +
" id integer primary key autoincrement, " +
" author text, " +
" price real, " +
" pages integer, " +
" name text)";
private Context mContext;
public MyDatabaseHelper(@Nullable Context context, @Nullable String name, @Nullable SQLiteDatabase.CursorFactory factory, int version) {
super(context, name, factory, version);
this.mContext = context;
}
@Override
public void onCreate(SQLiteDatabase db) {
db.execSQL(CREATE_BOOK);
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
db.execSQL("drop table if exists Book");
}
}
这步没啥可讲的,就是创建一个用于操作数据库的类,比较基本的操作。
2.自定义 ContentProvider 类
这一步主要是通过继承ContentProvider类,来实现自己的ContentProvider的逻辑。
在Android Studio中,可以直接用右键New->Other->Content Provider的方式来创建自定义ContentProvider。
具体的ContentProvider类如下:
public class MyProvider extends ContentProvider {
public static final int BOOK_DIR = 0;
public static final int BOOK_ITEM = 1;
public static final String AUTHORITY = "com.bupt.testlogin.provider";
private static UriMatcher uriMatcher;
private MyDatabaseHelper dbHelper;
static{
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
uriMatcher.addURI(AUTHORITY,"book",BOOK_DIR);
uriMatcher.addURI(AUTHORITY,"book/#",BOOK_ITEM);
}
public MyProvider() {
}
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
return 0;
}
@Override
public String getType(Uri uri) {
switch (uriMatcher.match(uri)){
case BOOK_DIR:
return "vnd.android.cursor.dir/vnd.com.bupt.testlogin.provider.book";
case BOOK_ITEM:
return "vnd.android.cursor.item/vnd.com.bupt.testlogin.provider.book";
}
return null;
}
@Override
public Uri insert(Uri uri, ContentValues values) {
return null;
}
@Override
public boolean onCreate() {
dbHelper = new MyDatabaseHelper(getContext(),"BookStore.db",null,4);
return true;
}
@Override
public Cursor query(Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder) {
SQLiteDatabase db = dbHelper.getReadableDatabase();
Cursor cursor = null;
switch (uriMatcher.match(uri)){
case BOOK_DIR:
cursor = db.query("Book",projection,selection,selectionArgs,null,null,sortOrder);
break;
case BOOK_ITEM:
String boodId = uri.getPathSegments().get(1);
cursor = db.query("Book",projection,"id = ?",new String[]{boodId},null,null,sortOrder);
break;
default:
break;
}
return cursor;
}
@Override
public int update(Uri uri, ContentValues values, String selection,
String[] selectionArgs) {
return 0;
}
}
这里我首先定义了两个整型常量BOOK_DIR和BOOK_ITEM,表示访问Book表中的所有数据和单条数据。在静态代码块中,创建了UriMatcher实例,并调用addURI方法,将期望匹配的URI格式传递进去(可以用通配符)。UriMatcher的主要作用就是用match方法匹配内容URI,然后返回期望的操作类型。
这里只实现了query()方法用于查询,其他的增、删、改的操作都是差不多的,就不在这里重复了。
先说getType方法,这个方法是所有ContentProvider都必须实现的,根据传入的内容URI来返回相应的MIME类型。用于解析传入的Uri参数,分析出调用方的期望的表和数据。
内容URI所对应的MIME字符串主要由三部分组分,Android对这三个部分做了如下格式规定:
- 必须以vnd开头;
- 如果内容URI以路径结尾,则后接android.cursor.dir/,如果内容URI以id结尾,则后接android.cursor.item/;
- 最后接上vnd.< authority>.< path>。
这部分不怎么复杂,只要按照格式写就行。
3.注册ContentProvider类
如果是自己新建创建的ContentProvider类,还需要在AndroidManifest.xml文件中添加注册信息。当然了,如果用Android Studio创建,那么系统会自动添加好注册信息
至此一个自定义的ContentProvider就实现完成了。
总结
ContentProvider为应用间的数据交互提供了一个安全的环境:允许把自己的应用数据根据需求开放给其他应用 进行 增、删、改、查,而不用担心因为直接开放数据库权限而带来的安全问题。显然,我们不写在UriMatcher中的表,外部是无法访问到的,所有访问均在可控范围内,自然敏感信息就不会外泄。
另外,其他对外共享数据的方式,会因数据存储方式的不同而导致数据访问方式的不同:
采用共享文件方式对外共享数据,需要进行文件操作读写数据;采用Sharedpreferences共享数据,则需要使用sharedpreferences API读写数据。这很明显降低了开发效率。
而ContentProvider则解耦了底层数据的存储方式,使得无论底层数据存储采用何种方式,外界对数据的访问方式都是统一的,开发效率提高。
至此,Android的四大组件的基本用法及相关知识就都总结完毕了。