FileProvider

前言

在Android中经常会遇到存储和访问文件,一般情况下我们会使用Context#openFileOutput()或者Context#getCacheDir()来获得文件存储路径,但是这两种方式存储的文件只能在APP内部访问,不能共享给其他APP访问。这个时候我们就需要将文件存储在外部存储卡上面,使用Environment#getExternalStorageDirectory()或者Environment#getDownloadCacheDirectory(),但是这样带来了两个潜在的问题。

  1. 所有应用都可以访问该数据,造成安全问题,我们只希望部分应用可访问。
  2. 为了读写该文件APP需要有READ_EXTERNAL_STORAGEWRITE_EXTERNAL_STORAGE权限,需要访问的其他APP也需要READ_EXTERNAL_STORAGE权限才能读取。对于内容的提供者我们不能确保访问的应用程序就一定有READ_EXTERNAL_STORAGE权限 。

因此使用file://... URI来共享文件并不好,替代方案就是定义一个ContentProvider,使用content://... URI来共享文,而FileProvider是对ContentProvider的进一步封装,专门用于文件共享。

FileProvider是什么

FileProvider是ContentProvider的一个特殊子类,它通过创建一个 content:// Uri 来使应用程序相关的文件实现安全共享:file:/// Uri.

之前我们在使用URL来访问内容的时候可以使用 Intent.setFlags() 来设置一些临时访问权限,这些Google认为是不安全的,所以从Android7.0开始执行了“StrictMode API 政策禁”,来使用FileProvider来解决这个访问权限问题。

之前的做法:

File file=new File(Environment.getExternalStorageDirectory(), "/temp/"+System.currentTimeMillis() + ".jpg");
if (!file.getParentFile().exists())file.getParentFile().mkdirs();
Uri imageUri = Uri.fromFile(file);
Intent intent = new Intent();
intent.setAction(MediaStore.ACTION_IMAGE_CAPTURE);//设置Action为拍照
intent.putExtra(MediaStore.EXTRA_OUTPUT, imageUri);//将拍取的照片保存到指定URI
startActivityForResult(intent,1006);

在Android7.0上使用上述方式调用系统相拍照会抛出如下异常:

android.os.FileUriExposedException: file:////storage/emulated/0/temp/1474956193735.jpg exposed beyond app through Intent.getData()
at android.os.StrictMode.onFileUriExposed(StrictMode.java:1799)
at android.net.Uri.checkFileUriExposed(Uri.java:2346)
at android.content.Intent.prepareToLeaveProcess(Intent.java:8933)
at android.content.Intent.prepareToLeaveProcess(Intent.java:8894)
at android.app.Instrumentation.execStartActivity(Instrumentation.java:1517)
at android.app.Activity.startActivityForResult(Activity.java:4223)
...
at android.app.Activity.startActivityForResult(Activity.java:4182)

使用FileProvider

使用FileProvider的大致步骤如下:

第一步:在manifest清单文件中注册provider

因为FileProvider默认包括生成文件的URI,所以我们只需要在XML配置。

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

心得:exported:要求必须为false,为true则会报安全异常。grantUriPermissions:true,表示授予 URI 临时访问权限。

如果我们要要覆盖FileProvider方法的任何默认行为,可以扩展FileProvider类并在android:name属性中使用我们自己定义的类名。

第二步:指定共享的目录

为了指定共享的目录我们需要在资源(res)目录下创建一个xml目录,然后创建一个名为“file_paths”(名字可以随便起,只要和在manifest注册的provider所引用的resource保持一致即可)的资源文件,内容如下:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <paths>
        <external-path path="" name="camera_photos" />
    </paths>
</resources>

这个/标签必须是一个或者多个如下标签:

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

等同于Context.getFilesDir().

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

等同于getCacheDir().

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

等同于Environment.getExternalStorageDirectory().

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

等同于 Context.getExternalFilesDir(null).

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

等同于Context.getExternalCacheDir().

这些标签都使用相同的两个属性

name=“name”

这个name名字可以随便起,替代path的一个显式称谓,这个值能起到隐藏共享目录的名称的作用。

path=“path”

这个path是要共享的子目录路径,这个值只能是一个目录路径而不能是一个文件的路径。另外path=“ ”,是有特殊意义的,它代码根目录,也就是说你可以向其它的应用共享根目录及其子目录下任何一个文件了。

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

第三步:使用FileProvider

上述准备工作做完之后,现在我们就可以使用FileProvider了。 以调用系统相机拍照为例,我们需要将上述拍照代码修改为如下:

File file=new File(Environment.getExternalStorageDirectory(), "/temp/"+System.currentTimeMillis() + ".jpg");
if (!file.getParentFile().exists())file.getParentFile().mkdirs();
Uri imageUri = FileProvider.getUriForFile(context, "com.jph.takephoto.fileprovider", file);//通过FileProvider创建一个content类型的Uri
Intent intent = new Intent();
intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION); //添加这一句表示对目标应用临时授权该Uri所代表的文件
intent.setAction(MediaStore.ACTION_IMAGE_CAPTURE);//设置Action为拍照
intent.putExtra(MediaStore.EXTRA_OUTPUT, imageUri);//将拍取的照片保存到指定URI
startActivityForResult(intent,1006);

上述代码中主要有两处改变:

  1. 将之前Uri的scheme类型为file的Uri改成了有FileProvider创建一个content类型的Uri。
  2. 添加了intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);来对目标应用临时授权该Uri所代表的文件。

将getUriForFile方法获取的Uri打印出来如下:

content://com.jph.takephoto.fileprovider/camera_photos/temp/1474960080319.jpg。

其中camera_photos就是file_paths.xml中paths的name。

因为上述指定的path为path=””,所以

content://com.jph.takephoto.fileprovider/camera_photos/

代表的真实路径就是根目录即:/storage/emulated/0/。

content://com.jph.takephoto.fileprovider/camera_photos/temp/1474960080319.jpg
````
代表的真实路径是:/storage/emulated/0/temp/1474960080319.jpg。

### 为什么要使用ContentProvider

ContentProvider一般为存储和获取数据提供统一的接口,可以在不同的应用程序之间共享数据。

之所以使用ContentProvider,主要有以下几个理由:

- ContentProvider提供了对底层数据存储方式的抽象。比如下图中,底层使用了SQLite数据库,在用了ContentProvider封装后,即使你把数据库换成MongoDB,也不会对上层数据使用层代码产生影响。

![ContentProvider原理](/post/fileprovider/image1.png)

- Android框架中的一些类需要ContentProvider类型数据。如果你想让你的数据可以使用在如SyncAdapter, Loader, CursorAdapter等类上,那么你就需要为你的数据做一层ContentProvider封装。

- 第三个原因也是最主要的原因,是ContentProvider为应用间的数据交互提供了一个安全的环境。它准许你把自己的应用数据根据需求开放给其他应用进行增、删、改、查,而不用担心直接开放数据库权限而带来的安全问题。

### ContentResolver

我们知道了ContentProvider是对数据层的封装后,那么大家可能会问我们要如何对ContentProvider进行增,删,改,查的操作呢?下面我们来介绍一个新的类ContentResolver,我们可以通过它,来对不同的ContentProvider进行操作。

有些人可能会疑惑,为什么我们不直接访问Provider,而是又在上面加了一层ContentResolver来进行对其的操作,这样岂不是更复杂了吗?其实不然,大家要知道一台手机中可不是只有一个Provider内容,它可能安装了很多含有Provider的应用,比如联系人应用,日历应用,字典应用等等。有如此多的Provider,如果你开发一款应用要使用其中多个,如果让你去了解每个ContentProvider的不同实现,岂不是要头都大了。所以Android为我们提供了ContentResolver来统一管理与不同ContentProvider间的操作。

<img src="/post/fileprovider/image2.png" width=600 alt="ContentResolver来统一管理与不同ContentProvider间的操作" />

在Context.java的源码中有一段

java /** Return a ContentResolver instance for your application’s package. */ public abstract ContentResolver getContentResolver();


所以我们可以通过在所有继承Context的类中通过调用getContentResolver()来获得ContentResolver。

可能又有童鞋会问,那ContentResolver是如何来区别不同的ContentProvider的呢?这就涉及到URI(Uniform Resource Identifier)问题,对URI是什么还不明白的童鞋请自行Google

#### ContentProvider中的URI

ContentProvider中的URI有固定格式,如下图:

![ContentProvider中的URI有固定格式](/post/fileprovider/image3.png)

**Authority:**授权信息,用以区别不同的ContentProvider;
**Path:**表名,用以区分ContentProvider中不同的数据表;
**Id:**Id号,用以区别表中的不同数据;

### ContentProvider使用

首先我们创建一个自己的TestProvider继承ContentProvider。默认该Provider需要实现如下六个方法,onCreate(), query(Uri, String[], String, String[], String),insert(Uri, ContentValues), update(Uri, ContentValues, String, String[]), delete(Uri, String, String[]),  getType(Uri),方法的具体介绍可以参考

http://developer.android.com/reference/android/content/ContentProvider.html

下面我们以实现insert和query方法为例

java private final static int TEST = 100;

static UriMatcher buildUriMatcher() { final UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH); final String authority = TestContract.CONTENT_AUTHORITY;

matcher.addURI(authority, TestContract.PATH_TEST, TEST);

return matcher;

}

@Nullable @Override public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) { final SQLiteDatabase db = mOpenHelper.getReadableDatabase();

Cursor cursor = null;
switch ( buildUriMatcher().match(uri)) {
    case TEST:
        cursor = db.query(TestContract.TestEntry.TABLE_NAME, projection, selection, selectionArgs, sortOrder, null, null);
        break;
}

return cursor;

}

@Nullable @Override public Uri insert(Uri uri, ContentValues values) { final SQLiteDatabase db = mOpenHelper.getWritableDatabase(); Uri returnUri; long _id; switch ( buildUriMatcher().match(uri)) { case TEST: _id = db.insert(TestContract.TestEntry.TABLE_NAME, null, values); if ( _id > 0 ) returnUri = TestContract.TestEntry.buildUri(_id); else throw new android.database.SQLException(“Failed to insert row into ” + uri); break; default: throw new android.database.SQLException(“Unknown uri: “ + uri); } return returnUri; }


此例中我们可以看到,我们根据path的不同,来区别对不同的数据库表进行操作,从而完成uri与具体数据库间的映射关系。

因为ContentProvider作为四大组件之一,所以还需要在AndroidManifest.xml中注册一下。

xml


然后你就可以使用getContentResolver()方法来对该ContentProvider进行操作了,ContentResolver对应ContentProvider也有insert,query,delete等方法,详情请参考:

http://developer.android.com/reference/android/content/ContentResolver.html

此处因为我们只实现了ContentProvider的query和insert的方法,所以我们可以进行插入和查询处理。如下我们可以在某个Activity中进行如下操作,先插入一个数据peng,然后再从从表中读取第一行数据中的第二个字段的值。

java ContentValues contentValues = new ContentValues(); contentValues.put(TestContract.TestEntry.COLUMN_NAME, “peng”); contentValues.put(TestContract.TestEntry._ID, System.currentTimeMillis()); getContentResolver().insert(TestContract.TestEntry.CONTENT_URI, contentValues);

Cursor cursor = getContentResolver().query(TestContract.TestEntry.CONTENT_URI, null, null, null, null);

try { Log.e(“ContentProviderTest”, “total data number = ” + cursor.getCount()); cursor.moveToFirst(); Log.e(“ContentProviderTest”, “total data number = ” + cursor.getString(1)); } finally { cursor.close(); }


### 数据共享


以上例子中创建的ContentProvider只能在本应用内访问,那如何让其他应用也可以访问此应用中的数据呢,一种方法是向此应用设置一个android:sharedUserId,然后需要访问此数据的应用也设置同一个sharedUserId,具有同样的sharedUserId的应用间可以共享数据。

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

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

1. android:exported 设置此provider是否可以被其他应用使用。
2. android:readPermission 该provider的读权限的标识
3. android:writePermission 该provider的写权限标识
4. android:permission provider读写权限标识
5. android:grantUriPermissions 临时权限标识,true时,意味着该provider下所有数据均可被临时使用;false时,则反之,但可以通过设置\<grant-uri-permission\>标签来指定哪些路径可以被临时使用。这么说可能还是不容易理解,我们举个例子,比如你开发了一个邮箱应用,其中含有附件需要第三方应用打开,但第三方应用又没有向你申请该附件的读权限,但如果你设置了此标签,则可以在start第三方应用时,传入FLAG_GRANT_READ_URI_PERMISSION或FLAG_GRANT_WRITE_URI_PERMISSION来让第三方应用临时具有读写该数据的权限。

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

声明一个permission

xml


然后改变provider标签为

xml

则在其他应用中可以使用以下权限来对TestProvider进行访问。

xml


有人可能又想问,如果我的provider里面包含了不同的数据表,我希望对不同的数据表有不同的权限操作,要如何做呢?Android为这种场景提供了provider的子标签`<path-permission>`,path-permission包括了以下几个标签。

xml ```

可以对不同path设置不同的权限规则,具体如何设定我这里就不做详细介绍了,可以参考 http://developer.android.com/guide/topics/manifest/path-permission-element.html