1. 程式人生 > >Android FileProvider詳細解析和踩坑指南

Android FileProvider詳細解析和踩坑指南

        其實很早之前我的應用就已經相容到Android7.0了,此次寫這個文章就是想詳細梳理一下android的檔案系統,以及做一下FileProvider的解析。
        Android7.0 (N) 開始,將嚴格執行 StrictMode 模式,也就是說,將對安全做更嚴格的校驗。而從 Android N 開始,將不允許在 App 間,使用 file:// 的方式,傳遞一個 File ,否者會丟擲 FileUriExposedException

的錯誤,會直接引發 Crash。
        但是,既然官方對檔案的分享做了一個這麼強硬的修改(直接丟擲異常),實際上也提供瞭解決方案,那就是 FileProvider,通過 content://的模式替換掉 file://,同時,需要開發者主動升級 targetSdkVersion 到 24 才會執行此策略。
        FileProvider是android support v4包提供的,是ContentProvider的子類,便於將自己app的資料提供給其他app訪問。
        在app開發過程中需要用到FileProvider的主要有

  1. 相機拍照以及圖片裁剪
  2. 呼叫系統應用安裝器安裝apk(應用升級)

具體使用的方法
1、配置AndroidManifest檔案

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

authorities:一個標識,在當前系統內必須是唯一值,一般用包名。
exported:表示該 FileProvider 是否需要公開出去。
granUriPermissions:是否允許授權檔案的臨時訪問許可權。這裡需要,所以是 true。

2、在res的建xml目錄,放入provider_paths.xml檔案

<?xml version="1.0" encoding="utf-8"?>
<paths>
    <external-path
        name="external_storage_root"
        path="." />
    <files-path
        name="files-path"
        path="." />
    <cache-path
        name="cache-path"
        path="." />
    <!--/storage/emulated/0/Android/data/...-->
    <external-files-path
        name="external_file_path"
        path="." />
    <!--代表app 外部儲存區域根目錄下的檔案 Context.getExternalCacheDir目錄下的目錄-->
    <external-cache-path
        name="external_cache_path"
        path="." />
    <!--配置root-path。這樣子可以讀取到sd卡和一些應用分身的目錄,否則微信分身儲存的圖片,就會導致 java.lang.IllegalArgumentException: Failed to find configured root that contains /storage/emulated/999/tencent/MicroMsg/WeiXin/export1544062754693.jpg,在小米6的手機上微信分身有這個crash,華為沒有
-->
    <root-path
        name="root-path"
        path="" />
/paths>

這個配置的標籤參照FileProvider裡面的TAG配置。
在這裡插入圖片描述

之後FileProvider的path解析策略如下

    private static FileProvider.PathStrategy parsePathStrategy(Context context, String authority) throws IOException, XmlPullParserException {
        FileProvider.SimplePathStrategy strat = new FileProvider.SimplePathStrategy(authority);
        ProviderInfo info = context.getPackageManager().resolveContentProvider(authority, 128);
        XmlResourceParser in = info.loadXmlMetaData(context.getPackageManager(), "android.support.FILE_PROVIDER_PATHS");
        if (in == null) {
            throw new IllegalArgumentException("Missing android.support.FILE_PROVIDER_PATHS meta-data");
        } else {
            int type;
            while((type = in.next()) != 1) {
                if (type == 2) {
                    String tag = in.getName();
                    String name = in.getAttributeValue((String)null, "name");
                    String path = in.getAttributeValue((String)null, "path");
                    File target = null;
                    if ("root-path".equals(tag)) {
                        target = DEVICE_ROOT;
                    } else if ("files-path".equals(tag)) {
                        target = context.getFilesDir();
                    } else if ("cache-path".equals(tag)) {
                        target = context.getCacheDir();
                    } else if ("external-path".equals(tag)) {
                        target = Environment.getExternalStorageDirectory();
                    } else {
                        File[] externalMediaDirs;
                        if ("external-files-path".equals(tag)) {
                            externalMediaDirs = ContextCompat.getExternalFilesDirs(context, (String)null);
                            if (externalMediaDirs.length > 0) {
                                target = externalMediaDirs[0];
                            }
                        } else if ("external-cache-path".equals(tag)) {
                            externalMediaDirs = ContextCompat.getExternalCacheDirs(context);
                            if (externalMediaDirs.length > 0) {
                                target = externalMediaDirs[0];
                            }
                        } else if (VERSION.SDK_INT >= 21 && "external-media-path".equals(tag)) {
                            externalMediaDirs = context.getExternalMediaDirs();
                            if (externalMediaDirs.length > 0) {
                                target = externalMediaDirs[0];
                            }
                        }
                    }

                    if (target != null) {
                        strat.addRoot(name, buildPath(target, path));
                    }
                }
            }

            return strat;
        }
    }

root-path 對應DEVICE_ROOT,也就是File DEVICE_ROOT = new File("/"),即根目錄,一般不需要配置。
files-path對應 content.getFileDir() 獲取到的目錄。
cache-path對應 content.getCacheDir() 獲取到的目錄
external-path對應 Environment.getExternalStorageDirectory() 指向的目錄。
external-files-path對應 ContextCompat.getExternalFilesDirs() 獲取到的目錄。
external-cache-path對應 ContextCompat.getExternalCacheDirs() 獲取到的目錄。

TAG Value Path
TAG_ROOT_PATH root-path /
TAG_FILES_PATH files-path /data/data/<包名>/files
TAG_CACHE_PATH cache-path /data/data/<包名>/cache
TAG_EXTERNAL external-path /storage/emulate/0
TAG_EXTERNAL_FILES external-files-path /storage/emulate/0/Android/data/<包名>/files
TAG_EXTERNAL_CACHE external-cache-path /storage/emulate/0/Android/data/<包名>/cache

在這裡插入圖片描述
3、使用,以安裝apk為例

  	        Intent intent = new Intent(Intent.ACTION_VIEW);
            intent.addCategory(Intent.CATEGORY_DEFAULT);
            Uri uri;
            File file = new File(saveFolder, updateSaveName);
            if (Build.VERSION.SDK_INT >= 24) {//android 7.0以上
                uri = FileProvider.getUriForFile(activity, BuildConfig.APPLICATION_ID.concat(".provider"), file);
            } else {
                uri = Uri.fromFile(file);
            }
            String type = "application/vnd.android.package-archive";
            intent.setDataAndType(uri, type);
            intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
            if (Build.VERSION.SDK_INT >= 24) {
                intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
            }
            activity.startActivityForResult(intent, 10);

注意點
        經過大量使用者使用,後期反饋,在小米6,開啟微信分身之後,分身微信儲存的圖片,使用FileProvider將一張圖片的path轉成Uri的過程中crash了。這張圖片路徑如下

/storage/emulated/999/tencent/MicroMsg/WeiXin/mmexport1544062754693.jpg

你一定覺得很奇怪,正常路徑是/storage/emulate/0,怎麼會有/storage/emulate/999的路徑,查詢原因是應用分身導致的。之後會拋

 java.lang.IllegalArgumentException: Failed to find configured root that contains /storage/emulated/999/tencent/MicroMsg/WeiXin/mmexport1544062754693.jpg

那個時候,我的程式碼的xml的path裡面是沒有配置root-path節點的。debug時,fileProvide的mRoots是5個元素
在這裡插入圖片描述

後面我添加了root-path節點之後,mRoots變成了6個
在這裡插入圖片描述
之後就完美實現了將path轉成Uri。
        部分手機可以插外接sdcard,比如紅米手機,之後就導致找不到sdcard的root,這時候也是需要配置root-path
        下面在聊一聊Android的檔案系統
外部儲存的公共目錄
DIRECTORY_MUSIC:音樂型別 /storage/emulate/0/music
DIRECTORY_PICTURES:圖片型別
DIRECTORY_MOVIES:電影型別
DIRECTORY_DCIM:照片型別,相機拍攝的照片視訊都在這個目錄(digital camera in memory) /storage/emulate/0/DCIM
DIRECTORY_DOWNLOADS:下載檔案型別 /storage/emulate/0/downloads
DIRECTORY_DOCUMENTS:文件型別
DIRECTORY_RINGTONES:鈴聲型別
DIRECTORY_ALARMS:鬧鐘提示音型別
DIRECTORY_NOTIFICATIONS:通知提示音型別
DIRECTORY_PODCASTS:播客音訊型別

這些可以通過Environment的getExternalStoragePublicDirectory()來獲取

public static File getExternalStoragePublicDirectory(String type);

其他的就不寫了,好累呀
找了兩篇還不錯的文章,貼一下,偷個懶
Android檔案系統詳解
徹底理解android中的內部儲存與外部儲存
Android檔案系統的結構及目錄用途、操作方法 整理
後面那位大兄弟,寫的很詳細,很不錯哦!


致敬前輩,砥礪前行!