重学Android之FileProvider

发表于 | 更新于 | 分类于 |   |   字数统计:3.7k字   |   阅读时长:15分

前言

项目之前使用了第三方库的时候，对于FileProvider的适配还不是很了解，因为使用时第三方库已经进行了适配。但是自己去覆写别人的第三方库的时候了解到了FileProvider的适配。

对于Android 7.0，提供了非常多的变化，详细的可以阅读官方文档Android 7.0 行为变更，但是该文章主要叙述关于FileProvider的适配。

在官方7.0的以上的系统中，尝试传递 file://URI可能会触发FileUriExposedException。

出错案例

先来一个常用的例子，大家应该对于手机拍照一定都不陌生，在希望得到一张高清拍照图的时候，我们通过Intent会传递一个File的Uri给相机应用。

大致代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
private static final int REQUEST_CODE_TAKE_PHOTO = 0x110;
    private String mCurrentPhotoPath;

    public void takePhotoNoCompress(View view) {
        Intent takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
        if (takePictureIntent.resolveActivity(getPackageManager()) != null) {

            String filename = new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.CHINA)
                    .format(new Date()) + ".png";
            File file = new File(Environment.getExternalStorageDirectory(), filename);
            mCurrentPhotoPath = file.getAbsolutePath();
						// File -> Uri 
            takePictureIntent.putExtra(MediaStore.EXTRA_OUTPUT, Uri.fromFile(file));
            startActivityForResult(takePictureIntent, REQUEST_CODE_TAKE_PHOTO);
        }
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        super.onActivityResult(requestCode, resultCode, data);
        if (resultCode == RESULT_OK && requestCode == REQUEST_CODE_TAKE_PHOTO) {
            mIvPhoto.setImageBitmap(BitmapFactory.decodeFile(mCurrentPhotoPath));
        }
        // else tip?

}

未处理6.0权限，有需要的自行处理下，nexus系列如果未处理，需要手动在设置页开启存储权限。

此时如果我们使用Android 7.0或者以上的原生系统，再次运行一下，你会发现应用直接停止运行，抛出了android.os.FileUriExposedException：

1
2
3
4
5
Caused by: android.os.FileUriExposedException: 
    file:///storage/emulated/0/20170601-030254.png 
        exposed beyond app through ClipData.Item.getUri()
    at android.os.StrictMode.onFileUriExposed(StrictMode.java:1932)
    at android.net.Uri.checkFileUriExposed(Uri.java:2348)

原因在官网已经给了解释：

对于面向 Android 7.0 的应用，Android 框架执行的 StrictMode API 政策禁止在您的应用外部公开 file:// URI。如果一项包含文件 URI 的 intent 离开您的应用，则应用出现故障，并出现 FileUriExposedException 异常。

同样的，官网也给出了解决方案：

要在应用间共享文件，您应发送一项 content:// URI，并授予 URI 临时访问权限。进行此授权的最简单方式是使用 FileProvider 类。如需了解有关权限和共享文件的详细信息，请参阅共享文件。
https://developer.android.com/about/versions/nougat/android-7.0-changes.html#accessibility

使用FileProvider

FileProvider属于Android 7.0新增的一个类，该类位于v4或者androidx包下，详情可见android.support.v4.content.FileProvider或者androidx.core.content.FileProvider，使用方法类似与ContentProvider，简单概括为三个步骤，这里先以调用系统相机拍照并保存sdcard公共目录为例，演示使用过程：

  • 在资源文件夹res/xml下新建file_paths.xml文件，文件声明权限请求的路径，代码如下：
1
2
3
4
5
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
	<!--3、对应外部内存卡根目录：Environment.getExternalStorageDirectory()-->
	<external-path name="external" path="/" />
</paths>

要使用content://uri替代file://uri，需要一个虚拟的路径对文件路径进行映射，所以需要编写个xml文件，通过path以及xml节点确定可访问的目录，通过name属性来映射真实的文件路径。

  • 在AndroidManifest.xml添加组件provider相关信息，类似组件activity，指定resource属性引用上一步创建的xml文件（后面会详细介绍各个属性的用法），代码如下：
1
2
3
4
5
6
7
8
9
10
<!-- 定义FileProvider -->
<provider
	android:name="androidx.core.content.FileProvider"
	android:authorities="com.siyee.android7.fileprovider"
	android:exported="false"
	android:grantUriPermissions="true">
	<meta-data
		android:name="android.support.FILE_PROVIDER_PATHS"
		android:resource="@xml/file_paths"/>
</provider>
  • 最后一步，Java代码申请权限，使用新增的方法getUriForFile()和grantUriPermission()，代码如下（后面会详细介绍方法对应参数的使用）：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
public void takePhotoNoCompress(View view) {
        Intent takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
        if (takePictureIntent.resolveActivity(getPackageManager()) != null) {

            String filename = new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.CHINA)
                    .format(new Date()) + ".png";
            File file = new File(Environment.getExternalStorageDirectory(), filename);
            mCurrentPhotoPath = file.getAbsolutePath();
          
						// 核心就是这一行代码
            Uri fileUri = FileProvider.getUriForFile(this, "com.siyee.android7.fileprovider", file);
            takePictureIntent.putExtra(MediaStore.EXTRA_OUTPUT, fileUri);
            startActivityForResult(takePictureIntent, REQUEST_CODE_TAKE_PHOTO);
        }
    }

通过FileProvider把file转化为content://uri了

核心代码就这一行了~

1
FileProvider.getUriForFile(this, "com.siyee.android7.fileprovider", file);

第二个参数就是我们配置的authorities，这个很正常了，总得映射到确定的ContentProvider吧~所以需要这个参数。

然后再看一眼我们生成的uri：

1
content://com.siyee.android7.fileprovider/external/20200819-041411.png

可以看到格式为：content://authorities/定义的name属性/文件的相对路径，即name隐藏了可存储的文件夹路径。

兼容

如果使用以上代码跑在7.0以上系统的手机没有问题，但是拿回到低版本的手机又会出现崩溃：

1
2
3
4
5
Caused by: java.lang.SecurityException: Permission Denial: opening provider androidx.core.content.FileProvider from ProcessRecord{52b029b8 1670:com.android.camera/u0a36} (pid=1670, uid=10036) that is not exported from uid 10052
at android.os.Parcel.readException(Parcel.java:1465)
at android.os.Parcel.readException(Parcel.java:1419)
at android.app.ActivityManagerProxy.getContentProvider(ActivityManagerNative.java:2848)
at android.app.ActivityThread.acquireProvider(ActivityThread.java:4399)

因为低版本的系统，仅仅是把这个当成一个普通的Provider在使用，而我们没有授权，contentprovider的export设置的也是false；导致Permission Denial。

而解决的办法就是授权了。通过grantUriPermission(String toPackage, Uri uri, int modeFlags)和revokeUriPermission(Uri uri, int modeFlags)方法。

可以看到grantUriPermission需要传递一个包名，就是你给哪个应用授权，但是很多时候，比如分享，我们并不知道最终用户会选择哪个app，所以我们可以这样：

1
2
3
4
5
6
List<ResolveInfo> resInfoList = context.getPackageManager()
            .queryIntentActivities(intent, PackageManager.MATCH_DEFAULT_ONLY);
for (ResolveInfo resolveInfo : resInfoList) {
    String packageName = resolveInfo.activityInfo.packageName;
    context.grantUriPermission(packageName, uri, flag);
}

根据Intent查询出的所以符合的应用，都给他们授权~~

恩，你可以在不需要的时候通过revokeUriPermission移除权限~

那么增加了授权后的代码是这样的：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
public void takePhotoNoCompress(View view) {
    Intent takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
    if (takePictureIntent.resolveActivity(getPackageManager()) != null) {

        String filename = new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.CHINA)
                .format(new Date()) + ".png";
        File file = new File(Environment.getExternalStorageDirectory(), filename);
        mCurrentPhotoPath = file.getAbsolutePath();

        Uri fileUri = FileProvider.getUriForFile(this, "com.siyee.android7.fileprovider", file);

        List<ResolveInfo> resInfoList = getPackageManager()
                .queryIntentActivities(takePictureIntent, PackageManager.MATCH_DEFAULT_ONLY);
        for (ResolveInfo resolveInfo : resInfoList) {
            String packageName = resolveInfo.activityInfo.packageName;
            grantUriPermission(packageName, fileUri, Intent.FLAG_GRANT_READ_URI_PERMISSION
                    | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
        }

        takePictureIntent.putExtra(MediaStore.EXTRA_OUTPUT, fileUri);
        startActivityForResult(takePictureIntent, REQUEST_CODE_TAKE_PHOTO);
    }
}

但是这样的做法相对麻烦，我们可以对系统版本进行判断高版本用FileProvider.getUriForFile，低版本继续使用Uri.fromFile即可。

1
2
3
4
5
6
Uri fileUri = null;
if (Build.VERSION.SDK_INT >= 24) {
    fileUri = FileProvider.getUriForFile(this, "com.siyee.android7.fileprovider", file);
} else {
    fileUri = Uri.fromFile(file);
}

理解FileProvider

定义FileProvider

直接使用FileProvider本身或者它的子类，需要在AndroidManifest.xml文件中声明组件的相关属性，包括：

  • android:name，对应属性值：android.support.v4.content.FileProvider或者子类完整路径
  • android:authorities，对应属性值是一个常量，通常定义的方式packagename.fileprovider，例如：cn.teachcourse.fileprovider
  • android:exported，对应属性值是一个boolean变量，设置为false
  • android:grantUriPermissions，对应属性值也是一个boolean变量，设置为true，允许获得文件临时的访问权限
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<manifest>
    ...
    <application>
        ...
        <provider
					android:name="androidx.core.content.FileProvider"
					android:authorities="com.siyee.android7.fileprovider"
					android:exported="false"
					android:grantUriPermissions="true">
					<meta-data
						android:name="android.support.FILE_PROVIDER_PATHS"
						android:resource="@xml/file_paths"/>
					</provider>
        ...
    </application>
</manifest>

指定授予临时访问权限的文件目录

想要关联res/xml文件夹下创建的file_paths.xml文件，需要在<provider>标签内，添加<meta-data>子标签，设置<meta-data>标签的属性值，包括：

  • android:name，对应属性值是一个固定的系统常量android.support.FILE_PROVIDER_PATHS
  • android:resource，对应属性值指向我们的xml文件@xml/file_paths

在xml文件中指定文件存储的区块和区块的相对路径，在<paths>根标签中添加<files-path>子标签（稍后详细列出所有子标签），设置子标签的属性值，包括：

  • name，是一个虚设的文件名（可以自由命名），对外可见路径的一部分，隐藏真实文件目录
  • path，是一个相对目录，相对于当前的子标签<files-path>根目录
  • <files-path>，表示内部内存卡根目录，对应根目录等价于Context.getFilesDir()，查看完整路径：
    /data/user/0/com.siyee.demos/files
  • 代码如下：
1
2
3
4
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <files-path name="my_images" path="images/"/>
    ...
</paths>

<paths>根标签下可以添加的子标签也是有限的，参考官网的开发文档，除了上述的提到的<files-path>这个子标签外，还包括下面几个：

  1. <cache-path>，表示应用默认缓存根目录，对应根目录等价于getCacheDir()，查看完整路径：/data/user/0/com.siyee.demos/cache
  2. <external-path>，表示外部内存卡根目录，对应根目录等价于
    Environment.getExternalStorageDirectory()，
    查看完整路径：/storage/emulated/0
  3. <external-files-path>，表示外部内存卡根目录下的APP公共目录，对应根目录等价于
    Context#getExternalFilesDir(String) Context.getExternalFilesDir(null)，
    查看完整路径：
    /storage/emulated/0/Android/data/com.siyee.demos/files/Download
  4. <external-cache-path>，表示外部内存卡根目录下的APP缓存目录，对应根目录等价于Context.getExternalCacheDir()，查看完整路径：
    /storage/emulated/0/Android/data/com.siyee.demos/cache

最终，在file_provider.xml文件中，添加上述5种类型的临时访问权限的文件目录，代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <!--
    1、name对应的属性值，开发者可以自由定义；
    2、path对应的属性值，当前external-path标签下的相对路径
    比如：/storage/emulated/0/92Recycle-release.apk
    sdcard路径：/storage/emulated/0(WriteToReadActivity.java:176)
                      at cn.teachcourse.nougat.WriteToReadActivity.onClick(WriteToReadActivity.java:97)
                      at android.view.View.performClick(View.java:5610)
                      at android.view.View$PerformClick.run(View.java:22265)
    相对路径：/
    -->
    <!--1、对应内部内存卡根目录：Context.getFileDir()-->
    <files-path
        name="int_root"
        path="/" />
    <!--2、对应应用默认缓存根目录：Context.getCacheDir()-->
    <cache-path
        name="app_cache"
        path="/" />
    <!--3、对应外部内存卡根目录：Environment.getExternalStorageDirectory()-->
    <external-path
        name="ext_root"
        path="pictures/" />
    <!--4、对应外部内存卡根目录下的APP公共目录：Context.getExternalFileDir(String)-->
    <external-files-path
        name="ext_pub"
        path="/" />
    <!--5、对应外部内存卡根目录下的APP缓存目录：Context.getExternalCacheDir()-->
    <external-cache-path
        name="ext_cache"
        path="/" />
</paths>

生成指定文件的Content URI

Content URI方便与另一个APP应用程序共享同一个文件，共享的方式通过ContentResolver.openFileDescriptor获得一个ParcelFileDescriptor对象，读取文件内容。那么，如何生成一条完整的Content URI呢？TeachCourse总结后，概括为三个步骤，第一步：明确上述5种类型中的哪一种，第二步：明确指定文件的完整路径（包括目录、文件名），第三步：调用getUriForFile()方法生成URI

1
2
3
File imagePath = new File(Environment.getExternalStorageDirectory(), "download");
File newFile = new File(imagePath, "default_image.jpg");
Uri contentUri = getUriForFile(getContext(), "com.siyee.android7.fileprovider", newFile);

授予Content URI临时访问权限

上一步获得的Content URI，并没有获得指定文件的读写权限，想要获得文件的读写权限需要调用Context.grantUriPermission(package, Uri, mode_flags)方法，该方法向指定包名的应用程序申请获得读取或者写入文件的权限，参数说明如下：

  • package，指定应用程序的包名，Android Studio真正的包名指build.gradle声明的applicationId属性值；getPackageName()指AndroidManifest.xml文件声明的package属性值，如果两者不一致，就不能提供getPackageName()获取包名，否则报错！
  • Uri，指定请求授予临时权限的URI，例如：contentUri
  • mode_flags，指定授予临时权限的类型，选择其中一个常量或两个：Intent.FLAG_GRANT_READ_URI_PERMISSION，Intent.FLAG_GRANT_WRITE_URI_PERMISSION

授予文件的临时读取或写入权限，如果不再需要了，TeachCourse该如何撤销授予呢？撤销权限有两种方式：第一种：通过调用revokeUriPermission()撤销，第二种：重启系统后自动撤销

使用FileProvider兼容安装apk

正常我们在编写安装apk的时候，是这样的：

1
2
3
4
5
6
7
8
public void installApk(View view) {
    File file = new File(Environment.getExternalStorageDirectory(), "testandroid7-debug.apk");

    Intent intent = new Intent(Intent.ACTION_VIEW);
    intent.setDataAndType(Uri.fromFile(file),
            "application/vnd.android.package-archive");
    startActivity(intent);
}

拿个7.0的原生手机跑一下，android.os.FileUriExposedException又来了~~

1
android.os.FileUriExposedException: file:///storage/emulated/0/testandroid7-debug.apk exposed beyond app through Intent.getData()

好在有经验了，简单修改下uri的获取方式。

1
2
3
4
5
if (Build.VERSION.SDK_INT >= 24) {
    fileUri = FileProvider.getUriForFile(this, "com.zhy.android7.fileprovider", file);
} else {
    fileUri = Uri.fromFile(file);
}

再跑一次，没想到还是抛出了异常（警告，没有Crash）:

1
2
3
java.lang.SecurityException: Permission Denial: 
opening provider android.support.v4.content.FileProvider 
        from ProcessRecord{18570a 27107:com.google.android.packageinstaller/u0a26} (pid=27107, uid=10026) that is not exported from UID 10004123

可以看到是权限问题，对于权限我们刚说了一种方式为grantUriPermission，这种方式当然是没问题的啦~

加上后运行即可。

其实对于权限，还提供了一种方式，即：

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

我们可以在安装包之前加上上述代码，再次运行正常啦~

现在我有两个非常疑惑的问题：

  • 问题1：为什么刚才拍照的时候，Android 7的设备并没有遇到Permission Denial的问题？

恩，之所以不需要权限，主要是因为Intent的action为ACTION_IMAGE_CAPTURE，当我们startActivity后，会辗转调用Instrumentation的execStartActivity方法，在该方法内部，会调用intent.migrateExtraStreamToClipData();方法。

该方法中包含：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
        || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
        || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
    final Uri output;
    try {
        output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
    } catch (ClassCastException e) {
        return false;
    }
    if (output != null) {
        setClipData(ClipData.newRawUri("", output));
        addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
        return true;
    }
}

可以看到将我们的EXTRA_OUTPUT，转为了setClipData，并直接给我们添加了WRITE和READ权限。

注：该部分逻辑应该是21之后添加的。

  • 问题2：为什么刚才拍照案例的时候，Android 4.4设备遇到权限问题，不通过addFlags这种方式解决？

因为addFlags主要用于setData，setDataAndType以及setClipData（注意：4.4时，并没有将ACTION_IMAGE_CAPTURE转为setClipData实现）这种方式。

所以addFlags方式对于ACTION_IMAGE_CAPTURE在5.0以下是无效的，所以需要使用grantUriPermission，如果是正常的通过setData分享的uri，使用addFlags是没有问题的（可以写个简单的例子测试下，两个app交互，通过content://）。

总结

使用content://替代file://，主要需要FileProvider的支持，而因为FileProvider是ContentProvider的子类，所以需要在AndroidManifest.xml中注册；而又因为需要对真实的filepath进行映射，所以需要编写一个xml文档，用于描述可使用的文件夹目录，以及通过name去映射该文件夹目录。

对于权限，有两种方式：

  • 方式一为Intent.addFlags，该方式主要用于针对intent.setData，setDataAndType以及setClipData相关方式传递uri的。
  • 方式二为grantUriPermission来进行授权

参考资料

https://blog.csdn.net/lmj623565791/article/details/72859156

https://www.cnblogs.com/dazhao/p/6547811.html

https://www.jianshu.com/p/bce6a4c779dd

坚持技术分享，您的支持将鼓励我继续创作！