1. 实用场景
ContentProvider 为存储和读取数据提供了对立的接口
应用 ContentProvider,应用程序能够实现数据共享
android 内置的许多数据都是应用 ContentProvider 模式,供开发者调用的(如视频,音频,图片,通讯录等)
2. 相干概念介绍
1)ContentProvider 简介
当利用继承 ContentProvider 类,并重写该类用于提供数据和存储数据的办法,就能够向其余利用共享其数据。尽管应用其余办法也能够对外共享数据,但数据拜访形式会因数据存储的形式而不同,如:采纳文件形式对外共享数据,须要进行文件操作读写数据;采纳 sharedpreferences 共享数据,须要应用 sharedpreferences API 读写数据。而应用 ContentProvider 共享数据的益处是对立了数据拜访形式。
2)Uri 类简介
Uri uri = Uri.parse(“content://com.changcheng.provider.contactprovider/contact”)
在 Content Provider 中应用的查问字符串有别于规范的 SQL 查问。很多诸如 select, add, delete, modify 等操作咱们都应用一种非凡的 URI 来进行,这种 URI 由 3 个局部组成,“content://”, 代表数据的门路,和一个可选的标识数据的 ID。以下是一些示例 URI:
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 cur = managedQuery(person, null, null, null);
这个查问返回一个蕴含所有数据字段的游标,咱们能够通过迭代这个游标来获取所有的数据:
package com.wissen.testApp;
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());
}
}
}
上例示范了一个如何顺次读取联系人信息表中的指定数据列 name 和 number。
批改记录:
咱们能够应用 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”
增加记录:
要减少记录,咱们能够调用 ContentResolver.insert()办法,该办法承受一个要减少的记录的指标 URI,以及一个蕴含了新记录值的 Map 对象,调用后的返回值是新记录的 URI,蕴含记录号。
下面的例子中咱们都是基于联系人信息簿这个规范的 Content Provider,当初咱们持续来创立一个 insertRecord() 办法以对联系人信息簿中进行数据的增加:
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);
}
这样咱们就能够调用 insertRecords(name, phoneNo)的形式来向联系人信息簿中增加联系人姓名和电话号码。
删除记录:
Content Provider 中的 getContextResolver.delete()办法能够用来删除记录,上面的记录用来删除设施上所有的联系人信息:
private void deleteRecords() {
Uri uri = People.CONTENT_URI;
getContentResolver().delete(uri, null, null);
}
你也能够指定 WHERE 条件语句来删除特定的记录:
getContentResolver().delete(uri,“NAME=”+“‘XYZ XYZ’”, null);
这将会删除 name 为‘XYZ XYZ’的记录。
创立 ContentProvider
要创立咱们本人的 Content Provider 的话,咱们须要遵循以下几步:
a. 创立一个继承了 ContentProvider 父类的类
b. 定义一个名为 CONTENT_URI,并且是 public static final 的 Uri 类型的类变量,你必须为其指定一个惟一的字符串值,最好的计划是以类的全名称,如:
public static final Uri CONTENT_URI = Uri.parse(“content://com.google.android.MyContentProvider”);
c. 定义你要返回给客户端的数据列名。如果你正在应用 Android 数据库,必须为其定义一个叫_id 的列,它用来示意每条记录的唯一性。
d. 创立你的数据存储系统。大多数 Content Provider 应用 Android 文件系统或 SQLite 数据库来保持数据,然而你也能够以任何你想要的形式来存储。
e. 如果你要存储字节型数据,比方位图文件等,数据列其实是一个示意理论保留文件的 URI 字符串,通过它来读取对应的文件数据。解决这种数据类型的 Content Provider 须要实现一个名为_data 的字段,_data 字段列出了该文件在 Android 文件系统上的准确门路。这个字段不仅是供客户端应用,而且也能够供 ContentResolver 应用。客户端能够调用 ContentResolver.openOutputStream()办法来解决该 URI 指向的文件资源;如果是 ContentResolver 自身的话,因为其持有的权限比客户端要高,所以它能间接拜访该数据文件。
f. 申明 public static String 型的变量,用于指定要从游标处返回的数据列。
g. 查问返回一个 Cursor 类型的对象。所有执行写操作的办法如 insert(), update() 以及 delete()都将被监听。咱们能够通过应用 ContentResover().notifyChange()办法来告诉监听器对于数据更新的信息。
h. 在 AndroidMenifest.xml 中应用 <provider> 标签来设置 Content Provider。
i. 如果你要解决的数据类型是一种比拟新的类型,你就必须先定义一个新的 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 类型。
下列代码将创立一个 Content Provider,它仅仅是存储用户名称并显示所有的用户名称(应用 SQLLite 数据库存储这些数据):
public class MyUsers {
public static final String AUTHORITY =“com.wissen.MyContentProvider”;
// BaseColumn 类中曾经蕴含了 _id 字段
public static final class User implements BaseColumns {public static final Uri CONTENT_URI = Uri.parse(”content://com.wissen.MyContentProvider”);
// 表数据列
public static final String USER_NAME =“USER_NAME”;
}
}
下面的类中定义了 Content Provider 的 CONTENT_URI,以及数据列。上面咱们将定义基于下面的类来定义理论的 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);
}
}
@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 数据库中增加和读取记录。
Content Provider 的入口须要在 AndroidManifest.xml 中配置:
<provider android:name=”MyContentProvider”android:authorities=”com.wissen.MyContentProvider”/>
之后,让咱们来应用这个定义好的 Content Provider:
1)为应用程序增加 ContentProvider 的拜访权限。
2)通过 getContentResolver()办法失去 ContentResolver 对象。
3)调用 ContentResolver 类的 query()办法查问数据,该办法会返回一个 Cursor 对象。
4)对失去的 Cursor 对象进行剖析,失去须要的数据。
5)调用 Cursor 类的 close()办法将 Cursor 对象敞开。
public class MyContentDemo 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());
}
}
}