Android ContentProvider：提供數據共享和訪問的方式

在Android平台上，ContentProvider是一種非常有用的組件，用於共享數據和簡化數據訪問的過程。ContentProvider能夠幫助應用程序之間共享數據，同時提供了一種標準化的接口來訪問數據。

一、ContentProvider的基本概念

ContentProvider是Android中的四大組件之一，其它三種組件是Activity、Service和BroadcastReceiver。ContentProvider的主要作用是提供數據給其他應用程序或其他部分的應用程序。ContentProvider是一個標準的接口，它用於訪問數據。它隱藏了底層的數據訪問方式，提供了一組標準的方法來進行數據訪問。通過這些方法，應用程序可以添加、查詢、更新和刪除數據。

ContentProvider通過URI來標識和訪問數據。URI包含三部分：schema、authority和path。例如，下面的URI表示一個ContentProvider，可以通過該ContentProvider來訪問聯繫人數據。

content://com.android.contacts/contacts

URI的三部分：

schema：URI的協議部分，表明這是一個ContentProvider的URI。
authority：ContentProvider的唯一標識符。
path：ContentProvider中數據的路徑。

二、創建自定義ContentProvider

下面是一個簡單的ContentProvider的創建過程，以提供聯繫人數據為例。

1.定義Provider的metadata

在AndroidManifest.xml文件中定義Provider的metadata：

<provider
  android:name=".ContactsProvider"
  android:authorities="com.example.provider.contacts"
  android:exported="true" />

android:name：Provider的類名。

android:authorities：Provider的唯一標識符。

android:exported：是否允許其它應用程序訪問Provider。

2.定義Provider的接口

創建一個類實現ContentProvider的接口：

public class ContactsProvider extends ContentProvider {
    public static final String AUTHORITY = "com.example.provider.contacts";
    private static final String DATABASE_NAME = "contacts.db";
    private static final int DATABASE_VERSION = 1;
    private static final String TABLE_NAME = "contacts";
    
    private SQLiteDatabase database;

    // onCreate方法：初始化數據庫和表
    public boolean onCreate() {
        DatabaseHelper databaseHelper = new DatabaseHelper(getContext());
        database = databaseHelper.getWritableDatabase();
        return (database == null) ? false : true;
    }

    // getType方法：返回MIME類型
    public String getType(Uri uri) {
        return null;
    }

    // insert方法：插入一行數據
    public Uri insert(Uri uri, ContentValues values) {
        database.insert(TABLE_NAME, null, values);
        getContext().getContentResolver().notifyChange(uri, null);
        return uri;
    }

    // query方法：查詢數據
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
        // 根據查詢參數獲取需要查詢的數據
        Cursor cursor = database.query(TABLE_NAME,
                new String[] { "id", "name", "phone" }, selection, selectionArgs, null, null, sortOrder);
        cursor.setNotificationUri(getContext().getContentResolver(), uri);
        return cursor;
    }

    // update方法：更新數據
    public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
        int count = database.update(TABLE_NAME, values, selection, selectionArgs);
        getContext().getContentResolver().notifyChange(uri, null);
        return count;
    }

    // delete方法：刪除數據
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        int count = database.delete(TABLE_NAME, selection, selectionArgs);
        getContext().getContentResolver().notifyChange(uri, null);
        return count;
    }

    // DatabaseHelper類：用於創建和更新數據庫
    private static class DatabaseHelper extends SQLiteOpenHelper {
        public DatabaseHelper(Context context) {
            super(context, DATABASE_NAME, null, DATABASE_VERSION);
        }

        // onCreate方法：創建表
        public void onCreate(SQLiteDatabase database) {
            database.execSQL("CREATE TABLE IF NOT EXISTS " + TABLE_NAME +
                    "(id INTEGER PRIMARY KEY autoincrement, name TEXT, phone TEXT);");
        }

        // onUpgrade方法
        public void onUpgrade(SQLiteDatabase database, int oldVersion, int newVersion) {
            database.execSQL("DROP TABLE IF EXISTS " + TABLE_NAME);
            onCreate(database);
        }
    }
}

在上面的代碼中，需要注意一下方法：

onCreate：初始化ContentProvider的實例。
getType：返回MIME類型。
insert：插入一行數據。
query：查詢數據。
update：更新數據。
delete：刪除數據。

3.使用自定義Provider

使用ContentProvider的步驟如下：

// 定義需要查詢的數據
String[] projection = new String[] { "id", "name", "phone" };
String selection = "id = ?";
String[] selectionArgs = new String[] { "1" };
String sortOrder = "name desc";

// ContentResolver：用於訪問ContentProvider
ContentResolver contentResolver = getContentResolver();

// 獲取ContentProvider的數據，使用Cursor保存查詢結果
Uri uri = Uri.parse("content://com.example.provider.contacts/contacts");
Cursor cursor = contentResolver.query(uri, projection, selection, selectionArgs, sortOrder);

// 遍歷查詢結果
while (cursor.moveToNext()) {
    int id = cursor.getInt(cursor.getColumnIndex("id"));
    String name = cursor.getString(cursor.getColumnIndex("name"));
    String phone = cursor.getString(cursor.getColumnIndex("phone"));
    Log.i(TAG, String.format("id=%s, name=%s, phone=%s", id, name, phone));
}

// 關閉Cursor
cursor.close();

在上面的代碼中，需要注意一下幾點：

URI：ContentProvider的標識符。
ContentResolver：用於訪問ContentProvider。
Cursor：用於保存查詢結果。

三、ContentProvider的權限控制

ContentProvider能夠控制訪問權限，以允許或拒絕訪問者訪問數據。通過使用AndroidManifest.xml中的標籤，可以控制ContentProvider的訪問權限。

<provider
  android:name=".ContactsProvider"
  android:authorities="com.example.provider.contacts"
  android:exported="false"
  android:readPermission="com.example.provider.permission.READ_CONTACTS"
  android:writePermission="com.example.provider.permission.WRITE_CONTACTS" />

android:readPermission和android:writePermission：用於控制讀寫權限。

當ContentProvider中有多個表或多種數據類型時，可以將URI分為不同的路徑。例如下面的代碼是一個內容提供者，可以訪問聯繫人和日曆表：

<provider
  android:name=".ContactsProvider"
  android:authorities="com.example.provider"
  android:exported="false">
  <!-- 聯繫人表 -->
  <path-permission
    android:pathPrefix="/contacts"
    android:readPermission="com.example.provider.permission.READ_CONTACTS"
    android:writePermission="com.example.provider.permission.WRITE_CONTACTS" />
  <!-- 日曆表 -->
  <path-permission
    android:pathPrefix="/calendar"
    android:readPermission="com.example.provider.permission.READ_CALENDAR"
    android:writePermission="com.example.provider.permission.WRITE_CALENDAR" />
</provider>

使用ContentProvider需要注意以下幾點：

ContentProvider提供了一種標準的接口來訪問數據。
ContentProvider可以通過URI來標識和訪問數據。
ContentProvider可以控制訪問權限，以允許或拒絕訪問者訪問數據。

完整的代碼示例：

// 定義Provider的metadata
<provider
  android:name=".ContactsProvider"
  android:authorities="com.example.provider.contacts"
  android:exported="true" />

// 創建一個類實現ContentProvider的接口
public class ContactsProvider extends ContentProvider {
    public static final String AUTHORITY = "com.example.provider.contacts";
    private static final String DATABASE_NAME = "contacts.db";
    private static final int DATABASE_VERSION = 1;
    private static final String TABLE_NAME = "contacts";

    private SQLiteDatabase database;

    // onCreate方法：初始化數據庫和表
    public boolean onCreate() {
        DatabaseHelper databaseHelper = new DatabaseHelper(getContext());
        database = databaseHelper.getWritableDatabase();
        return (database == null) ? false : true;
    }

    // getType方法：返回MIME類型
    public String getType(Uri uri) {
        return null;
    }

    // insert方法：插入一行數據
    public Uri insert(Uri uri, ContentValues values) {
        database.insert(TABLE_NAME, null, values);
        getContext().getContentResolver().notifyChange(uri, null);
        return uri;
    }

    // query方法：查詢數據
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
        // 根據查詢參數獲取需要查詢的數據
        Cursor cursor = database.query(TABLE_NAME,
                new String[] { "id", "name", "phone" }, selection, selectionArgs, null, null, sortOrder);
        cursor.setNotificationUri(getContext().getContentResolver(), uri);
        return cursor;
    }

    // update方法：更新數據
    public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
        int count = database.update(TABLE_NAME, values, selection, selectionArgs);
        getContext().getContentResolver().notifyChange(uri, null);
        return count;
    }

    // delete方法：刪除數據
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        int count = database.delete(TABLE_NAME, selection, selectionArgs);
        getContext().getContentResolver().notifyChange(uri, null);
        return count;
    }

    // DatabaseHelper類：用於創建和更新數據庫
    private static class DatabaseHelper extends SQLiteOpenHelper {
        public DatabaseHelper(Context context) {
            super(context, DATABASE_NAME, null, DATABASE_VERSION);
        }

        // onCreate方法：創建表
        public void onCreate(SQLiteDatabase database) {
            database.execSQL("CREATE TABLE IF NOT EXISTS " + TABLE_NAME +
                    "(id INTEGER PRIMARY KEY autoincrement, name TEXT, phone TEXT);");
        }

        // onUpgrade方法
        public void onUpgrade(SQLiteDatabase database, int oldVersion, int newVersion) {
            database.execSQL("DROP TABLE IF EXISTS " + TABLE_NAME);
            onCreate(database);
        }
    }
}

// 使用自定義Provider
// 定義需要查詢的數據
String[] projection = new String[] { "id", "name", "phone" };
String selection = "id = ?";
String[] selectionArgs = new String[] { "1" };
String sortOrder = "name desc";

// ContentResolver：用於訪問ContentProvider
ContentResolver contentResolver = getContentResolver();

// 獲取ContentProvider的數據，使用Cursor保存查詢結果
Uri uri = Uri.parse("content://com.example.provider.contacts/contacts");
Cursor cursor = contentResolver.query(uri, projection, selection, selectionArgs, sortOrder);

// 遍歷查詢結果
while (cursor.moveToNext()) {
    int id = cursor.getInt(cursor.getColumnIndex("id"));
    String name = cursor.getString(cursor.getColumnIndex("name"));
    String phone = cursor.getString(cursor.getColumnIndex("phone"));
    Log.i(TAG, String.format("id=%s, name=%s, phone=%s", id, name, phone));
}

// 關閉Cursor
cursor.close();

原創文章，作者：YRBL，如若轉載，請註明出處：https://www.506064.com/zh-hant/n/144468.html