本文標簽： Android7.0 FileProvider

由於 Android 7.0 或更高版本的系統在國內手機市場上的占比不是很高，很多 Android 開發人員並沒有做 7.0 適配工作，同時測試人員也容易忽視這方面的兼容問題。這導致 7.0 及以上版本的手機用戶在使用到應用部分功能時可能出現 App 崩潰閃退。其中，大部分原因都是由項目中使用到 file:// 類型的 URI 所引發的。本文我們便來一探究竟。

Android 7.0 權限變更

為了提高私有目錄的安全性，防止應用信息的泄漏，從 Android 7.0 開始，應用私有目錄的訪問權限被做限制。具體表現為，開發人員不能夠再簡單地通過 file://

備註：如果你對應用私有目錄不太清楚的話，可以閱讀我的這篇文章：了解 Android 應用的文件存儲目錄，掌握持久化數據的正確姿勢。

同時，也是從 7.0 開始，Android SDK 中的 StrictMode 策略禁止開發人員在應用外部公開 file:// URI。具體表現為，當我們在應用中使用包含 file:// URI 的 Intent 離開自己的應用時，程序會發生故障。原文地址：http://whosmall.com/?post=451

開發中，如果我們在使用 file:// URI 時忽視了這兩條規定，將導致用戶在 7.0 及更高版本系統的設備中使用到相關功能時，出現 FileUriExposedException

FileProvider

作為四大組件之一的 ContentProvider，一直扮演著應用間共享資源的角色。這裏我們要使用到的 FileProvider，就是 ContentProvider 的一個特殊子類，幫助我們將訪問受限的 file:// URI 轉化為可以授權共享的 content:// URI。

第一步，註冊一個 FileProvider

作為系統四大組件之一的 ContentProvider，其子類FileProvider，也同樣需要使用 元素在 Manifest 文件中添加註冊信息，並按照要求設置相關屬性值。

1
2
3
4
5
6
7
8
9
10
11

<application>
    ...
    <provider
        android:name="android.support.v4.content.FileProvider"
        android:authorities="${applicationId}.yourname"
        android:exported="false"
        android:grantUriPermissions="true">
        ...
    </provider>
    ...
</application>

其中，android:authorities 屬性值是一個由 build.gradle 文件中的 applicationId 值和自定義的名稱組成的 Uri 字符串（這樣寫是約定俗成的）。其他屬性值使用如上固定值即可。

第二步，添加共享目錄

在 res/xml 目錄下新建一個 xml 文件，用於存放應用需要共享的目錄文件。這個 xml 文件的內容類似這樣：

1
2
3
4
5

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

元素必須包含一到多個子元素。這些子元素用於指定共享文件的目錄路徑，必須是這些元素之一：

• <files-path>：內部存儲空間應用私有目錄下的 files/ 目錄，等同於 Context.getFilesDir() 所獲取的目錄路徑；

• <cache-path>：內部存儲空間應用私有目錄下的 cache/ 目錄，等同於 Context.getCacheDir() 所獲取的目錄路徑；

• <external-path>：外部存儲空間根目錄，等同於 Environment.getExternalStorageDirectory() 所獲取的目錄路徑；

• <external-files-path>：外部存儲空間應用私有目錄下的 files/ 目錄，等同於 Context.getExternalFilesDir(null) 所獲取的目錄路徑；

• <external-cache-path>：外部存儲空間應用私有目錄下的 cache/ 目錄，等同於 Context.getExternalCacheDir()；

可以看出，這五種子元素基本涵蓋內外存儲空間所有目錄路徑，包含應用私有目錄。同時，每個子元素都擁有 name 和 path 兩個屬性。

其中，path 屬性用於指定當前子元素所代表目錄下需要共享的子目錄名稱。註意：path 屬性值不能使用具體的獨立文件名，只能是目錄名。

而 name 屬性用於給 path 屬性所指定的子目錄名稱取一個別名。後續生成 content:// URI 時，會使用這個別名代替真實目錄名。這樣做的目的，很顯然是為了提高安全性。

如果我們需要分享的文件位於同級別目錄下不同的子目錄中，就需要添加多個子元素逐一指定要分享的文件目錄，或者共享他們通用的父目錄也行。

添加完共享目錄後，再在 <provider> 元素中使用 <meta-data> 元素將 res/xml 中的 path 文件與註冊的 FileProvider 鏈接起來：

1
2
3
4
5
6
7
8
9

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

第三步，生成 Content URI

在 Android 7.0 出現之前，我們通常使用 Uri.fromFile() 方法生成一個 File URI。這裏，我們需要使用 FileProvider 類提供的公有靜態方法 getUriForFile 生成 Content URI。比如：

1
2

Uri contentUri = FileProvider.getUriForFile(this,
                BuildConfig.APPLICATION_ID + ".myprovider", myFile);

需要傳遞三個參數。第二個參數便是 Manifest 文件中註冊 FileProvider 時設置的 authorities 屬性值，第三個參數為要共享的文件，並且這個文件一定位於第二步我們在 path 文件中添加的子目錄裏面。

舉個例子：

1
2
3
4
5
6
7

String filePath = Environment.getExternalStorageDirectory() + "/images/"+System.currentTimeMillis()+".jpg";
File outputFile = new File(filePath);
if (!outputFile.getParentFile().exists()) {
    outputFile.getParentFile().mkdir();
}
Uri contentUri = FileProvider.getUriForFile(this,
        BuildConfig.APPLICATION_ID + ".myprovider", outputFile);

生成的 Content URI 是這樣的：

1

content://com.yifeng.samples.myprovider/my_images/1493715330339.jpg

其中，構成 URI 的 host 部分為 <provider> 元素的 authorities 屬性值（applicationId ＋ customname），path 片段 my_images 為 res/xml 文件中指定的子目錄別名（真實目錄名為：images）。

第四步，授予 Content URI 訪問權限

生成 Content URI 對象後，需要對其授權訪問權限。授權方式有兩種：

第一種方式，使用 Context 提供的 grantUriPermission(package, Uri, mode_flags) 方法向其他應用授權訪問 URI 對象。三個參數分別表示授權訪問 URI 對象的其他應用包名，授權訪問的 Uri 對象，和授權類型。其中，授權類型為 Intent 類提供的讀寫類型常量：

• FLAG_GRANT_READ_URI_PERMISSION

• FLAG_GRANT_WRITE_URI_PERMISSION

或者二者同時授權。這種形式的授權方式，權限有效期截止至發生設備重啟或者手動調用 revokeUriPermission() 方法撤銷授權時。

第二種方式，配合 Intent 使用。通過 setData() 方法向 intent 對象添加 Content URI。然後使用 setFlags() 或者 addFlags() 方法設置讀寫權限，可選常量值同上。這種形式的授權方式，權限有效期截止至其它應用所處的堆棧銷毀，並且一旦授權給某一個組件後，該應用的其它組件擁有相同的訪問權限。

第五步，提供 Content URI 給其它應用

擁有授予權限的 Content URI 後，便可以通過 startActivity() 或者 setResult() 方法啟動其他應用並傳遞授權過的 Content URI 數據。當然，也有其他方式提供服務。

如果你需要一次性傳遞多個 URI 對象，可以使用 intent 對象提供的 setClipData() 方法，並且 setFlags() 方法設置的權限適用於所有 Content URIs。

常見使用場景

前面介紹的內容都是理論部分，在 開發者官方 FileProvider 部分 都有所介紹。接下來我們看看，實際開發一款應用的過程中，會經常遇見哪些 FileProvider 的使用場景。

自動安裝文件

版本更新完成時打開新版本 apk 文件實現自動安裝的功能，應該是最常見的使用場景，也是每個應用必備功能之一。常見操作為，通知欄顯示下載新版本完畢，用戶點擊或者監聽下載過程自動打開新版本 apk 文件。適配 Android 7.0 版本之前，我們代碼可能是這樣：

1
2
3
4
5
6

File apkFile = new File(getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS), "app_sample.apk");

Intent installIntent = new Intent(Intent.ACTION_VIEW);
installIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
installIntent.setDataAndType(Uri.fromFile(apkFile), "application/vnd.android.package-archive");
startActivity(installIntent);

現在為了適配 7.0 及以上版本的系統，必須使用 Content URI 代替 File URI。

在 res/xml 目錄下新建一個 file_provider_paths.xml 文件（文件名自由定義），並添加子目錄路徑信息：

1
2
3
4
5
6

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

    <external-files-path name="my_download" path="Download"/>

</paths>

然後在 Manifest 文件中註冊 FileProvider 對象，並鏈接上面的 path 路徑文件：

1
2
3
4
5
6
7
8
9
10
11

<provider
    android:name="android.support.v4.content.FileProvider"
    android:authorities="com.yifeng.samples.myprovider"
    android:exported="false"
    android:grantUriPermissions="true">

    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/file_provider_paths"/>

</provider>

修改 java 代碼，根據 File 對象生成 Content URI 對象，並授權訪問：

1
2
3
4
5
6
7
8
9

File apkFile = new File(getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS), "app_sample.apk");
Uri apkUri = FileProvider.getUriForFile(this,
        BuildConfig.APPLICATION_ID+".myprovider", apkFile);

Intent installIntent = new Intent(Intent.ACTION_VIEW);
installIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
installIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
installIntent.setDataAndType(apkUri, "application/vnd.android.package-archive");
startActivity(installIntent);

如此這般，便完成了應用中調用系統功能打開 apk 文件的 7.0 適配工作。

調用系統拍照

調用系統拍照功能時也需要傳遞一個 Uri 對象，用於保存圖片至指定目錄，這裏也需要適配 7.0 版本。其他步驟不再贅述，核心 java 代碼如下（路徑不同，註意添加 res/xml 中的 path 文件子目錄）：

1
2
3
4
5
6
7
8
9
10
11

String filePath = Environment.getExternalStorageDirectory() + "/images/"+System.currentTimeMillis()+".jpg";
File outputFile = new File(filePath);
if (!outputFile.getParentFile().exists()) {
    outputFile.getParentFile().mkdir();
}
Uri contentUri = FileProvider.getUriForFile(this,
        BuildConfig.APPLICATION_ID + ".myprovider", outputFile);

Intent intent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
intent.putExtra(MediaStore.EXTRA_OUTPUT, contentUri);
startActivityForResult(intent, REQUEST_TAKE_PICTURE);

調用系統裁剪

調用系統裁剪的過程中涉及到兩個 Uri 對象：inputUri 和 outputUri，較為復雜一些。通常，調用系統裁剪的來源為調用系統拍照或選擇系統相冊。前者返回的是一個 File URI 對象，後者返回的是一個 Content URI 對象。作為裁剪源，我們要做的就是對其做進一步處理。但是不能像上面那樣使用 getUriForFile() 方法，這個並不難理解，因為如果是選擇系統相冊所得的圖片，本身也不一定屬於我們自己的應用。正確處理方式是這樣：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

private Uri getImageContentUri(String path){
    Cursor cursor = getContentResolver().query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI,
            new String[]{MediaStore.Images.Media._ID},
            MediaStore.Images.Media.DATA + "=? ",
            new String[]{path}, null);
    if (cursor != null && cursor.moveToFirst()) {
        int id = cursor.getInt(cursor.getColumnIndex(MediaStore.Images.Media._ID));
        Uri baseUri = Uri.parse("content://media/external/images/media");
        return Uri.withAppendedPath(baseUri, ""+id);
    }else {
        ContentValues contentValues = new ContentValues(1);
        contentValues.put(MediaStore.Images.Media.DATA, path);
        return getContentResolver().insert(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, contentValues);
    }
}

拿到正確的 Content URI 後，作為 inputUri，傳遞給 Intent 對象：

1
2
3
4
5
6
7
8

Intent intent = new Intent("com.android.camera.action.CROP");
intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION | Intent.FLAG_GRANT_READ_URI_PERMISSION);
intent.setDataAndType(inputUri, "image/*");
intent.putExtra("crop", "true");
intent.putExtra("aspectX", 1);
intent.putExtra("aspectY", 1);
intent.putExtra(MediaStore.EXTRA_OUTPUT, Uri.fromFile(outputFile));
startActivityForResult(intent, REQUEST_PICK);

註意：這裏的 outputUri 並沒有改變，仍然使用的是 Uri.fromFile() 方法獲取的 File URI 類型！這是很奇怪的一點，但是不得不這麽做。事實上，使用這種方式調用系統裁剪功能本身就是有問題的！Crop Intent 在官方文檔中本來就無跡可尋，本身就是一種不推薦的用法！取而代之的是，我們可以使用 GitHub 上的一些開源庫實現應用內的圖片裁剪功能，比如 uCrop、cropper 等。

歷史版本問題

說了這麽多，還有一個大家比較關心的問題就是：哪些已經上線的舊版本應用沒有做 7.0 適配工作怎麽辦？關於這個問題，Google 已經提前幫我們想好解決方案啦。

還記得 6.0 運行時權限問題嗎？如果你不想處理運行時權限事宜的話，只需要在 build.gradle 文件中將 targetSdkVersion 的值設為 23 以下即可。

同樣的，只要 targetSdkVersion 值小於 24，File URI 的使用依舊可以出現在 7.0 及以上版本的設備中。不過需要註意的是，如前面所述，調用系統裁剪功能比較特殊，可能會出現一些問題。

雖然 Google 在每次發布新版 Android 系統時，都提供這種設置 targetSdkVersion 的方式兼容舊版本，但只是一種臨時解決方案，並不推薦大家使用這種技巧繞開新版本的適配問題。要知道，新出現的 API 改變一定是在解決過去存在的系統問題，是一種進步的表現。遵循規範，是我們每個開發人員開發時都應銘記於心的格言。

本文由 亦楓 創作並首發於 亦楓的個人博客

寫在最後：FOR Freedom 看看外邊的世界，以及IT這一行，少不了去Google查資料，最後，安利一些速器代理。

本文標簽： Android7.0 FileProvider

轉自 SUN‘S BLOG - 專註互聯網知識，分享互聯網精神！

原文地址： 《我們來一探究竟 Android 7.0 適配中 FileProvider 部分》

相關閱讀：《Chrome 擴展 Stylish ：給不喜歡某個網站一鍵「換膚」》

相關閱讀：《將 QQ 音樂、網易雲音樂和蝦米音樂資源「整合」一起的Chrome 擴展Listen 1》

相關閱讀：《8 個「新標簽頁」Chrome 擴展： 教你把 New Tab 頁面玩的溜溜溜》

相關閱讀：《7 款實用 Chrome 擴展推薦：幫你提升 Chrome 使用體驗》

相關閱讀：《無擴展就不是 Chrome 了：15 款優質的Chrome 擴展推薦給大家》

相關閱讀：《12 款不能少的使網頁瀏覽獲得的最佳體驗Chrome 擴展》

相關閱讀：《5 款可以帶來幸福感的 Chrome 擴展》

相關閱讀： 《關於 Android 中的 Palette 類的使用案例：色彩自適應的 Toolbar》

相關閱讀:《GIT能做什麽、它和SVN在深層次上究竟有什麽不同》

相關閱讀:《分享一些對開發者最有用的、用戶友好和功能豐富的Google Chrome擴展工具》

相關閱讀:《分享一些實際Android開發過程中很多相見恨晚的工具或網站》

相關閱讀:《我是 G 粉，一直關註 Google，最近 Google 有一些小動作，可能很多人不太了解》

相關閱讀:《機器學習引領認知領域的技術創新，那麽SaaS行業會被機器學習如何改變？》

相關閱讀:《VPS 教程系列：Dnsmasq + DNSCrypt + SNI Proxy 順暢訪問 Google 配置教程》

相關閱讀: 對程序員有用：2017最新能上Google的hosts文件下載及總結網友遇到的各種hosts問題解決方法及配置詳解

相關BLOG：SUN’S BLOG - 專註互聯網知識，分享互聯網精神！去看看：www.whosmall.com

原文地址：http://whosmall.com/?post=451

我們來一探究竟 Android 7.0 適配中 FileProvider 部分