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

問(wèn)題

以下是一段簡(jiǎn)單的代碼灰蛙,它調(diào)用系統(tǒng)的相機(jī)app來(lái)拍攝照片:

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);
}

在一般情況下,運(yùn)行沒有任何問(wèn)題隔躲;可是當(dāng)把targetSdkVersion指定成24及之上并且在API>=24的設(shè)備上運(yùn)行時(shí)摩梧,會(huì)拋出異常:

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)
    ...

原因

我們來(lái)看一下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宣旱,包括但不局限于通過(guò)Intent或ClipData 等方法仅父。

原因在于使用file://Uri會(huì)有一些風(fēng)險(xiǎn),比如:

  • 文件是私有的浑吟,接收file://Uri的app無(wú)法訪問(wèn)該文件笙纤。
  • 在Android6.0之后引入運(yùn)行時(shí)權(quán)限,如果接收file://Uri的app沒有申請(qǐng)READ_EXTERNAL_STORAGE權(quán)限组力,在讀取文件時(shí)會(huì)引發(fā)崩潰省容。

因此,google提供了FileProvider燎字,使用它可以生成content://Uri來(lái)替代file://Uri蓉冈。


解決方案

先上解決方案,感興趣的同學(xué)可以看下一節(jié)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的優(yōu)點(diǎn):

  • 它可以控制共享文件的讀寫權(quán)限寞酿,只要調(diào)用Intent.setFlags()就可以設(shè)置對(duì)方app對(duì)共享文件的訪問(wèn)權(quán)限,并且該權(quán)限在對(duì)方app退出后自動(dòng)失效脱柱。相比之下伐弹,使用file://Uri時(shí)只能通過(guò)修改文件系統(tǒng)的權(quán)限來(lái)實(shí)現(xiàn)訪問(wèn)控制,這樣的話訪問(wèn)控制是它對(duì)所有 app都生效的榨为,不能區(qū)分app惨好。
  • 它可以隱藏共享文件的真實(shí)路徑。

定義FileProvider

AndroidManifest.xml<application>節(jié)點(diǎn)中添加<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是用來(lái)標(biāo)識(shí)provider的唯一標(biāo)識(shí)随闺,在同一部手機(jī)上一個(gè)"authority"串只能被一個(gè)app使用日川,沖突的話會(huì)導(dǎo)致app無(wú)法安裝。我們可以利用manifest placeholders來(lái)保證authority的唯一性矩乐。

  • android:exported必須設(shè)置成false龄句,否則運(yùn)行時(shí)會(huì)報(bào)錯(cuò)java.lang.SecurityException: Provider must not be exported回论。

  • android:grantUriPermissions用來(lái)控制共享文件的訪問(wèn)權(quán)限,也可以在java代碼中設(shè)置分歇。

指定路徑和轉(zhuǎn)換規(guī)則

FileProvider會(huì)隱藏共享文件的真實(shí)路徑傀蓉,將它轉(zhuǎn)換成content://Uri路徑,因此职抡,我們還需要設(shè)定轉(zhuǎn)換的規(guī)則葬燎。android:resource="@xml/provider_paths"這個(gè)屬性指定了規(guī)則所在的文件。

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>中可以定義以下子節(jié)點(diǎn)

子節(jié)點(diǎn) 對(duì)應(yīng)路徑
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://的轉(zhuǎn)換規(guī)則:

  1. 替換前綴:把file://替換成content://${android:authorities}缚甩。
  2. 匹配和替換
    1. 遍歷<paths>的子節(jié)點(diǎn)谱净,找到最大能匹配上文件路徑前綴的那個(gè)子節(jié)點(diǎn)。
    2. 用path的值替換掉文件路徑里所匹配的內(nèi)容擅威。
  3. 文件路徑剩余的部分保持不變岳遥。
轉(zhuǎn)換示意圖

需要注意的是,文件的路徑必須包含在xml中裕寨,也就是2.1中必須能找到一個(gè)匹配的子節(jié)點(diǎn),否則會(huì)拋出異常:

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);

設(shè)置文件的訪問(wèn)權(quán)限

有兩種設(shè)置權(quán)限的辦法:

  • 調(diào)用Context.grantUriPermission(package, uri, modeFlags)派继。這樣設(shè)置的權(quán)限只有在手動(dòng)調(diào)用Context.revokeUriPermission(uri, modeFlags)或系統(tǒng)重啟后才會(huì)失效宾袜。
  • 調(diào)用Intent.setFlags()來(lái)設(shè)置權(quán)限。權(quán)限失效的時(shí)機(jī):接收IntentActivity所在的stack銷毀時(shí)驾窟。

題外話:ContentProvider的一個(gè)小技巧

許多Android SDK在使用前往往需要使用者調(diào)用初始化代碼:SomeSdk.init(Context)庆猫,其實(shí)借助ContentProvider就可以把這一步省略掉。

原理是在SDK的AndroidManifest里注冊(cè)一個(gè)ContentProvider绅络,在它的OnCreate中進(jìn)行SDK的初始化工作月培。ContentProvider會(huì)在app進(jìn)程被創(chuàng)建時(shí)創(chuàng)建,并且在它的onCreate里可以拿到Context的引用恩急。

具體實(shí)現(xiàn)可以參照How does Firebase initialize on Android?


參考文檔


打個(gè)廣告

美團(tuán)平臺(tái)及酒旅事業(yè)群招人啦杉畜,歡迎加入我們!
我可以幫忙內(nèi)推衷恭,簡(jiǎn)歷請(qǐng)發(fā)到我郵箱gelitenight@gmail.com

【美團(tuán)網(wǎng)】高級(jí)Android開發(fā)工程師
工作內(nèi)容: 負(fù)責(zé)美團(tuán)酒店此叠、旅游產(chǎn)品 Android 客戶端的設(shè)計(jì)、開發(fā)與改進(jìn)随珠。

  1. 3年以上工作經(jīng)驗(yàn)灭袁,2年以上Android開發(fā)經(jīng)驗(yàn);
  2. 熟悉Android系統(tǒng)窗看,熟悉Android軟件的開發(fā)茸歧、測(cè)試、分發(fā)流程显沈;
  3. 良好的編程風(fēng)格软瞎,扎實(shí)的編程基礎(chǔ)和數(shù)據(jù)結(jié)構(gòu)算法基礎(chǔ);
  4. 熟悉移動(dòng)網(wǎng)絡(luò)的特性,對(duì)網(wǎng)絡(luò)編程和常用網(wǎng)絡(luò)協(xié)議有較深刻理解和經(jīng)驗(yàn)铜涉;
  5. 有一定的架構(gòu)設(shè)計(jì)能力智玻,良好的編碼能力,編寫文檔能力芙代;
  6. 熱愛互聯(lián)網(wǎng)和新技術(shù)吊奢,具有極強(qiáng)的快速學(xué)習(xí)能力;
  7. 有以下特征優(yōu)先考慮:
    • 有開源作品或技術(shù)博客(需原創(chuàng)技術(shù)文章)纹烹;
    • 熟悉Socket編程页滚。

北京、上海铺呵、廈門裹驰、成都都有職位,更多職位請(qǐng)見職位列表片挂。


本文遵循“署名-非商業(yè)性使用-相同方式共享”的創(chuàng)作共同協(xié)議幻林,歡迎轉(zhuǎn)載,轉(zhuǎn)載時(shí)請(qǐng)注明作者和出處音念。
作者: gelitenight
出處: 使用FileProvider解決file:// URI引起的FileUriExposedException

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末沪饺,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子闷愤,更是在濱河造成了極大的恐慌整葡,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,277評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件讥脐,死亡現(xiàn)場(chǎng)離奇詭異遭居,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)旬渠,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,689評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門俱萍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人告丢,你說(shuō)我怎么就攤上這事鼠次。” “怎么了芋齿?”我有些...
    開封第一講書人閱讀 163,624評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵腥寇,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我觅捆,道長(zhǎng)赦役,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,356評(píng)論 1 293
  • 正文 為了忘掉前任栅炒,我火速辦了婚禮掂摔,結(jié)果婚禮上术羔,老公的妹妹穿的比我還像新娘。我一直安慰自己乙漓,他們只是感情好级历,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,402評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著叭披,像睡著了一般寥殖。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上涩蜘,一...
    開封第一講書人閱讀 51,292評(píng)論 1 301
  • 那天嚼贡,我揣著相機(jī)與錄音,去河邊找鬼同诫。 笑死粤策,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的误窖。 我是一名探鬼主播叮盘,決...
    沈念sama閱讀 40,135評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼霹俺!你這毒婦竟也來(lái)了柔吼?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,992評(píng)論 0 275
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤吭服,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后蝗罗,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體艇棕,經(jīng)...
    沈念sama閱讀 45,429評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,636評(píng)論 3 334
  • 正文 我和宋清朗相戀三年串塑,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了沼琉。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,785評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡桩匪,死狀恐怖打瘪,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情傻昙,我是刑警寧澤闺骚,帶...
    沈念sama閱讀 35,492評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站妆档,受9級(jí)特大地震影響僻爽,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜贾惦,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,092評(píng)論 3 328
  • 文/蒙蒙 一胸梆、第九天 我趴在偏房一處隱蔽的房頂上張望敦捧。 院中可真熱鬧,春花似錦碰镜、人聲如沸兢卵。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,723評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)秽荤。三九已至,卻和暖如春菠发,著一層夾襖步出監(jiān)牢的瞬間王滤,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,858評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工滓鸠, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留雁乡,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,891評(píng)論 2 370
  • 正文 我出身青樓糜俗,卻偏偏與公主長(zhǎng)得像踱稍,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子悠抹,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,713評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,104評(píng)論 25 707
  • 如何創(chuàng)建apps與設(shè)備之間共享數(shù)據(jù)的app. Sharing Simple Data 使用Intent和Actio...
    nancymi閱讀 594評(píng)論 0 0
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理珠月,服務(wù)發(fā)現(xiàn),斷路器楔敌,智...
    卡卡羅2017閱讀 134,654評(píng)論 18 139
  • 別人有的是背景卵凑,你就只有背影 丑小鴨能變成天鵝庆聘,不是因?yàn)樗卸嗯Γ撬謰屖前滋禊Z勺卢。 撩你不是因?yàn)槟阌卸鄡?yōu)秀伙判,...
    如初見_6208閱讀 358評(píng)論 0 1
  • 驅(qū)車直往六環(huán)前,盡采櫻桃晏子①邊黑忱。雨歇日升株轉(zhuǎn)翠宴抚,梢頭葉下果相連。扶梯緩上高枝摘甫煞,換手輕償滿口鮮菇曲。行樂(lè)也憑詩(shī)遣興,...
    風(fēng)小揚(yáng)閱讀 1,085評(píng)論 5 2