Android ContentProvider 基本使用

ContentProvider 虽然是Android四大组件之一,但是对比其他组件,出场频率的确是低了一些。不过它在一些场合上还是非常好用的,比如跨进程传输数据,接下来介绍下它的基本使用。

一、创建ContentProvider

自定义一个类继承ContentProvider:

public class TestProvider extends ContentProvider {

  @Override
  public boolean onCreate() {
    return true;
  }

  @Nullable
  @Override
  public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection,
      @Nullable String[] selectionArgs, @Nullable String sortOrder) {
    return null;
  }

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

  @Nullable
  @Override
  public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
    return null;
  }

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

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

在 AndroidManifest.xml 中进行声明:

      
      

android:authorities 可以理解为是 Provider 的一个标志符,用于后续找到我们的自定义的Provider。

二、创建数据源

自定义Provider的时候,需要重写下面几个方法,也就是增删改查:

query()
insert()
delete()
update()

ContentProvider 本质上只是一个搬运工,具体数据的存储还是需要其他模块完成,比如 SQLite ,但是不建议使用 Room,它的用法对ContentProvider不太友好。
创建数据库:

public class DbHelper extends SQLiteOpenHelper {

  private static final String DB_NAME = "test.db";
  private static final int DB_VERSION = 1;

  public DbHelper(@Nullable Context context) {
    super(context, DB_NAME, null, DB_VERSION);
  }

  @Override
  public void onCreate(SQLiteDatabase db) {

    createFlowTable(db);
  }

  private void createUserTable(SQLiteDatabase db) {
    String sql = "CREATE TABLE user(id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,name TEXT)";
    db.execSQL(sql);
  }

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

  }
}

然后在Provider中,直接对数据库进行操作。

public class TestProvider extends ContentProvider {

  private SQLiteDatabase db;

  @Override
  public boolean onCreate() {
    DbHelper helper = new DbHelper(getContext());
    db = helper.getWritableDatabase();
    return true;
  }

  @Nullable
  @Override
  public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection,
      @Nullable String[] selectionArgs, @Nullable String sortOrder) {
    return db.query("user", projection, selection, selectionArgs, null, null,
        sortOrder);
  }

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

  @Nullable
  @Override
  public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
    db.insert("user", null, values);
    return null;
  }

  @Override
  public int delete(@NonNull Uri uri, @Nullable String selection,
      @Nullable String[] selectionArgs) {
    db.delete("user", selection, selectionArgs);
    return 0;
  }

  @Override
  public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection,
      @Nullable String[] selectionArgs) {
    db.update("user", values, selection, selectionArgs);
    return 0;
  }
}

三、访问Provider

3.1 统一资源标识符(URI)

URI 用来在提供程序中标识数据。内容 URI 包括整个提供程序的符号名称(其授权)和指向表的名称(路径)。当您调用客户端方法以访问提供程序中的表时,该表的内容 URI 将是其参数之一。
自定义URI:content://test/user/1

content://: 主题名,Android固定的
test:授权信息,AndroidManifest中声明的authorities
user:表名,指向数据库中的某个表
1:记录ID,表中的某个记录,若无指定,则返回全部记录

3.2 UriMatcher类

  1. 作用
  • 在ContentProvider 中注册URI
  • 根据 URI 匹配 ContentProvider 中对应的数据表
  1. 具体使用
    private static final int CODE_USER = 1;

    private static final int CODE_JOB = 2;
    
    //初始化
    private static final UriMatcher MATCHER = new UriMatcher(UriMatcher.NO_MATCH);

    static {
        //注册URI
        MATCHER.addURI(AUTHORITY, "user", CODE_USER);
        MATCHER.addURI(AUTHORITY, "job", CODE_JOB);
    }
    
    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        //根据URI匹配的返回码执行对应的操作
        switch (MATCHER.match(uri)) {
            case CODE_USER:
                return "user";
            case CODE_JOB:
                return "job";
            default:
                throw new IllegalArgumentException("Unknown URI: " + uri);
        }
    }

3.3 插入数据

ContentValues contentValues = new ContentValues();
//插入表中的数据
contentValues.put("name", "fracis");
//AndroidManifest中声明的
String authorities = "test";
//操作的表
String tableName = "user";
Uri uri = Uri.parse("content://" + authorities + "/" + tableName);
getContentResolver().insert(uri, contentValues);

3.4 访问数据:

//AndroidManifest中声明的
String authorities = "test";
//操作的表
String tableName = "user";
Uri uri = Uri.parse("content://" + authorities + "/" + tableName);
Cursor cursor = context.getContentResolver()
        .query(uri, null, null, null, null, null);
    if (cursor != null) {
      while (cursor.moveToNext()) {
        //获取 "name" 字段在表中的位置
        int nameColumnIndex = cursor.getColumnIndex("name");
        //获取 "name" 的值
        String name = cursor.getString(nameColumnIndex);
      }
      cursor.close();
    }

具体代码可以参考官网提供的 demo:

你可能感兴趣的:(Android ContentProvider 基本使用)