FileProvider是什么?
FileProvider
是安卓7.0以上版本因为谷歌官方对StrictMode
(严格模式)的开启而产生的安全机制的产物(也就是说,在7.0以下是不需要它的),它继承自ContentProvider
。
那安卓7.0以上版本我就一定需要它吗?
不是。只有在你需要把文件在2个(或以上)app之间交互的时候才需要它。
有人说我也没打算把我的app的数据给别的app或者需要别的app给我数据呀?其实不然,不一定其他app是指第三方app,还包括系统app,比如:系统相机拍照(让系统相机把照片保存到你指定的路径)?要不再把照片给裁剪一下(uCrop
中的UCrop.of(xxx).start()
方法其实也是用startActivityForResult(xxx)
方法)?检测到新版本时候再自动安装一下(把需要安装的apk包给系统安装器来安装)?
总的来说就一句话:只要你需要把文件地址(比如:file://xxx/xx
)用Intent
传递的时候就必须用它。
怎么用?
简单来说就是把file://xxx/xx
这种File格式地址改造为Uri
格式地址content://xxx/xx
。
那怎么改呢?很简单:Uri uri = FileProvider.getUriForFile(context,authority,file);
,第2个参数待会儿再讲,第3个参数就是需要被改造的File文件,这个Uri的路径格式就是上面提到的content://xxx/xx
。
但是,在使用这个方法之前还有2个前提步骤需要先做:
- 前面提到过,
FileProvider
继承自ContentProvider
,所以自然需要在AndroidManifest.xml
里先声明它:
<provider
android:name="androidx.core.content.FileProvider"
android:authorities="${applicationId}.my_test_file_provider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/my_file_paths">
</meta-data>
</provider>
简单作一下解释:
android:name
:实际解析处理这个provider
的FileProvider
,这个一般就用系统帮我实现的androidx.core.content.FileProvider
。不一定非要androidx
里的,v4
包也有这种FileProvider
。当然,你也可以自己实现一个。
android:authorities
:前面提到的.getUriForFile(xxx,authority,xxx)
就是它。作用就是用它来匹配找到对应该使用哪个provider
的。值得注意的是,这个值在一个app中必须是唯一的,所以最好根据${applicationId}
来让gradle
来自动生成。不过也不是一定要这么搞,如果这个provider
本身就是app
里使用,并不是作为一个module
或lib
来使用的话,你也可以写死。(它本质是一个字符串而已,但是很多博文都是${applicationId}.fileProvider
,其实大可不必,你随便写一个都行,只要在上面那个方法的第二个字段跟它一样就行。)
android:exported
:是否需要公开这个provider
? 一般我们单进程干活的app都设置为false就行
android:grantUriPermissions
:是否授权这个文件给第三方。更多信息可以自行了解一下Context.grantUriPermission(toPackage,uri,modeFlags)
这个方法
meta-data
里的android:name
:也是固定值不用动,源码里就是写死的用这个值来解析xml的
meta-data
里的android:resource
:需要自己新建一个文件res/xml/my_file_paths.xml
,路径与文件名就是这个值。
- 在自己新建的
res/xml/my_file_paths.xml
里写下如下代码:
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
<external-files-path name="xxx" path="xxxx" />
</paths>
paths
里值可以是如下几个:
<root-path name="xxx" path="xxxx" /> <!-- 对应/跟目录 -->
<files-path name="xxx" path="xxxx" /> <!-- 对应context.getFilesDir()获取到的目录-->
<cache-path name="xxx" path="xxxx" /> <!-- 对应context.getCacheDir()获取到的目录 -->
<external-path name="xxx" path="xxxx" /> <!-- 对应Environment.getExternalStorageDirectory()获取到的目录 -->
<external-files-path name="xxx" path="xxxx" /> <!-- 对应context.getExternalFilesDir(type)获取到的目录,这个type其实就是拼接在当前这个方法获取到的路径的下一级。比如:/storage/emulated/0/Android/data/com.example.myapp/files/type -->
<external-cache-path name="xxx" path="xxxx" /> <!-- 对应context.getExternalCacheDir(type)获取到的目录 -->
<external-media-path name="xxx" path="xxxx" /> <!-- 对应context.getExternalMediaDirs()[0]获取到的目录 -->
上面的name
里的xxx
是用作生成的Uri
格式路径的中间路径,比如:content://com.example.myapp/xxx/test1.jpg
上面的path
里的xxxx
是用作生成File
格式路径的中间路径,比如:
/storage/emulated/0/Android/data/com.example.myapp/files/xxxx/test1.jpg
上面每个值后面的注释就是上面这个File
格式对应的,比如:external-files-path
对应的context.getExternalFilesDir(type)
获取到的值----/storage/emulated/0/Android/data/com.example.myapp/files
也就是说,当需要传递某个文件时,你可以用以上context.getXxxDir()
方法的路径来选择具体在paths.xml
里写对应哪个值。还是最开始讲的那句:其目的无非就是把File
的路径转为Uri
来暴露给其他app
。
好了,至此讲得差不多。