上一章讲到怎么使用ContentResolver访问系统提供的数据接口读取联系人信息,那么系统程序是怎样对外建立并开放这些数据接口的呢?好多时候我们自己应用程序也需要数据共享的功能,以便于其他程序访问我们的数据,那么我们该怎么实现我们自己的数据接口,接下来让我们来一起学习。
其实把我们程序的数据提供给其他应用程序使用有好多方式,比如我们把数据写到一个文件里面,让其他程序读取我们的文件。但是这样并不能很好地保证数据安全性和永久性。官方推荐我们的方式就是使用提供器,可以新建一个类去继承ContentProvider的方式创建一个自己的内容提供器。ContentProvider类中有六个抽象方法。我们在使用子类继承他的时候,需要将这六个方法重写,接下来我们新建我们的MyProvider继承自ContentProvider,代码如下:
public class MyProvider extends ContentProvider{
@Override
public boolean onCreate() {
return false;
}
@Nullable
@Override
public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
return null;
}
@Nullable
@Override
public String getType(@NonNull Uri uri) {
return null;
}
@Nullable
@Override
public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
return null;
}
@Override
public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {
return 0;
}
@Override
public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection, @Nullable String[] selectionArgs) {
return 0;
}
}
简单介绍一下这几个方法:
- onCreate()
初始化内容提供器的时候调用,通常会在这里完成对数据库的创建和升级操作,返回 true 表示内容提供器初试化成功,返回 false则表示失败。注意,只有当存在ContentResolver尝试访问我们的程序中的数据时,内容提供器才会被初始化。 - query()
从内容提供器中查询数据。使用 uri 参数来确定查询那张表,projection参数用于确定查询哪些列,selection 和 selectionArgs参数用于约束查询哪些行,sortOrder 参数用于对结果经行排序,查询的结果存放在 Cursor 对象中返回。 - insert()
向内容提供器中添加一条数据。使用 uri 参数确定要添加到的表,待添加的数据保存在 values 中。添加完成后,返回一个用于表示该条新记录的URI。 - update()
更新内容提供器中已有的数据。使用 uri 参数确定要更新哪一张表里面的数据,新数据保存在values参数中,selection 和 selectionArgs 参数用于约束更新哪些行,受影响的行数据将作为返回值返回。 - delete()
从内容提供器中删除数据。使用 uri 参数确定删除哪张表的数据,selection 和 selectionArgs 参数用来约束删除哪些行,被删除的行数将作为返回值返回。 - getType()
根据出入的内容 uri 来返回相应的 MIME 类型。
我们再来回顾一下前面关于内容 Uri 的知识。
我们上一章提到,一个标准的内容 Uri 写成是这样的:
content://com.example.app.provider/table1
这就表示了我们想要访问的是 com.example.app 这个应用下的 table1 这张表。除此之外我们还可以在最后面加上一个id。如下:
content://com.example.app.provider/table1/1
这就表示了我们想要访问的是 com.example.app 这个应用下的 table1 这张表中 id 为 1 的数据。
内容Uri就这两种类型,一种是一路径结尾的,表明的是要访问表里面所有的数据;另一种就是以id结尾的,表明的是要访问相应id的数据。我们可以用通配符的方式来分别表示这两种类型,规则如下:
1. *:表示匹配任意长度的任意字符
2. #:表示匹配任意长度的数字
所以一个能够匹配任意表的内容uri就可以写成:
content://com.example.app.provider/*
一个能够匹配table1表中的所有数据的内容uri就可以写成:
content://com.example.app.provider/table1/#
在这里我们可以借助 UriMatcher 类来轻松的实现匹配内容Uri的功能。 UriMatcher 中提供了一个 addURI() 方法,这个方法接受三个参数,分别是我们能容Uri的权限、路径和一个Code(int)。当我们调用 UriMatcher 的 match() 方法时,就可以传入一个Uri,返回值则是对应这个Uri所对应匹配的 Code。利用这个Code我们就能够判断调用方期望的是哪张表中的数据了。具体操作如下:
public class MyProvider extends ContentProvider {
private SQLiteDatabase db;
private static UriMatcher uriMatcher;
private static final int TABLE_DIR = 0;//表明要访问table1中的所有数据
private static final int TABLE_ITEM = 1;//表明要访问table1中的某行数据
static {
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
uriMatcher.addURI("com.example.app.provider", "table1", TABLE_DIR);
uriMatcher.addURI("com.example.app.provider", "table1/#", TABLE_ITEM);
}
@Override
public boolean onCreate() {
db = SQLiteDatabase.openOrCreateDatabase(flie, factory);
return true;
}
@Nullable
@Override
public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
Cursor cursor = null;
switch (uriMatcher.match(uri)) {
case TABLE_DIR:
cursor = db.query("table1",projection,selection,selectionArgs,null,null,sortOrder);
//。。。访问table1中的所有数据相应的操作
break;
case TABLE_ITEM:
String Id = uri.getPathSegments().get(1);
cursor = db.query("table1",projection,"id=?",new String[]{Id},null,null,sortOrder);
//。。。访问table1中某行数据相应的操作
break;
}
return cursor;
}
........
}
我们可以看到我们利用UriMatcher来判断调用者的访问意图,并按意图用switch分开处理。在这里数据库的操作就不再多加解释,相信大家应该已经能够灵活掌握。重点来说一下 uri.getPathSegments().get(1) 的用法。
uri.getPathSegments().get(int)这个方法用来获取uri中的路径部分,并以'/'为分隔符来给路径从零标号。比如 content://com.example.app.provider/table1/1 这个uri,我们使用uri.getPathSegments().get(0)返回的结果则是"table1",同理uri.getPathSegments().get(1)返回的是"1"。
其实其他增、删、改操作跟查询是一样的道理,就不再堆多余代码了。除此之外还有一个比较陌生的getType()方法。
它是所有内容提供器都必须提供的一个方法,用于获取Uri对象所对应的MIME类型。MIME字符串主要有三部分组成,Android对这三部分做了如下格式规定。
1. 必须以 vnd 开头。
2. 如果Uri以路径为结尾,则后接 android.cursor.dir/,如果Uri以id为结尾,则后接 android.cursor.item/.
3. 最后接上 vnd.<anthority>.<path>.
所以对于 content://com.example.app.provider/table1 这个内容 Uri,它所对应的MIME类型就可以写成:
vnd.android.coursor.dir/vnd.com.example.app.provider.table1
相应的 content://com.example.app.provider/table1/1 就可以写成:
vnd.android.coursor.item/vnd.com.example.app.provider.table1
修改getType()方法如下:
@Override
public String getType(@NonNull Uri uri) {
switch (uriMatcher.match(uri)) {
case TABLE_DIR:
return "vnd.android.coursor.dir/vnd.com.example.app.provider.table1";
break;
case TABLE_ITEM:
return "vnd.android.coursor.item/vnd.com.example.app.provider.table1";
break;
}
return null;
}
我们把其他方法补充完整后我们的内容提供器就写好了,但是现在其他应用程序还不能调用。我们要在 AndroidManifest.xml 的<appliction> 标签中添加如下代码:
<provider
android:name="com.example.app.MyProvider"
android:authorities="com.example.app.provider"
android:exported="true"/>
android:name属性中制定了类的全名,android:authorities指定了该内容提供器的权限(为了避免与其他应用冲突,尽量以 包名.provider 来命名)。android:exported属性制定了内容提供器是可以被其他应用访问的。
到现在我们的内容提供器就编写完成了,我们可以通过权限为 com.example.app.provider 的内容Uri 来访问我们的内容提供器,至于要访问的表自己可以通过数据库的知识建立一个数据库来存放数据。