萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> Android 開發

Android ContentProvider 基礎架構與實作指南

注意: 原始內容為空。本文補充 ContentProvider 核心概念、實作步驟、權限控制、跨進程調用與最佳實踐,作為知識庫完善。

什麼是 ContentProvider?

ContentProvider 是 Android 四大組件之一,提供**結構化資料的標準化跨進程存取介面**。它封裝底層儲存 (SQLite、檔案、Preferences、網路),對外暴露統一的 Uri 格式 (content://authority/path),支援 CRUD (query, insert, update, delete) 與批次操作,是實現**應用間資料共享**的標準方式。

核心組件

組件說明
Uri資料唯一識別符,格式:content://com.example.app.provider/user/123,authority 需在 Manifest 宣告唯一。
MIME TypegetType(uri) 回傳:
單筆:vnd.android.cursor.item/vnd.com.example.user
多筆:vnd.android.cursor.dir/vnd.com.example.user
Cursor查詢結果游標,攜帶資料列與欄位資訊,支援 moveToNext()、getString() 等。
ContentValues鍵值對容器,用於 insert/update 傳遞資料。
ContentResolver客戶端存取入口,context.getContentResolver(),自動處理跨進程 IPC (Binder)。

實作步驟

1. 定義合約類 (Contract)

public final class UserContract {
    public static final String AUTHORITY = "com.example.app.provider";
    public static final Uri BASE_URI = Uri.parse("content://" + AUTHORITY);
    public static final String PATH_USERS = "users";

    public static final Uri CONTENT_URI = Uri.withAppendedPath(BASE_URI, PATH_USERS);

    // MIME Types
    public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/vnd.example.user";
    public static final String CONTENT_DIR_TYPE = "vnd.android.cursor.dir/vnd.example.user";

    // Columns
    public static final String _ID = BaseColumns._ID;
    public static final String NAME = "name";
    public static final String EMAIL = "email";
    public static final String AVATAR_URL = "avatar_url";

    private UserContract() {}
}

2. 繼承 ContentProvider 實作六大抽象方法

public class UserProvider extends ContentProvider {
    private AppDatabaseHelper dbHelper;

    @Override
    public boolean onCreate() {
        dbHelper = new AppDatabaseHelper(getContext());
        return true;
    }

    @Nullable @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection,
                        @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        SQLiteDatabase db = dbHelper.getReadableDatabase();
        SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
        qb.setTables(AppDatabaseHelper.TABLE_USER);

        // 根據 URI 類型決定查詢條件
        switch (sUriMatcher.match(uri)) {
            case USERS:
                break;
            case USER_ID:
                qb.appendWhere(_ID + "=" + uri.getLastPathSegment());
                break;
            default:
                throw new IllegalArgumentException("Unknown URI: " + uri);
        }
        Cursor cursor = qb.query(db, projection, selection, selectionArgs, null, null, sortOrder);
        // 關鍵:設定通知 URI,資料變更時自動通知 CursorLoader/ContentObserver
        cursor.setNotificationUri(getContext().getContentResolver(), uri);
        return cursor;
    }

    @Nullable @Override
    public String getType(@NonNull Uri uri) {
        switch (sUriMatcher.match(uri)) {
            case USERS: return UserContract.CONTENT_DIR_TYPE;
            case USER_ID: return UserContract.CONTENT_ITEM_TYPE;
            default: throw new IllegalArgumentException("Unknown URI: " + uri);
        }
    }

    @Nullable @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
        if (sUriMatcher.match(uri) != USERS) throw new IllegalArgumentException("Invalid URI for insert");
        SQLiteDatabase db = dbHelper.getWritableDatabase();
        long id = db.insert(AppDatabaseHelper.TABLE_USER, null, values);
        if (id > 0) {
            Uri newUri = ContentUris.withAppendedId(UserContract.CONTENT_URI, id);
            getContext().getContentResolver().notifyChange(newUri, null); // 通知觀察者
            return newUri;
        }
        throw new SQLException("Failed to insert row into " + uri);
    }

    @Override
    public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection,
                      @Nullable String[] selectionArgs) {
        SQLiteDatabase db = dbHelper.getWritableDatabase();
        int count;
        switch (sUriMatcher.match(uri)) {
            case USERS:
                count = db.update(AppDatabaseHelper.TABLE_USER, values, selection, selectionArgs);
                break;
            case USER_ID:
                count = db.update(AppDatabaseHelper.TABLE_USER, values, 
                        _ID + "=" + uri.getLastPathSegment() + (!TextUtils.isEmpty(selection) ? " AND " + selection : ""), 
                        selectionArgs);
                break;
            default: throw new IllegalArgumentException("Unknown URI: " + uri);
        }
        if (count > 0) getContext().getContentResolver().notifyChange(uri, null);
        return count;
    }

    @Override
    public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {
        SQLiteDatabase db = dbHelper.getWritableDatabase();
        int count;
        switch (sUriMatcher.match(uri)) {
            case USERS:
                count = db.delete(AppDatabaseHelper.TABLE_USER, selection, selectionArgs);
                break;
            case USER_ID:
                count = db.delete(AppDatabaseHelper.TABLE_USER, 
                        _ID + "=" + uri.getLastPathSegment() + (!TextUtils.isEmpty(selection) ? " AND " + selection : ""), 
                        selectionArgs);
                break;
            default: throw new IllegalArgumentException("Unknown URI: " + uri);
        }
        if (count > 0) getContext().getContentResolver().notifyChange(uri, null);
        return count;
    }

    // UriMatcher 靜態初始化
    private static final int USERS = 100;
    private static final int USER_ID = 101;
    private static final UriMatcher sUriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
    static {
        sUriMatcher.addURI(UserContract.AUTHORITY, PATH_USERS, USERS);
        sUriMatcher.addURI(UserContract.AUTHORITY, PATH_USERS + "/#", USER_ID);
    }
}

3. AndroidManifest 註冊

<provider
    android:name=".provider.UserProvider"
    android:authorities="com.example.app.provider"
    android:exported="true"           
    android:grantUriPermissions="true" 
    android:readPermission="com.example.app.permission.READ_USER"
    android:writePermission="com.example.app.permission.WRITE_USER"
    android:multiprocess="true" >     
</provider>

<!-- 定義權限 (可選) -->
<permission android:name="com.example.app.permission.READ_USER" android:protectionLevel="normal" />
<permission android:name="com.example.app.permission.WRITE_USER" android:protectionLevel="normal" />

客戶端存取 (ContentResolver)

ContentResolver resolver = context.getContentResolver();

// 查詢所有用戶
Cursor cursor = resolver.query(UserContract.CONTENT_URI, null, null, null, "name ASC");
while (cursor.moveToNext()) {
    String name = cursor.getString(cursor.getColumnIndex(UserContract.NAME));
}
// 插入
ContentValues cv = new ContentValues();
cv.put(UserContract.NAME, "Alice");
cv.put(UserContract.EMAIL, "alice@example.com");
Uri newUri = resolver.insert(UserContract.CONTENT_URI, cv);

// 觀察資料變更 (自動更新 UI)
resolver.registerContentObserver(UserContract.CONTENT_URI, true, new ContentObserver(new Handler()) {
    @Override public void onChange(boolean selfChange, Uri uri) { refreshList(); }
});

進階主題

  • FileProvider: 官方封裝,安全分享 files/、cache/、external-files/ 下檔案,避免 file:// URI 暴露路徑 (API 24+ 強制)。
  • call() 方法: 執行 Provider 端自定義邏輯 (如匯出報表、觸發同步),回傳 Bundle。
  • 管道流 : openPipeHelper 實現大檔案串流傳輸 (不佔用記憶體)。
  • 多進程同步: android:multiprocess="true" + ContentProviderClient 獲取跨進程介面。

安全性檢查清單

  • ✅ android:exported 僅在必要時設 true,並配合 readPermission/writePermission。
  • ✅ 使用 grantUriPermissions="true" + Intent.FLAG_GRANT_READ_URI_PERMISSION 臨時授權,而非永久開放。
  • ✅ selectionArgs 參數化查詢,防 SQL 注入。
  • ✅ 敏感資料 (Token、密碼) **不** 暴露於 Provider,改用 Keystore/EncryptedSharedPreferences。
copyright © 萬盛學電腦網 all rights reserved