轉自:http://www.cnblogs.com/devinzhang/archive/2012/01/20/2327863.
1.適用情境
1) ContentProvider為儲存和讀取資料提供了統一的介面
2) 使用ContentProvider,應用程式可以實現資料共用
3) 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’的記錄。
3. 建立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()); } }}