Android - base - ContentProvider

2017-10-17 本文已影响0人 no_today

四大组件之内容提供器
提供一个外部访问接口，让其他APP访问到我们这个APP的数据。

大纲

内容提供器简介
核心类
内容URI
访问其他APP中的数据
提供自己的内容提供器

#内容提供器简介

内容提供器 Content Provider 主要用于在不同的APP之间实现数据共享。

#核心类

ContentResolver 类：访问其他APP数据的工具类，内置CRUD方法。

获取：Context 类的 getContentResolver() 方法。

#内容URI

内容URI给内容提供器中的数据建立唯一的标识符，同时也是ContentResolver类进行CURD操作的所需参数之一。

内容URI由两部分组成：

权限<authority>：用于对不同的应用程序进行区分。一般情况下，都会采用程序的包名进行区分
路径<path>：用于对同一应用程序中不同的表做区分，添加在去权限的后面。一般情况下，使用表名

再在字符串的头部加上协议声明，故内容URI的标准格式如下：
content:/com.example.cheng.android_contentprovider/book
我们可以在内容URI的后面加上一个id：
content://com.example.cheng.android_contentprovider/book/1
表示调用方期望访问的是 com.example.cheng.android_contentprovider 这个应用的
book 表中 id 为 1 的数据。

两种格式的内容 URI：

以路径结尾就表示期望访问该表中所有的数据
以id结尾表示期望访问该表中拥有响应id的数据

可以使用通配符的方式来分别匹配这两种格式的内容 URI：

"*" ：表示匹配任意长度的任意字符
"#"：表示匹配任意长度的数字

例：

一个能匹配任意表的内容 URI 格式就可以写成：
content://com.example.cheng.android_contentprovider/*
一个能匹配 book 表中任意一行数据的内容 URI 就可以写成：
content://com.example.cheng.android_contentprovider/book/#

得到了内容URI字符串，我们需要将之解析成Uri对象才可以做为参数传入：

Uri uri = Uri.parse("content://com.example.app.provider/table1");

访问其他APP中的数据

获取联系人数据 需要运行时权限处理

if (ContextCompat.checkSelfPermission(this, READ_CONTACTS) != PackageManager.PERMISSION_GRANTED) {
    ActivityCompat.requestPermissions(this, new String[] {READ_CONTACTS}, READ_CONTACTS_REQUEST);
} else {
    Cursor result = getContentResolver().query(
            ContactsContract.CommonDataKinds.Phone.CONTENT_URI,
            null,
            null,
            null,
            null);

    if (result != null) {
        while(result.moveToNext()) {
            String name = result.getString(result.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
            String phone = result.getString(result.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
            
            Toast.makeText(this, name + ":" + phone, Toast.LENGTH_SHORT).show();
        }
    }
}

和SQLite操作很相似，但访问外部数据传入的不是表名而是 URL ，query() 方法参数也少了几个。

query

/*
 * @param uri 内容uri "content://com.example.cheng.android_contentprovider/book"
 * @param projection 查询的列
 * @param selection 条件
 * @param selectionArgs 占位值
 * @param sortOrder 排序
 */
public final Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)

其他三个方法的用法类似，不作赘述。

访问外部资源前提是得知道外部资源的内容URI

#提供自己的内容提供器

创建类继承 ContentProvider 类并实现6个方法。
在 onCreate() 方法内完成初始化操作。
将提供给外部访问的 URI 封装到 UriMatcher 对象

// 标识
public static final int BOOK_DIR = 0;
public static final int BOOK_ITEM = 1;
public static final int CATEGORY_DIR = 2;
public static final int CATEGORY_ITEM = 3;

// 包名
public static final String authority = "com.example.cheng.android_contentprovider";

private static UriMatcher uriMatcher;

static {
    uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
    uriMatcher.addURI(authority, "book", BOOK_DIR);
    uriMatcher.addURI(authority, "book/#", BOOK_ITEM);
    uriMatcher.addURI(authority, "category", CATEGORY_DIR);
    uriMatcher.addURI(authority, "category/#", CATEGORY_ITEM);
}

这些 URI 只是给其他APP访问的，并不能直接访问数据安全。我们的内容提供器的CRUD方法被调用时会经过 uriMatcher.match(uri) 方法得到封装进去的标记，然后我们根据标记写逻辑。

在 getType() 方法内将 URI 转成 MIME 类型

/*
 * 转成URI对应的MIME类型
 * @param uri
 * @return
 */
@Nullable
@Override
public String getType(@NonNull Uri uri) {
    switch (uriMatcher.match(uri)) {
        case BOOK_DIR:
            return "vnd.android.cursor.dir/vnd.com.example.cheng.android_contentprovider.book";
        case BOOK_ITEM:
            return "vnd.android.cursor.item/vnd.com.example.cheng.android_contentprovider.book";
        case CATEGORY_DIR:
            return "vnd.android.cursor.dir/vnd.com.example.cheng.android_contentprovider.category";
        case CATEGORY_ITEM:
            return "vnd.android.cursor.item/vnd.com.example.cheng.android_contentprovider.category";
        }
        return null;
    }

内容 URI 转 MIME 规则

必须以 vnd. 开头。
如果内容 URI 以路径结尾，则后接 android.cursor.dir/，如果内容 URI 以
结尾，则后接 android.cursor.item/。
最后接上 vnd.<authority>.<path>。

内容URI：content://com.example.cheng.android_contentprovider/book
MIME：android.cursor.dir/vnd.com.example.cheng.android_contentprovider.book
vnd. 开头
android.cursor.dir/ 路径结尾
vnd.com.example.cheng.android_contentprovider.book vnd.<authority>.<path>

query

// uri.getPathSegments().get(1)：将路径 "/" 前后切割 1索引是id值
@Nullable
@Override
public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String order) {
    Cursor result = null;
    
    // 根据标记得知用户想操作哪张表。
    switch (uriMatcher.match(uri)) {
        case BOOK_DIR:
            result = database.query("book", projection, selection, selectionArgs, null, null, order);
            break;
        case BOOK_ITEM:
            String bid = uri.getPathSegments().get(1);
            result = database.query("book", projection, "id = ?", new String[] {bid}, null, null, order);
            break;
        case CATEGORY_DIR:
            result = database.query("category", projection, selection, selectionArgs, null, null, order);
            break;
        case CATEGORY_ITEM:
            String cid = uri.getPathSegments().get(1);
            result = database.query("category", projection, "id = ?", new String[] {cid}, null, null, order);
            break;
            default:
        }
        return result;
    }

方法内是数据库操作，但是我们不能让外部程序 乱搞 套了一层 壳 让外部程序只能访问到我们想提供的数据 数据安全。

CRUD剩余方法

/*
 * @param uri 内容uri
 * @param contentValues 存值对象
 * @return 插入数据的 内容uri   "content://com.example.cheng.android_contentprovider/1"
 */
public Uri insert(@NonNull Uri uri, @Nullable ContentValues contentValues)

/*
 * @param uri 内容uri
 * @param selection 条件
 * @param selectionArgs 占位值
 * @return 影响数据行数
 */
public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs)


/*
 * @param uri 内容uri
 * @param contentValues 存值对象
 * @param selection 条件
 * @param selectionArgs 占位值
 * @return 影响数据行数
 */
public int update(@NonNull Uri uri, @Nullable ContentValues contentValues, @Nullable String selection, @Nullable String[] selectionArgs)

最后别忘了注册内容提供器