FileProvider简介

如果我们想在应用之间共享文件，那么我们就需要用到FileProvider这个类。他是属于ContentProvider的一个特殊子类，它让应用间共享文件变得更加容易，其通过创建一个Content URI来代替File URI。

一个Content URI 允许开发者可赋予一个临时的读或写权限。当创建一个包含Content URI的Intent的时候，为了能够让另一个应用也可以使用这个URI，你需要调用Intent.setFlags()来添加权限。只要接收Activity的栈是活跃的，则客户端应用就可以获取到这些权限。如果该Intent是用来启动一个Service，则只要该Service是正在运行的，则也可以获取到这些权限。

相比之下，如果想要通过File URI来控制权限，开发者必须修改底层文件系统的权限。这些权限会对任意的app开放，直到你修改了它。这种级别的访问基本上是不安全的。

通过Content URI来提高文件访问的安全性，使得FileProvider成为Android安全基础设置的一个关键部分。

FileProvider的使用

  1. 定义一个FileProvider
  2. 指定有效文件
  3. 从一个File得到一个对应的Content URI
  4. 对URI赋予临时权限
  5. 分享这个URI给另外的APP

1、定义一个FileProvider
由于FileProvider中已经包含了为file生成Content URI的基本代码了，所以开发者不必再去定义一个FileProvider的子类。你可以在XML文件中指定一个FileProvider：在manifest中使用provider标签来指定。

<manifest>
    ...
    <application>
        ...
        <provider
            android:name="android.support.v4.content.FileProvider"
            android:authorities="com.example.myapp.fileprovider"
            android:exported="false"
            android:grantUriPermissions="true">
            <meta-data
                android:name=".provider"
                android:resource="@xml/filepath" />
            ...
        </provider>
        ...
    </application>
</manifest>

说明：

  • name的值一般都固定为android.support.v4.content.FileProvider。如果开发者继承了FileProvider，则可以写上其绝对路径。
  • authorities字段的值用来表明使用的使用者，在FileProvider的函数getUriForFile需要传入该参数。
  • exported 的值为false，表示该FileProvider只能本应用使用，不是public的。
  • grantUriPermissions 的值为true，表示允许赋予临时权限。
  • meta-data指向了一个XML文件，该文件指定了我们希望共享的目录路径。“android:resource”属性字段是这个文件的路径和名字（无“.xml”后缀）。

2、指定有效的文件
在上面meta-data指定的xml中我们可以指定存储路径，例如：

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

paths 元素指定/data/data/<package-name>/files/images/为共享的目录。(file-path所对应的目录与Context.getFilesDir()所对应，即/data/data/<package-name>/files)。其中：name属性表示在URI中的描述，path属性表示文件实际存储的位置。

paths里边的元素必须是一下的一个或者多个：

  1. <files-path name="name" path="path" /> 对应Context.getFilesDir() + “/path/”，即/data/data/<package-name>/files/path/。
  2. <cache-path name="name" path="path" /> 对应Context.getCacheDir() + “/path/”，即/data/data/<package-name>/cache/path/。
  3. <external-files-path name="name" path="path" /> 对应Context.getExternalFilesDir(null) + “/path/”，即/storage/emulated/0/Android/data/<package_name>/files/path/。
  4. <external-cache-path name="name" path="path" /> 对应Context.getExternalCacheDir() + “/path/”，即/storage/emulated/0/Android/data/<package-name>/cache/path/。
  5. <external-path name="name" path="path" /> 对应Environment.getExternalStorageDirectory() + “/path/”，即/storage/emulated/0/path/。

这些paths里边有相同的子元素，即name和path。

name
这是URI的path。为了加强安全性，这个值隐藏了分享文件的子目录，具体的文件真实路径在path字段中保存。

path
分享文件的真实路径。需要注意的是，这个值表示的是一个子目录，不是一个具体的文件或者多个文件。开发者不能通过文件名来分享一个文件，也不能通过一个通配符来分享文件。

3、从一个File得到一个对应的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);

需要注意的是：

  1. imagePath：使用的路径需要和你在file_paths.xml申明的其中一个符合(或者子文件夹：”images/work”)。当然，你可以申明N个你需要共享的路径。即文件的绝对路径与第二步指定的文件目录保持一致：(假设包名为com.example.myapp.fileprovider)。如上边的代码的文件的绝对路径为/data/data/com.example.myapp.fileprovider/files/images/default_image.jpg，对应paths中的内容为:<files-path name="my_images" path="images/"/>。
  2. getUriForFile()的第二个参数是authority，与manifest文件中声明的authorities保持一致。

4、赋予临时权限
两种方法：（通常使用第2种）

  1. Context.grantUriPermission(package, uri, mode_flags);
  2. Intent.setFlag();
intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);

FLAG_GRANT_READ_URI_PERMISSION：表示读取权限；
FLAG_GRANT_WRITE_URI_PERMISSION：表示写入权限。

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

5、分享这个URI给另外一个APP
通常是通过Intent来传递的

Intent intent = new Intent();
ComponentName componentName = new ComponentName("com.ysx.fileproviderclient",
                "com.ysx.fileproviderclient.MainActivity");
        intent.setComponent(componentName);
File imagePath = new File(Context.getFilesDir(), "images");
if(!imagePath.exists()){
    imagePath.mkdirs();
}
Uri uri;
File newFile = new File(imagePath, "default_image.jpg");
if(Build.VERSION_INIT >= Build.VERSION_CODES.N){
    uri = FileProvider.getUriForFIle(mContext, FILE_PROVIDER_AUTHORITIES, newFile);
    intent.setFlag(Intent.FLAG_GRANT_READ_URI_PRIMISSION);
}else{
    uri = Uri.fromFile(newFile);
}
intent.setData(uri);
startActivity(intent);