内容提供者ContentProvider的基本使用

一、ContentProvider简介

当应用继承ContentProvider类，并重写该类用于提供数据和存储数据的方法，就可以向其他应用共享其数据。ContentProvider为存储和获取数据提供了统一的接口。虽然使用其他方法也可以对外共享数据，但数据访问方式会因数据存储的方式而不同，如采用文件方式对外共享数据，需要进行文件操作读写数据；采用sharedpreferences共享数据，需要使用sharedpreferences API读写数据。而使用ContentProvider共享数据的好处是统一了数据访问方式。

 

query(Uri uri, String[] projection, String selection, String[] selectionArgs,String sortOrder)
通过Uri进行查询，返回一个Cursor

insert(Uri url, ContentValues values)
将一组数据插入到Uri 指定的地方

update(Uri uri, ContentValues values, String where, String[] selectionArgs)
更新Uri指定位置的数据

delete(Uri url, String where, String[] selectionArgs)
删除指定Uri并且符合一定条件的数据

 

 

二、Uri类简介

Uri代表了要操作的数据，Uri主要包含了两部分信息
①需要操作的ContentProvider
②对ContentProvider中的什么数据进行操作

 

组成部分
①scheme:ContentProvider的scheme已经由Android所规定为content://
②主机名(Authority):用于唯一标识这个ContentProvider，外部调用者可以根据这个标识来找到它。建议为公司域名，保持唯一性
③路径(path):可以用来表示我们要操作的数据，路径的构建应根据业务而定:

 

要操作person表中id为10的记录
content://cn.xyCompany.providers.personProvider/person/10

 

要操作person表中id为10的记录的name字段
content://cn.xyCompany.providers.personProvider/person/10/name

 

要操作person表中的所有记录
content://cn.xyCompany.providers.personProvider/person

 

要操作的数据不一定来自数据库，也可以是文件等他存储方式，如要操作xml文件中user节点下的name节点

content://cn.xyCompany.providers.personProvider/person/10/name

 

把一个字符串转换成Uri，可以使用Uri类中的parse()方法
Uri uri = Uri.parse("content://cn.xyCompany.providers.personProvider/person")

 

三、UriMatcher、ContentUris和ContentResolver简介

Uri代表了要操作的数据，所以经常需要解析Uri，并从Uri中获取数据。Android系统提供了两个用于操作Uri的工具类，分别为UriMatcher 和ContentUris。掌握它们的使用会便于我们的开发工作。

 

UriMatcher

用于匹配Uri

①把需要匹配Uri路径全部给注册上

// 常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码(-1)。
UriMatcher  uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);

// 若match()方法匹配content://cn.xyCompany.providers.personProvider/person路径则返回匹配码为1
uriMatcher.addURI("content://cn.xyCompany.providers.personProvider","person", 1);

// 若match()方法匹配content://cn.xyCompany.providers.personProvider/person/10路径则返回匹配码为2
uriMatcher.addURI("content://cn.xyCompany.providers.personProvider","person/#", 1);

②注册完需要匹配的Uri后，就可以使用uriMatcher.match(uri)方法对输入的Uri进行匹配

ContentUris
ContentUris是对URI的操作类，其中的withAppendedId(uri, id)用于为路径加上ID部分，parseId(uri)方法用于从路径中获取ID部分方法很实用。
Uri insertUri = Uri.parse("content://cn.xyCompany.providers.personProvider/person" + id);等价于
Uri insertUri = ContentUris.withAppendedId(uri, id);

ContentResolver
当外部应用需要对ContentProvider中的数据进行添加、删除、修改和查询操作时，可以使用ContentResolver 类来完成。要获取ContentResolver 对象，可以使用Activity提供的getContentResolver()方法。 ContentResolver使用insert、delete、update、query方法来操作数据。

 

三、实例代码

当数据需要在应用程序间共享时，我们就可以利用ContentProvider为数据定义一个URI。之后其他应用程序对数据进行查询或者修改时，只需要从当前上下文对象获得一个ContentResolver(内容解析器)传入相应的URI就可以了。

contentProvider和Activity一样是Android的组件，故使用前需要在AndroidManifest.xml中注册，必须放在主应用所在包或其子包下。

[html]  view plain  copy

 print ?

1.  <application android:icon="@drawable/icon" android:label="@string/app_name">  
2.      <activity android:name=".MainActivity"  
3.                android:label="@string/app_name">  
4.          <intent-filter>  
5.              <action android:name="android.intent.action.MAIN" />  
6.              <category android:name="android.intent.category.LAUNCHER" />  
7.          </intent-filter>  
8.          <intent-filter>  
9.              <data android:mimeType="vnd.android.cursor.dir/person" />  
10.          </intent-filter>  
11.          <intent-filter>  
12.              <data android:mimeType="vnd.android.cursor.item/person" />  
13.          </intent-filter>  
14.      </activity>  
15.      <!-- 配置内容提供者,android:authorities为该内容提供者取名作为在本应用中的唯一标识 -->  
16.      <provider android:name=".providers.PersonProvider"   
17. android:authorities="cn.xyCompany.providers.personProvider"/>  
18.  </application>  

 

内容提供者和测试代码

[java]  view plain  copy

 print ?

1. 内容提供者  
2. package cn.xy.cotentProvider.app.providers;  
3. import android.content.ContentProvider;  
4. import android.content.ContentUris;  
5. import android.content.ContentValues;  
6. import android.content.UriMatcher;  
7. import android.database.Cursor;  
8. import android.database.sqlite.SQLiteDatabase;  
9. import android.net.Uri;  
10. import android.util.Log;  
11. import cn.xy.cotentProvider.service.DBOpeningHelper;  
12.   
13. /** 
14.  * contentProvider作为一种组件必须放在应用所在包或其子包下，主要作用是对外共享数据 
15.  * 测试步骤1：将本项目先部署 
16.  * 测试步骤2：调用测试方法 
17.  * @author xy 
18.  *  
19.  */  
20. public class PersonProvider extends ContentProvider  
21. {  
22.     private DBOpeningHelper dbHelper;  
23.   
24.     // 若不匹配采用UriMatcher.NO_MATCH(-1)返回  
25.     private static final UriMatcher MATCHER = new UriMatcher(UriMatcher.NO_MATCH);  
26.   
27.     // 匹配码  
28.     private static final int CODE_NOPARAM = 1;  
29.     private static final int CODE_PARAM = 2;  
30.   
31.     static  
32.     {  
33.         // 对等待匹配的URI进行匹配操作，必须符合cn.xyCompany.providers.personProvider/person格式  
34.         // 匹配返回CODE_NOPARAM，不匹配返回-1  
35.         MATCHER.addURI("cn.xyCompany.providers.personProvider", "person", CODE_NOPARAM);  
36.   
37.         // #表示数字 cn.xyCompany.providers.personProvider/person/10  
38.         // 匹配返回CODE_PARAM，不匹配返回-1  
39.         MATCHER.addURI("cn.xyCompany.providers.personProvider", "person/#", CODE_PARAM);  
40.     }  
41.   
42.     @Override  
43.     public boolean onCreate()  
44.     {  
45.         dbHelper = new DBOpeningHelper(this.getContext());  
46.         return true;  
47.     }  
48.   
49.     /** 
50.      * 外部应用向本应用插入数据 
51.      */  
52.     @Override  
53.     public Uri insert(Uri uri, ContentValues values)  
54.     {  
55.         SQLiteDatabase db = dbHelper.getWritableDatabase();  
56.         switch (MATCHER.match(uri))  
57.         {  
58.             case CODE_NOPARAM:  
59.                 // 若主键值是自增长的id值则返回值为主键值，否则为行号，但行号并不是RecNo列  
60.                 long id = db.insert("person", "name", values);   
61.                 Uri insertUri = ContentUris.withAppendedId(uri, id);   
62.                 return insertUri;  
63.             default:  
64.                 throw new IllegalArgumentException("this is unkown uri:" + uri);  
65.         }  
66.     }  
67.   
68.     /** 
69.      * 外部应用向本应用删除数据 
70.      */  
71.     @Override  
72.     public int delete(Uri uri, String selection, String[] selectionArgs)  
73.     {  
74.         SQLiteDatabase db = dbHelper.getWritableDatabase();  
75.         switch (MATCHER.match(uri))  
76.         {  
77.             case CODE_NOPARAM:  
78.                 return db.delete("person", selection, selectionArgs); // 删除所有记录  
79.             case CODE_PARAM:  
80.                 long id = ContentUris.parseId(uri); // 取得跟在URI后面的数字  
81.                 Log.i("provider", String.valueOf(id));  
82.                 String where = "id = " + id;  
83.                 if (null != selection && !"".equals(selection.trim()))  
84.                 {  
85.                     where += " and " + selection;  
86.                 }  
87.                 return db.delete("person", where, selectionArgs);  
88.             default:  
89.                 throw new IllegalArgumentException("this is unkown uri:" + uri);  
90.         }  
91.     }  
92.   
93.     /** 
94.      * 外部应用向本应用更新数据 
95.      */  
96.     @Override  
97.     public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)  
98.     {  
99.         SQLiteDatabase db = dbHelper.getWritableDatabase();  
100.         switch (MATCHER.match(uri))  
101.         {  
102.             case CODE_NOPARAM:  
103.                 return db.update("person",values,selection, selectionArgs); // 更新所有记录  
104.             case CODE_PARAM:  
105.                 long id = ContentUris.parseId(uri); // 取得跟在URI后面的数字  
106.                 String where = "id = " + id;  
107.                 if (null != selection && !"".equals(selection.trim()))  
108.                 {  
109.                     where += " and " + selection;  
110.                 }  
111.                 return db.update("person",values,where,selectionArgs);  
112.             default:  
113.                 throw new IllegalArgumentException("this is unkown uri:" + uri);  
114.         }  
115.     }  
116.       
117.     /** 
118.      * 返回对应的内容类型 
119.      * 如果返回集合的内容类型，必须以vnd.android.cursor.dir开头 
120.      * 如果是单个元素，必须以vnd.android.cursor.item开头 
121.      */  
122.     @Override  
123.     public String getType(Uri uri)  
124.     {  
125.         switch(MATCHER.match(uri))  
126.         {  
127.             case CODE_NOPARAM:  
128.                 return "vnd.android.cursor.dir/person";  
129.             case CODE_PARAM:  
130.                 return "vnd.android.cursor.item/person";  
131.             default:  
132.                 throw new IllegalArgumentException("this is unkown uri:" + uri);  
133.         }  
134.     }  
135.   
136.     @Override  
137.     public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)  
138.     {  
139.         SQLiteDatabase db = dbHelper.getReadableDatabase();  
140.         switch (MATCHER.match(uri))  
141.         {  
142.             case CODE_NOPARAM:  
143.                 return db.query("person", projection, selection, selectionArgs, null, null, sortOrder);  
144.             case CODE_PARAM:  
145.                 long id = ContentUris.parseId(uri); // 取得跟在URI后面的数字  
146.                 String where = "id = " + id;  
147.                 if (null != selection && !"".equals(selection.trim()))  
148.                 {  
149.                     where += " and " + selection;  
150.                 }  
151.                 return db.query("person", projection, where, selectionArgs, null, null, sortOrder);  
152.             default:  
153.                 throw new IllegalArgumentException("this is unkown uri:" + uri);  
154.         }  
155.     }  
156.   
157. }  
158.   
159.   
160.   
161. 测试代码  
162. package cn.xy.test.test;  
163. import android.content.ContentResolver;  
164. import android.content.ContentValues;  
165. import android.database.Cursor;  
166. import android.net.Uri;  
167. import android.test.AndroidTestCase;  
168. import android.util.Log;  
169.   
170. /** 
171.  * 测试代码 
172.  * @author xy 
173.  * 
174.  */  
175. public class TestProviders extends AndroidTestCase  
176. {  
177.     // 在执行该测试方法时需要先将还有内容提供者的项目部署到Android中，否则无法找到内容提供者  
178.     public void testInsert()  
179.     {  
180.         Uri uri = Uri.parse("content://cn.xyCompany.providers.personProvider/person");  
181.         ContentResolver resolver = this.getContext().getContentResolver();  
182.         ContentValues values = new ContentValues();  
183.         values.put("name", "xy");  
184.         values.put("phone", "111");  
185.         resolver.insert(uri, values); // 内部调用内容提供者的insert方法  
186.     }  
187.   
188.     // 不带id参数的删除  
189.     public void testDelete1()  
190.     {  
191.         Uri uri = Uri.parse("content://cn.xyCompany.providers.personProvider/person");  
192.         ContentResolver resolver = this.getContext().getContentResolver();  
193.         int rowAffect = resolver.delete(uri, null, null);  
194.         Log.i("rowAffect", String.valueOf(rowAffect));  
195.     }  
196.   
197.     // 带参数的删除，通过URI传递了id至contentProvider并可追加其他条件  
198.     public void testDelete2()  
199.     {  
200.         Uri uri = Uri.parse("content://cn.xyCompany.providers.personProvider/person/18");  
201.         ContentResolver resolver = this.getContext().getContentResolver();  
202.         int rowAffect = resolver.delete(uri, "name = ?", new String[] { "XY2" }); // 在provider中手动进行了拼装  
203.         Log.i("rowAffect", String.valueOf(rowAffect));  
204.     }  
205.       
206.     public void testUpdate()  
207.     {  
208.         Uri uri = Uri.parse("content://cn.xyCompany.providers.personProvider/person/19");  
209.         ContentResolver resolver = this.getContext().getContentResolver();  
210.         ContentValues values = new ContentValues();  
211.         values.put("name", "newxy");  
212.         values.put("phone", "new111");  
213.         int rowAffect = resolver.update(uri, values, null, null);  
214.         Log.i("rowAffect", String.valueOf(rowAffect));  
215.     }  
216.       
217.     public void testQuery()  
218.     {  
219.         Uri uri = Uri.parse("content://cn.xyCompany.providers.personProvider/person/19");  
220.         ContentResolver resolver = this.getContext().getContentResolver();  
221.         Cursor cursor = resolver.query(uri, new String[]{"id","name","phone"}, null, null, "id asc");  
222.         if(cursor.moveToFirst())  
223.         {  
224.             Log.i("query", cursor.getString(cursor.getColumnIndex("name")));  
225.         }  
226.         cursor.close();  
227.     }  
228. }