Android四大组件之3 - ContentProvider

目录

1. ContentProvider 简介

2. contentProvider类的方法

 3. ContentResolver

 4.ContentUris类

5. UriMatcher 类

6. 不同应用/进程间的数据共享

7. 对数据进行增删改查

---

1. ContentProvider 简介

ContentProvider (内容提供者) 可以让我们的 APP 访问别的应用，或者说一些 ContentProvider 暴露给我们的一些数据，比如手机联系人，短信等，如果我们想对这些数据进行读取或者修改，就需要用到 ContentProvider

当然了, ContentProvider 也允许我们将自己应用里的数据暴露出来，给其它的应用进行读取或操作，我们可以选择要暴露的数据，可以避免了我们隐私数据的的泄露

 

当我们想允许自己 APP 的数据开放给别的 APP 进行读取操作，我们就需要让 APP 实现 ContentProvider 类，同时注册一个 URI，然后其它的 APP 就可以通过 ContentResolver 根据 URI 就可以访问我们 APP 的数据

数据可以是任何内容，比如数据库，一个文件，一个 XML 或者SharedPreference ，其它

 

Android已经为常见的一些数据提供了默认的 ContentProvider。

数据通过唯一的 URI 标识来源。ContentProvider 将数据看作表，查询 / 操作数据的时候，通过类似数据库操作的 insert / delete / query / update 方法来实现增删查改操作。

作为应用间数据交换 / 共享接口，当然需要有一个“桥梁”来连接数据提供方和使用方。数据提供方提供数据，使用方使用 content://authorities/path 类似的 URI 来访问数据。 

运行流程：

Uri通用资源标志符（Universal Resource Identifier, 简称 "URI"）: 

从ContentProvider的数据操作方法可以看出都依赖于Uri，对于Uri有其固定的数据格式

字段	含义	对应项
前缀	默认的固定开头格式	content://
授权	唯一标识provider	com.example.app.provider
路径	数据类别以及数据项	/table1/1

一个标准的内容 URI 写法是这样的：

content://com.example.app.provider/table1/1

//这就表示调用方期望访问的是 com.example.app 这个应用的 table1 表中 id 为 1 的数据。

Authority：授权信息，用以区别不同的ContentProvider；
Path：表名，用以区分ContentProvider中不同的数据表；
Id：Id号，用以区别表中的不同数据；

2. contentProvider类的方法

ContentProvider作为Android四大组件之一，并没有Activity那样复杂的生命周期，只有简单地onCreate过程。ContentProvider是一个抽象类，当实现自己的ContentProvider类，只需继承于ContentProvider，并且实现以下六个abstract方法即可：

• insert(Uri, ContentValues)：插入新数据；
• delete(Uri, String, String[])：删除已有数据；
• update(Uri, ContentValues, String, String[])：更新数据；
• query(Uri, String[], String, String[], String)：查询数据；
• onCreate()：执行初始化工作；
• getType(Uri)：获取数据MIME类型。

 3. ContentResolver

其他app或者进程想要操作ContentProvider，则需要先获取其相应的ContentResolver，再利用ContentResolver类来完成对数据的增删改查操作，下面列举一个查询操作，查询得到的是一个Cursor结果集，再通过操作该Cursor便可获取想要查询的结果。

ContentResolver cr = getContentResolver();  //获取ContentResolver
Uri uri = Uri.parse("content://com.gityuan.articles/android/3");
Cursor cursor = cr.query(uri, null, null, null, null);  //执行查询操作
...
cursor.close(); //关闭

 4.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

5. UriMatcher 类

根据 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的表
    }   
}

 

6. 不同应用/进程间的数据共享

首先我们先介绍下，共享数据所涉及到的几个重要标签：

android:exported 设置此provider是否可以被其他应用使用。
android:readPermission 该provider的读权限的标识
android:writePermission 该provider的写权限标识
android:permission  provider读写权限标识
android:grantUriPermissions 临时权限标识，true时，意味着该provider下所有数据均可被临时使用；false时，则反之，但可以通过设置<grant-uri-permission>标签来指定哪些路径可以被临时使用。

这么说可能还是不容易理解，我们举个例子，比如你开发了一个邮箱应用，其中含有附件需要第三方应用打开，但第三方应用又没有向你申请该附件的读权限，但如果你设置了此标签，则可以在start第三方应用时，传入FLAG_GRANT_READ_URI_PERMISSION或FLAG_GRANT_WRITE_URI_PERMISSION来让第三方应用临时具有读写该数据的权限。

知道了这些标签用法后，让我们改写下AndroidManifest.xml，让ContentProvider可以被其他应用查询。

注意读写权限的声明：

只需要显示authorities的前两项： com.mike

<provider 
               android:name="MyProvider"
               android:authorities="com.mike.myprovider"

               // 声明外界进程可访问该Provider的权限（读 & 写）
               android:permission="com.mike.PROVIDER"             
               
               // 权限可细分为读 & 写的权限
               // 外界需要声明同样的读 & 写的权限才可进行相应操作，否则会报错
               // android:readPermisson = "com.mike.Read"
               // android:writePermisson = "com.mike.Write"

               // 设置此provider是否可以被其他进程使用
               android:exported="true"
                
  />

// 声明本应用 可允许通信的权限
    <permission android:name="com.mike.Read" android:protectionLevel="normal"/>
    // 细分读 & 写权限如下，但本Demo直接采用全权限
    // <permission android:name="com.mike.Write" android:protectionLevel="normal"/>
    // <permission android:name="com.mike.PROVIDER" android:protectionLevel="normal"/>

7. 对数据进行增删改查

继承于CotentProvider，创建自己的内容提供者

public class MyProvider extends ContentProvider {

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

    public static final String AUTOHORITY = "com.mike.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
     */
    @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;
    }

    /**
     * 添加数据
     */

    @Override
    public Uri insert(Uri uri, 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 Cursor query(Uri uri, String[] projection, String selection,
                        String[] selectionArgs, 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);
    }

    /**
     * 更新数据
     */
    @Override
    public int update(Uri uri, ContentValues values, String selection,
                      String[] selectionArgs) {
        // 由于不展示,此处不作展开
        return 0;
    }

    /**
     * 删除数据
     */
    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        // 由于不展示,此处不作展开
        return 0;
    }

    @Override
    public String getType(Uri uri) {

        // 由于不展示,此处不作展开
        return null;
    }

    /**
     * 根据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;
        }
    }

需要赋予权限：

    // 声明本应用可允许通信的权限（全权限）
    <uses-permission android:name="com.mike.PROVIDER"/>

    // 细分读 & 写权限如下，但本Demo直接采用全权限
    // <uses-permission android:name="com.mike.Read"/>
    //  <uses-permission android:name="com.mike.Write"/>
    
// 注：声明的权限必须与进程1中设置的权限对应

接着，对数据进行操作：

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.mike.myprovider/user");

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


        // 获取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://scut.carson_ho.myprovider/job");

        // 插入表中数据
        ContentValues values2 = new ContentValues();
        values2.put("_id", 4);
        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();
        // 关闭游标
    }
}

 

拿最常用的联系人为例

1. 系统源码文件下: all-src.rar -> TeleponeProvider -> AndroidManifest.xml 查找对应 API

2. 打开模拟器的 file exploer/data/data/com.android.providers.contacts/databases/contact2.db

3. 导出后使用 SQLite 图形工具查看，三个核心的表: raw_contact 表 ， data 表 ， mimetypes 表

动态获取联系人的信息：

1. 在AndroidManifest.xml 添加读取联系人的信息 权限

<uses-permission android:name="android.permission.READ_CONTACTS"/>

2.  具体的实现类 

package com.example.newdemo.contentprovider;

import androidx.annotation.NonNull;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;

import android.Manifest;
import android.content.pm.PackageManager;
import android.database.Cursor;
import android.os.Bundle;
import android.provider.ContactsContract;
import android.util.Log;
import android.widget.TextView;

import com.example.newdemo.R;
import com.example.newdemo.util.ToastManager;

import java.util.ArrayList;
import java.util.List;

public class SystemProviderActivity extends AppCompatActivity {

    private TextView provider_text;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_system_provider);
        provider_text = findViewById(R.id.provider_text);

        // 动态获取权限

        // 如果 电话权限没有获取， 则先获取电话权限
        if (ContextCompat.checkSelfPermission(this, Manifest.permission.READ_CONTACTS) != PackageManager.PERMISSION_GRANTED){
            ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.READ_CONTACTS}, 1);
        }else{
            readContacts();
        }


    }

    // 获取权限申请返回
    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        switch(requestCode){
            case 1:
                if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED){
                    readContacts();
                }else{
                    ToastManager.showMsg(this, "获取电话权限失败");
                }
                break;
            default:
                break;
        }
    }

    private void readContacts(){
        List contactList;
        Cursor cursor;

        contactList = new ArrayList();
        cursor = getContentResolver().query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI,
                null, null, null, null);
        if (cursor != null){
            while (cursor.moveToNext()){
                String name = cursor.getString(
                        cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
                String number = cursor.getString(
                        cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
                contactList.add(name + "\n" + number);
                String msg = "姓名： " + name + "\n" + "电话： "+ number;
                Log.d("SystemActivity", msg);
                provider_text.setText(msg);
            }
            cursor.close();
        }
    }

}