Android 總結:ContentProvider 的使用
一、概述
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()); } } }
Android 總結:ContentProvider 的使用