如何自定義一個優雅的ContentProvider

最近在code review的時候發現很多人的provider定義的不是很好，寫的很粗糙 以至於程式碼健壯性不夠好，可讀性也不強

但是你既然寫了content provider 就是要給別人呼叫的，如果provider寫的漏洞百出的話  還不如不寫，

要麼別讓別的app 對你的資料進行crud，要麼就讓自己的app 直接用db 來運算元據，既然要寫provider，就要寫的標準

優雅~~放一個provider的例項在這裡，有大量註釋 告訴你為什麼要這麼寫。跟我一樣有程式碼潔癖的人可以參考下。

 

package com.example.providertest;

import android.net.Uri;
import android.provider.BaseColumns;

/**
 * 常量類
 */
public final class StudentProfile {

    /**
     * 一般來說 我們的authority都是設定成 我們這個常量類的包名+類名
     */
    public static final String AUTHORITY = "com.example.providertest.StudentProfile";

    /**
     * 注意這個建構函式 是私有的 目的就是讓他不能被初始化
     */
    private StudentProfile() {

    }

    /**
     * 實現了這個BaseColumns介面 可以讓我們少寫幾行程式碼
     * 
     */
    public static final class Students implements BaseColumns {
        /**
         * 這個類同樣也是不能被初始化的
         */
        private Students() {

        }

        // 定義我們的表名
        public static final String TABLE_NAME = "students";

        /**
         * 下面開始uri的定義
         */

        // uri的scheme部分 這個部分是固定的寫法
        private static final String SCHEME = "content://";

        // 部分學生
        private static final String PATH_STUDENTS = "/students";

        // 某一個學生
        private static final String PATH_STUDENTS_ID = "/students/";

        /**
         * path這邊的第幾個值是指的位置 我們設定成第一個位置
         */
        public static final int STUDENT_ID_PATH_POSITION = 1;

        // 這個表的基本的uri格式
        public static final Uri CONTENT_URI = Uri.parse(SCHEME + AUTHORITY
                + PATH_STUDENTS);
        // 某一條資料的基本uri格式 這個通常在自定義的provider的insert方法裡面被呼叫
        public static final Uri CONTENT_ID_URI_BASE = Uri.parse(SCHEME
                + AUTHORITY + PATH_STUDENTS_ID);

        /**
         * 定義一下我們的mime型別 注意一下mime型別的寫法
         * 
         * 一般都是後面vnd.應用程式的包名.表名
         */

        // 多行的mime型別
        public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.com.example.providertest.students";
        // 單行的mime型別
        public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/vnd.google.com.example.providertest.students";

        /**
         * 既然provider提供了查詢的方法 我們肯定要設定一個預設的排序方式 這裡我們就預設讓他根據建立的時間 來降序排序
         */
        public static final String DEFAULT_SORT_ORDER = "created DESC";

        /**
         * 下面就是表的列定義了
         */

        // 學生的名字
        public static final String COLUMN_NAME_NAME = "name";
        // 學生的年齡
        public static final String COLUMN_NAME_AGE = "age";
        // 學生的學號
        public static final String COLUMN_NAME_NUMBER = "number";
        // 這個學生建立的時間
        public static final String COLUMN_NAME_CREATE_DATE = "created";
        // 這個學生入庫以後修改的時間
        public static final String COLUMN_NAME_MODIFICATION_DATE = "modified";

    }

}

 

 

package com.example.providertest;

import java.util.HashMap;

import android.content.ContentProvider;
import android.content.ContentUris;
import android.content.ContentValues;
import android.content.Context;
import android.content.UriMatcher;
import android.database.Cursor;
import android.database.SQLException;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
import android.database.sqlite.SQLiteQueryBuilder;
import android.net.Uri;
import android.text.TextUtils;
import android.util.Log;

public class StudentProfileProvider extends ContentProvider {

    // tag 打日誌用
    private static final String TAG = "StudentProfileProvider";

    // 資料庫的名字
    private static final String DATABASE_NAME = "students_info.db";

    // 資料庫版本號
    private static final int DATABASE_VERSION = 1;

    /**
     * A UriMatcher instance
     */
    private static final UriMatcher sUriMatcher;

    // 匹配成功的返回值 這裡代表多行匹配成功
    private static final int STUDENTS = 1;

    // 匹配成功的返回值 這裡代表多單行匹配成功
    private static final int STUDENTS_ID = 2;

    /**
     * 注意看一下這個雜湊表 這個雜湊表實際上是主要為了SQLiteQueryBuilder這個類的 setProjectionMap這個方法使用的
     * 
     * 他的值的初始化我放在靜態程式碼塊裡面，這個地方實際上主要是為了多表查詢而存在的
     * 
     * 比如你要多表查詢的時候 你有2個表 一個表A 一個表B 你join的時候 肯定需要重新命名某個表的某個列
     * 
     * 比如你要把表A的 name1 這個列名重新命名成 a.name1 那你就可以add一個key value對，key為name1
     * 
     * value 為a.name1 即可。當然咯 如果你不想重新命名或者只是單表查詢那就只需要吧key 和value
     * 
     * 的值都寫成 一樣的即可
     * 
     */
    private static HashMap<String, String> sStudentsProjectionMap;

    // 定義資料庫helper.
    private DatabaseHelper mOpenHelper;

    // 靜態程式碼塊執行
    static {

        // 先構造urimatcher
        sUriMatcher = new UriMatcher(UriMatcher.NO_MATCH);

        sUriMatcher.addURI(StudentProfile.AUTHORITY, "students", STUDENTS);

        // #代表任意數字 *一般代表任意文字
        sUriMatcher.addURI(StudentProfile.AUTHORITY, "students/#", STUDENTS_ID);

        // 因為我們這裡是單表查詢 所以這個地方key和value的值都寫成固定的就可以了
        sStudentsProjectionMap = new HashMap<String, String>();

        sStudentsProjectionMap.put(StudentProfile.Students._ID,
                StudentProfile.Students._ID);

        sStudentsProjectionMap.put(StudentProfile.Students.COLUMN_NAME_AGE,
                StudentProfile.Students.COLUMN_NAME_AGE);

        sStudentsProjectionMap.put(
                StudentProfile.Students.COLUMN_NAME_CREATE_DATE,
                StudentProfile.Students.COLUMN_NAME_CREATE_DATE);

        sStudentsProjectionMap.put(
                StudentProfile.Students.COLUMN_NAME_MODIFICATION_DATE,
                StudentProfile.Students.COLUMN_NAME_MODIFICATION_DATE);

        sStudentsProjectionMap.put(StudentProfile.Students.COLUMN_NAME_NAME,
                StudentProfile.Students.COLUMN_NAME_NAME);

        sStudentsProjectionMap.put(StudentProfile.Students.COLUMN_NAME_NUMBER,
                StudentProfile.Students.COLUMN_NAME_NUMBER);
    }

    @Override
    public boolean onCreate() {
        // TODO Auto-generated method stub
        mOpenHelper = new DatabaseHelper(getContext());
        return true;
    }

    /**
     * 對於自定義contentprovider來說CRUD的這幾個方法的寫法 要儘量保證 程式碼優美 和 容錯性高
     * 
     */

    @Override
    public Cursor query(Uri uri, String[] projection, String selection,
            String[] selectionArgs, String sortOrder) {
        SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
        qb.setTables(StudentProfile.Students.TABLE_NAME);

        // 先匹配uri
        switch (sUriMatcher.match(uri)) {
        // 多行查詢
        case STUDENTS:
            qb.setProjectionMap(sStudentsProjectionMap);
            break;
        // 單行查詢
        case STUDENTS_ID:
            qb.setProjectionMap(sStudentsProjectionMap);
            qb.appendWhere(StudentProfile.Students._ID
                    + "="
                    + uri.getPathSegments().get(
                            StudentProfile.Students.STUDENT_ID_PATH_POSITION));
            break;
        default:
            throw new IllegalArgumentException("Unknown uri" + uri);
        }

        // 如果沒有傳orderby的值過來 那我們就使用預設的
        String orderBy;
        if (TextUtils.isEmpty(sortOrder)) {
            orderBy = StudentProfile.Students.DEFAULT_SORT_ORDER;
        } else {
            // 如果傳過來了 就使用傳來的值
            orderBy = sortOrder;
        }

        // 開始運算元據庫
        SQLiteDatabase db = mOpenHelper.getReadableDatabase();

        Cursor c = qb.query(db, projection, selection, selectionArgs, null,
                null, orderBy);

        // 這個地方要解釋一下 這句語句的作用，很多人自定義provider的時候 在query方法裡面都忘記
        // 寫這句話，有的人寫了也不知道這句話是幹嘛的，實際上這句話就是給我們的cursor加了一個觀察者
        // 有興趣的可以看一下sdk裡面這個函式的原始碼，非常簡單。那麼他的實際作用就是如果返回的cursor
        // 被用在SimpleCursorAdapter 類似的這種adapter的話，一旦uri所對應的provider資料發生了變化
        // 那麼這個adapter裡的資料是會自己變化重新整理的。這句話起的就是這個作用 有興趣的可以自己寫程式碼
        // 驗證一下 如果把這句話刪除掉的話 adapter裡的資料是不會再uri更新的時候 自動更新的
        c.setNotificationUri(getContext().getContentResolver(), uri);
        return c;
    }

    /**
     * 這個地方的返回值 一定要和manifest你配置activity的時候data 欄位的值相同 不然會報錯
     */
    @Override
    public String getType(Uri uri) {
        switch (sUriMatcher.match(uri)) {
        case STUDENTS:
            return StudentProfile.Students.CONTENT_TYPE;
        case STUDENTS_ID:
            return StudentProfile.Students.CONTENT_ITEM_TYPE;
        default:
            // 注意這個地方記得不匹配的時候丟擲異常資訊 這樣當比人呼叫失敗的時候會知道哪裡不對
            throw new IllegalArgumentException("Unknown uri" + uri);
        }

    }

    @Override
    public Uri insert(Uri uri, ContentValues initialValues) {

        if (sUriMatcher.match(uri) != STUDENTS) {
            throw new IllegalArgumentException("Unknown URI " + uri);
        }

        ContentValues values;

        if (initialValues != null) {
            values = new ContentValues(initialValues);
        } else {
            values = new ContentValues();
        }

        // 下面幾行程式碼實際上就是告訴我們對於某些表而言 預設的欄位的值 可以在insert裡面自己寫好
        // 不要讓呼叫者去手動再做重複勞動，我們應該允許呼叫者寫入最少的欄位的值 來完成db的insert
        // 操作
        Long now = Long.valueOf(System.currentTimeMillis());

        if (values.containsKey(StudentProfile.Students.COLUMN_NAME_CREATE_DATE) == false) {
            values.put(StudentProfile.Students.COLUMN_NAME_CREATE_DATE, now);
        }
        if (values
                .containsKey(StudentProfile.Students.COLUMN_NAME_MODIFICATION_DATE) == false) {
            values.put(StudentProfile.Students.COLUMN_NAME_MODIFICATION_DATE,
                    now);
        }

        SQLiteDatabase db = mOpenHelper.getWritableDatabase();

        long rowId = db.insert(StudentProfile.Students.TABLE_NAME,
                StudentProfile.Students.COLUMN_NAME_NAME, values);

        if (rowId > 0) {
            Uri stuUri = ContentUris.withAppendedId(
                    StudentProfile.Students.CONTENT_ID_URI_BASE, rowId);
            // 用於通知所有觀察者資料已經改變
            getContext().getContentResolver().notifyChange(stuUri, null);
            return stuUri;
        }

        // 如果插入失敗也最好丟擲異常 通知呼叫者
        throw new SQLException("Failed to insert row into " + uri);

    }

    @Override
    public int delete(Uri uri, String where, String[] whereArgs) {
        SQLiteDatabase db = mOpenHelper.getWritableDatabase();
        String finalWhere;

        int count;

        switch (sUriMatcher.match(uri)) {

        case STUDENTS:
            count = db.delete(StudentProfile.Students.TABLE_NAME, where,
                    whereArgs);
            break;

        case STUDENTS_ID:
            finalWhere = StudentProfile.Students._ID
                    + " = "
                    + uri.getPathSegments().get(
                            StudentProfile.Students.STUDENT_ID_PATH_POSITION);

            if (where != null) {
                finalWhere = finalWhere + " AND " + where;
            }

            count = db.delete(StudentProfile.Students.TABLE_NAME, finalWhere,
                    whereArgs);
            break;

        default:
            throw new IllegalArgumentException("Unknown URI " + uri);
        }

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

        return count;
    }

    @Override
    public int update(Uri uri, ContentValues values, String where,
            String[] whereArgs) {
        SQLiteDatabase db = mOpenHelper.getWritableDatabase();
        int count;
        String finalWhere;

        switch (sUriMatcher.match(uri)) {

        case STUDENTS:

            count = db.update(StudentProfile.Students.TABLE_NAME, values,
                    where, whereArgs);
            break;

        case STUDENTS_ID:

            finalWhere = StudentProfile.Students._ID
                    + " = "
                    + uri.getPathSegments().get(
                            StudentProfile.Students.STUDENT_ID_PATH_POSITION);

            if (where != null) {
                finalWhere = finalWhere + " AND " + where;
            }

            count = db.update(StudentProfile.Students.TABLE_NAME, values,
                    finalWhere, whereArgs);
            break;
        default:
            throw new IllegalArgumentException("Unknown URI " + uri);
        }

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

        return count;
    }

    // 自定義helper
    static class DatabaseHelper extends SQLiteOpenHelper {

        DatabaseHelper(Context context) {
            super(context, DATABASE_NAME, null, DATABASE_VERSION);
        }

        @Override
        public void onCreate(SQLiteDatabase db) {
            // TODO Auto-generated method stub
            db.execSQL("CREATE TABLE " + StudentProfile.Students.TABLE_NAME
                    + " (" + StudentProfile.Students._ID
                    + " INTEGER PRIMARY KEY,"
                    + StudentProfile.Students.COLUMN_NAME_NAME + " TEXT,"
                    + StudentProfile.Students.COLUMN_NAME_NUMBER + " TEXT,"
                    + StudentProfile.Students.COLUMN_NAME_AGE + " INTEGER,"
                    + StudentProfile.Students.COLUMN_NAME_CREATE_DATE
                    + " INTEGER,"
                    + StudentProfile.Students.COLUMN_NAME_MODIFICATION_DATE
                    + " INTEGER" + ");");
        }

        @Override
        public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
            // TODO Auto-generated method stub
            // 資料庫升級的時候 這邊的程式碼 不寫了,看各自的業務邏輯了,一般建議大家在這個地方多打一些日誌
        }

    }
}