Android 适配 - FileProvider
前因
响应 Google 号召,App 适配 Android 8.0 之上。只包括我们 App 中遇到的情况进行记录。
参考了 FileProvider
文档和网络上可以搜索的一些资料。
适配核心
本适配的核心就是 FileProvider
的使用。
AndroidManifest 适配
在 application 节点里面增加一个 provider 节点。
<manifest>
...
<application>
...
<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>
</appliction>
</manifest>
复制代码
上面的写法基本是固定的,很多项都是可以修改,但不建议做,下面只是记录一下。
可修改项 1
android:name="androidx.core.content.FileProvider"
复制代码
上面为指定提供服务的 Provider 类。如上是 Android androidx 包提供的类,可以自定义。可以使用ContentProvider提供服务的目标即可。
可修改项 2
android:authorities="${applicationId}.fileProvider"
复制代码
唯一字符串即可,上面为一般常用的写法。
可修改项 3
android:name="android.support.FILE_PROVIDER_PATHS"
复制代码
是可以修改,但是如果没有自己实现 Provider ,这个值只能是这个。这个字符串是在类 FileProvider
里面定义的。
可修改项 4
android:resource="@xml/file_paths"
复制代码
定义了类 FileProvider
使用的配置文件,文件名字不违法命名规范情况下随意。
增加一个特定的ContentProvider
,FileProvider
,包名androidx.core.content
。
FileProvider 适配文件
文件地址 res/xml/file_paths.xml
空文件内容如下
<?xml version="1.0" encoding="utf-8"?>
<paths>
</paths>
复制代码
里面的具体配置为,Android Studio 提示为这五个地方。
<files-path name="name" path="path" />
<cache-path name="name" path="path" />
<external-path name="name" path="path" />
<external-files-path name="name" path="path" />
<external-cache-path name="name" path="path" />
复制代码
网站介绍上还有一个
<!-- this directory is only available on API 21+ devices. -->
<external-media-path name="name" path="path" />
复制代码
代码里面可以看到还有一个
<!-- 这个定义的根目录是 / -->
<root-path name="name" path="path" />
复制代码
上面各个 -path
的区别是定义的根目录不同。
-path | 根目录 |
---|---|
files-path | Context.getFilesDir() |
cache-path | Context.getCacheDir() |
external-path | Environment.getExternalStorageDirectory() |
external-files-path | Context.getExternalFilesDir(null) |
external-cache-path | Context.getExternalCacheDir() |
external-media-path | Context.getExternalMediaDirs() |
root-path | / |
Path 节点里面的 name 属性
唯一不重复
Path 节点里面的 path 属性
文件夹名字,自动包括此文件夹下面的子目录
例子:
<external-path name="pic" path="Pictures" />
复制代码
这样定义后,/sdcard/Pictures
里面的所有文件,都可以从自己的App里面发出到其他App中使用。
具体应用
我们 App 涉及到这个地方不多。都是简单的应用。
图片分享
场景,App 内部生成一张图片,并使用系统分享。
核心代码
Uri uri = null;
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
uri = FileProvider.getUriForFile(this, getPackageName() + ".fileProvider", file);
} else {
uri = Uri.fromFile(file);
}
复制代码
视频播放
有个功能视频播放使用的系统播放器,同时有视频异步下载。如果下载完成,播放本地视频。会使用这个功能。
核心代码
Uri uri = null;
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
uri = FileProvider.getUriForFile(this, getPackageName() + ".fileProvider", file);
} else {
uri = Uri.fromFile(file);
}
// 上面的和图片分享一致。但需要额外增加一行权限代码
intent.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
复制代码
总结
相对而言,这个适配是比较简单的。我认为需要注意的有两个点。
- 要全部修改,不能有遗漏。包括代码和配置
- 版本判断