android: 创建自己的内容提供器

Posted 2020-06-20 dodo

我们学习了如何在自己的程序中访问其他应用程序的数据。总体来说思 路还是非常简单的，只需要获取到该应用程序的内容 URI，然后借助 ContentResolver 进行CRUD 操作就可以了。可是你有没有想过，那些提供外部访问接口的应用程序都是如何实现这种功能的呢？它们又是怎样保证数据的安全性，使得隐私数据不会泄漏出去？

7.3.1    创建内容提供器的步骤

 

前面已经提到过，如果想要实现跨程序共享数据的功能，官方推荐的方式就是使用内容提供器，可以通过新建一个类去继承 ContentProvider 的方式来创建一个自己的内容提供器。 ContentProvider 类中有六个抽象方法，我们在使用子类继承它的时候，需要将这六个方法全 部重写。新建 MyProvider 继承自 ContentProvider，代码如下所示：

 

public class MyProvider extends ContentProvider {

 

 

@Override

public boolean onCreate() {

return false;

}

 

 

@Override

public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {

return null;

}

 

 

@Override

public Uri insert(Uri uri, ContentValues values) {

return null;

}

 

 

@Override

public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {

return 0;

}

 

 

@Override

public int delete(Uri uri, String selection, String[] selectionArgs) {

return 0;

}

 

 

 

@Override

public String getType(Uri uri) {

return null;

}

 

 

}

在这六个方法中，相信大多数你都已经非常熟悉了，我再来简单介绍一下吧。

1.    onCreate()

初始化内容提供器的时候调用。通常会在这里完成对数据库的创建和升级等操作， 返回 true 表示内容提供器初始化成功，返回 false 则表示失败。注意，只有当存在 ContentResolver 尝试访问我们程序中的数据时，内容提供器才会被初始化。

2.    query()

从内容提供器中查询数据。使用 uri 参数来确定查询哪张表，projection 参数用于确 定查询哪些列，selection 和 selectionArgs 参数用于约束查询哪些行，sortOrder 参数用于 对结果进行排序，查询的结果存放在 Cursor 对象中返回。

3.    insert()

向内容提供器中添加一条数据。使用 uri 参数来确定要添加到的表，待添加的数据 保存在 values 参数中。添加完成后，返回一个用于表示这条新记录的 URI。

4.    update()

更新内容提供器中已有的数据。使用 uri 参数来确定更新哪一张表中的数据，新数 据保存在 values 参数中，selection 和 selectionArgs 参数用于约束更新哪些行，受影响的 行数将作为返回值返回。

5.    delete()

从内容提供器中删除数据。使用 uri 参数来确定删除哪一张表中的数据，selection

和 selectionArgs 参数用于约束删除哪些行，被删除的行数将作为返回值返回。

6.    getType()

根据传入的内容 URI 来返回相应的 MIME 类型。 可以看到，几乎每一个方法都会带有 Uri 这个参数，这个参数也正是调用 ContentResolver的增删改查方法时传递过来的。而现在，我们需要对传入的 Uri 参数进行解析，从中分析出 调用方期望访问的表和数据。

回顾一下，一个标准的内容 URI 写法是这样的：

 

content://com.example.app.provider/table1

这就表示调用方期望访问的是 com.example.app 这个应用的 table1 表中的数据。除此之 外，我们还可以在这个内容 URI 的后面加上一个 id，如下所示：

 

content://com.example.app.provider/table1/1

这就表示调用方期望访问的是 com.example.app 这个应用的 table1 表中 id 为 1 的数据。 内容 URI 的格式主要就只有以上两种，以路径结尾就表示期望访问该表中所有的数据，

以 id 结尾就表示期望访问该表中拥有相应 id 的数据。我们可以使用通配符的方式来分别匹 配这两种格式的内容 URI，规则如下。

1.    *：表示匹配任意长度的任意字符

2.    #：表示匹配任意长度的数字 所以，一个能够匹配任意表的内容 URI 格式就可以写成：

content://com.example.app.provider/*

而一个能够匹配 table1 表中任意一行数据的内容 URI 格式就可以写成：

content://com.example.app.provider/table1/#

接着，我们再借助 UriMatcher 这个类就可以轻松地实现匹配内容 URI 的功能。UriMatcher 中提供了一个 addURI()方法，这个方法接收三个参数，可以分别把权限、路径和一个自定义 代码传进去。这样，当调用 UriMatcher 的 match()方法时，就可以将一个 Uri 对象传入，返 回值是某个能够匹配这个 Uri 对象所对应的自定义代码，利用这个代码，我们就可以判断出 调用方期望访问的是哪张表中的数据了。修改 MyProvider 中的代码，如下所示：

 

public class MyProvider extends ContentProvider {

public static final int TABLE1_DIR = 0;

public static final int TABLE1_ITEM = 1;

public static final int TABLE2_DIR = 2;

public static final int TABLE2_ITEM = 3;

private static UriMatcher uriMatcher; static {

uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);

uriMatcher.addURI("com.example.app.provider", "table1", TABLE1_DIR);

uriMatcher.addURI("com.example.app.provider ", "table1/#", TABLE1_ITEM);

uriMatcher.addURI("com.example.app.provider ", "table2", TABLE2_ITEM);

uriMatcher.addURI("com.example.app.provider ", "table2/#", TABLE2_ITEM);

}

……

 

 

@Override

public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {

switch (uriMatcher.match(uri)) {

case TABLE1_DIR:

// 查询table1表中的所有数据

break;

case TABLE1_ITEM:

// 查询table1表中的单条数据

break;

case TABLE2_DIR:

// 查询table2表中的所有数据

break;

case TABLE2_ITEM:

// 查询table2表中的单条数据

break;

default:

break;

}

……

}

……

}

可以看到，MyProvider 中新增了四个整型常量，其中 TABLE1_DIR 表示访问 table1 表 中的所有数据，TABLE1_ITEM 表示访问 table1 表中的单条数据，TABLE2_DIR 表示访问 table2 表中的所有数据，TABLE2_ITEM 表示访问 table2 表中的单条数据。接着在静态代码 块里我们创建了 UriMatcher 的实例，并调用 addURI()方法，将期望匹配的内容 URI 格式传 递进去，注意这里传入的路径参数是可以使用通配符的。然后当 query()方法被调用的时候， 就会通过 UriMatcher 的 match()方法对传入的 Uri 对象进行匹配，如果发现 UriMatcher 中某 个内容 URI 格式成功匹配了该 Uri 对象，则会返回相应的自定义代码，然后我们就可以判断 出调用方期望访问的到底是什么数据了。

上述代码只是以 query()方法为例做了个示范，其实 insert()、update()、delete()这几个方 法的实现也是差不多的，它们都会携带 Uri 这个参数，然后同样利用 UriMatcher 的 match() 方法判断出调用方期望访问的是哪张表，再对该表中的数据进行相应的操作就可以了。

除此之外，还有一个方法你会比较陌生，即 getType()方法。它是所有的内容提供器都必 须提供的一个方法，用于获取 Uri 对象所对应的 MIME 类型。一个内容 URI 所对应的 MIME 字符串主要由三部分组分，android 对这三个部分做了如下格式规定。

1.    必须以 vnd 开头。

2.    如果内容 URI 以路径结尾，则后接 android.cursor.dir/，如果内容 URI 以 id 结尾， 则后接 android.cursor.item/。

3.    最后接上 vnd.<authority>.<path>。

所以，对于 content://com.example.app.provider/table1 这个内容 URI，它所对应的 MIME

类型就可以写成：

vnd.android.cursor.dir/vnd.com.example.app.provider.table1

对于 content://com.example.app.provider/table1/1 这个内容 URI，它所对应的 MIME 类型 就可以写成：

vnd.android.cursor.item/vnd. com.example.app.provider.table1

现在我们可以继续完善 MyProvider 中的内容了，这次来实现 getType()方法中的逻辑， 代码如下所示：

public class MyProvider extends ContentProvider {

……

@Override

public String getType(Uri uri) { switch (uriMatcher.match(uri)) { case TABLE1_DIR:

return "vnd.android.cursor.dir/vnd.com.example.app.provider.

table1";

case TABLE1_ITEM:

return "vnd.android.cursor.item/vnd.com.example.app.provider.

table1";

case TABLE2_DIR:

return "vnd.android.cursor.dir/vnd.com.example.app.provider.

table2";

case TABLE2_ITEM:

return "vnd.android.cursor.item/vnd.com.example.app.provider.

table2";

default:

break;

}

return null;

}

}

 

到这里，一个完整的内容提供器就创建完成了，现在任何一个应用程序都可以使用ContentResolver 来访问我们程序中的数据。那么前面所提到的，如何才能保证隐私数据不会 泄漏出去呢？其实多亏了内容提供器的良好机制，这个问题在不知不觉中已经被解决了。因 为所有的 CRUD 操作都一定要匹配到相应的内容 URI 格式才能进行的，而我们当然不可能 向 UriMatcher 中添加隐私数据的 URI，所以这部分数据根本无法被外部程序访问到，安全问题也就不存在了。