Android初级学习路线 四大组件之ContentProvider

概述

ContentProvider虽说我们平时用的并不多，但是作为安卓四大组件之一，其地位不容忽视。ContentProvider的作用是为不同的应用之间数据共享，提供统一的接口，我们知道安卓系统中应用内部的数据是对外隔离的，要想让其它应用能使用自己的数据（例如通讯录）这个时候就用到了ContentProvider。

关于ContentProvider的使用主要介绍以下内容： 

1 统一资源标识符（URI）

• 定义：Uniform Resource Identifier，即统一资源标识符
• 作用：唯一标识 ContentProvider & 其中的数据

外界进程通过 URI 找到对应的ContentProvider & 其中的数据，再进行数据操作

• 具体使用
  URI分为 系统预置 & 自定义，分别对应系统内置的数据（如通讯录、日程表等等）和自定义数据库

1. 关于 系统预置URI 此处不作过多讲解，需要的同学可自行查看
2. 此处主要讲解 自定义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 MIME数据类型

• 作用：指定某个扩展名的文件用某种应用程序来打开
  如指定.html文件采用text应用程序打开、指定.pdf文件采用flash应用程序打开

• 具体使用：

1 ContentProvider根据 URI 返回MIME类型

ContentProvider.geType(uri) ；

2 MIME类型组成
每种MIME类型 由2部分组成 = 类型 + 子类型

MIME类型是 一个 包含2部分的字符串

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

text/css
text/xml
application/pdf

3 MIME类型形式
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

 ContentProvider类

1 组织数据方式

• ContentProvider主要以 表格的形式 组织数据

同时也支持文件数据，只是表格形式用得比较多

• 每个表格中包含多张表，每张表包含行 & 列，分别对应记录 & 字段

同数据库

2 主要方法

• 进程间共享数据的本质是：添加、删除、获取 & 修改（更新）数据
• 所以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

• ContentProvider类并不会直接与外部进程交互，而是通过ContentResolver 类

 

 

ContentResolver类

1 作用

统一管理不同 ContentProvider间的操作

1. 即通过 URI 即可操作 不同的ContentProvider 中的数据
2. 外部进程通过 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)

• 实例说明

// 使用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

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

UriMatcher类

• 作用

  1. 在ContentProvider 中注册URI
  2. 根据 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的表
    }   
}

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进程内的调用

步骤说明：

1. 创建数据库类

先使用greenDao框架实现创建表user

2.自定义 ContentProvider 类

创建自定义的contentProvider

3 注册 创建的 ContentProvider类

 在清单配置

进程内访问 ContentProvider的数据 

1插入数据

查询出数据 

完成

2进程间的调用

假设B应用调用A应用的数据库。操作A数据的数据库进行插入和查询。A的创建和上面1的进程 内的调用创建一样，唯一区别就是在A的注册Provider中注册添加访问数据的权限。

 在B中需要把权限加入

在A中创建调用的Acvity

public class ContentProviderTestActivity extends Activity implements View.OnClickListener{
    Button querbtn,insertbtn;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test);
        querbtn=findViewById(R.id.insertuser);
        insertbtn=findViewById(R.id.queryuser);
        querbtn.setOnClickListener(this);
        insertbtn.setOnClickListener(this);


    }

    @Override
    public void onClick(View view) {

        if(view.getId()==R.id.insertuser){
                new Thread(){
                    @Override
                    public void run() {
                        super.run();
                        Uri uri=Uri.parse("content://com.example.myprovider/user");
                        ContentValues contentValues=new ContentValues();
                        contentValues.put("id",3);
                        contentValues.put("name","zhuyu");
                        contentValues.put("age",28);
                        ContentResolver contentResolver= getContentResolver();
                        contentResolver.insert(uri,contentValues);
                    }
                }.start();


        }else if(view.getId()==R.id.queryuser){
            new Thread(){

                @SuppressLint("LongLogTag")
                @RequiresApi(api = Build.VERSION_CODES.O)
                @Override
                public void run() {
                    super.run();
                    Uri uri=Uri.parse("content://com.example.myprovider/user");
                    Cursor cursor=getContentResolver().query(uri,new String[]{"_id","NAME","AGE"},null,null);
                    while (cursor.moveToNext()){
                        Log.d("ContentProviderTestActivity","id:"+cursor.getLong(cursor.getColumnIndex("_id"))+"name:"+cursor.getString(cursor.getColumnIndex("NAME"))+"age:"+cursor.getInt(cursor.getColumnIndex("AGE")));

                    }
                }
            }.start();

        }

    }

完成进程间的调用。