【Android】内容提供器(Content Provider)

一、内容提供器(Content Provider)

Content Provider 主要实现在不同程序之间进行数据共享的功能。允许程序访问另一个程序的数据，同时保证被访数据的安全性。使用内容提供器是Android实现跨进程共享数据的标准方式。

1. 利用 getContentResolver 进行 CURD 实现跨程序获取数据

使用现有的内容提供器来读取和操作相应程序中的数据，电话簿、短信、媒体库等程序都提供了类似的访问接口，使得任何其他的应用程序都可以对这部分数据进行访问。对于每个应用程序来说，借助ContentResoler类，通过Context中的getContentResolver（）方法获取到该类的实例。ContentResoler类提供了一系列的CURD操作。

得到了URI字符串之后，需要将其解析成Uri对象才可以作为参数传入，代码如下：

//只需调用Uri.parse（）方法，就可以将内容URI字符串解析成Uri对象了
Uri uri=Uri.parse("Content://com.example.app.provider/table");//这个uri的意思就是去找包为com.example.app中的table表

//现在就可以使用此Uri对象来查询table1表中的数据
Cursor cursor=getContentResolver().query(
    uri,               //from table_name
    projection,        //selection colunm
    selection,         //where colunm = value(?)
    selectionArgs,     //为占位符提供具体的值
    sortOrder);        //指定结果的排序方式
    
//查询出来的是Cursor对象，此时我们可以将数据从Cursor对象中逐个读取，思路是通过移动游标来遍历Cursor的所有行，然后再取出每一行中相应列的数据
//借助ContentResolver进行CURD操作
cursor = getContentResolver().query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI, null, null, null, null);
if (cursor != null) {
    while (cursor.moveToNext()) {
        //获取联系人姓名
        String displayName = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
        //获取联系人手机号
        String number = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
        //将姓名号码存入结果集合
        contactsList.add(displayName + "\n" + number);
    }
    //适配器提示数据改变。
    adapter.notifyDataSetChanged();
}
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

2. New ContentProvider 提供共享数据的接口

那么，上面只是说了如何访问其他程序的数据，如何开启数据的提供，通过内容提供器来给他加入外部访问接口，则是以下的内容。
右击程序包（com.example.xxx包 → New → Other → Content Provider ）


提醒：URI Authorities 是内容提供器对外访问进行区分的取名，格式为：本程序的 包名 + .provider

修改自定义provider，设置匹配规则。

技术点如下：

• 静态代码块中对UriMatcher进行了初始化操作，将期望匹配的几种URI格式添加了进去
• ’#‘ 是数字通配符，表示匹配任意长度的数字； *‘ 是字符通配符，表示匹配任意长度的任意字符（设置匹配规则）
• 创建一个MyDatabaseHelper的实例（该类在下边的代码块），返回true表示内容提供器初始化成功，这时数据库就已经完成了创建或升级操作
• 获取SQLiteDatabase的实例，然后根据传入的Uri参数判断出用户想要访问哪张表，再调用SQLiteDatabase的query()进行查询，并返回Cursor对象
• uri.getPathSegments().get(1)==获取id

getType ( ) 是所有内容提供器都必须提供的一个方法，用于获取Uri对象所对应的MIME类型。一个内容URI所对应的MIME字符串主要由3部分组成：

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

代码如下： 注释写的很详细，认真看！

package com.example.contactstest;

import android.content.ContentProvider;
import android.content.ContentValues;
import android.content.UriMatcher;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.net.Uri;

public class MyContentProvider extends ContentProvider {
    public static final int BOOK_DIR = 0;
    public static final int BOOK_ITEM = 1;
    public static final int CATEGORY_DIR = 3;
    public static final int CATEGORY_ITEM = 4;
    public static final String AUTHORITY = "com.example.contactstest.provider";
    private static UriMatcher uriMatcher;
    private MyDatabaseHelper dbHelper;
    
    //静态代码块中对UriMatcher进行了初始化操作，将期望匹配的几种URI格式添加了进去
    // # 是数字通配符，表示匹配任意长度的数字
    // * 是字符通配符，表示匹配任意长度的任意字符
    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);
    }
    
    @Override
    public boolean onCreate() {
        // 创建了一个MyDatabaseHelper的实例（该类在下边的代码块），返回true表示内容提供器初始化成功，这时数据库就已经完成了创建或升级操作
        dbHelper = new MyDatabaseHelper(getContext(), "BookStore.db", null, 2);
        return true;
    }

    @Override
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
        // 先获取到了SQLiteDatabase的实例，然后根据传入的Uri参数判断出用户想要访问哪张表，再调用SQLiteDatabase的query()进行查询，并将Cursor对象返回
        SQLiteDatabase db = dbHelper.getReadableDatabase();//SQLiteDatabase库中方法
        Cursor cursor = null;
        switch (uriMatcher.match(uri)) {//上面写的匹配器初始化了，用键值对原理进行匹配
            case BOOK_DIR:
                cursor = db.query("Book", projection, selection, selectionArgs, null, null, sortOrder);
                break;
            case BOOK_ITEM:
                //将内容URI权限之后的部分以"/"符号进行分割，并将分割后的结果放入到字符串列表。
                //第0个位置中存放的是路径，第1个位置存放的就是id
                String bookId = uri.getPathSegments().get(1);
                cursor = db.query("Book", projection, "id=?", new String[]{bookId}, null, null, sortOrder);
                break;
            case CATEGORY_DIR:
                cursor = db.query("Category", projection, selection, selectionArgs, null, null, sortOrder);
                break;
            case CATEGORY_ITEM:
                String categoryId = uri.getPathSegments().get(1);
                cursor = db.query("Category", projection, "id=?", new String[]{categoryId}, null, null, sortOrder);
                break;
            default:
                break;
        }
        return cursor;
    }
    
    public MyContentProvider() {
    }

    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        // Implement this to handle requests to delete one or more rows.
        SQLiteDatabase db = dbHelper.getReadableDatabase();
        int deletedRows = 0;
        switch (uriMatcher.match(uri)) {
            case BOOK_DIR:
                deletedRows = db.delete("Book", selection, selectionArgs);
                break;
            case BOOK_ITEM:
                String bookId = uri.getPathSegments().get(1);
                deletedRows = db.delete("Book", "id=?", new String[]{bookId});
                break;
            case CATEGORY_DIR:
                deletedRows = db.delete("Category", selection, selectionArgs);
                break;
            case CATEGORY_ITEM:
                String categoryId = uri.getPathSegments().get(1);
                deletedRows = db.delete("Category", "id=?", new String[]{categoryId});
                break;
            default:
                break;
        }
        return deletedRows;
    }

    /*
    是所有内容提供器都必须提供的一个方法，
    用于获取Uri对象所对应的MIME类型。一个内容URI所对应的MIME字符串主要由3部分组成：
        1.必须以vnd开头
        2.如果内容URI以路径结尾，则后接android.cursor.dir/ 
          如果内容URI以id结尾，则后接android.cursor.item/
        3.最后接上vnd.<authority>.<path>
    */
    @Override
    public String getType(Uri uri) {
        switch (uriMatcher.match(uri)) {
            case BOOK_DIR:
                return "vnd.android.cursor.dir/vnd.com.example.contactstest.provider.book";
            case BOOK_ITEM:
                return "vnd.android.cursor.item/vnd.com.example.contactstest.provider.book";
            case CATEGORY_DIR:
                return "vnd.android.cursor.dir/vnd.com.example.contactstest.provider.category";
            case CATEGORY_ITEM:
                return "vnd.android.cursor.item/vnd.com.example.contactstest.provider.category";
        }
        return null;
    }

    @Override
    public Uri insert(Uri uri, ContentValues values) {
        // TODO: Implement this to handle requests to insert a new row.
        SQLiteDatabase db = dbHelper.getReadableDatabase();
        Uri uriReturn = null;

        switch (uriMatcher.match(uri)) {
            case BOOK_DIR:
            case BOOK_ITEM:
                long newBookId = db.insert("Book", null, values);
                uriReturn = Uri.parse("content://" + AUTHORITY + "/book/" + newBookId);
                break;
            case CATEGORY_DIR:
            case CATEGORY_ITEM:
                long newCategoryId = db.insert("Category", null, values);
                uriReturn = Uri.parse("content://" + AUTHORITY + "/book/" + newCategoryId);
                break;
            default:
                break;
        }
        return uriReturn;
    }
    @Override
    public int update(Uri uri, ContentValues values, String selection,
                      String[] selectionArgs) {
        // TODO: Implement this to handle requests to update one or more rows.
        SQLiteDatabase db = dbHelper.getReadableDatabase();
        int updatedRows = 0;
        switch (uriMatcher.match(uri)) {
            case BOOK_DIR:
                updatedRows = db.update("Book", values, selection, selectionArgs);
                break;
            case BOOK_ITEM:
                String bookId = uri.getPathSegments().get(1);
                updatedRows = db.update("Book", values, "id=?", new String[]{bookId});
                break;
            case CATEGORY_DIR:
                updatedRows = db.update("Category", values, selection, selectionArgs);
                break;
            case CATEGORY_ITEM:
                String categoryId = uri.getPathSegments().get(1);
                updatedRows = db.update("Category", values, "id=?", new String[]{categoryId});
                break;
            default:
                break;
        }
        return updatedRows;
    }
}
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

MyDatabaseHelper.java

package com.example.contactstest;

import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
import android.widget.Toast;

import androidx.annotation.Nullable;

public class MyDatabaseHelper extends SQLiteOpenHelper {
    public static final String CREATE_BOOK = "create table Book (" +
            "id integer primary key autoincrement," +
            "author text," +
            "price real," +
            "pages integer," +
            "name text)";
    private Context mContext;

    public MyDatabaseHelper(@Nullable Context context, @Nullable String name, @Nullable SQLiteDatabase.CursorFactory factory, int version) {
        super(context, name, factory, version);
        mContext = context;
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        db.execSQL(CREATE_BOOK);
        Toast.makeText(mContext, "Create succeed", Toast.LENGTH_SHORT).show();
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {

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