Android 自定义内容提供器

发表于 | 分类于
字数统计: 938 word | 阅读时长 ≈ 4 min
创建内容提供器

  • 1.继承ContentProvider类

    自定义内容提供器可以通过新建一个类去继承ContentProvider来创建自己的内容提供器，该类一共有6个抽象方法，需要我们来重写。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    public class MyProvider extends ContentProvider {
        
        // 初始化内容提供器的时候调用，通常在这里完成数据库创建和升级，返回true代表成功
        @Override
        public boolean onCreate() {
            return false;
        }
        
        // uri:表名 projection:列名 selection(args):约束查询哪些行 sortOrder:排序 查询的结果在Cursor中返回
        @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 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;
        }
      
        // 根据传入的uri返回相应的MIME【后面解释】
        @Nullable
        @Override
        public String getType(@NonNull Uri uri) {
            return null;
        }
    }

  • 2.URI 参数解析

    • 内容URI的格式主要有两种

      • 1.以路径结尾 content://com.example.app.provider/table1，表示期望访问该表中的所有的数据
      • 2.以id结尾content://com.example.app.provider/table1/1`，表示期望访问该表中拥有相应id的数据

    • 我们可以用通配符的方式来分别匹配这两种格式的内容URI,规则如下：

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

    • 举例：

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

    • 借助UriMatcher类实现匹配内容URI的功能

      UriMatcher类提供了一个addURI()方法，该方法接收3个参数，authority、path和自定义代码

      当调用UriMatcher的match()方法时，将一个Uri对象传入，返回值就是某个能够匹配这个Uri对象所对应的自定义代码,利用这个代码，就可以判断出调用方期望访问的是哪张表中的数据了。

  • query() 示例：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    public class MyProvider extends ContentProvider {
        //创建4个常量，代表调用方期望访问的不同内容
        public static final int TABLE1_DIR = 0; //期望访问table1所有数据
        public static final int TABLE1_ITEM = 1; //期望访问table1某一条数据
        public static final int TABLE2_DIR = 2; //期望访问table2所有数据
        public static final int TABLE2_ITEM = 3; //期望访问table2某一条数据
        private static UriMatcher uriMatcher;

        static {
            uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);  //创建UriMatcher实例
            uriMatcher.addURI("com.example.app.provider", "tabke1", TABLE1_DIR);
            uriMatcher.addURI("com.example.app.provider", "tabke1/#", TABLE1_ITEM);
            uriMatcher.addURI("com.example.app.provider", "tabke2", TABLE2_DIR);
            uriMatcher.addURI("com.example.app.provider", "tabke2/#", TABLE2_ITEM);
        }

        // uri:表名 projection:列名 selection(args):约束 sortOrder:排序 查询的结果在Cursor中返回
        @Nullable
        @Override
        public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
            switch (uriMatcher.match(uri)) {
                case TABLE1_DIR:
                    // 查询表一所有数据
                    break;
                case TABLE1_ITEM:
                    // 查询表一单条数据
                    break;
                case TABLE2_DIR:
                    break;
                case TABLE2_ITEM:
                    break;
                default:
            }
            return null;
        }

    }

  • getType()方法

    getType()方法，是所有内容提供器都必须提供的一个方法，用于获取Uri对象所对应的MIME类型

    MIME由三部分组成：

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

    例如：

    1
    2
    3
    content://com.example.app.provider/table1
    则为：
    vnd.android.cursor.dir/vnd.com.example.app.provider/table1

    所以getType():

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    public String getType(@NonNull 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;
    }
0%