Android四大组件之ContentProvider

作者: 12313凯皇 | 来源:发表于2019-03-21 16:30 被阅读27次

一、概述

ContentProvider即内容提供者，是Android四大组件之一，是一种共享型组件，常用于向其他组件乃至其他应用共享数据。

ContentProvider通过Uri来唯一标识ContentProvider & 其中的数据，通过ContentProvider.getType(uri)来返回MIME类型数据。通过ContentResolver的增删改查方法实现对共享数据的操作，还可以通过注册ContentObserver来监听数据是否发生了变化来对应的刷新界面。

由于ContentProvider涉及到的东西有点多，所以在讲ContentProvider之前有必要先讲上面提到的几个相关类简单的介绍一下：

二、相关类介绍

2.1 URI（统一资源定位符）

Uri(Uniform Resource Identifier)，统一资源定位符，外界进程通过URI来找到对应的ContentProvider & 其中的数据，再进行数据操作。
URI分为系统预制URI和自定义URI，分别对应系统内置的数据（如通讯录。日程表等等）和自定义数据库。下面主要讲解一下自定义URI：

// 设置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.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

2.3 ContentResolver类

用于管理不同的ContentProvider间的操作，即通过URI即可操作不同的ContentProvider中的数据，外部进程通过ContentResolver类从而与ContentProvider类进行交互。
一般来说，一款应用要使用多个ContentProvider，若需要了解每个ContentProvider的不同实现从而完成数据交互，操作成本高、难度大。因此需要在ContentProvider上多加一个ContentResolver来进行统一管理。

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)

实例说明

// 使用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个用于辅助ContentProvider的工具类：ContentUris、UriMatcher和ContentObserver。

2.4 ContentObserver

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类进行解除

三、ContentProvider实例

由于ContentProvider不仅常用于进程间通信，同时也适用于进程内通信，所以下面将分别通过两个例子分别讲述两种通信中ContentProvider的使用方法。
ps：示例中的数据源是Android中的SQLite数据库。

进程内通信：

步骤1：创建数据库类，DBHelper.java：

public class DBHelper extends SQLiteOpenHelper {

    // 数据库名
    private static final String DATABASE_NAME = "finch.db";

    // 表名
    public static final String USER_TABLE_NAME = "user";
    public static final String JOB_TABLE_NAME = "job";

    private static final int DATABASE_VERSION = 1;
    //数据库版本号

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

    @Override
    public void onCreate(SQLiteDatabase db) {

        // 创建两个表格:用户表 和职业表
        db.execSQL("CREATE TABLE IF NOT EXISTS " + USER_TABLE_NAME + "(_id INTEGER PRIMARY KEY AUTOINCREMENT," + " name TEXT)");
        db.execSQL("CREATE TABLE IF NOT EXISTS " + JOB_TABLE_NAME + "(_id INTEGER PRIMARY KEY AUTOINCREMENT," + " job TEXT)");
    }

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

    }
}

步骤2：自定义ContentProvider类

public class MyProvider extends ContentProvider {

    private Context mContext;
    DBHelper mDbHelper = null;
    SQLiteDatabase db = null;

    public static final String AUTOHORITY = "com.hu.yu.contentproviderdemo.myprovider";
    // 设置ContentProvider的唯一标识

    public static final int User_Code = 1;
    public static final int Job_Code = 2;

    // UriMatcher类使用:在ContentProvider 中注册URI
    private static final UriMatcher mMatcher;
    static{
        mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
        // 初始化
        mMatcher.addURI(AUTOHORITY,"user", User_Code);
        mMatcher.addURI(AUTOHORITY, "job", Job_Code);
        // 若URI资源路径 = content://cn.scu.myprovider/user ，则返回注册码User_Code
        // 若URI资源路径 = content://cn.scu.myprovider/job ，则返回注册码Job_Code
    }

    // 以下是ContentProvider的6个方法

    /**
     * 初始化ContentProvider
     * @return boolean
     */
    @Override
    public boolean onCreate() {
        mContext = getContext();
        // 在ContentProvider创建时对数据库进行初始化
        // 运行在主线程，故不能做耗时操作,此处仅作展示
        mDbHelper = new DBHelper(getContext());
        db = mDbHelper.getWritableDatabase();

        // 初始化两个表的数据(先清空两个表,再各加入一个记录)
        db.execSQL("delete from user");
        db.execSQL("insert into user values(1,'Carson');");
        db.execSQL("insert into user values(2,'Kobe');");

        db.execSQL("delete from job");
        db.execSQL("insert into job values(1,'Android');");
        db.execSQL("insert into job values(2,'iOS');");

        return true;
    }

    /**
     * 查询数据
     */
    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        // 根据URI匹配 URI_CODE，从而匹配ContentProvider中相应的表名
        // 该方法在最下面
        String table = getTableName(uri);

        //        // 通过ContentUris类从URL中获取ID
        //        long personid = ContentUris.parseId(uri);
        //        System.out.println(personid);

        // 查询数据
        return db.query(table,projection,selection,selectionArgs,null,null,sortOrder,null);

    }

    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        // 由于不展示,此处不作展开
        return null;
    }

    /**
     * 添加数据
     */
    @Nullable
    @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
        // 根据URI匹配 URI_CODE，从而匹配ContentProvider中相应的表名
        // 该方法在最下面
        String table = getTableName(uri);

        // 向该表添加数据
        db.insert(table, null, values);

        // 当该URI的ContentProvider数据发生变化时，通知外界（即访问该ContentProvider数据的访问者）
        mContext.getContentResolver().notifyChange(uri, null);

        //        // 通过ContentUris类从URL中获取ID
        //        long personid = ContentUris.parseId(uri);
        //        System.out.println(personid);

        return uri;
    }

    /**
     * 删除数据
     */
    @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;
    }

    /**
     * 根据URI匹配 URI_CODE，从而匹配ContentProvider中相应的表名
     */
    private String getTableName(Uri uri){
        String tableName = null;
        switch (mMatcher.match(uri)) {
            case User_Code:
                tableName = DBHelper.USER_TABLE_NAME;
                break;
            case Job_Code:
                tableName = DBHelper.JOB_TABLE_NAME;
                break;
        }
        return tableName;
    }
}

步骤3：在AndroidManifest.xml中注册自定义的ContentProvider

<provider
            android:authorities="com.hu.yu.contentproviderdemo.myprovider"
            android:name=".MyProvider"
            android:exported="true" />

步骤4：进程内访问 ContentProvider中的数据

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        /**
         * 对user表进行操作
         */

        // 设置URI
        Uri uri_user = Uri.parse("content://com.hu.yu.contentproviderdemo.myprovider/user");

        // 插入表中数据
        ContentValues values = new ContentValues();
        values.put("_id", 3);
        values.put("name", "Iverson");


        // 获取ContentResolver
        ContentResolver resolver = getContentResolver();
        // 通过ContentResolver 根据URI 向ContentProvider中插入数据
        resolver.insert(uri_user, values);

        // 通过ContentResolver 向ContentProvider中查询数据
        Cursor cursor = resolver.query(uri_user, new String[]{"_id", "name"}, null, null, null);
        while (cursor.moveToNext()) {
            System.out.println("query book:" + cursor.getInt(0) + " " + cursor.getString(1));
            // 将表中数据全部输出
        }
        cursor.close();
        // 关闭游标

        /**
         * 对job表进行操作
         */
        // 和上述类似,只是URI需要更改,从而匹配不同的URI CODE,从而找到不同的数据资源
        Uri uri_job = Uri.parse("content://com.hu.yu.contentproviderdemo.myprovider/job");

        // 插入表中数据
        ContentValues values2 = new ContentValues();
        values2.put("_id", 3);
        values2.put("job", "NBA Player");

        // 获取ContentResolver
        ContentResolver resolver2 = getContentResolver();
        // 通过ContentResolver 根据URI 向ContentProvider中插入数据
        resolver2.insert(uri_job, values2);

        // 通过ContentResolver 向ContentProvider中查询数据
        Cursor cursor2 = resolver2.query(uri_job, new String[]{"_id", "job"}, null, null, null);
        while (cursor2.moveToNext()) {
            System.out.println("query job:" + cursor2.getInt(0) + " " + cursor2.getString(1));
            // 将表中数据全部输出
        }
        cursor2.close();
        // 关闭游标
    }
}

结果：

进程间数据共享

进程间数据共享与进程内的方法基本一致，想要具体查看的话可以点开最后的参考文章中查看。

四、ContentProvider优点

安全
ContentProvider为应用间的数据交互提供了一个安全的环境：允许把自己的应用数据根据需求开放给其他应用进行增、删、改、查，而不用担心因为直接开放数据库权限而带来的安全问题。
访问简单 & 高效
ContentProvider 解耦了底层数据的存储方式，使得无论底层数据存储采用何种方式，外界对数据的访问方式都是统一的，这使得访问简单 & 高效

五、总结

使用ContentProvider需要在AndroidManifest.xml注册，其中exported属性用于设置是否可跨APP访问。
自定义ContentProvider必需要实现ContentProvider的6个方法：增删改查以及onCreate()和getType()方法。
使用ContentProvider时先通过Uri来获取ContentProvider，然后通过ContentResolver来对其进行增删改查操作。

参考文章：Android：关于ContentProvider的知识都在这里了！

Android四大组件之ContentProvider

一、概述

二、相关类介绍

2.1 URI（统一资源定位符）

2.2 MIME数据类型

2.3 ContentResolver类

2.4 ContentObserver

三、ContentProvider实例

进程内通信：

进程间数据共享

四、ContentProvider优点

五、总结

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Android