ContentProvider

一、定义

• ContentProvider即内容提供者，是Android四大组件之一，是一种共享型组件，常用于向其他组件乃至其他应用共享数据。
• ContentProvider通过Uri来唯一标识ContentProvider & 其中的数据，通过ContentProvider.getType(uri)来返回MIME类型数据。通过ContentResolver的增删改查方法实现对共享数据的操作，还可以通过注册ContentObserver来监听数据是否发生了变化来对应的刷新界面。

二、作用

进程间 进行数据交互 & 共享，即跨进程通信

三、优点

1、安全

ContentProvider为应用间的数据交互提供了一个安全的环境：允许把自己的应用数据根据需求开放给 其他应用 进行 增、删、改、查，而不用担心因为直接开放数据库权限而带来的安全问题。

2、访问简单 & 高效

对比于其他对外共享数据的方式，数据访问方式会因数据存储的方式而不同：

• 采用 文件方式 对外共享数据，需要进行文件操作读写数据；
• 采用 Sharedpreferences 共享数据，需要使用 sharedpreferences API读写数据这使得访问数据变得复杂 & 难度大。

而采用ContentProvider方式，其 解耦了 底层数据的存储方式，使得无论底层数据存储采用何种方式，外界对数据的访问方式都是统一的，这使得访问简单 & 高效，如一开始数据存储方式 采用 SQLite 数据库，后来把数据库换成 MongoDB，也不会对上层数据ContentProvider使用代码产生影响。

944365-a0e46788a2151e4e.png

四、相关类的介绍

1、URI（统一资源定位符）

• 定义：Uniform Resource Identifier，即统一资源标识符
• 作用：唯一标识 ContentProvider & 其中的数据
• 具体使用：URI分为 系统预置 & 自定义，分别对应系统内置的数据（如通讯录、日程表等等）和自定义数据库

944365-96019a2054eb27cf.png

// 设置URI
Uri uri = Uri.parse("content://com.carson.provider/User/1") 
// 上述URI指向的资源是：名为 `com.carson.provider`的`ContentProvider` 中表名 为`User` 中的 `id`为1的数据

// 特别注意：URI模式存在匹配通配符* & ＃

// *：匹配任意长度的任何有效字符的字符串
// 以下的URI 表示 匹配provider的任何内容
content://com.example.app.provider/* 
// ＃：匹配任意长度的数字字符的字符串
// 以下的URI 表示 匹配provider中的table表的所有行
content://com.example.app.provider/table/# 

2、MIME数据类型

MIME用于指定某个扩展名的文件用某种应用程序打开，如指定.html文件采用text应用程序打开，指定.pdf文件用flash应用程序打开。
MIME类型是一个包含两部分（类型 + 子类型）的字符串。例如：

text / html
// 类型 = text、子类型 = html

text/css
text/xml
application/pdf

MIME类型有2种形式：

// 形式1：单条记录  
vnd.android.cursor.item/自定义
// 形式2：多条记录（集合）
vnd.android.cursor.dir/自定义 

// 注：
  // 1. vnd：表示父类型和子类型具有非标准的、特定的形式。
  // 2. 父类型已固定好（即不能更改），只能区别是单条还是多条记录
  // 3. 子类型可自定义

实例说明：

<-- 单条记录 -->
  // 单个记录的MIME类型
  vnd.android.cursor.item/vnd.yourcompanyname.contenttype 

  // 若一个Uri如下
  content://com.example.transportationprovider/trains/122   
  // 则ContentProvider会通过ContentProvider.geType(url)返回以下MIME类型
  vnd.android.cursor.item/vnd.example.rail


<-- 多条记录 -->
  // 多个记录的MIME类型
  vnd.android.cursor.dir/vnd.yourcompanyname.contenttype 
  // 若一个Uri如下
  content://com.example.transportationprovider/trains 
  // 则ContentProvider会通过ContentProvider.geType(url)返回以下MIME类型
  vnd.android.cursor.dir/vnd.example.rail

3、ContentProvider

• ContentProvider主要以 表格的形式 组织数据，同时也支持文件数据，只是表格形式用得比较多。
• 每个表格中包含多张表，每张表包含行 & 列，分别对应记录 & 字段，同数据库。
• 进程间共享数据的本质是：添加、删除、获取 & 修改（更新）数据，所以ContentProvider的核心方法也主要是上述4个作用。

<-- 4个核心方法 -->
  public Uri insert(Uri uri, ContentValues values) 
  // 外部进程向 ContentProvider 中添加数据

  public int delete(Uri uri, String selection, String[] selectionArgs) 
  // 外部进程 删除 ContentProvider 中的数据

  public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)
  // 外部进程更新 ContentProvider 中的数据

  public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,  String sortOrder)　 
  // 外部应用 获取 ContentProvider 中的数据

// 注：
  // 1. 上述4个方法由外部进程回调，并运行在ContentProvider进程的Binder线程池中（不是主线程）
 // 2. 存在多线程并发访问，需要实现线程同步
   // a. 若ContentProvider的数据存储方式是使用SQLite & 一个，则不需要，因为SQLite内部实现好了线程同步，若是多个SQLite则需要，因为SQL对象之间无法进行线程同步
  // b. 若ContentProvider的数据存储方式是内存，则需要自己实现线程同步

<-- 2个其他方法 -->
  public boolean onCreate() 
// ContentProvider创建后 或 打开系统后其它进程第一次访问该ContentProvider时 由系统进行调用
// 注：运行在ContentProvider进程的主线程，故不能做耗时操作

  public String getType(Uri uri)
// 得到数据类型，即返回当前 Url 所代表数据的MIME类型

• Android为常见的数据（如通讯录、日程表等）提供了内置了默认的ContentProvider, 但也可根据需求自定义ContentProvider，但上述6个方法必须重写。
• ContentProvider类并不会直接与外部进程交互，而是通过ContentResolver 类。

4、ContentResolver

（1）ContentResolver的作用：统一管理不同 ContentProvider间的操作

• 即通过 URI 即可操作 不同的ContentProvider 中的数据
• 外部进程通过 ContentResolver类 从而与ContentProvider类进行交互

（2） 为什么要使用通过ContentResolver类从而与ContentProvider类进行交互，而不直接访问ContentProvider类？

• 一般来说，一款应用要使用多个ContentProvider，若需要了解每个ContentProvider的不同实现从而再完成数据交互，操作成本高 & 难度大
• 所以再ContentProvider类上加多了一个 ContentResolver类对所有的ContentProvider进行统一管理。

（3）具体使用

ContentResolver 类提供了与ContentProvider类相同名字 & 作用的4个方法

// 外部进程向 ContentProvider 中添加数据
public Uri insert(Uri uri, ContentValues values)　 

// 外部进程 删除 ContentProvider 中的数据
public int delete(Uri uri, String selection, String[] selectionArgs)

// 外部进程更新 ContentProvider 中的数据
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)　 

// 外部应用 获取 ContentProvider 中的数据
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)

（4）实例说明

// 使用ContentResolver前，需要先获取ContentResolver
// 可通过在所有继承Context的类中 通过调用getContentResolver()来获得ContentResolver
ContentResolver resolver =  getContentResolver(); 

// 设置ContentProvider的URI
Uri uri = Uri.parse("content://cn.scu.myprovider/user"); 
 
// 根据URI 操作 ContentProvider中的数据
// 此处是获取ContentProvider中 user表的所有记录 
Cursor cursor = resolver.query(uri, null, null, null, "userid desc"); 

Android 提供了3个用于辅助ContentProvide的工具类：

• ContentUris
• UriMatcher
• ContentObserver

5、ContentUris

作用：

• 操作 URI

具体使用，核心方法有两个：

• withAppendedId（）
• parseId（）

// withAppendedId（）作用：向URI追加一个id
Uri uri = Uri.parse("content://cn.scu.myprovider/user") 
Uri resultUri = ContentUris.withAppendedId(uri, 7);  
// 最终生成后的Uri为：content://cn.scu.myprovider/user/7

// parseId（）作用：从URL中获取ID
Uri uri = Uri.parse("content://cn.scu.myprovider/user/7") 
long personid = ContentUris.parseId(uri); 
//获取的结果为:7

6、UriMatcher

作用：

• 在ContentProvider 中注册URI
• 根据 URI 匹配 ContentProvider 中对应的数据表

具体使用：

// 步骤1：初始化UriMatcher对象
    UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH); 
    //常量UriMatcher.NO_MATCH  = 不匹配任何路径的返回码
    // 即初始化时不匹配任何东西

// 步骤2：在ContentProvider 中注册URI（addURI（））
    int URI_CODE_a = 1；
    int URI_CODE_b = 2；
    matcher.addURI("cn.scu.myprovider", "user1", URI_CODE_a); 
    matcher.addURI("cn.scu.myprovider", "user2", URI_CODE_b); 
    // 若URI资源路径 = content://cn.scu.myprovider/user1 ，则返回注册码URI_CODE_a
    // 若URI资源路径 = content://cn.scu.myprovider/user2 ，则返回注册码URI_CODE_b

// 步骤3：根据URI 匹配 URI_CODE，从而匹配ContentProvider中相应的资源（match（））

@Override   
    public String getType(Uri uri) {   
      Uri uri = Uri.parse(" content://cn.scu.myprovider/user1");   

      switch(matcher.match(uri)){   
     // 根据URI匹配的返回码是URI_CODE_a
     // 即matcher.match(uri) == URI_CODE_a
      case URI_CODE_a:   
        return tableNameUser1;   
        // 如果根据URI匹配的返回码是URI_CODE_a，则返回ContentProvider中的名为tableNameUser1的表
      case URI_CODE_b:   
        return tableNameUser2;
        // 如果根据URI匹配的返回码是URI_CODE_b，则返回ContentProvider中的名为tableNameUser2的表
    }   
}

7、ContentObserver

• 定义：内容观察者
• 作用：观察 Uri引起 ContentProvider 中的数据变化 & 通知外界（即访问该数据访问者），当ContentProvider 中的数据发生变化（增、删 & 改）时，就会触发该 ContentObserver类
• 具体使用

// 步骤1：注册内容观察者ContentObserver
    getContentResolver().registerContentObserver（uri）；
    // 通过ContentResolver类进行注册，并指定需要观察的URI

// 步骤2：当该URI的ContentProvider数据发生变化时，通知外界（即访问该ContentProvider数据的访问者）
    public class UserContentProvider extends ContentProvider { 
      public Uri insert(Uri uri, ContentValues values) { 
      db.insert("user", "userid", values); 
      getContext().getContentResolver().notifyChange(uri, null); 
      // 通知访问者
   } 
}

// 步骤3：解除观察者
 getContentResolver().unregisterContentObserver（uri）；
    // 同样需要通过ContentResolver类进行解除

五、简单使用示例

1、创建项目A，创建SQLite数据库，并初始化数据

/**
 * @ClassName StuDBHelper
 * @Description TODO
 * @Author xiazhenjie
 * @Date 2022/8/2 14:55
 * @Version 1.0
 */
public class StuDBHelper extends SQLiteOpenHelper {

    //必须要有构造函数
    public StuDBHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
        super(context, name, factory, version);
    }

    //当第一次创建数据库的时候，调用该方法
    @Override
    public void onCreate(SQLiteDatabase db) {
        String sql =  "create table user_table(" +
                "id integer  PRIMARY KEY AUTOINCREMENT ," +
                "sname varchar(20)," +
                "sage int," +
                "ssex varchar(10)" +
                ")";
        //输出创建数据库的日志信息
        Log.i("this", "create Database------------->");
        //execSQL函数用于执行SQL语句
        db.execSQL(sql);

    }

    //当更新数据库的时候执行该方法
    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        //输出更新数据库的日志信息
        Log.i("this", "update Database------------->");
    }
}

private void initSQLite(){
      createDB();
        insertData();
    }

    private void createDB(){
        StuDBHelper dbHelper = new StuDBHelper(this,"user_db",null,1);
        //得到一个可读的SQLiteDatabase对象
        SQLiteDatabase db = dbHelper.getReadableDatabase();
        Toast.makeText(this,"创建数据库成功",Toast.LENGTH_LONG).show();
    }

    private void insertData(){
        StuDBHelper dbHelper = new StuDBHelper(this,"user_db",null,1);
        SQLiteDatabase db = dbHelper.getWritableDatabase();

        //插入数据SQL语句
        String sql = "insert into user_table(id,sname,sage,ssex) values(1,'张三',23,'男'), " +
                "(2,'李四',24,'男'), " +
                "(3,'王五',24,'男'), " +
                "(4,'马老六',22,'男'), " +
                "(5,'李蓉蓉',24,'女')";

        //执行SQL语句
        db.execSQL(sql);
        Toast.makeText(this,"插入数据成功!",Toast.LENGTH_LONG).show();
    }

2、创建UserContentProvider类，提供内容

/**
 * @ClassName UserContentProvider
 * @Description TODO
 * @Author xiazhenjie
 * @Date 2022/8/2 14:48
 * @Version 1.0
 */
public class UserContentProvider extends ContentProvider {

    private static UriMatcher uriMatcher;
    private static final String AUTHORITY = "cross.process.callee.usercontentprovider";
    private static final int SINGLE_USER = 1;
    private static final int PREFIX_USER = 2;

    private SQLiteDatabase database;

    static
    {
        //  添加访问ContentProvider的Uri
        uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
        uriMatcher.addURI(AUTHORITY, "single/*", SINGLE_USER);
        uriMatcher.addURI(AUTHORITY, "prefix/*", PREFIX_USER);
    }

    @Override
    public boolean onCreate() {
        StuDBHelper dbHelper = new StuDBHelper(getContext(),"user_db",null,1);
        //得到一个可写的数据库
        database = dbHelper.getReadableDatabase();
        return true;
    }

    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        Cursor cursor = null;
        switch (uriMatcher.match(uri)){
            case SINGLE_USER:
                String name = uri.getPathSegments().get(1);
                cursor = database.rawQuery("select * from user_table  where sname=?",new String[]{name});
                break;
            case PREFIX_USER:
                cursor = database.query("user_table",
                        new String[]{"id","sname","sage","ssex"},
                        null,
                        null,
                        null,
                        null,
                        null
                );
                break;
            default:
                throw new IllegalArgumentException("<" + uri + ">格式不正确.");
        }

        return cursor;
    }

    @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;
    }
}

别忘了注册

        <provider
            android:authorities="cross.process.callee.usercontentprovider"
            android:name=".contentProvider.UserContentProvider"
            android:enabled="true"
            android:exported="true"/>

3、创建项目B，构建ContentResolver，跨进程获取数据

val SEARCH_SINGLE_USER_URI =  "content://cross.process.callee.usercontentprovider/single"

try {
      val uri = Uri.parse("$SEARCH_SINGLE_USER_URI/张三")
      //  通过ContentProvider查询单词，并返回Cursor对象，然后的操作就和直接从数据中获得
      //  Cursor对象后的操作是一样的了
      //  通过ContentProvider查询单词，并返回Cursor对象，然后的操作就和直接从数据中获得
      //  Cursor对象后的操作是一样的了
        val cursor: Cursor? = contentResolver.query(
                    uri,
                    null,
                    null,
                    null,
                    null
                )

      cursor?.let {
          var result = ""
          while(it.moveToNext()){
              val id = it.getInt(it.getColumnIndex("id"))
              val sname = it.getString(it.getColumnIndex("sname"))
              val sage = it.getInt(it.getColumnIndex("sage"))
              val ssex = it.getString(it.getColumnIndex("ssex"))

              val resultItem = "ID:$id 姓名：$sname 年龄：$sage 性别：$ssex\n\n"
              result += resultItem
          }
          AlertDialog.Builder(this).setTitle("查询结果").setMessage(result)
              .setPositiveButton("关闭", null).show()
      }
  }catch (e:Exception){
      Toast.makeText(this,"Failed to find provider, 请检查资源是否已开启",Toast.LENGTH_SHORT).show()
  }