Android ContentProvider基礎應用詳解

一、適用場景

1、ContentProvider為存儲和讀取數據提供瞭統一的接口

2、 使用ContentProvider,應用程序可以實現數據共享

3、 android內置的許多數據都是使用ContentProvider形式,供開發者調用的(如視頻,音頻,圖片,通訊錄等)

二、概念介紹

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)。

三、使用步驟

1、首先創建一個繼承自ContentProvider的類,並實現其6個方法:

此6個方法隻有onCreate方法運行在UI線程中,這裡在onCreate方法中進行一些數據的初始化工作,初始瞭SQLite數據庫【這裡拿封裝數據庫操作舉例,也可以是其他】,創建瞭兩張表book、user 並分別默認插入瞭兩本書,和兩個管理員。

package com.hongri.androidipc.contentprovider;
 
/**
 * @author zhongyao
 * @date 2018/6/11
 *
 * onCreate方法運行在主線程(main)中
 * 其他方法運行在Binder線程池中
 *
 */
 
public class MyContentProvider extends ContentProvider {
    private static final String TAG = MyContentProvider.class.getSimpleName() + " ";
    /**
     * 唯一標識
     */
    public static final String AUTHORITIES = "com.hongri.androidipc.contentprovider.provider";
 
    public static final Uri BOOK_CONTENT_URI = Uri.parse("content://" + AUTHORITIES + "/book");
 
    public static final Uri USER_CONTENT_URI = Uri.parse("content://" + AUTHORITIES + "/user");
 
    public static final int BOOK_URI_CODE = 0;
 
    public static final int USER_URI_CODE = 1;
 
    private DbOpenHelper mDbHelper;
 
    private SQLiteDatabase mDB;
 
    private Context mContext;
 
    private static final UriMatcher mUriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
 
    static {
        mUriMatcher.addURI(AUTHORITIES, "book", BOOK_URI_CODE);
        mUriMatcher.addURI(AUTHORITIES, "user", USER_URI_CODE);
    }
 
    /**
     * ContentProvider的創建:做一些初始化的工作
     * onCreate方法 運行在主線程,其他方法運行在工作線程
     * @return
     */
    @Override
    public boolean onCreate() {
        String currentThreadName = Thread.currentThread().getName();
        Logger.d(TAG + "onCreate--" + "currentThreadName:" + currentThreadName);
 
        mContext = getContext();
 
        mDbHelper = new DbOpenHelper(getContext(), "", null, 1);
        mDB = mDbHelper.getWritableDatabase();
        mDB.execSQL("delete from " + DbOpenHelper.BOOK_TABLE_NAME);
        mDB.execSQL("delete from " + DbOpenHelper.USER_TABLE_NAME);
        mDB.execSQL("insert into book values('1','Android',234);");
        mDB.execSQL("insert into book values('2','Java',348);");
        mDB.execSQL("insert into user values('1','hongri',1);");
        mDB.execSQL("insert into user values('2','huyin',1);");
        return true;
    }
 
    private String getTableName(Uri uri) {
        switch (mUriMatcher.match(uri)) {
            case BOOK_URI_CODE:
                return DbOpenHelper.BOOK_TABLE_NAME;
            case USER_URI_CODE:
                return DbOpenHelper.USER_TABLE_NAME;
            default:
                break;
        }
        return "";
    }
 
    /**
     * 用來返回一個MIME類型(媒體類型)
     *
     * @param uri
     * @return
     */
    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        return null;
    }
 
    /**
     * 增
     *
     * @param uri
     * @param values
     * @return
     */
    @Nullable
    @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
        String tableName = getTableName(uri);
        mDB.insert(tableName, null, values);
        mContext.getContentResolver().notifyChange(uri, null);
        return uri;
    }
 
    /**
     * 刪
     *
     * @param uri
     * @param selection
     * @param selectionArgs
     * @return
     */
    @Override
    public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {
        String tableName = getTableName(uri);
        int count = mDB.delete(tableName, selection, selectionArgs);
        if (count > 0) {
            mContext.getContentResolver().notifyChange(uri, null);
        }
        return count;
    }
 
    /**
     * 查
     *
     * @param uri
     * @param projection
     * @param selection
     * @param selectionArgs
     * @param sortOrder
     * @return
     */
    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection,
                        @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        String currentThreadName = Thread.currentThread().getName();
        Logger.d(TAG + "query: currentThreadName:" + currentThreadName + " uri:" + uri);
 
        String tableName = getTableName(uri);
 
        return mDB.query(tableName, projection, selection, selectionArgs, null, null, sortOrder, null);
    }
 
    /**
     * 改
     *
     * @param uri
     * @param values
     * @param selection
     * @param selectionArgs
     * @return
     */
    @Override
    public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection,
                      @Nullable String[] selectionArgs) {
        String tableName = getTableName(uri);
        if (tableName == null) {
            return 0;
        }
        int row = mDB.update(tableName, values, selection, selectionArgs);
        if (row > 0) {
            mContext.getContentResolver().notifyChange(uri, null);
        }
        return row;
    }
}

上面封裝的 DbOpenHelper 代碼如下:

package com.hongri.androidipc.db;
 
/**
 * @author zhongyao
 * @date 2018/6/11
 */
 
public class DbOpenHelper extends SQLiteOpenHelper {
    public static final String BOOK_TABLE_NAME = "book";
    public static final String USER_TABLE_NAME = "user";
 
    public static final String DB_NAME = "library";
    public static final int DB_VERSION = 1;
 
    private String BOOK_SQL;
    private String USER_SQL;
 
    public DbOpenHelper(Context context, String name,
                        CursorFactory factory, int version) {
        super(context, DB_NAME, factory, DB_VERSION);
 
        BOOK_SQL = "CREATE TABLE IF NOT EXISTS " + BOOK_TABLE_NAME + "(_id INTEGER PRIMARY KEY," + "name TEXT,"
            + "page INT)";
        USER_SQL = "CREATE TABLE IF NOT EXISTS " + USER_TABLE_NAME + "(_id INTEGER PRIMARY KEY," + "name TEXT,"
            + "sex INT)";
 
    }
 
    @Override
    public void onCreate(SQLiteDatabase db) {
        db.execSQL(BOOK_SQL);
        db.execSQL(USER_SQL);
    }
 
    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
 
    }
}

2、在Manifest文件中註冊這個ContentProvider:

    <provider
         android:name="com.hongri.androidipc.contentprovider.MyContentProvider"
         android:authorities="com.hongri.androidipc.contentprovider.provider"
         android:permission="com.hongri.androidipc.PROVIDER"
         android:process=":provider" />

3、在外部應用中訪問它:

        <activity
            android:name=".ContentProviderActivity"
            android:process=":remoteProcess">
            <intent-filter>
                <action android:name="android.intent.action.MAIN"/>
                <category android:name="android.intent.category.LAUNCHER"/>
            </intent-filter>
        </activity>

這裡單獨開啟瞭一個進程 remoteProcess 用來模擬第三方App。

該Activity頁面如下,點擊相關按鈕可以進行基礎的增、刪、查、改操作,可通過log查看調用結果。

這裡註意如果希望監聽數據更新,那麼需要註冊內容觀察者 ContentObserver,增、刪、改動的時候,會有回調通知,前提是在自定義的ContentProvider類方法中,調用getContentResolver().notifyChange(uri, null);方法即可。

package com.hongri.androidipc;
 
 
/**
 * @author hongri
 */
public class ContentProviderActivity extends AppCompatActivity implements View.OnClickListener {
 
    //book uri
    private final Uri bookUri = MyContentProvider.BOOK_CONTENT_URI;
    //user uri
    private final Uri userUri = MyContentProvider.USER_CONTENT_URI;
    private Button btnInsert, btnQuery, btnQueryByUser, btnModify, btnDelete;
    private Handler mHandler = new Handler();
 
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_content_provider);
 
        btnInsert = (Button) findViewById(R.id.btnInsert);
        btnQuery = (Button) findViewById(R.id.btnQuery);
        btnQueryByUser = (Button) findViewById(R.id.btnQueryByUser);
        btnModify = (Button) findViewById(R.id.btnModify);
        btnDelete = (Button) findViewById(R.id.btnDelete);
 
        btnInsert.setOnClickListener(this);
        btnQuery.setOnClickListener(this);
        btnQueryByUser.setOnClickListener(this);
        btnModify.setOnClickListener(this);
        btnDelete.setOnClickListener(this);
 
        getContentResolver().registerContentObserver(bookUri, true, mContentObserver);
        getContentResolver().registerContentObserver(userUri, true, mContentObserver);
    }
 
    /**
     * 定義一個內容觀察者【數據有更新時會調用】
     */
    private ContentObserver mContentObserver = new ContentObserver(mHandler) {
        @Override
        public void onChange(boolean selfChange) {
            super.onChange(selfChange);
            //這裡selfChange都是返回false的,不用理會這個參數
            Logger.d("onChange調用 --- 數據有更新");
        }
    };
 
 
    /**
     * 向 bookUri 中插入一本書
     */
    private void doInsert() {
        ContentValues values = new ContentValues();
        values.put("name", "Android框架");
        values.put("page", "1213");
        Uri uri = getContentResolver().insert(bookUri, values);
        Logger.d("插入成功 ---> uri:" + uri.toString());
    }
 
    /**
     * 根據 bookUri 查詢所有書籍
     */
    private void doQuery() {
        Cursor bookCursor = getContentResolver().query(bookUri, new String[]{"_id", "name", "page"}, null, null, null);
        while (bookCursor.moveToNext()) {
            Book book = new Book();
            book.set_id(bookCursor.getInt(0));
            book.setName(bookCursor.getString(1));
            book.setPage(bookCursor.getInt(2));
            Logger.d("book:" + book.toString());
        }
        bookCursor.close();
    }
 
    /**
     * 查詢 userUri 所有圖書員
     */
    private void doQueryUser() {
        Cursor userCursor = getContentResolver().query(userUri, new String[]{"_id", "name", "sex"}, null, null, null);
        while (userCursor.moveToNext()) {
            User user = new User();
            user.set_id(userCursor.getInt(0));
            user.setName(userCursor.getString(1));
            user.setSex(userCursor.getInt(2));
            Logger.d("user:" + user.toString());
        }
        userCursor.close();
    }
 
    /**
     * 更新書籍【Android底層開發】
     */
    private void doUpdate() {
        ContentValues updateValues = new ContentValues();
        updateValues.put("name", "Android底層開發");
        updateValues.put("page", 3345);
        int row = getContentResolver().update(bookUri, updateValues, "name=?", new String[]{"Android框架"});
        if (row > 0) {
            Logger.d("book:已修改");
        }
    }
 
    /**
     * 刪除 名為"Java" 這本書
     */
    private void doDelete() {
        int count = getContentResolver().delete(bookUri, "name=?", new String[]{"Java"});
        if (count > 0) {
            Logger.d("book:已進行刪除操作");
        }
    }
 
    @SuppressLint("NonConstantResourceId")
    @Override
    public void onClick(View v) {
        int id = v.getId();
        switch (id) {
            case R.id.btnInsert:
                /**
                 * 增
                 */
                doInsert();
                break;
 
            case R.id.btnQuery:
                /**
                 * 查
                 */
                doQuery();
                break;
 
            case R.id.btnQueryByUser:
                /**
                 * 查
                 */
                doQueryUser();
                break;
 
            case R.id.btnModify:
                /**
                 * 改
                 */
                doUpdate();
                doQuery();
                break;
 
            case R.id.btnDelete:
                /**
                 * 刪
                 */
                doDelete();
                doQuery();
                break;
 
            default:
                break;
        }
    }
 
    @Override
    protected void onDestroy() {
        super.onDestroy();
        getContentResolver().unregisterContentObserver(mContentObserver);
    }
}

以上便是ContentProvider的基礎應用。

源碼地址:AndroidIPC 

到此這篇關於Android ContentProvider基礎應用詳解的文章就介紹到這瞭,更多相關Android ContentProvider內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: