Android ContentProvider

一、介紹

  • ContentProvider 內(nèi)容提供者,是 Android 四大組件之一,被設計用于 不同應用或進程間 數(shù)據(jù)共享與交互。
  • ContentProvider是 Android 中一種數(shù)據(jù)訪問的接口,數(shù)據(jù)形式可以是數(shù)據(jù)庫、xml、文件等。
  • 底層原理是 Binder 機制。

二、具體使用

系統(tǒng)默認實現(xiàn)了很多 ContentProvider 如 聯(lián)系人、通話記錄、媒體信息。開發(fā)者可通過相應 Uri 直接訪問,本文為加深理解介紹自定義 ContentProvider。

1、Uri

Uniform Resource Identifier 統(tǒng)一資源定位符,在 Android 中是一種常用的資源訪問方式。外界進程通過 Uri 查找對應 的 ContentProvider 與其中的數(shù)據(jù)。
Uri 標準格式:

<srandard_prefix>://<authority>/<data_path>/<id>

  • srandard_prefix:ContentProvider的srandard_prefix始終是content://
  • <authority>:為ContentProvider 的Authority(唯一標識符,清單文件注冊時需要填寫)。
  • data_path:表名(數(shù)據(jù)為 數(shù)據(jù)庫形式)、文件名(數(shù)據(jù)為文件形式)
  • id: 具體的某條數(shù)據(jù),若無指定 則返回全部。

舉例 一個自定義Uri:

content://kekeProvider/user

2、ContentProvider類

  • 主要以表格的形式組織數(shù)據(jù),類似數(shù)據(jù)庫,用的較多
<-- 4個核心方法 -->
  public Uri insert(Uri uri, ContentValues values) 
  // 外部進程向 ContentProvider 中添加數(shù)據(jù)

  public int delete(Uri uri, String selection, String[] selectionArgs) 
  // 外部進程 刪除 ContentProvider 中的數(shù)據(jù)

  public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)
  // 外部進程更新 ContentProvider 中的數(shù)據(jù)

  public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,  String sortOrder)  
  // 外部應用 獲取 ContentProvider 中的數(shù)據(jù)
  • 也支持文件數(shù)據(jù)
     @Override
    public ParcelFileDescriptor openFile(Uri uri, String mode)
            throws FileNotFoundException

其他方法:

<-- 2個其他方法 -->
public boolean onCreate() 
// ContentProvider創(chuàng)建后 或 打開系統(tǒng)后其它進程第一次訪問該ContentProvider時 由系統(tǒng)進行調(diào)用
// 注:運行在ContentProvider進程的主線程,故不能做耗時操作

public String getType(Uri uri)
// 得到數(shù)據(jù)類型,即返回當前 Url 所代表數(shù)據(jù)的MIME類型

3、ContentResolver

用于統(tǒng)一管理不同 ContentProvider間 操作即:

  • 通過 Uri 操作 ContentProvider 中的數(shù)據(jù)
  • 外部進程通過 ContentResolver 類與 ContentProvider 進行交互

Android 系統(tǒng) 或 應用中 會有很多 ContentProvider ,若要直接通過 ContentProvider 進行交互,需了解每一個 相應的ContentProvider,操作成本高,難度大。
故設計ContentResolver 類對所有的 ContentProvider 進行統(tǒng)一管理。

4、ContentObserver

用于 ContentProvider 中數(shù)據(jù)發(fā)生變化時通知觀察類

// 步驟1:注冊內(nèi)容觀察者ContentObserver
    getContentResolver().registerContentObserver(uri,notifyForDescendents,contentObserver);
    // 通過ContentResolver類進行注冊,并指定需要觀察的URI

// 步驟2:當該URI的ContentProvider數(shù)據(jù)發(fā)生變化時,通知外界(即訪問該ContentProvider數(shù)據(jù)的訪問者)
    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(contentObserver);
    // 同樣需要通過ContentResolver類進行解除

registerContentObserver 時有一個 notifyForDescendents參數(shù) :
false 表示精確匹配,即只匹配該Uri,為true 表示可以同時匹配其派生的Uri。比如:
假設UriMatcher 里注冊的Uri共有一下類型:
1 、content://com.qin.cb/student (學生)
2 、content://com.qin.cb/student/#
3、 content://com.qin.cb/student/schoolchild(小學生,派生的Uri)
假設我們當前需要觀察的Uri為content://com.qin.cb/student,如果發(fā)生數(shù)據(jù)變化的 Uri 為
content://com.qin.cb/student/schoolchild ,當notifyForDescendents為 false,那么該ContentObserver會監(jiān)聽不到, 但是當notifyForDescendents 為ture,能捕捉該Uri的數(shù)據(jù)庫變化。

ContentObserver 類我們一般重寫其:

             @Override
            public void onChange(boolean selfChange, Uri uri) {
                super.onChange(selfChange, uri);
            }

5、輔助類UriMatcher與ContentUris

  • UriMatcher
    向 ContentProvider 中注冊 Uri。
    根據(jù) Uri 返回ContentProvider 中 的數(shù)據(jù)類型
// 步驟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("myprovider", "user1", URI_CODE_a); 
    matcher.addURI("myprovider", "user2", URI_CODE_b); 
    // 若URI資源路徑 = content://cn.scu.myprovider/user1 ,則返回注冊碼URI_CODE_a
    // 若URI資源路徑 = content://cn.scu.myprovider/user2 ,則返回注冊碼URI_CODE_b

// 步驟3:根據(jù)URI 匹配 URI_CODE,從而匹配ContentProvider中相應的資源(match())

@Override   
    public String getType(Uri uri) {   
      Uri uri = Uri.parse(" content://myprovider/user1");   

      switch(matcher.match(uri)){   
     // 根據(jù)URI匹配的返回碼是URI_CODE_a
     // 即matcher.match(uri) == URI_CODE_a
      case URI_CODE_a:   
        return tableNameUser1;   
        // 如果根據(jù)URI匹配的返回碼是URI_CODE_a,則返回ContentProvider中的名為tableNameUser1的表
      case URI_CODE_b:   
        return tableNameUser2;
        // 如果根據(jù)URI匹配的返回碼是URI_CODE_b,則返回ContentProvider中的名為tableNameUser2的表
    }   
}
  • ContentUris
    操作 Uri
// withAppendedId()作用:向URI追加一個id
Uri uri = Uri.parse("content://myprovider/user") 
Uri resultUri = ContentUris.withAppendedId(uri, 7);  
// 最終生成后的Uri為:content://myprovider/user/7

// parseId()作用:從URL中獲取ID
Uri uri = Uri.parse("content://myprovider/user/7") 
long personid = ContentUris.parseId(uri); 
//獲取的結(jié)果為:7

三、代碼實現(xiàn)

1、創(chuàng)建數(shù)據(jù)庫

public class DBHelper extends SQLiteOpenHelper {

    public static final String DATABASE_NAME = "keke.db";
    public static final String USER_TABLE_NAME = "user";

    public static final int database_version = 1;

    public DBHelper(Context context) {
        super(context, DATABASE_NAME, null, database_version);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        // 創(chuàng)建表格:用戶表
        db.execSQL("CREATE TABLE IF NOT EXISTS " + USER_TABLE_NAME + "(_id INTEGER PRIMARY KEY AUTOINCREMENT," + " name TEXT)");

    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {

    }
}

2、自定義 ContentProvider

public class MyContentProvider extends ContentProvider {

    private Context context;
    private SQLiteDatabase db;

    public static final String AUTOHORITY = "kekeProvider";
    // 設置ContentProvider的唯一標識

    public static final int User_Code = 1;

    // UriMatcher類使用:在ContentProvider 中注冊URI
    private static final UriMatcher mMatcher;
    static{
        mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
        // 初始化
        mMatcher.addURI(AUTOHORITY,"user", User_Code);
        // 若URI資源路徑 = content://cn.scu.myprovider/user ,則返回注冊碼User_Code
    }

    public MyContentProvider() {
    }

    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        return 0;
    }

    @Override
    public String getType(Uri uri) {
        return null;
    }

    @Override
    public Uri insert(Uri uri, ContentValues values) {
        // 根據(jù)URI匹配 URI_CODE,從而匹配ContentProvider中相應的表名
        // 該方法在最下面
        String table = getTableName(uri);

        // 向該表添加數(shù)據(jù)
        db.insert(table, null, values);

        // 當該URI的ContentProvider數(shù)據(jù)發(fā)生變化時,通知外界(即訪問該ContentProvider數(shù)據(jù)的訪問者)
        context.getContentResolver().notifyChange(uri, null);

        return uri;
    }

    @Override
    public boolean onCreate() {

        context = getContext();
        DBHelper dbHelper = new DBHelper(context);
          //  此處不應做耗時操作 只為快速展示, 請無視
        db = dbHelper.getWritableDatabase();
        db.execSQL("delete from user");
        db.execSQL("insert into user values(1,'Carson');");
        db.execSQL("insert into user values(2,'Kobe');");

        return true;
    }

    @Override
    public Cursor query(Uri uri, String[] projection, String selection,
                        String[] selectionArgs, String sortOrder) {
        String tableName = getTableName(uri);

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

    @Override
    public int update(Uri uri, ContentValues values, String selection,
                      String[] selectionArgs) {
        return 0;
    }

    /**
     * 根據(jù)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;
        }
        return tableName;
    }
}

清單文件:

<provider
            android:name=".MyContentProvider"
            android:authorities="kekeProvider"
            android:enabled="true"
            android:exported="true"></provider>

同進程測試:

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Uri uri = Uri.parse("content://kekeProvider/user");
        ContentResolver contentResolver = getContentResolver();

        ContentValues values = new ContentValues();
        values.put("_id",3);
        values.put("name","version");
        contentResolver.insert(uri,values);

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

        while (cursor.moveToNext()) {
            Log.d("TestProvider","query book:" + cursor.getInt(0) + " " + cursor.getString(1));

        }
        cursor.close();

    }
}

輸出:

 D/TestProvider: query book:1 Carson
 D/TestProvider: query book:2 Kobe
 D/TestProvider: query book:3 version

跨進程測試:
新建一個應用

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Uri uri = Uri.parse("content://kekeProvider/user");
        ContentResolver contentResolver = getContentResolver();

        ContentValues values = new ContentValues();
        values.put("_id",4);
        values.put("name","new app test");
        contentResolver.insert(uri,values);

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

        while (cursor.moveToNext()) {
            Log.d("TestProvider","query book:" + cursor.getInt(0) + " " + cursor.getString(1));

        }
        cursor.close();

    }
}

輸出:

D/TestProvider: query book:1 Carson
D/TestProvider: query book:2 Kobe
D/TestProvider: query book:3 version
D/TestProvider: query book:4 new app test

不同應用之間可自定義permission。不再演示。

四、總結(jié)

  • 定義 :內(nèi)容提供者,Android 四大組件之一
  • 作用: 進程間數(shù)據(jù)共享與交互
  • 優(yōu)點:
    1. 安全,為應用間數(shù)據(jù)交互提供了一個安全的環(huán)境,允許把自己的應用數(shù)據(jù)根據(jù)需求 開放給其他應用 增刪改查,不用擔心開放數(shù)據(jù)庫帶來的安全問題。
    2. 訪問簡單 高效,解耦了數(shù)據(jù)底層的存儲方式,使得底層無論如何存儲訪問方式都是不變的。
  • 原理: Binder 機制。
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

  • 一、定義ContentProvider即內(nèi)容提供者,Android四大組件之一。一般為存儲和獲取數(shù)據(jù)提供統(tǒng)一的接口...
    云天隨筆閱讀 1,969評論 0 1
  • 一、使用ContentProvider(內(nèi)容提供者)共享數(shù)據(jù) ContentProvider在android中的作...
    IT楓閱讀 4,478評論 0 7
  • 上一篇文章Android ContentProvider(二)學習了如何在自己的應用程序中訪問其他程序的數(shù)據(jù),這篇...
    前端develop閱讀 2,871評論 0 2
  • 今天畫的人眼。因為過于真實,可能引起不適。 心理素質(zhì)差的同學,就不推薦了。 就只用了鉛筆、橡皮、衛(wèi)生紙和B4的紙。...
    UCAN在線學習閱讀 1,095評論 0 2
  • 1. 新學期伊始,每過一次假期,只要是暑寒假,稍微假期一長,也許是每過一個假期,來學以后總是感受到寢室人關(guān)系的微妙...
    顏末小趣閱讀 311評論 0 1

友情鏈接更多精彩內(nèi)容