使用FileProvider解决file:// URI引起的FileUriExposedException

问题

以下是一段简单的代码,它调用系统的相机app来拍摄照片:

void takePhoto(String cameraPhotoPath) {
    File cameraPhoto = new File(cameraPhotoPath);
    Intent takePhotoIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
    takePhotoIntent.putExtra(MediaStore.EXTRA_OUTPUT, Uri.fromFile(cameraPhoto));
    startActivityForResult(takePhotoIntent, REQUEST_TAKE_PHOTO);
}

在一般情况下,运行没有任何问题;可是当把targetSdkVersion指定成24及之上并且在API>=24的设备上运行时,会抛出异常:

android.os.FileUriExposedException:         file:///storage/emulated/0/DCIM/IMG_20170125_144112.jpg exposed beyond app through ClipData.Item.getUri()
    at android.os.StrictMode.onFileUriExposed(StrictMode.java:1799)
    at android.net.Uri.checkFileUriExposed(Uri.java:2346)
    at android.content.ClipData.prepareToLeaveProcess(ClipData.java:832)
    at android.content.Intent.prepareToLeaveProcess(Intent.java:8909)
    ...

原因

我们来看一下FileUriExposedException文档

The exception that is thrown when an application exposes a file:// Uri to another app.

This exposure is discouraged since the receiving app may not have access to the shared path. For example, the receiving app may not have requested the READ_EXTERNAL_STORAGE runtime permission, or the platform may be sharing the Uri across user profile boundaries.

Instead, apps should use content:// Uris so the platform can extend temporary permission for the receiving app to access the resource.

This is only thrown for applications targeting N or higher. Applications targeting earlier SDK versions are allowed to share file:// Uri, but it's strongly discouraged.

总而言之,就是Android不再允许在app中把file://Uri暴露给其他app,包括但不局限于通过Intent或ClipData 等方法。

原因在于使用file://Uri会有一些风险,比如:

  • 文件是私有的,接收file://Uri的app无法访问该文件。
  • 在Android6.0之后引入运行时权限,如果接收file://Uri的app没有申请READ_EXTERNAL_STORAGE权限,在读取文件时会引发崩溃。

因此,google提供了FileProvider,使用它可以生成content://Uri来替代file://Uri。


解决方案

先上解决方案,感兴趣的同学可以看下一节FileProvider的具体讲解。

首先在AndroidManifest.xml中添加provider

<provider
    android:name="android.support.v4.content.FileProvider"
    android:authorities="${applicationId}.fileprovider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/provider_paths" />
</provider>

res/xml/provider_paths.xml

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

然后修改代码

void takePhoto(String cameraPhotoPath) {
    File cameraPhoto = new File(cameraPhotoPath);
    Intent takePhotoIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
    Uri photoUri = FileProvider.getUriForFile(
                this,
                getPackageName() + ".provider",
                cameraPhoto);
    takePhotoIntent.putExtra(MediaStore.EXTRA_OUTPUT, photoUri);
    startActivityForResult(takePhotoIntent, REQUEST_TAKE_PHOTO);
}

FileProvider

使用content://Uri的优点:

  • 它可以控制共享文件的读写权限,只要调用Intent.setFlags()就可以设置对方app对共享文件的访问权限,并且该权限在对方app退出后自动失效。相比之下,使用file://Uri时只能通过修改文件系统的权限来实现访问控制,这样的话访问控制是它对所有 app都生效的,不能区分app。
  • 它可以隐藏共享文件的真实路径。

定义FileProvider

AndroidManifest.xml<application>节点中添加<provider>

<provider
    android:name="android.support.v4.content.FileProvider"
    android:authorities="${applicationId}.fileprovider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/provider_paths" />
</provider>
  • android:authorities是用来标识provider的唯一标识,在同一部手机上一个"authority"串只能被一个app使用,冲突的话会导致app无法安装。我们可以利用manifest placeholders来保证authority的唯一性。

  • android:exported必须设置成false,否则运行时会报错java.lang.SecurityException: Provider must not be exported

  • android:grantUriPermissions用来控制共享文件的访问权限,也可以在java代码中设置。

指定路径和转换规则

FileProvider会隐藏共享文件的真实路径,将它转换成content://Uri路径,因此,我们还需要设定转换的规则。android:resource="@xml/provider_paths"这个属性指定了规则所在的文件。

res/xml/provider_paths.xml:

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

<paths>中可以定义以下子节点

子节点 对应路径
files-path Context.getFilesDir()
cache-path Context.getCacheDir()
external-path Environment.getExternalStorageDirectory()
external-files-path Context.getExternalFilesDir(null)
external-cache-path Context.getExternalCacheDir()

file://content://的转换规则:

  1. 替换前缀:把file://替换成content://${android:authorities}
  2. 匹配和替换
    1. 遍历<paths>的子节点,找到最大能匹配上文件路径前缀的那个子节点。
    2. 用path的值替换掉文件路径里所匹配的内容。
  3. 文件路径剩余的部分保持不变。
转换示意图

需要注意的是,文件的路径必须包含在xml中,也就是2.1中必须能找到一个匹配的子节点,否则会抛出异常:

java.lang.IllegalArgumentException: Failed to find configured root that contains /data/data/com.xxx/cache/test.txt
    at android.support.v4.content.FileProvider$SimplePathStrategy.getUriForFile(FileProvider.java:679)
    at android.support.v4.content.FileProvider.getUriForFile(FileProvider.java:378)
    ...

代码中生成Content Uri

File imagePath = new File(Context.getFilesDir(), "images");
File newFile = new File(imagePath, "2016/pic.png");
Uri contentUri = getUriForFile(getContext(), getPackageName() + ".fileprovider", newFile);

设置文件的访问权限

有两种设置权限的办法:

  • 调用Context.grantUriPermission(package, uri, modeFlags)。这样设置的权限只有在手动调用Context.revokeUriPermission(uri, modeFlags)或系统重启后才会失效。
  • 调用Intent.setFlags()来设置权限。权限失效的时机:接收IntentActivity所在的stack销毁时。

题外话:ContentProvider的一个小技巧

许多Android SDK在使用前往往需要使用者调用初始化代码:SomeSdk.init(Context),其实借助ContentProvider就可以把这一步省略掉。

原理是在SDK的AndroidManifest里注册一个ContentProvider,在它的OnCreate中进行SDK的初始化工作。ContentProvider会在app进程被创建时创建,并且在它的onCreate里可以拿到Context的引用。

具体实现可以参照How does Firebase initialize on Android?


参考文档


打个广告

美团平台及酒旅事业群招人啦,欢迎加入我们!
我可以帮忙内推,简历请发到我邮箱gelitenight@gmail.com

【美团网】高级Android开发工程师
工作内容: 负责美团酒店、旅游产品 Android 客户端的设计、开发与改进。

  1. 3年以上工作经验,2年以上Android开发经验;
  2. 熟悉Android系统,熟悉Android软件的开发、测试、分发流程;
  3. 良好的编程风格,扎实的编程基础和数据结构算法基础;
  4. 熟悉移动网络的特性,对网络编程和常用网络协议有较深刻理解和经验;
  5. 有一定的架构设计能力,良好的编码能力,编写文档能力;
  6. 热爱互联网和新技术,具有极强的快速学习能力;
  7. 有以下特征优先考虑:
    • 有开源作品或技术博客(需原创技术文章);
    • 熟悉Socket编程。

北京、上海、厦门、成都都有职位,更多职位请见职位列表


本文遵循“署名-非商业性使用-相同方式共享”的创作共同协议,欢迎转载,转载时请注明作者和出处。
作者: gelitenight
出处: 使用FileProvider解决file:// URI引起的FileUriExposedException

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,418评论 25 707
  • 如何创建apps与设备之间共享数据的app. Sharing Simple Data 使用Intent和Actio...
    nancymi阅读 582评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • 别人有的是背景,你就只有背影 丑小鸭能变成天鹅,不是因为她有多努力,而是她爸妈是白天鹅。 撩你不是因为你有多优秀,...
    如初见_6208阅读 352评论 0 1
  • 驱车直往六环前,尽采樱桃晏子①边。雨歇日升株转翠,梢头叶下果相连。扶梯缓上高枝摘,换手轻偿满口鲜。行乐也凭诗遣兴,...
    风小扬阅读 1,073评论 5 2