一、概述
ContentProvider:为存储和获取数据提供统一的接口,可以在不同的应用程序之间共享数据。
Android内置的许多数据都是使用ContentProvider形式,供开发者调用的 (如视频,音频,图片,通讯录等)。
1. 使用表的形式来组织数据
- 无论数据来源是什么,ContentProvider都会认为是一种表。(把数据组织成表格)
2. 提供的方法
- query:查询
- insert:插入
- update:更新
- delete:删除
- getType:得到数据类型
- onCreate:创建数据时调用的回调函数
3. 公共的URI
- 每个ContentProvider都有一个公共的URI,这个URI用于表示这个ContentProvider所提供的数据。
- Android所提供的ContentProvider都存放在android.provider包当中。
4. 对比分析
虽然使用其他方法也可以对外共享数据,但数据访问方式会因数据存储的方式而不同。
- 采用文件方式对外共享数据,需要进行文件操作读写数据;
- 采用sharedpreferences共享数据,需要使用sharedpreferences API读写数据。
- 使用ContentProvider共享数据的好处是统一了数据访问方式。
二、ContentProvider 的实现步骤
1. 定义一个 CONTENT_URI 常量
// CONTENT_URI 的字符串必须是唯一
public static final Uri CONTENT_URI = Uri.parse("content://com.WangWeiDa.MyContentprovider");
// 如果有子表,URI为:
public static final Uri CONTENT_URI = Uri.parse("content://com.WangWeiDa.MyContentProvider/users");
2. 定义一个继承自ContentProvider的类
public class MyContentProvider extends ContentProvider { ... }
3. 实现ContentProvider的所有方法
为ContentProvider提供一个常量类 MyContentProviderMetaData.java
public class MyContentProviderMetaData {
//URI的指定,此处的字符串必须和声明的authorities一致
public static final String AUTHORITIES = "com.zhuanghongji.app.MyContentProvider";
//数据库名称
public static final String DATABASE_NAME = "myContentProvider.db";
//数据库的版本
public static final int DATABASE_VERSION = 1;
//表名
public static final String USERS_TABLE_NAME = "user";
public static final class UserTableMetaData implements BaseColumns{
//表名
public static final String TABLE_NAME = "user";
//访问该ContentProvider的URI
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITIES + "/user");
//该ContentProvider所返回的数据类型的定义
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.myprovider.user";
public static final String CONTENT_TYPE_ITEM = "vnd.android.cursor.item/vnd.myprovider.user";
//列名
public static final String USER_NAME = "name";
//默认的排序方法
public static final String DEFAULT_SORT_ORDER = "_id desc";
}
}
public class MyContentProvider extends ContentProvider {
//访问表的所有列
public static final int INCOMING_USER_COLLECTION = 1;
//访问单独的列
public static final int INCOMING_USER_SINGLE = 2;
//操作URI的类
public static final UriMatcher uriMatcher;
//为UriMatcher添加自定义的URI
static{
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
uriMatcher.addURI(MyContentProviderMetaData.AUTHORITIES,"/user",
INCOMING_USER_COLLECTION);
uriMatcher.addURI(MyContentProviderMetaData.AUTHORITIES,"/user/#",
INCOMING_USER_SINGLE);
}
private DatabaseHelper dh;
//为数据库表字段起别名
public static HashMap userProjectionMap;
static
{
userProjectionMap = new HashMap();
userProjectionMap.put(UserTableMetaData._ID,UserTableMetaData._ID);
userProjectionMap.put(UserTableMetaData.USER_NAME, UserTableMetaData.USER_NAME);
}
/**
* 删除表数据
*/
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
System.out.println("delete");
//得到一个可写的数据库
SQLiteDatabase db = dh.getWritableDatabase();
//执行删除,得到删除的行数
int count = db.delete(UserTableMetaData.TABLE_NAME, selection, selectionArgs);
return count;
}
/**
* 数据库访问类型
*/
@Override
public String getType(Uri uri) {
System.out.println("getType");
//根据用户请求,得到数据类型
switch (uriMatcher.match(uri)) {
case INCOMING_USER_COLLECTION:
return MyContentProviderMetaData.UserTableMetaData.CONTENT_TYPE;
case INCOMING_USER_SINGLE:
return MyContentProviderMetaData.UserTableMetaData.CONTENT_TYPE_ITEM;
default:
throw new IllegalArgumentException("UnKnown URI"+uri);
}
}
/**
* 插入数据
*/
@Override
public Uri insert(Uri uri, ContentValues values) {
//得到一个可写的数据库
SQLiteDatabase db = dh.getWritableDatabase();
//向指定的表插入数据,得到返回的Id
long rowId = db.insert(UserTableMetaData.TABLE_NAME, null, values);
if(rowId > 0){ // 判断插入是否执行成功
//如果添加成功,利用新添加的Id和
Uri insertedUserUri = ContentUris.withAppendedId(UserTableMetaData.CONTENT_URI, rowId);
//通知监听器,数据已经改变
getContext().getContentResolver().notifyChange(insertedUserUri, null);
return insertedUserUri;
}
return uri;
}
/**
* 创建ContentProvider时调用的回调函数
*/
@Override
public boolean onCreate() {
System.out.println("onCreate");
//得到数据库帮助类
dh = new DatabaseHelper(getContext(),MyContentProviderMetaData.DATABASE_NAME);
return false;
}
/**
* 查询数据库
*/
@Override
public Cursor query(Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder) {
//创建一个执行查询的Sqlite
SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
//判断用户请求,查询所有还是单个
switch(uriMatcher.match(uri)){
case INCOMING_USER_COLLECTION:
//设置要查询的表名
qb.setTables(UserTableMetaData.TABLE_NAME);
//设置表字段的别名
qb.setProjectionMap(userProjectionMap);
break;
case INCOMING_USER_SINGLE:
qb.setTables(UserTableMetaData.TABLE_NAME);
qb.setProjectionMap(userProjectionMap);
// 追加条件,getPathSegments()得到用户请求的Uri地址截取的数组,
// get(1)得到去掉地址中/以后的第二个元素
qb.appendWhere(UserTableMetaData._ID + "=" + uri.getPathSegments().get(1));
break;
}
//设置排序
String orderBy;
if(TextUtils.isEmpty(sortOrder)){
orderBy = UserTableMetaData.DEFAULT_SORT_ORDER;
} else {
orderBy = sortOrder;
}
//得到一个可读的数据库
SQLiteDatabase db = dh.getReadableDatabase();
//执行查询,把输入传入
Cursor c = qb.query(db, projection, selection, selectionArgs, null, null, orderBy);
//设置监听
c.setNotificationUri(getContext().getContentResolver(), uri);
return c;
}
/**
* 更新数据库
*/
@Override
public int update(Uri uri, ContentValues values, String selection,
String[] selectionArgs) {
System.out.println("update");
//得到一个可写的数据库
SQLiteDatabase db = dh.getWritableDatabase();
//执行更新语句,得到更新的条数
int count = db.update(UserTableMetaData.TABLE_NAME, values, selection, selectionArgs);
return count;
}
}
4. 在AndroidMinifest.xml中进行声明
<provider
android:name=".MyContentProvider"
android:authorities="com.zhuanghongji.app.MyContentProvider" />
三、另外一个实例说明
1. Uri类简介
Uri uri = Uri.parse("content://com.changcheng.provider.contactprovider/contact")
在Content Provider中使用的查询字符串有别于标准的SQL查询。
诸如select, add, delete, modify等操作我们都使用一种特殊的URI来进行,这种URI由3个部分组成:
-
- “content://”
- 代表数据的路径,
- 一个可选的标识数据的ID
content://media/internal/images 这个URI将返回设备上存储的所有图片
content://contacts/people/ 这个URI将返回设备上的所有联系人信息
content://contacts/people/45 这个URI返回单个结果(联系人信息中ID为45的联系人记录)
尽管这种查询字符串格式很常见,但是它看起来还是有点令人迷惑。
为此,Android提供一系列的帮助类(在android.provider包
下),里面包含了很多以类变量形式给出的查询字符串,这种方式更容易让我们理解一点,因此,如上面 content://contacts/people/45
这个URI就可以写成如下形式:
Uri person = ContentUris.withAppendedId(People.CONTENT_URI, 45);
然后执行数据查询:
Cursor cursor = managedQuery(person, null, null, null);
这个查询返回一个包含所有数据字段的游标,我们可以通过迭代这个游标来获取所有的数据。
2. 范例
如何依次读取联系人信息表中的指定数据列name和number。
public class ContentProviderDemo extends Activity {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
displayRecords();
}
private void displayRecords() {
//该数组中包含了所有要返回的字段
String columns[] = new String[] { People.NAME, People.NUMBER };
Uri mContacts = People.CONTENT_URI;
Cursor cur = managedQuery(
mContacts,
columns, // 要返回的数据字段
null, // WHERE子句
null, // WHERE 子句的参数
null // Order-by子句
);
if (cur.moveToFirst()) {
String name = null;
String phoneNo = null;
do {
// 获取字段的值
name = cur.getString(cur.getColumnIndex(People.NAME));
phoneNo = cur.getString(cur.getColumnIndex(People.NUMBER));
Toast.makeText(this, name + ” ” + phoneNo, Toast.LENGTH_LONG).show();
} while (cur.moveToNext());
}
}
}
3. 修改记录
可以使用ContentResolver.update()方法来修改数据:
private void updateRecord(int recNo, String name) {
Uri uri = ContentUris.withAppendedId(People.CONTENT_URI, recNo);
ContentValues values = new ContentValues();
values.put(People.NAME, name);
getContentResolver().update(uri, values, null, null);
}
现在你可以调用上面的方法来更新指定记录:
updateRecord(10, ”XYZ”); // 更改第10条记录的name字段值为“XYZ”
4. 添加记录
可以调用ContentResolver.insert()方法:
- 该方法接受一个要增加的记录的目标URI,以及一个包含了新记录值的Map对象,
- 调用后的返回值是新记录的URI,包含记录号。
上面的例子中我们都是基于联系人信息簿这个标准的Content Provider
下面创建 insertRecords(name, phoneNo)
的方式来向联系人信息簿中添加联系人姓名和电话号码。
private void insertRecords(String name, String phoneNo) {
ContentValues values = new ContentValues();
values.put(People.NAME, name);
Uri uri = getContentResolver().insert(People.CONTENT_URI, values);
Log.d(”ANDROID”, uri.toString());
Uri numberUri = Uri.withAppendedPath(uri, People.Phones.CONTENT_DIRECTORY);
values.clear();
values.put(Contacts.Phones.TYPE, People.Phones.TYPE_MOBILE);
values.put(People.NUMBER, phoneNo);
getContentResolver().insert(numberUri, values);
5. 删除记录
private void deleteRecords() {
Uri uri = People.CONTENT_URI;
getContentResolver().delete(uri, null, null);
}
你也可以指定WHERE条件语句来删除特定的记录:
getContentResolver().delete(uri, "NAME=" + "'XYZ XYZ'", null);
这将会删除name为‘XYZ XYZ’的记录。
6. 创建ContentProvider
1. 创建一个继承了ContentProvider父类的类
2. 定义一个名为CONTENT_URI,并且是public static final的Uri类型的类变量
- 你必须为其指定一个唯一的字符串值,最好的方案是以类的全名称, 如:
public static final Uri CONTENT_URI = Uri.parse( "content://com.google.android.MyContentProvider");
3. 定义你要返回给客户端的数据列名
- 如果你正在使用Android数据库,必须为其定义一个叫_id的列,它用来表示每条记录的唯一性。
4. 创建你的数据存储系统
- 大多数Content Provider使用
Android文件系统
或SQLite数据库
来保持数据,但是你也可以以任何你想要的方式来存储。 - 如果你要存储字节型数据,比如位图文件等。
a. 数据列其实是一个表示实际保存文件的URI字符串,通过它来读取对应的文件数据。
b. 处理这种数据类型的Content Provider需要实现一个名为_data的字段,_data字段列出了该文件在Android文件系统
上的精确路径。
c. 这个字段不仅是供客户端使用,而且也可以供ContentResolver
使用。
d. 客户端可以调用ContentResolver.openOutputStream()
方法来处理该URI指向的文件资源。
e. 如果是ContentResolver
本身的话,由于其持有的权限比客户端要高,所以它能直接访问该数据文件。
5. 声明public static String型的变量
- 用于指定要从游标处返回的数据列。
6. 查询返回一个Cursor类型的对象
- 所有执行写操作的方法如insert(), update() 以及delete()都将被监听。
7. 在AndroidMenifest.xml中使用< provider />标签来设置ContentProvider
8. 如果要处理的数据类型是一种比较新的类型
- 你就必须先定义一个新的MIME类型,以供ContentProvider.geType(url)来返回。
- MIME类型有两种形式:
- 一种是为指定的单个记录的
- 另一种是为多条记录的。
这里给出一种常用的格式:
vnd.android.cursor.item/vnd.yourcompanyname.contenttype // 单个记录的MIME类型
比如, 一个请求列车信息的URI
content://com.example.transportationprovider/trains/122
可能就会返回
typevnd.android.cursor.item/vnd.example.rail
这样一个MIME类型
vnd.android.cursor.dir/vnd.yourcompanyname.contenttype // 多个记录的MIME类型
比如, 一个请求所有列车信息的URI
content://com.example.transportationprovider/trains
可能就会返回
vnd.android.cursor.dir/vnd.example.rail
这样一个MIME 类型
9. 创建ContentProvider
下面代码将创建一个 ContentProvider
,它仅仅是存储用户名称并显示所有的用户名称。
(使用 SQLLite数据库存储这些数据):
(1)下面这个类中定义了ContentProvider
的 CONTENT_URI
,以及数据列
:
public class MyUsers {
public static final String AUTHORITY = "com.zhuanghongji.MyContentProvider";
// BaseColumn类中已经包含了 _id字段
public static final class User implements BaseColumns {
public static final Uri CONTENT_URI = Uri.parse("content://com.zhuanghongji.MyContentProvider");
// 表数据列
public static final String USER_NAME = "USER_NAME";
}
}
(2) 接着定义基于上面的类来定义实际的Content Provider类:
public class MyContentProvider extends ContentProvider {
private SQLiteDatabase sqlDB;
private DatabaseHelper dbHelper;
private static final String DATABASE_NAME = “Users.db”;
private static final int DATABASE_VERSION= 1;
private static final String TABLE_NAME= “User”;
private static final String TAG = “MyContentProvider”;
private static class DatabaseHelper extends SQLiteOpenHelper {
DatabaseHelper(Context context) {
super(context, DATABASE_NAME, null, DATABASE_VERSION);
}
@Override
public void onCreate(SQLiteDatabase db) {
//创建用于存储数据的表
db.execSQL("Create table " + TABLE_NAME + "( _id INTEGER PRIMARY KEY AUTOINCREMENT, USER_NAME TEXT);");
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
db.execSQL("DROP TABLE IF EXISTS " + TABLE_NAME);
onCreate(db); // 调用onCreate()再进行创建
}
}
@Override
public int delete(Uri uri, String s, String[] as) {
return 0;
}
@Override
public String getType(Uri uri) {
return null;
}
@Override
public Uri insert(Uri uri, ContentValues contentvalues) {
sqlDB = dbHelper.getWritableDatabase();
long rowId = sqlDB.insert(TABLE_NAME,"",contentvalues);
if (rowId > 0) {
Uri rowUri = ContentUris.appendId(MyUsers.User.CONTENT_URI.buildUpon(), rowId).build();
getContext().getContentResolver().notifyChange(rowUri, null);
return rowUri;
}
throw new SQLException("Failed to insert row into " + uri);
}
@Override
public boolean onCreate() {
dbHelper = new DatabaseHelper(getContext());
return (dbHelper == null) ? false : true;
}
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
SQLiteDatabase db = dbHelper.getReadableDatabase();
qb.setTables(TABLE_NAME);
Cursor c = qb.query(db, projection, selection, null, null, null, sortOrder);
c.setNotificationUri(getContext().getContentResolver(), uri);
return c;
}
@Override
public int update(Uri uri, ContentValues contentvalues, String s, String[] as) {
return 0;
}
}
一个名为MyContentProvider
的Content Provider
创建完成了,它用于从Sqlite数据库中添加和读取记录。
10. 在AndroidManifest.xml中配置:
<provider
android:name=”MyContentProvider”
android:authorities=”com.zhuanghongji.MyContentProvider” />
11. 使用刚才定义好的ContentProvider
- 为应用程序添加ContentProvider的访问权限。
- 通过
getContentResolver()
方法得到ContentResolver对象。 - 调用ContentResolver类的
query()
方法查询数据,该方法会返回一个Cursor对象。 - 对得到的Cursor对象进行分析,得到需要的数据。
- 调用Cursor类的
close()
方法将Cursor对象关闭。
public class MyContentProviderDemo extends Activity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
insertRecord(”MyUser”);
displayRecords();
}
private void insertRecord(String userName) {
ContentValues values = new ContentValues();
values.put(MyUsers.User.USER_NAME, userName);
getContentResolver().insert(MyUsers.User.CONTENT_URI, values);
}
private void displayRecords() {
String columns[] = new String[] { MyUsers.User._ID, MyUsers.User.USER_NAME };
Uri myUri = MyUsers.User.CONTENT_URI;
Cursor cur = managedQuery(myUri, columns,null, null, null );
if (cur.moveToFirst()) {
String id = null;
String userName = null;
do {
id = cur.getString(cur.getColumnIndex(MyUsers.User._ID));
userName = cur.getString(cur.getColumnIndex(MyUsers.User.USER_NAME));
Toast.makeText(this, id + ” ” + userName, Toast.LENGTH_LONG).show();
} while (cur.moveToNext());
}
}
}