Android学习笔记（二十）——自定义内容提供器

 　　//此系列博文是《第一行Android代码》的学习笔记，如有错漏，欢迎指正！

　　如果我们想要实现跨程序共享数据的功能，官方推荐的方式就是使用内容提供器，可以通过新建一个类去继承 ContentProvider 的方式来创建一个自己的内容提供器：

一、继承ContentProvider的六个方法：

　　ContentProvider 类中有六个抽象方法，我们需要使用子类去继承它，并重写六个方法，我们先来认识这六个类。新建 MyProvider继承自 ContentProvide，代码如下所示：

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类型。

二、使用UriMatcher类：

　　我们知道，一个标准的内容 URI写法是这样的：

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

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

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

这就表示调用方期望访问的是 com.example.app 这个应用的 table1表中 id 为 1的数据。我们可以使用通配符的方式来分别匹配这两种格式的内容 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 boolean onCreate() {
        return false;
    }

    @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;
        }
    }

    @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;
    }
}

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

　　最后我们还得完成getType()方法的逻辑。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.table  最后，我们完成getType()的逻辑如下：

@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;
        }
    }

　　至此，一个完整的内容提供器就创建完成了，由于内容提供器接受完Uri对象后的操作是自定义的，所以我们可以控制哪些数据可以被访问，哪些不可以，我们自然不会允许隐私数据被访问。

　　//End.