Android7.0 FileProvider的使用

一、前言

从 Android 7.0 开始,安卓系统不允许在应用间使用 file:// 形式的 Uri,来传递一个 FIle,否则就会抛出 FileUriExposedException 异常,因为安卓出于以下原因考虑:

  • 接收方 app 可能没有申请 Manifest.permission.READ_EXTERNAL_STORAGE 权限,从而导致崩溃

那么我们如果在应用间传递一个文件呢?
官方给出了解决方案,就是使用 content:// 形式的 Uri 来使接收方 app 获得临时权限。

虽然只有在 Android 7.0 以上的系统才会抛出异常,但是还是强烈建议不要使用 file:// 的形式来传递文件


二、使用 FileProvider

FileProvider 是 ContentProvider 的子类,它提供更高级别的文件访问安全性,是 Android 安全基础结构的关键部分。

在 app 开发过程中需要用到 FileProvider 的场景有使用相机拍照、图片裁剪。

通过以下步骤来使用 FileProvider:

  1. 定义 FileProvider

  2. 指定可共享的文件

  3. 生成 content:// 形式的 Uri

  4. 授予 Uri 临时权限

  5. 向另一个应用提供 content:// 形式的 Uri

    定义 FileProvider

    • 在 Manifest.xml 中增加 <provider> 标签
    • android:name 固定都写 androidx.core.content.FileProvider
    • android:authorities 设为 包名.fileprovider,例如 com.mydomain.fileprovider
    • android:exported 固定都写 false
    • android:grantUriPermissions 固定都写 true,来为文件授予临时访问权限

    完整示例如下:

<manifest>
    ...
    <application>
        ...
        <provider
            android:name="androidx.core.content.FileProvider"
            android:authorities="com.mydomain.fileprovider"
            android:exported="false"
            android:grantUriPermissions="true">
            ...
        </provider>
        ...
    </application>
</manifest>

如果你需要自定义 FileProvider,那么就将 android:name 标签设为自己 FileProvider 的完整目录,比如 support 包就为 android.support.v4.content.FileProvider

指定可共享的文件

FileProvider 只能为预先指定过目录的文件生成 content:// 形式的 Uri。要指定目录,需要在 xml 格式的文件中使用 <paths> 标签来指定其存储路径,例如:

<paths xmlns:android="http://schemas.android.com/apk/res/android">
    <files-path name="my_images" path="images/"/>
</paths>

解释一下:

  • file-path,等同于 Context.getFilesDir(),其目录为/data/user/0/包名/files
  • name,为了加强安全性,此值将隐藏您要共享的子目录的名称
  • path,会在 /data/user/0/包名/files 目录下会生成一个 images 的文件夹

也就是说现在你的 /data/user/0/包名/files/images/ 下面的文件具备了提供给外部应用共享的能力了

当然,除了 files-path 标签之外还有许多标签,道理都是一样的,只是路径改变了而已

Context.getFilesDir()   /data/user/0/com.mydomain/files
<files-path name="name" path="path/"/>

Context.getFilesDir()   /data/user/0/com.mydomain/cache
<cache-path name="name" path="path" />

Environment.getExternalStorageDirectory()   /storage/emulated/0
<external-path name="name" path="path" />

Context.getExternalFilesDir(null)   /storage/emulated/0/Android/data/com.mydomain/files
<external-files-path name="name" path="path" />

Context.getExternalCacheDir()   /storage/emulated/0/Android/data/com.mydomain/cache
<external-cache-path name="name" path="path" />

Context.getExternalMediaDirs()   /storage/emulated/0/Android/media/com.mydomain
<external-media-path name="name" path="path" />

最后,将这个 xml 文件应用在你的应用中,假设 xml 名为 res/xml/file_paths,那么示例如下:

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

生成 content:// 形式的 Uri

生成一个 content:// 形式的 Uri 可以分为三步:

  • 在具有共享能力的文件夹下创建一个文件夹
  • 在上面的文件夹中创建图片文件
  • 在 getUriForFile 方法中传入 authority 和 上面创建的图片文件,返回获得 content:// 形式的 Uri

代码如下:

File imagePath = new File(Context.getFilesDir(), "images");
File newFile = new File(imagePath, "default_image.jpg");
if (!imagePath.exists()) {
    imagePath.mkdirs();
}
Uri contentUri = getUriForFile(getContext(), "com.mydomain.fileprovider", newFile);

最终返回的 contentUri 为 content://com.mydomain.fileprovider/my_images/default_image.jpg

授予 Uri 临时权限

通过以下任意一步,来为 getUriForFile 返回的 uri 授予访问权限

  • 使用 Context.grantUriPermission(package, Uri, mode_flags) 。package 参数用来指定获取临时访问权限的包名,mode_flags 设置为 Intent.FLAG_GRANT_READ_URI_PERMISSIONIntent.FLAG_GRANT_WRITE_URI_PERMISSION 或两者都设置
  • 调用 Intent 的 setData() 方法,把 uri 传入
  • 调用 Intent 的 setFlags() 方法,设置 Intent.FLAG_GRANT_READ_URI_PERMISSIONIntent.FLAG_GRANT_WRITE_URI_PERMISSION 或两者都设置

注意:当接收 Activity 的堆栈处于活动状态时,在 Intent 中授予的权限仍然有效。堆栈完成后,权限将自动删除。在客户端应用程序中授予一个 Activity 的权限会自动扩展到该应用程序的其他组件。

向另一个应用提供 content:// 形式的 Uri

传递一个 content:// 形式的 Uri 给其他应用有许多方式,最常用的一种是通过 startActivityForResult(),将 Intent 传递给另一个应用。


实现选择图片、拍照、裁剪| 本文源码:https://github.com/Linfeng1028/FileProvider

参考文章:https://developer.android.com/reference/androidx/core/content/FileProvider?hl=en

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355

推荐阅读更多精彩内容