ContentProvider讲解与实例应用

747 阅读6分钟

什么是ContentProvider:

是Android的四大组件之一
主要用于不同的应用程序之间实现数据共享功能

什么是ContentResolver:

是数据调用者,ContentProvider将数据发布出来,通过ContentResolver对象结合Uri进行调用
通过ContentResolver对象可以调用ContentProvider的增删改查

什么是Uri:

Uri(通用资源标识符 Universal Resource Identifer),代表数据操作的地址,每一个ContentProvider发布数据时都会有唯一的地址。
比如:content://(固定写法)+com.android.contacts(包名,可变)+/contacts(path路径)

创建自定义ContentProvider的步骤:

1.使用SQLite技术,创建好数据库和数据表
2.新建类继承ContentProvider
3.重写6个抽象方法
4.创建UriMatcher,定义Uri规则
5.在Manifest中注册provider
6.ContentResolver对ContentProvider中共享的数据进行增删改查操作


数据共享

如果让其他应用也可以访问此应用中的数据呢,一种方法是向此应用设置一个android:sharedUserId,然后需要访问此数据的应用也设置同一个sharedUserId,具有同样的sharedUserId的应用间可以共享数据。

但此种方法不够安全,也无法做到对不同数据进行不同读写权限的管理,下面我们就来详细介绍下ContentProvider中的数据共享规则。

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

  • android:exported 设置此provider是否可以被其他应用使用。
  • android:readPermission 该provider的读权限的标识
  • android:writePermission 该provider的写权限标识
  • android:permission provider读写权限标识

ContentProvider实例应用

TestProvider.java

public class TestProvider extends ContentProvider {
    private final static DateFormat FORMAT = new SimpleDateFormat("yyyy-MM-dd", Locale.getDefault());

    private final static int ADD = 100;
    private final static int DEL = 101;
    private final static String PATH_TEST = "person";
    //其中# 是通配符.
    private final static String PATH_DEL = "person/#";
    private StudentDao mStudentDao;


    /**
     * UriMatcher类用于匹配Uri.
     * @return
     */
    static UriMatcher buildUriMatcher(){
        //常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码
        final UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);

        final String authorith = "com.johnny.provider";

        //如果match()方法匹配content://com.johnny.provider/person路径,返回匹配码为ADD
        matcher.addURI(authorith,PATH_TEST,ADD);
        //如果match()方法匹配content://com.johnny.provider/person/10 路径,返回匹配码为GET
        matcher.addURI(authorith,PATH_DEL,DEL);

        return matcher;
    }


    @Override
    public boolean onCreate() {

        return true;
    }

    private void initDatabase(){
        DaoSession daoSession = DbHelper.getInstance().getDaoSession();
        mStudentDao = daoSession.getStudentDao();
    }



    @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) {
        initDatabase();
        switch (buildUriMatcher().match(uri)){
            case ADD:
                String name = values.getAsString("name");
                int age = values.getAsInteger("age");
                String date = values.getAsString("date");
                Student student = new Student(null,name,age, TimeUtils.string2Date(date,FORMAT));
                LogHelper.i("insert " + student.toString());
                long id = mStudentDao.insert(student);
                LogHelper.i("insert id" + id);
                getContext().getContentResolver().notifyChange(uri,null);
                /**
                 * withAppendedId(uri, id)用于为路径加上ID部分:
                 * Uri uri = Uri.parse("content://com.johnny.provider/person")
                 Uri resultUri = ContentUris.withAppendedId(uri, 10);
                 //生成后的Uri为:content://om.johnny.provider/person/10
                 */
                return ContentUris.withAppendedId(uri,id);

            default:
                throw new IllegalArgumentException("Unknown URI"+ uri);
        }
    }

    @Override
    public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {
        initDatabase();
        switch (buildUriMatcher().match(uri)){
            case DEL:
                /**
                 * parseId(uri)方法用于从路径中获取ID部分:
                 * Uri uri = Uri.parse("content://com.johnny.provider/person/10")
                  long personid = ContentUris.parseId(uri);//获取的结果为:10
                 */
                long id = ContentUris.parseId(uri);
                mStudentDao.deleteByKey(id);
                return 1;
            default:
                throw new IllegalArgumentException("Unknown URI"+ uri);
        }
    }

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


}

androidManifest.xml进行配置注册。

<provider
    android:authorities="com.johnny.provider"
    android:name=".activity.provider.TestProvider" />

ProviderActivity.java

public class ProviderActivity extends BaseActivity {

    private Uri insertUri = Uri.parse("content://com.johnny.provider/person");

    /**
     * 监听ContentProvider中数据的变化.
     * 使用ContentObserver对数据(数据采用uri描述)进行监听,当监听到数据变化通知时,系统就会调用ContentObserver的onChange()方法.
     * 必须在ContentProvider发生数据变化时调用getContentResolver().notifyChange(uri, null)来通知注册在此URI上的访问者
     */
    private class PersonObserver extends ContentObserver{
        private Uri personContentUri;       // 需要观察的Uri

        public PersonObserver(Uri uri,Handler handler) {
            super(handler);
            personContentUri = uri;
        }

        @Override
        public void onChange(boolean selfChange) {
            super.onChange(selfChange);
            handleContentChange(personContentUri);
        }
    }

    @Override
    protected void loadViewLayout() {
        setContentView(R.layout.test_provider_activity);

        getContentResolver().registerContentObserver(insertUri,true,new PersonObserver(insertUri,new Handler()));
    }


    @Override
    protected void setListener() {
        findViewById(R.id.insert).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                testInsert();
            }
        });
    }

    private void testInsert(){
        ContentResolver contentResolver = mContext.getContentResolver();

        ContentValues values = new ContentValues();
        values.put("name","Jim");
        values.put("age",21);
        values.put("date","1992-09-18");
        Uri uri = contentResolver.insert(insertUri,values);

        LogHelper.i(" testInsert " + uri);

    }

    private void handleContentChange(Uri uri){
        LogHelper.i("---回调---" +uri);
    }
}

FileProvider

Android 7.0适配-应用之间共享文件(FileProvider)

一、前言
Android 7.0强制启用了被称作 StrictMode的策略,带来的影响就是你的App对外无法暴露file://类型的URI了。

如果你使用Intent携带这样的URI去打开外部App(比如:打开系统相机拍照),那么会抛出FileUriExposedException异常。

官方给出解决这个问题的方案,就是使用FileProvider

FileProvider.png

我们来看一段代码:

String cachePath = getApplicationContext().getExternalCacheDir().getPath();
File picFile = new File(cachePath, "test.jpg");
Uri picUri = Uri.fromFile(picFile);
Intent intent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
intent.putExtra(MediaStore.EXTRA_OUTPUT, picUri);
startActivityForResult(intent, 100);

这是常见的打开系统相机拍照的代码,拍照成功后,照片会存储在picFile文件中。

这段代码在Android 7.0之前是没有任何问题的(奇葩情况忽略),但是如果你尝试在7.0的系统上运行(可以用模拟器测试,我也没真机),会抛出文章开头提到的FileUriExposedException异常。

既然官方推荐使用FileProvider来解决此问题,我们就来看下如何使用吧~

二、使用FileProvider
FileProvider使用大概分为以下几个步骤:

  1. manifest中申明FileProvider
  2. res/xml中定义对外暴露的文件夹路径
  3. 生成content://类型的Uri
  4. 给Uri授予临时权限
  5. 使用Intent传递Uri

我们分别看下这几个步骤的具体实现吧

1.manifest中申明FileProvider:

<manifest>
  ...
  <application>
    ...
    <provider
        android:name="android.support.v4.content.FileProvider"
        android:authorities="com.mydomain.fileprovider"
        android:exported="false"
        android:grantUriPermissions="true">
        ...
    </provider>
    ...
  </application>
</manifest>

android:name:provider你可以使用v4包提供的FileProvider,或者自定义您自己的,只需要在name申明就好了,一般使用系统的就足够了。
**android:authorities:**类似schema,命名空间之类,后面会用到。
android:exported:false表示我们的provider不需要对外开放。
**android:grantUriPermissions:**申明为true,你才能获取临时共享权限。

2. res/xml中定义对外暴露的文件夹路径:
新建file_paths.xml,文件名随便起,后面会引用到。

<paths xmlns:android="http://schemas.android.com/apk/res/android">
  <files-path name="my_images" path="images"/>
</paths>

**name:**一个引用字符串。
**path:**文件夹“相对路径”,完整路径取决于当前的标签类型。

path可以为空,表示指定目录下的所有文件、文件夹都可以被共享。

<paths>这个元素内可以包含以下一个或多个,具体如下:

<files-path name="name" path="path" />

物理路径相当于Context.getFilesDir() + /path/。

<cache-path name="name" path="path" />

物理路径相当于Context.getCacheDir() + /path/。

<external-path name="name" path="path" />

物理路径相当于Environment.getExternalStorageDirectory() + /path/。

<external-files-path name="name" path="path" />

物理路径相当于**Context.getExternalFilesDir(String) **+ /path/。

<external-cache-path name="name" path="path" />

物理路径相当于Context.getExternalCacheDir() + /path/。

注意:external-cache-path在support-v4:24.0.0这个版本并未支持,直到support-v4:25.0.0才支持,最近适配才发现这个坑!!!

番外:以上是官方提供的几种path类型,不过如果你想使用外置SD卡,可以用这个:

<root-path name="name" path="path" />

物理路径相当于/path/。

这个官方文档并没有给出,我们查看源码可以发现:

root.png

编写好file_paths.xml,我们在manifest中的provider这样使用:

<provider
  android:name="android.support.v4.content.FileProvider"
  android:authorities="com.mydomain.fileprovider"
  android:exported="false"
  android:grantUriPermissions="true">
  <meta-data
      android:name="android.support.FILE_PROVIDER_PATHS"
      android:resource="@xml/file_paths" />
</provider>

3.生成content://类型的Uri
我们通常通过File生成Uri的代码是这样:

File picFile = xxx;
Uri picUri = Uri.fromFile(picFile);

这样生成的Uri,路径格式为file://xxx。前面我们也说了这种Uri是无法在App之间共享的,我们需要生成content://xxx类型的Uri,方法就是通过Context.getUriForFile来实现:

File imagePath = new File(Context.getFilesDir(), "images");
File newFile = new File(imagePath, "default_image.jpg");
Uri contentUri = getUriForFile(getContext(), 
                 "com.mydomain.fileprovider", newFile);

imagePath:使用的路径需要和你在file_paths.xml申明的其中一个符合(或者子文件夹:"images/work")。当然,你可以申明N个你需要共享的路径:

<paths xmlns:android="http://schemas.android.com/apk/res/android">    
  <files-path name="my_images" path="images"/>    
  <files-path name="my_docs" path="docs"/>
  <external-files-path name="my_video" path="video" />
  //...
</paths>

getUriForFile:第一个参数是Context;第二个参数,就是我们之前在manifest#provider中定义的android:authorities属性的值;第三个参数是File

4.给Uri授予临时权限

intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION
               | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);  

**FLAG_GRANT_READ_URI_PERMISSION:**表示读取权限;
**FLAG_GRANT_WRITE_URI_PERMISSION:**表示写入权限。

你可以同时或单独使用这两个权限,视你的需求而定。

5.使用Intent传递Uri
以开头的拍照代码作为示例,需要这样改写:

// 重新构造Uri:content://
File imagePath = new File(Context.getFilesDir(), "images");
if (!imagePath.exists()){imagePath.mkdirs();}
File newFile = new File(imagePath, "default_image.jpg");
Uri contentUri = getUriForFile(getContext(), 
                 "com.mydomain.fileprovider", newFile);
Intent intent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
intent.putExtra(MediaStore.EXTRA_OUTPUT, contentUri);
// 授予目录临时共享权限
intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION
               | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
startActivityForResult(intent, 100);

当然,6.0以上系统需要动态申请权限,这个不在本篇文章讨论的范围。

www.jianshu.com/p/55eae30d1…