Android ContentProvider一个标准的内容提供器的创建封装代码和使用例子

最新推荐文章于 2024-09-07 15:19:21 发布

尹中文

最新推荐文章于 2024-09-07 15:19:21 发布

阅读量811

点赞数

文章标签： android

本文链接：https://blog.csdn.net/yzwfeng/article/details/128481200

版权

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

1. public class MyProvider extends ContentProvider {
2.
3. @Override
4. public boolean onCreate() {
5. return false;
6. }
7.
8. @Override
9. public Cursor query(Uri uri, String[] projection, String selection,
10. String[] selectionArgs, String sortOrder) {
11. return null;
12. }//查询
13.
14. @Override
15. public Uri insert(Uri uri, ContentValues values) {
16. return null;
17. }//添加
18.
19. @Override
20. public int update(Uri uri, ContentValues values, String selection,
21. String[] selectionArgs) {
22. return 0;
23. }//更新
24.
25. @Override
26. public int delete(Uri uri, String selection, String[] selectionArgs) {
27. return 0;
28. }//删除
29.
30. @Override
31. public String getType(Uri uri) {
32. return null;
33. }
34. }

在这6 个方法中，相信出来增删改查的方法你知道之外，剩下两个方法你可能不知
道，下面就对这些方法进行一一介绍：
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 写法是这样的：

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

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

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

这就表示调用方期望访问的是com.example.app 这个应用的table1 表中id 为1 的数
据。
内容URI 的格式主要有以上两种，以路径结尾就表示期望访问该表中所有的数据，以
id 结果就表示期望访问该表中拥有相应id 的数据。我们可以使用通配符的方式来分别匹配
这两中格式的内容URI,规则如下：
*：表示匹配任意长度的任意字符。
#：表示匹配任意长度的任意数字。
所以，一个能够匹配任意表的内容URI 格式就可以写成：

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

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

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

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

1. public class MyProvider extends ContentProvider {
2.
3. public static fianl int TABLE1_DIR = 0;
4.
5. public static fianl int TABLE1_ITEM = 1;
6.
7. public static fianl int TABLE2_DIR = 2;
8.
9. public static fianl int TABLE2_ITEM = 3;
10.
11. private static UriMatcher uriMatcher;
12.
13. static{
14.
15. uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
16. uriMatcher.addURI("com.example.app.provider","table1",TABLE1_DIR);
17. uriMatcher.addURI("com.example.app.provider","table1/#",TABLE1_ITEM)
;
18. uriMatcher.addURI("com.example.app.provider","table2",TABLE2_DIR);
19. uriMatcher.addURI("com.example.app.provider","table2/#",TABLE2_ITEM)
;
20.
21. }
22.
23.
24. ...
25.
26. @Override
27. public Cursor query(Uri uri, String[] projection, String selection,
28. String[] selectionArgs, String sortOrder) {
29. switch(uriMatcher.match(uri)){
30. case TABLE1_DIR:
31. //查询table1 中的数据
32. break;
33.
34. case TABLE1_ITEM:
35. //查询table1 中的单条数据
36. break;
37.
38. case TABLE2_DIR:
39. //查询table2 中的数据
40. break;
41.
42. case TABLE2_ITEM:
43. //查询table2 中的单条数据
44. break;
45.
46. }
47.
48.
49. return null;
50.
51. }//查询
52.
53. ...
54. }

上述代码只是以query()方法为例做了个示范，其实insert()方法，update(),delete()方法
的实现也是跟query()方法是差不多的，它们都会携带Uri 这个参数，然后同样利用
UriMatcher 的match()方法判断出调用方期望访问的是哪张表，再对该表中的数据进行相应
的操作就可以了。
除此之外，还有个方法你比较陌生，这个方法就是getType()方法。它是所有的内容提
供器都必须提供的一个方法，用于获取Uri 对象所对应的MIME 类型。一个内容URI 所对
应的MIME 字符串主要由3 部分组成，Android 对这3 个部分做了如下格式规定：
 必须以vnd 开头
 如果内容URI 以路径结尾，则后接android.cursor.dir/,如果内容URI 以id 结尾，则后接
android.cursor.item/。
 最后接vnd.< authority >.< path >
所以，对于content://com.example.app.provider/table1 这个内容URI,它所对应的MIME
类型就可以写成：
1. vnd.android.cursor.dir/vnd.com.example.app.provider.table1
对于content://com.example.app.provider/table1/1 这个内容URI,它所对应的MIME 类型
就可以写成：
1. vnd.android.cursor.dir/vnd.com.example.app.provider.table1
现在，我们可以继续完善MyProvider 类中的内容，这次实现getType()方法的逻辑，代
码如下：

1. public class MyProvider extends ContentProvider{
2.
3. ...
4.
5. @Override
6. public String getType(Uri uri){
7. switch(uriMatcher.match(uri)){
8. case TABLE1_DIR:
9. return "vnd.android.cursor.dir/vnd.com.example.app.provider.
table1"
10. break;
11.
12. case TABLE1_ITEM:
13. return "vnd.android.cursor.item/vnd.com.example.app.provider
.table1 "
14. break;
15.
16. case TABLE2_DIR:
17. return "vnd.android.cursor.dir/vnd.com.example.app.provider
.table2"
18. break;
19.
20. case TABLE2_ITEM:
21. return "vnd.android.cursor.item/vnd.com.example.app.provider
.table2 "
22. break;
23. }
24. }
25.
26. ...
27.
28. }

到这里，一个完整的内容提供器就创建完成了，现在任何一个应用程序都可以使用
ContentResolver 来访问我们程序中的数据。那么前面所提到的，如何才能保证隐私数据不
会泄漏出去呢？其实多亏了内容提供器的良好机制，这个问题在不知不觉中已经被解决
了。因为所有的 CRUD 操作都一定要匹配到相应的内容 URI 格式才能进行的，而我们当
然不可能向UriMatcher 中添加隐私数据的URI，所以这部分数据根本无法被外部程序访问
到，安全问题也就不存在了。
好了，创建内容提供器的步骤你也已经清楚了，下面就来实战一下，真正体验一回跨
程
序数据共享的功能。
还没有结束呢？我们都知道4 大组件都需要在AndroidManifest.xml 文件中进行注册，既然
完成的内容提供器写好了，那么下一步就是去AndroidManifest.xml 文件中进行注册，然后
这个内容提供器就可以使用了。我们就来拿一个例子进行讲解，一个标准的内容提供器的
封装代码如下所示：

1. public class DatabaseProvider extends ContentProvider {
2.
3. public static final int BOOK_DIR = 0;
4.
5. public static final int BOOK_ITEM = 1;
6.
7. public static final int CATEGORY_DIR = 2;
8.
9. public static final int CATEGORY_ITEM = 3;
10.
11. public static final String AUTHORITY = "com.example.databasetest.provide
r";
12.
13. private static UriMatcher uriMatcher;
14.
15. private MyDatabaseHelper dbHelper;//内容提供器数据库支持
16.
17. static {
18. uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
19. uriMatcher.addURI(AUTHORITY, "book", BOOK_DIR);
20. uriMatcher.addURI(AUTHORITY, "book/#", BOOK_ITEM);
21. uriMatcher.addURI(AUTHORITY, "category", CATEGORY_DIR);
22. uriMatcher.addURI(AUTHORITY, "category/#", CATEGORY_ITEM);
23. }
24.
25. @Override
26. public boolean onCreate() {
27. dbHelper = new MyDatabaseHelper(getContext(), "BookStore.db", null,
2);//创建内容提供器要使用的数据库
28. return true;//这里一定返回true，不然内容提供器无法被使用
29. }
30.
31. @Override
32. public Cursor query(Uri uri, String[] projection, String selection,
33. String[] selectionArgs, String sortOrder) {
34. // 查询数据
35. SQLiteDatabase db = dbHelper.getReadableDatabase();
36. Cursor cursor = null;
37. switch (uriMatcher.match(uri)) {
38. case BOOK_DIR:
39. cursor = db.query("Book", projection, selection, selectionArgs,
40. null, null, sortOrder);
41. break;
42.
43. case BOOK_ITEM:
44. String bookId = uri.getPathSegments().get(1);
45. cursor = db.query("Book", projection, "id = ?", new String[]
46. { bookId }, null, null, sortOrder);
47. break;
48.
49. case CATEGORY_DIR:
50. cursor = db.query("Category", projection, selection,
51. selectionArgs, null, null, sortOrder);
52. break;
53.
54. case CATEGORY_ITEM:
55. String categoryId = uri.getPathSegments().get(1);
56. cursor = db.query("Category", projection, "id = ?", new String[
]
57. { categoryId }, null, null, sortOrder);
58. break;
59.
60. default:
61. break;
62. }
63.
64. return cursor;
65. }
66.
67. @Override
68. public Uri insert(Uri uri, ContentValues values) {
69. // 添加数据
70. SQLiteDatabase db = dbHelper.getWritableDatabase();
71. Uri uriReturn = null;
72. switch (uriMatcher.match(uri)) {
73. case BOOK_DIR:
74.
75. case BOOK_ITEM:
76. long newBookId = db.insert("Book", null, values);
77. uriReturn = Uri.parse("content://" + AUTHORITY + "/book/" +
78. newBookId);
79. break;
80.
81. case CATEGORY_DIR:
82.
83. case CATEGORY_ITEM:
84. long newCategoryId = db.insert("Category", null, values);
85. uriReturn = Uri.parse("content://" + AUTHORITY + "/category/
" +
86. newCategoryId);
87. break;
88.
89. default:
90. break;
91. }
92.
93. return uriReturn;
94. }
95.
96. @Override
97. public int update(Uri uri, ContentValues values, String selection,
98. String[] selectionArgs) {
99. // 更新数据
100. SQLiteDatabase db = dbHelper.getWritableDatabase();
101. int updatedRows = 0;
102. switch (uriMatcher.match(uri)) {
103.
104. case BOOK_DIR:
105. updatedRows = db.update("Book", values, selection, selectionAr
gs);
106. break;
107.
108. case BOOK_ITEM:
109. String bookId = uri.getPathSegments().get(1);
110. updatedRows = db.update("Book", values, "id = ?", new String[]
111. { bookId });
112. break;
113.
114. case CATEGORY_DIR:
115. updatedRows = db.update("Category", values, selection,
116. selectionArgs);
117. break;
118.
119. case CATEGORY_ITEM:
120. String categoryId = uri.getPathSegments().get(1);
121. updatedRows = db.update("Category", values, "id = ?", new Stri
ng[]
122. { categoryId });
123. break;
124.
125. default:
126. break;
127. }
128.
129. return updatedRows;
130.
131. }
132.
133. @Override
134. public int delete(Uri uri, String selection, String[] selectionArgs) {
135. // 删除数据
136. SQLiteDatabase db = dbHelper.getWritableDatabase();
137. int deletedRows = 0;
138. switch (uriMatcher.match(uri)) {
139.
140. case BOOK_DIR:
141. deletedRows = db.delete("Book", selection, selectionArgs);
142. break;
143.
144. case BOOK_ITEM:
145. String bookId = uri.getPathSegments().get(1);
146. deletedRows = db.delete("Book", "id = ?", new String[] { bookI
d });
147. break;
148.
149. case CATEGORY_DIR:
150. deletedRows = db.delete("Category", selection, selectionArgs);
151. break;
152.
153. case CATEGORY_ITEM:
154. String categoryId = uri.getPathSegments().get(1);
155. deletedRows = db.delete("Category", "id = ?", new String[]
156. { categoryId });
157. break;
158.
159. default:
160. break;
161. }
162.
163. return deletedRows;
164. }
165.
166. @Override
167. public String getType(Uri uri) {
168.
169. switch (uriMatcher.match(uri)) {
170.
171. case BOOK_DIR:
172. return "vnd.android.cursor.dir/vnd.com.example.databasetest.
173. provider.book";
174.
175. case BOOK_ITEM:
176. return "vnd.android.cursor.item/vnd.com.example.databasetest.
177. provider.book";
178.
179. case CATEGORY_DIR:
180. return "vnd.android.cursor.dir/vnd.com.example.databasetest.
181. provider.category";
182.
183. case CATEGORY_ITEM:
184. return "vnd.android.cursor.item/vnd.com.example.databasetest.
185. provider.category";
186.
187. }
188.
189. return null;
190.
191. }
192. }

AndroidManifest.xml 文件中对内容提供器进行注册，标签为< provider >…< /provider >

1. <manifest xmlns:android="http://schemas.android.com/apk/res/android"
2. package="com.example.databasetest"
3. android:versionCode="1"
4. android:versionName="1.0" >
5. ……
6. <application
7. android:allowBackup="true"
8. android:icon="@drawable/ic_launcher"
9. android:label="@string/app_name"
10. android:theme="@style/AppTheme" >
11. ……
12. <provider
13. android:name="com.example.databasetest.DatabaseProvider"
14. android:authorities="com.example.databasetest.provider" >
15. </provider>
16. </application>
17. </manifest>

这样一个完整的内容提供器的创建流程就讲完了。