Android之FileProvider详解

简介

Android 7.0 之前,文件的 Urifile:// 形式提供给其他 app 访问。

Android 7.0 之后,分享文件的 Uri 发生了变化。为了安全起见,file:// 形式的Uri 不能正常访问。官方提供了 FileProviderFileProvider生成的Uri会以content://的形式分享给其他app使用。

content形式的Uri可以让其他app临时获得读取(Read)和写入(Write)权限,只要我们在创建 Intent 时,使用 Intent.setFlags() 添加权限。只要接收Uriapp在接收的Activity任务栈中处于活动状态,添加的权限就会一直有效,直到app被任务栈移除。

目的

7.0 以前,为了访问 file:// 形式的 Uri,我们必须修改文件的权限。修改后的权限对所有 app 都是有效的,这样的行为是不安全的。content://形式的UriAndroid的文件系统更安全,对于分享的文件,接收方 app 只拥有临时的权限,减少了我们app内部的文件被其他 app 恶意操作的行为。

使用

创建FileProvider

manifest文件<application>标签中添加pvodier标签,配置如下。

<manifest>
    ...
    <application>
        <activity>
          .....
      	</activity>
        <provider
            android:name="androidx.core.content.FileProvider"
            android:authorities="com.example.app.fileprovider"
            android:exported="false"
            android:grantUriPermissions="true">
            <meta-data 
                android:name="android.support.FILE_PROVIDER_PATHS"
                android:resource="@xml/file_paths" />
        </provider>
    </application>
</manifest>

android:name指定Provider所在的位置。官方自带的FileProvider已经相当完善,所以我们不需要像ServiceBroadcast一样自定义,直接使用自带的就行,直接输入privoder会自动出现提示。

android:authorities相当于一个用于认证的暗号,在分享文件生成Uri时,会通过它的值生成对应的Uri。值是一个域名,一般格式为<包名>.fileprovider

android:exported设置为falseFileProvider不需要公开。

android:grantUriPermissions设置为true,这样就能授权接收端的app临时访问权限了。

设置共享目录

res/xml中创建一个资源文件(如果xml目录不存在,先创建),名字随便(一般叫file_paths.xml)。

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <files-path name="my_logs" path="logs/"/>
    ...
</paths>

<paths>必须有1个或多个子标签,每个子标签代表要请求的私有文件目录。不同的子标签代表不同的目录类型。

<provider>标签中添加<meta-data>子标签。

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

设置<meta-data>的属性android:name值为android.support.FILE_PROVIDER_PATHS,属性android:resouce的值为刚才我们创建的path文件名。

配置paths

<paths>的每个子标签必须有path属性,代表content Uris的路径。name不需要和path保持一样,只是一个名称。

子标签有以下几种。

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

代表内部存储的files目录,与Context.getFilesDir()获取的路径对应。

最终生成的Uri格式为:authorities/pathname/filename

示例:

content://com.example.app.fileprovider/my_files/filexxx.jpg
cache-path
<cache-path name="name" path="path" />

代表内部存储的cache目录,与Context.getCacheDir()获取的路径对应。

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

代表外部存储(sdcard)的cache目录,与Environment.getExternalStorageDirectory()获取的路径对应。

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

代表app的外部存储的根目录,与Context#getExternalFilesDir(String) Context.getExternalFilesDir(null)获取的路径对应。

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

代表app外部缓存区域的根目录,与Context.getExternalCacheDir()获取的路径对应。

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

代表app外部存储媒体区域的根目录,与Context.getExternalMediaDirs()获取的路径对应。

注意: 这个目录只在API 21(也就是Android 5.0)以上的系统上才存在。

生成Content Uri文件

为了让其他app使用Content Uri,我们的app必须提前生成Uri

File filePath = new File(Context.getFilesDir(), "my_log");
File newFile = new File(filePath, "my_log.log");
// 生成Uri
Uri contentUri = FileProvider.getUriForFile(getContext(), "com.example.app.fileprovider", newFile);

这里注意获取目录,在配置paths时我们讲了,paths的子标签必须和获取目录的代码保持对应。这里我们用的是Context.getFilesDir(),所以paths文件中必须包含files-path子标签,不然别的app获取uri时会出现异常。

最终生成Uri是使用的FileProvider.getUriForFile()。第一个参数就是provider中设置的authorities属性值。

授权临时权限

分享一般只有这读取和写入2种权限,根据需要传入Intent.addFlags()中。

// 这里用的是发送文件。
Intent intent = new Intent(Intent.ACTION_SEND);
intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);

Uri传入Intent

有好几种传入的方式,根据不同的场景使用不同的方式。

为邮箱app分享附件文件
intent.putExtra(Intent.EXTRA_STREAM, contentUri);
其他分享

使用Intent.setDateIntent.setClipData()

intent.setClipDataClipData.newRawUri("", contentUri);

最后使用startActivity(intent)启动分享操作。

参考链接


Android之FileProvider详解

发布者

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注