Android FileProvider 踩坑指北

前言

从 Android N（7.0）开始，将严格执行 StrictMode 模式。而从 Android N 开始，将不允许在 App 间，使用 file:// 的方式，传递一个 File ，否者会抛出 FileUriExposedException 的异常引发 Crash。解决方案就是通过FileProvider 用 content:// 代替 file://，需要开发者主动升级 targetSdkVersion 到 24 才会执行此策略。

其实在 Android 7.0 出来后我们应用就就开始适配了，应用中加入了FileProvider，但偶尔还是会碰到 FileProvider 导致的问题，所以这边文章准备彻彻底底的分析下FileProvider，揪出FileProvider的庐山真面目。

Android 应用文件存储目录

内部存储空间中的应用私有目录

每安装一个 App 系统都会在内部存储空间的 data/data 目录下以应用包名为名字自动创建与之对应的文件夹，这个文件夹用于持久化 App 中的 WebView 缓存页面信息、SharedPreferences、SQLiteDatabase等应用相关数据。当用户卸载 App 时，系统自动删除 data/data 目录下对应包名的文件夹及其内容。

Android SDK 提供获取并操作内部存储空间中的应用私有目录的方法如下：

context.getFilesDir()
context.getCacheDir()
context.deleteFile()
context.fileList()
Environment.getDataDirectory()

外部存储空间中的应用私有目录

考虑到普通用户无法访问应用的内部存储空间，比如用户想从应用里面保存一张图片，那么这张图片应该存储在外部存储空间，用户才能访问的到，外部存储空间路径为：/storage/emulated/0/Android/data/<包名>

默认情况下，系统并不会自动创建外部存储空间的应用私有目录。只有在应用需要的时候，开发人员通过 SDK 提供的 API 创建该目录文件夹和操作文件夹内容。

当用户卸载 App 时，系统也会自动删除外部存储空间下的对应 App 私有目录文件夹及其内容。

Android SDK 中提供给开发人员直接操作外部存储空间下的应用私有目录的方法如下：

context.getExternalFilesDir()
context.getExternalCacheDir()
Environment.getExternalStorageDirectory()

外部存储空间中的公共目录

外部存储空间中的公共目录用来存放当应用被卸载时，仍然可以保存在设备中的信息，如：拍照类应用的图片文件，用户是使用浏览器手动下载的文件等。

外部存储空间已经为用户默认分类出一些公共目录。开发人员可以通过 Environment 类提供的方法直接获取相应目录的绝对路径，传递不同的 type 参数类型即可：

Environment.getExternalStoragePublicDirectory(String type);

Envinonment 类提供诸多 type 参数的常量，比如：

DIRECTORY_MUSIC：/storage/emulated/0/Music
DIRECTORY_MOVIES：/storage/emulated/0/Movies
DIRECTORY_PICTURES：/storage/emulated/0/Pictures
DIRECTORY_DOWNLOADS：/storage/emulated/0/Download

FileProvider

什么是 FileProvider

FileProvider 是 ContentProvider的子类目前 support v4 包和 androidx的core包里面都有提供。FileProvider 本质上就是一个 ContentProvider ，它其实也继承了 ContentProvider 的特性。其实ContentProvider 就是在可控的范围内，向外部其他的 App 分享数据。而 FileProvider 将这样的数据变成了一个 File 文件而已。

使用 FileProvider 的场景

在 App 内，通过一个 Intent 传递了一个 file:// 的 Uri 的场景都需要使用 FileProvider ，如：

调用相机拍照
剪裁图片
调用系统安装器去安装 Apk

如何使用 FileProvider

1 在AndroidManifest.xml 中声明

        <provider
            android:name="androidx.core.content.FileProvider"
            android:authorities="${applicationId}.fileProvider"
            android:exported="false"
            android:grantUriPermissions="true">
            
            <meta-data
                android:name="android.support.FILE_PROVIDER_PATHS"
                android:resource="@xml/file_paths" />
        </provider>

可以看到，provider 标签下，配置了几个属性：

name ：配置当前 FileProvider 的实现类。
authorities：配置一个 FileProvider 的名字，它在当前系统内需要是唯一值。
exported：表示该 FileProvider 是否需要公开出去，传 false 表示不公开。
granUriPermissions：是否允许授权文件的临时访问权限。传 true 表示需要。

name 属性就是标记当前 FileProvider 的实现类，对于一个 App Module 而言，如果只是自己使用，可以直接使用 FileProvider ，但是如果是作为一个 Lib Module 来供其他项目使用，最好还是重新创建一个Provider继承 FileProvider。

2 指定可分享的文件路径

在配置 Provider 的时候，还需要额外配置一个 <meta-data/> 标签，它用于配置 FileProvider 支持分享出去的目录。这个 <meta-data/> 标签的 name 值是固定的，resource 需要指向一个 xml 资源文件。

file_paths.xml 中内容如下：

<?xml version="1.0" encoding="utf-8"?>
<paths>
    <files-path
        name="files-path"
        path="." />
    <cache-path
        name="cache-path"
        path="." />
    <external-path
        name="external_storage_root"
        path="." />
    <external-files-path
        name="external_file_path"
        path="." />
    <external-cache-path
        name="external_cache_path"
        path="." />
    <!--配置root-path。这样子可以读取到sd卡和一些应用分身的目录，否则微信分身保存的图片，就会导致 java.lang.IllegalArgumentException: Failed to find configured root that contains /storage/emulated/999/tencent/MicroMsg/WeiXin/export1544062754693.jpg-->
    <root-path
        name="root-path"
        path="" />
</paths>

通过上面的内容可以看到，在paths根目录下定义了各种 xx-path 标签，这些标签，我们可以通过查看 FileProvider 的源码查到

这些 xx-path 标签所代表的目录可以通过源码了解

标签对应的目录汇总如下：

root-path：表示根目录，“/”。
files-path：表示 content.getFileDir() 获取到的目录
cache-path：表示 content.getCacheDir() 获取到的目录
external-path：表示Environment.getExternalStorageDirectory() 指向的目录
external-files-path：表示 ContextCompat.getExternalFilesDirs() 获取到的目录
external-cache-path：表示 ContextCompat.getExternalCacheDirs() 获取到的目录

TAG	Value	Path
TAG_ROOT_PATH	root-path	/
TAG_FILES_PATH	files-path	/data/data/<包名>/files
TAG_CACHE_PATH	cache-path	/data/data/<包名>/cache
TAG_EXTERNAL	external-path	/storage/emulate/0
TAG_EXTERNAL_FILES	external-files-path	/storage/emulate/0/Android/data/<包名>/files
TAG_EXTERNAL_CACHE	external-cache-path	/storage/emulate/0/Android/data/<包名>/cache

注意：
如果App有选择和剪裁图片的需求，最好配置下root-path，这样子可以读取到sd卡和一些应用分身的目录，否则微信等应用分身保存的图片，在App里面读取时就发生下面异常：

java.lang.IllegalArgumentException: Failed to find configured root that contains /storage/emulated/10/tencent/MicroMsg/WeiXin/mmexport1592487275473.jpg

3 将 file:// 转为 content://

使用FileProvider.getUriForFile()方法将file:// 转为 content://

getUriForFile() 方法，需要一个 authority 的参数，这里需要与前面在 AndroidManifest.xml 中配置的 android:authorities保持一致，因为是通过 android:authorities 属性配置的值，来唯一确定由谁来响应这个 provider 的。在 AndroidManifest.xml 中配置 provider 的时候，需要保证 android:authorities 的值，在整个系统中的唯一性，否者安装的时候会抛出如下异常：

4 授予临时的读写权限

在配置 provider 标签的时候，有一个属性 android:grantUriPermissions="true" ，它表示允许它授予 Uri 临时的权限。

当我们生成出一个 content:// 的 Uri 对象之后，其实也无法对其直接使用，还需要对这个 Uri 接收的 App 赋予对应的权限才可以。

授权类型的常量，被定义在 Intent 类中。

授权的两种方式：

使用 Context.grantUriPermission() 为其他 App 授予 Uri 对象的访问权限。

public abstract void grantUriPermission(String toPackage, Uri uri,@Intent.GrantUriMode int modeFlags);

grantUriPermission() 方法包含三个参数：

toPackage ：表示授予权限的 App 的包名。
uri：授予权限的 content:// 的 Uri
modeFlags：前面提到的定义在 Intent 中的读写权限。

授权有效期：从授权一刻开始，截止于设备重启或者手动调用 Context.revokeUriPermission() 方法，才会收回对此 Uri 的授权

2、配合 Intent.addFlags() 授权。

既然授权类型的常量是一个 Intent 的 Flag，Intent 也提供了另外一种比较方便的授权方式，那就是使用 Intent.setFlags() 或者 Intent.addFlag 的方式。

授权有效期：从授权一刻开始，截止于App完全退出应用

5 通过 startXxx 或者 setResult() 的方式，将 Uri 传递给其他的 App

拿剪裁图片举例

大功告成！