1. 程式人生 > >Android:ContentProvider的使用簡介

Android:ContentProvider的使用簡介

一、作用

     程序間 資料共享,跨程序通訊

    ContentProvider相當於中間的箱子,真正 儲存操作資料的還是原來的儲存資料的方式(資料庫、檔案、xml或者網路)

    底層的原理是Android中的Binder機制

二、使用

   1.統一資源識別符號(URL)

    URL = content://com.carson.provider/User/1

        content://    ContentProvider的URL字首

       com.carson.provider授權資訊

      User   ContentProvider指向資料庫的某個表名

      1   表中的某個記錄,不指定就返回全部記錄


URI Uri uri = Uri.parse("content://com.carson.provider/User/1") 
// 上述URI指向的資源是:名為 `com.carson.provider`的`ContentProvider` 中表名 為`User` 中的 `id`為1的資料 
 特別注意:URI模式存在匹配萬用字元* & # 
 *:匹配任意長度的任何有效字元的字串 
 以下的URI 表示 匹配provider的任何內容 content://com.example.app.provider/* 
#:匹配任意長度的數字字元的字串 
// 以下的URI 表示 匹配provider中的table表的所有行 
content://com.example.app.provider/table/# 

  2.MIME資料型別

作用:指定某個副檔名的檔案用某種應用程式來開啟 如指定.html檔案採用text應用程式開啟、指定.pdf檔案採用flash應用程式開啟

       2.1 ContentProvider根據 URI 返回MIME型別

ContentProvider.geType(uri) ;

          2.2 MIME型別組成

                    每種MIME型別 由2部分組成 = 型別 + 子型別 

text / html
// 型別 = text、子型別 = html

text/css
text/xml
application/pdf

2.3 MIME
型別形式

     2.3.1形式1:單條記錄 vnd.android.cursor.item/自定義 //

     2.3.2形式2:多條記錄(集合) vnd.android.cursor.dir/自定義 // 注:

    2.3.3. vnd:表示父型別和子型別具有非標準的、特定的形式。

    2.3.4. 父型別已固定好(即不能更改),只能區別是單條還是多條記錄

    2.3.5. 子型別可自定義

<-- 單條記錄 --> // 單個記錄的MIME型別 vnd.android.cursor.item/vnd.yourcompanyname.contenttype 
// 若一個Uri如下 content://com.example.transportationprovider/trains/122 
// 則ContentProvider會通過ContentProvider.geType(url)返回以下MIME型別 vnd.android.cursor.item/vnd.example.rail <-- 多條記錄 --> 
// 多個記錄的MIME型別 vnd.android.cursor.dir/vnd.yourcompanyname.contenttype
 // 若一個Uri如下 content://com.example.transportationprovider/trains 
// 則ContentProvider會通過ContentProvider.geType(url)返回以下MIME型別 vnd.android.cursor.dir/vnd.example.rail

3.ContentProvider

  3.1 組織資料方式

      主要是表格  每個表格中包含多張表,每張表包含行 & 列,分別對應記錄 & 欄位   同資料庫

      也可以是檔案

  3.2  主要方法

  程序間共享資料的本質是:新增、刪除、獲取 & 修改(更新)資料

<-- 4個核心方法 --> public Uri insert(Uri uri, ContentValues values) 
// 外部程序向 ContentProvider 中新增資料 public int delete(Uri uri, String selection, String[] selectionArgs) 
// 外部程序 刪除 ContentProvider 中的資料 public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) 
// 外部程序更新 ContentProvider 中的資料 public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)  
// 外部應用 獲取 ContentProvider 中的資料 
// 注: 
// 1. 上述4個方法由外部程序回撥,並執行在ContentProvider程序的Binder執行緒池中(不是主執行緒)
 // 2. 存在多執行緒併發訪問,需要實現執行緒同步 
// a. 若ContentProvider的資料儲存方式是使用SQLite & 一個,則不需要,因為SQLite內部實現好了執行緒同步,若是多個SQLite則需要,因為SQL物件之間無法進行執行緒同步 
// b. 若ContentProvider的資料儲存方式是記憶體,則需要自己實現執行緒同步 
<-- 2個其他方法 --> public boolean onCreate()
 // ContentProvider建立後 或 開啟系統後其它程序第一次訪問該ContentProvider時 由系統進行呼叫 
// 注:執行在ContentProvider程序的主執行緒,故不能做耗時操作 public String getType(Uri uri)
 // 得到資料型別,即返回當前 Url 所代表資料的MIME型別
  • Android為常見的資料(如通訊錄、日程表等)提供了內建了預設的ContentProvider
  • 但也可根據需求自定義ContentProvider,但上述6個方法必須重寫

4 ContentResolver類

    4.1 作用

        統一管理不同 ContentProvider間的操作

  1.  即通過 URI 即可操作 不同的ContentProvider 中的資料
  2. 外部程序通過 ContentResolver類 從而與ContentProvider類進行互動

4.2 為什麼要使用通過ContentResolver類從而與ContentProvider類進行互動,而不直接訪問ContentProvider類?

  • 一般來說,一款應用要使用多個ContentProvider,若需要了解每個ContentProvider的不同實現從而再完成資料互動,操作成本高 & 難度大
  • 所以再ContentProvider類上加多了一個 ContentResolver類對所有的ContentProvider進行統一管理。

4.3 具體使用

ContentResolver 類提供了與ContentProvider類相同名字 & 作用的4個方法

// 外部程序向 ContentProvider 中新增資料 
public Uri insert(Uri uri, ContentValues values)  
// 外部程序 刪除 ContentProvider 中的資料 public int delete(Uri uri, String selection, String[] selectionArgs) 
// 外部程序更新 ContentProvider 中的資料 public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)  
// 外部應用 獲取 ContentProvider 中的資料 public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) 

例項說明

// 使用ContentResolver前,需要先獲取ContentResolver 
// 可通過在所有繼承Context的類中 通過呼叫getContentResolver()來獲得ContentResolver ContentResolver resolver = getContentResolver(); 
// 設定ContentProvider的URI Uri uri = Uri.parse("content://cn.scu.myprovider/user"); 
// 根據URI 操作 ContentProvider中的資料 
// 此處是獲取ContentProvider中 user表的所有記錄 Cursor cursor = resolver.query(uri, null, null, null, "userid desc"); 

Android 提供了3個用於輔助ContentProvide的工具類:

  • ContentUris
  • UriMatcher
  • ContentObserver

4.5 ContentUris類

  • 作用:操作 URI
  • 具體使用 核心方法有兩個:withAppendedId() &parseId()
// withAppendedId()作用:向URI追加一個id 
Uri uri = Uri.parse("content://cn.scu.myprovider/user")
 Uri resultUri = ContentUris.withAppendedId(uri, 7); 
// 最終生成後的Uri為:
content://cn.scu.myprovider/user/7 // parseId()
作用:從URL中獲取ID
 Uri uri = Uri.parse("content://cn.scu.myprovider/user/7") 
long personid = ContentUris.parseId(uri); 
//獲取的結果為:7

4.6 UriMatcher類

  • 作用

    1. ContentProvider 中註冊URI
    2. 根據 URI 匹配 ContentProvider 中對應的資料表
  • 具體使用

// 步驟1:初始化UriMatcher物件 
UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH); 
//常量UriMatcher.NO_MATCH = 不匹配任何路徑的返回碼 
// 即初始化時不匹配任何東西 
// 步驟2:在ContentProvider 中註冊URI(addURI()) 
int URI_CODE_a = 1;
 int URI_CODE_b = 2;
 matcher.addURI("cn.scu.myprovider", "user1", URI_CODE_a); matcher.addURI("cn.scu.myprovider", "user2", URI_CODE_b); 
// 若URI資源路徑 = content://cn.scu.myprovider/user1 ,則返回註冊碼URI_CODE_a
 // 若URI資源路徑 = content://cn.scu.myprovider/user2 ,則返回註冊碼URI_CODE_b 
// 步驟3:根據URI 匹配 URI_CODE,從而匹配ContentProvider中相應的資源(match())
 @Override
 public String getType(Uri uri) 
{ Uri uri = Uri.parse(" content://cn.scu.myprovider/user1"); 
switch(matcher.match(uri)){ 
// 根據URI匹配的返回碼是URI_CODE_a 
// 即matcher.match(uri) == URI_CODE_a 
case URI_CODE_a: return tableNameUser1; 
// 如果根據URI匹配的返回碼是URI_CODE_a,則返回ContentProvider中的名為tableNameUser1的表 
case URI_CODE_b: return tableNameUser2; 
// 如果根據URI匹配的返回碼是URI_CODE_b,則返回ContentProvider中的名為tableNameUser2的表 } }

4.7 ContentObserver類

  • 定義:內容觀察者
  • 作用:觀察 Uri引起 ContentProvider 中的資料變化 & 通知外界(即訪問該資料訪問者)

ContentProvider 中的資料發生變化(增、刪 & 改)時,就會觸發該 ContentObserver

具體使用

// 步驟1:註冊內容觀察者
ContentObserver getContentResolver().registerContentObserver(uri);
 // 通過ContentResolver類進行註冊,並指定需要觀察的URI 
// 步驟2:當該URI的ContentProvider資料發生變化時,通知外界(即訪問該ContentProvider資料的訪問者) 
public class UserContentProvider extends ContentProvider 
{ public Uri insert(Uri uri, ContentValues values) {
 db.insert("user", "userid", values);
 getContext().getContentResolver().notifyChange(uri, null);
 // 通知訪問者 } } // 步驟3:解除觀察者 getContentResolver().unregisterContentObserver(uri);
 // 同樣需要通過ContentResolver類進行解除 

5.例項演示

  • 步驟說明:

    1. 建立資料庫類
    2. 自定義 ContentProvider
    3. 註冊 建立的 ContentProvider
    4. 程序內訪問 ContentProvider的資料
  • 具體使用

步驟1:建立資料庫類

DBHelper.java

public class DBHelper extends SQLiteOpenHelper { 
// 資料庫名 private static final String DATABASE_NAME = "finch.db"; 
// 表名 
public static final String USER_TABLE_NAME = "user"; 
public static final String JOB_TABLE_NAME = "job"; 
private static final int DATABASE_VERSION = 1; 
//資料庫版本號 
public DBHelper(Context context) { 
super(context, DATABASE_NAME, null, DATABASE_VERSION);
 }
 @Override public void onCreate(SQLiteDatabase db) { 
 // 建立兩個表格:使用者表 和職業表 
 db.execSQL("CREATE TABLE IF NOT EXISTS " + USER_TABLE_NAME + "(_id INTEGER PRIMARY KEY AUTOINCREMENT," + " name TEXT)");
 db.execSQL("CREATE TABLE IF NOT EXISTS " + JOB_TABLE_NAME + "(_id INTEGER PRIMARY KEY AUTOINCREMENT," + " job TEXT)"); } 
 @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
	 } }

步驟2:自定義 ContentProvider 類

public class MyProvider extends ContentProvider {



    private Context mContext;

    DBHelper mDbHelper = null;

    SQLiteDatabase db = null;

    public static final String AUTOHORITY = "cn.scu.myprovider";

    // 設定ContentProvider的唯一標識



    public static final int User_Code = 1;

    public static final int Job_Code = 2;



    // UriMatcher類使用:在ContentProvider 中註冊URI

    private static final UriMatcher mMatcher;

    static{

        mMatcher = new UriMatcher(UriMatcher.NO_MATCH);

        // 初始化

        mMatcher.addURI(AUTOHORITY,"user", User_Code);

        mMatcher.addURI(AUTOHORITY, "job", Job_Code);

        // 若URI資源路徑 = content://cn.scu.myprovider/user ,則返回註冊碼User_Code

        // 若URI資源路徑 = content://cn.scu.myprovider/job ,則返回註冊碼Job_Code

    }



    // 以下是ContentProvider的6個方法



    /**

     * 初始化ContentProvider

     */

    @Override

    public boolean onCreate() {



        mContext = getContext();

        // 在ContentProvider建立時對資料庫進行初始化

        // 執行在主執行緒,故不能做耗時操作,此處僅作展示

        mDbHelper = new DBHelper(getContext());

        db = mDbHelper.getWritableDatabase();



        // 初始化兩個表的資料(先清空兩個表,再各加入一個記錄)

        db.execSQL("delete from user");

        db.execSQL("insert into user values(1,'Carson');");

        db.execSQL("insert into user values(2,'Kobe');");



        db.execSQL("delete from job");

        db.execSQL("insert into job values(1,'Android');");

        db.execSQL("insert into job values(2,'iOS');");



        return true;

    }



    /**

     * 新增資料

     */



    @Override

    public Uri insert(Uri uri, ContentValues values) {



        // 根據URI匹配 URI_CODE,從而匹配ContentProvider中相應的表名

        // 該方法在最下面

        String table = getTableName(uri);



        // 向該表新增資料

        db.insert(table, null, values);



        // 當該URI的ContentProvider資料發生變化時,通知外界(即訪問該ContentProvider資料的訪問者)

        mContext.getContentResolver().notifyChange(uri, null);



//        // 通過ContentUris類從URL中獲取ID

//        long personid = ContentUris.parseId(uri);

//        System.out.println(personid);



        return uri;

        }



    /**

     * 查詢資料

     */

    @Override

    public Cursor query(Uri uri, String[] projection, String selection,

                        String[] selectionArgs, String sortOrder) {

        // 根據URI匹配 URI_CODE,從而匹配ContentProvider中相應的表名

        // 該方法在最下面

        String table = getTableName(uri);



//        // 通過ContentUris類從URL中獲取ID

//        long personid = ContentUris.parseId(uri);

//        System.out.println(personid);



        // 查詢資料

        return db.query(table,projection,selection,selectionArgs,null,null,sortOrder,null);

    }



    /**

     * 更新資料

     */

    @Override

    public int update(Uri uri, ContentValues values, String selection,

                      String[] selectionArgs) {

        // 由於不展示,此處不作展開

        return 0;

    }



    /**

     * 刪除資料

     */

    @Override

    public int delete(Uri uri, String selection, String[] selectionArgs) {

        // 由於不展示,此處不作展開

        return 0;

    }



    @Override

    public String getType(Uri uri) {



        // 由於不展示,此處不作展開

        return null;

    }



    /**

     * 根據URI匹配 URI_CODE,從而匹配ContentProvider中相應的表名

     */

    private String getTableName(Uri uri){

        String tableName = null;

        switch (mMatcher.match(uri)) {

            case User_Code:

                tableName = DBHelper.USER_TABLE_NAME;

                break;

            case Job_Code:

                tableName = DBHelper.JOB_TABLE_NAME;

                break;

        }

        return tableName;

        }

    }

步驟3:註冊 建立的 ContentProvider類AndroidManifest.xml

<provider android:name="MyProvider"
                android:authorities="cn.scu.myprovider"
                    />

步驟4:程序內訪問 ContentProvider中的資料

MainActivity.java

public class MainActivity extends AppCompatActivity {



    @Override

    protected void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_main);



        /**

         * 對user表進行操作

         */



        // 設定URI

        Uri uri_user = Uri.parse("content://cn.scu.myprovider/user");



        // 插入表中資料

        ContentValues values = new ContentValues();

        values.put("_id", 3);

        values.put("name", "Iverson");





        // 獲取ContentResolver

        ContentResolver resolver =  getContentResolver();

        // 通過ContentResolver 根據URI 向ContentProvider中插入資料

        resolver.insert(uri_user,values);



        // 通過ContentResolver 向ContentProvider中查詢資料

        Cursor cursor = resolver.query(uri_user, new String[]{"_id","name"}, null, null, null);

        while (cursor.moveToNext()){

            System.out.println("query book:" + cursor.getInt(0) +" "+ cursor.getString(1));

            // 將表中資料全部輸出

        }

        cursor.close();

        // 關閉遊標



        /**

         * 對job表進行操作

         */

        // 和上述類似,只是URI需要更改,從而匹配不同的URI CODE,從而找到不同的資料資源

        Uri uri_job = Uri.parse("content://cn.scu.myprovider/job");



        // 插入表中資料

        ContentValues values2 = new ContentValues();

        values2.put("_id", 3);

        values2.put("job", "NBA Player");



        // 獲取ContentResolver

        ContentResolver resolver2 =  getContentResolver();

        // 通過ContentResolver 根據URI 向ContentProvider中插入資料

        resolver2.insert(uri_job,values2);



        // 通過ContentResolver 向ContentProvider中查詢資料

        Cursor cursor2 = resolver2.query(uri_job, new String[]{"_id","job"}, null, null, null);

        while (cursor2.moveToNext()){

            System.out.println("query job:" + cursor2.getInt(0) +" "+ cursor2.getString(1));

            // 將表中資料全部輸出

        }

        cursor2.close();

        // 關閉遊標

}

}