Android ContentProvider詳解

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());
       }
    }
}