-
寫在前面
雖然這個(gè)出來(lái)好久了,之前也一直沒(méi)有遇到什么問(wèn)題,但是最近在不同app中共享的時(shí)候還是出了問(wèn)題,現(xiàn)在引用鴻神的一篇文章來(lái)做說(shuō)明,文章出處:Android 7.0 行為變更 通過(guò)FileProvider在應(yīng)用間共享文件吧
一、概述
之前項(xiàng)目的新特性適配工作都是同事在做,一直沒(méi)有怎么太關(guān)注,不過(guò)類似這些適配的工作還是有必要做一些記錄的。
對(duì)于Android 7.0,提供了非常多的變化,詳細(xì)的可以閱讀官方文檔Android 7.0 行為變更,記得當(dāng)時(shí)做了多窗口支持、FileProvider以及7.1的3D Touch的支持,不過(guò)和我們開(kāi)發(fā)者關(guān)聯(lián)最大的,或者說(shuō)必須要適配的就是去除項(xiàng)目中傳遞file://類似格式的uri了。
在官方7.0的以上的系統(tǒng)中,嘗試傳遞
file://URI可能會(huì)觸發(fā)FileUriExposedException。
所以本文主要描述如何適配該問(wèn)題,沒(méi)什么難度,僅做記錄。
注:本文targetSdkVersion 25 ,compileSdkVersion 25
二、拍照案例
大家應(yīng)該對(duì)于手機(jī)拍照一定都不陌生,在希望得到一張高清拍照?qǐng)D的時(shí)候,我們通過(guò)Intent會(huì)傳遞一個(gè)File的Uri給相機(jī)應(yīng)用。
大致代碼如下:
private static final int REQUEST_CODE_TAKE_PHOTO = 0x110;
private String mCurrentPhotoPath;
public void takePhotoNoCompress(View view) {
Intent takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
if (takePictureIntent.resolveActivity(getPackageManager()) != null) {
String filename = new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.CHINA)
.format(new Date()) + ".png";
File file = new File(Environment.getExternalStorageDirectory(), filename);
mCurrentPhotoPath = file.getAbsolutePath();
takePictureIntent.putExtra(MediaStore.EXTRA_OUTPUT, Uri.fromFile(file));
startActivityForResult(takePictureIntent, REQUEST_CODE_TAKE_PHOTO);
}
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (resultCode == RESULT_OK && requestCode == REQUEST_CODE_TAKE_PHOTO) {
mIvPhoto.setImageBitmap(BitmapFactory.decodeFile(mCurrentPhotoPath));
}
// else tip?
}
貼個(gè)效果圖吧~
[圖片上傳失敗...(image-c615af-1533087764199)]
未處理6.0權(quán)限,有需要的自行處理下,nexus系列如果未處理,需要手動(dòng)在設(shè)置頁(yè)開(kāi)啟存儲(chǔ)權(quán)限。
此時(shí)如果我們使用Android 7.0或者以上的原生系統(tǒng),再次運(yùn)行一下,你會(huì)發(fā)現(xiàn)應(yīng)用直接停止運(yùn)行,拋出了android.os.FileUriExposedException:
Caused by: android.os.FileUriExposedException:
file:///storage/emulated/0/20170601-030254.png
exposed beyond app through ClipData.Item.getUri()
at android.os.StrictMode.onFileUriExposed(StrictMode.java:1932)
at android.net.Uri.checkFileUriExposed(Uri.java:2348)
所以如果你意識(shí)到自己寫的代碼,在7.0的原生系統(tǒng)的手機(jī)上直接就crash是不是很方~
原因在官網(wǎng)已經(jīng)給了解釋:
對(duì)于面向 Android 7.0 的應(yīng)用,Android 框架執(zhí)行的 StrictMode API 政策禁止在您的應(yīng)用外部公開(kāi) file:// URI。如果一項(xiàng)包含文件 URI 的 intent 離開(kāi)您的應(yīng)用,則應(yīng)用出現(xiàn)故障,并出現(xiàn) FileUriExposedException 異常。
同樣的,官網(wǎng)也給出了解決方案:
要在應(yīng)用間共享文件,您應(yīng)發(fā)送一項(xiàng) content:// URI,并授予 URI 臨時(shí)訪問(wèn)權(quán)限。進(jìn)行此授權(quán)的最簡(jiǎn)單方式是使用 FileProvider 類。如需了解有關(guān)權(quán)限和共享文件的詳細(xì)信息,請(qǐng)參閱共享文件。
https://developer.android.com/about/versions/nougat/android-7.0-changes.html#accessibility
那么下面就看看如何通過(guò)FileProvider解決此問(wèn)題吧。
三、使用FileProvider兼容拍照
其實(shí)對(duì)于如何使用FileProvider,其實(shí)在FileProvider的API頁(yè)面也有詳細(xì)的步驟,有興趣的可以看下。
https://developer.android.com/reference/android/support/v4/content/FileProvider.html
FileProvider實(shí)際上是ContentProvider的一個(gè)子類,它的作用也比較明顯了,file:///Uri不給用,那么換個(gè)Uri為content://來(lái)替代。
下面我們看下整體的實(shí)現(xiàn)步驟,并考慮為什么需要怎么做?
(1)聲明provider
<provider
android:name="android.support.v4.content.FileProvider"
android:authorities="com.zhy.android7.fileprovider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_paths" />
</provider>
為什么要聲明呢?因?yàn)镕ileProvider是ContentProvider子類哇~~
注意一點(diǎn),他需要設(shè)置一個(gè)meta-data,里面指向一個(gè)xml文件。
(2)編寫resource xml file
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
<root-path name="root" path="" />
<files-path name="files" path="" />
<cache-path name="cache" path="" />
<external-path name="external" path="" />
<external-files-path name="name" path="path" />
<external-cache-path name="name" path="path" />
</paths>
在paths節(jié)點(diǎn)內(nèi)部支持以下幾個(gè)子節(jié)點(diǎn),分別為:
-
<root-path/>代表設(shè)備的根目錄new File("/"); -
<files-path/>代表context.getFilesDir() -
<cache-path/>代表context.getCacheDir() -
<external-path/>代表Environment.getExternalStorageDirectory() -
<external-files-path>代表context.getExternalFilesDirs() -
<external-cache-path>代表getExternalCacheDirs()
每個(gè)節(jié)點(diǎn)都支持兩個(gè)屬性:
- name
- path
path即為代表目錄下的子目錄,比如:
<external-path
name="external"
path="pics" />
代表的目錄即為:Environment.getExternalStorageDirectory()/pics,其他同理。
當(dāng)這么聲明以后,代碼可以使用你所聲明的當(dāng)前文件夾以及其子文件夾。
本例使用的是SDCard所以這么寫即可:
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
<external-path name="external" path="" />
</paths>
為了簡(jiǎn)單,我們直接使用SDCard根目錄,所以path里面就不填寫子目錄了~
這里你可能會(huì)有疑問(wèn),為什么要寫這么個(gè)xml文件,有啥用呀?
剛才我們說(shuō)了,現(xiàn)在要使用content://uri替代file://uri,那么,content://的uri如何定義呢?總不能使用文件路徑吧,那不是騙自己么~
所以,需要一個(gè)虛擬的路徑對(duì)文件路徑進(jìn)行映射,所以需要編寫個(gè)xml文件,通過(guò)path以及xml節(jié)點(diǎn)確定可訪問(wèn)的目錄,通過(guò)name屬性來(lái)映射真實(shí)的文件路徑。
(3)使用FileProvider API
好了,接下來(lái)就可以通過(guò)FileProvider把我們的file轉(zhuǎn)化為content://uri了~
public void takePhotoNoCompress(View view) {
Intent takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
if (takePictureIntent.resolveActivity(getPackageManager()) != null) {
String filename = new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.CHINA)
.format(new Date()) + ".png";
File file = new File(Environment.getExternalStorageDirectory(), filename);
mCurrentPhotoPath = file.getAbsolutePath();
Uri fileUri = FileProvider.getUriForFile(this, "com.zhy.android7.fileprovider", file);
takePictureIntent.putExtra(MediaStore.EXTRA_OUTPUT, fileUri);
startActivityForResult(takePictureIntent, REQUEST_CODE_TAKE_PHOTO);
}
}
核心代碼就這一行了~
FileProvider.getUriForFile(this, "com.zhy.android7.fileprovider", file);
第二個(gè)參數(shù)就是我們配置的authorities,這個(gè)很正常了,總得映射到確定的ContentProvider吧~所以需要這個(gè)參數(shù)。
然后再看一眼我們生成的uri:
content://com.zhy.android7.fileprovider/external/20170601-041411.png
可以看到格式為:content://authorities/定義的name屬性/文件的相對(duì)路徑,即name隱藏了可存儲(chǔ)的文件夾路徑。
現(xiàn)在拿7.0的原生手機(jī)運(yùn)行就正常啦~
不過(guò)事情到此并沒(méi)有結(jié)束~~
打開(kāi)一個(gè)4.4的模擬器,運(yùn)行上述代碼,你會(huì)發(fā)現(xiàn)又Crash啦,拋出了:Permission Denial~
Caused by: java.lang.SecurityException: Permission Denial: opening provider android.support.v4.content.FileProvider from ProcessRecord{52b029b8 1670:com.android.camera/u0a36} (pid=1670, uid=10036) that is not exported from uid 10052
at android.os.Parcel.readException(Parcel.java:1465)
at android.os.Parcel.readException(Parcel.java:1419)
at android.app.ActivityManagerProxy.getContentProvider(ActivityManagerNative.java:2848)
at android.app.ActivityThread.acquireProvider(ActivityThread.java:4399)
因?yàn)榈桶姹镜南到y(tǒng),僅僅是把這個(gè)當(dāng)成一個(gè)普通的Provider在使用,而我們沒(méi)有授權(quán),contentprovider的export設(shè)置的也是false;導(dǎo)致Permission Denial。
那么,我們是否可以將export設(shè)置為true呢?
很遺憾是不能的。
在FileProvider的內(nèi)部:
@Override
public void attachInfo(Context context, ProviderInfo info) {
super.attachInfo(context, info);
// Sanity check our security
if (info.exported) {
throw new SecurityException("Provider must not be exported");
}
if (!info.grantUriPermissions) {
throw new SecurityException("Provider must grant uri permissions");
}
mStrategy = getPathStrategy(context, info.authority);
}
確定了exported必須是false,grantUriPermissions必須是true ~~
所以唯一的辦法就是授權(quán)了~
context提供了兩個(gè)方法:
- grantUriPermission(String toPackage, Uri uri,
int modeFlags) - revokeUriPermission(Uri uri, int modeFlags);
可以看到grantUriPermission需要傳遞一個(gè)包名,就是你給哪個(gè)應(yīng)用授權(quán),但是很多時(shí)候,比如分享,我們并不知道最終用戶會(huì)選擇哪個(gè)app,所以我們可以這樣:
List<ResolveInfo> resInfoList = context.getPackageManager()
.queryIntentActivities(intent, PackageManager.MATCH_DEFAULT_ONLY);
for (ResolveInfo resolveInfo : resInfoList) {
String packageName = resolveInfo.activityInfo.packageName;
context.grantUriPermission(packageName, uri, flag);
}
根據(jù)Intent查詢出的所以符合的應(yīng)用,都給他們授權(quán)~~
恩,你可以在不需要的時(shí)候通過(guò)revokeUriPermission移除權(quán)限~
那么增加了授權(quán)后的代碼是這樣的:
public void takePhotoNoCompress(View view) {
Intent takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
if (takePictureIntent.resolveActivity(getPackageManager()) != null) {
String filename = new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.CHINA)
.format(new Date()) + ".png";
File file = new File(Environment.getExternalStorageDirectory(), filename);
mCurrentPhotoPath = file.getAbsolutePath();
Uri fileUri = FileProvider.getUriForFile(this, "com.zhy.android7.fileprovider", file);
List<ResolveInfo> resInfoList = getPackageManager()
.queryIntentActivities(takePictureIntent, PackageManager.MATCH_DEFAULT_ONLY);
for (ResolveInfo resolveInfo : resInfoList) {
String packageName = resolveInfo.activityInfo.packageName;
grantUriPermission(packageName, fileUri, Intent.FLAG_GRANT_READ_URI_PERMISSION
| Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
}
takePictureIntent.putExtra(MediaStore.EXTRA_OUTPUT, fileUri);
startActivityForResult(takePictureIntent, REQUEST_CODE_TAKE_PHOTO);
}
}
這樣就搞定了,不過(guò)還是挺麻煩的,如果你僅僅是對(duì)舊系統(tǒng)做兼容,還是建議做一下版本校驗(yàn)即可,也就是說(shuō)不要管什么授權(quán)了,直接這樣獲取uri
Uri fileUri = null;
if (Build.VERSION.SDK_INT >= 24) {
fileUri = FileProvider.getUriForFile(this, "com.zhy.android7.fileprovider", file);
} else {
fileUri = Uri.fromFile(file);
}
這樣會(huì)比較方便也避免導(dǎo)致一些問(wèn)題。當(dāng)然了,完全使用uri也有一些好處,比如你可以使用私有目錄去存儲(chǔ)拍攝的照片
文章最后會(huì)給出快速適配的方案~不需要這么麻煩
好像,還有什么知識(shí)點(diǎn)沒(méi)有提到,再看一個(gè)例子吧~
四、使用FileProvider兼容安裝apk
正常我們?cè)诰帉懓惭bapk的時(shí)候,是這樣的:
public void installApk(View view) {
File file = new File(Environment.getExternalStorageDirectory(), "testandroid7-debug.apk");
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setDataAndType(Uri.fromFile(file),
"application/vnd.android.package-archive");
startActivity(intent);
}
拿個(gè)7.0的原生手機(jī)跑一下,android.os.FileUriExposedException又來(lái)了~~
android.os.FileUriExposedException: file:///storage/emulated/0/testandroid7-debug.apk exposed beyond app through Intent.getData()
好在有經(jīng)驗(yàn)了,簡(jiǎn)單修改下uri的獲取方式。
if (Build.VERSION.SDK_INT >= 24) {
fileUri = FileProvider.getUriForFile(this, "com.zhy.android7.fileprovider", file);
} else {
fileUri = Uri.fromFile(file);
}
再跑一次,沒(méi)想到還是拋出了異常(警告,沒(méi)有Crash):
java.lang.SecurityException: Permission Denial:
opening provider android.support.v4.content.FileProvider
from ProcessRecord{18570a 27107:com.google.android.packageinstaller/u0a26} (pid=27107, uid=10026) that is not exported from UID 10004
可以看到是權(quán)限問(wèn)題,對(duì)于權(quán)限我們剛說(shuō)了一種方式為grantUriPermission,這種方式當(dāng)然是沒(méi)問(wèn)題的啦~
加上后運(yùn)行即可。
其實(shí)對(duì)于權(quán)限,還提供了一種方式,即:
intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
我們可以在安裝包之前加上上述代碼,再次運(yùn)行正常啦~
現(xiàn)在我有兩個(gè)非常疑惑的問(wèn)題:
- 問(wèn)題1:為什么剛才拍照的時(shí)候,Android 7的設(shè)備并沒(méi)有遇到
Permission Denial的問(wèn)題?
恩,之所以不需要權(quán)限,主要是因?yàn)镮ntent的action為ACTION_IMAGE_CAPTURE,當(dāng)我們startActivity后,會(huì)輾轉(zhuǎn)調(diào)用Instrumentation的execStartActivity方法,在該方法內(nèi)部,會(huì)調(diào)用intent.migrateExtraStreamToClipData();方法。
該方法中包含:
if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
|| MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
|| MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
final Uri output;
try {
output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
} catch (ClassCastException e) {
return false;
}
if (output != null) {
setClipData(ClipData.newRawUri("", output));
addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
return true;
}
}
可以看到將我們的EXTRA_OUTPUT,轉(zhuǎn)為了setClipData,并直接給我們添加了WRITE和READ權(quán)限。
注:該部分邏輯應(yīng)該是21之后添加的。
- 問(wèn)題2:為什么剛才拍照案例的時(shí)候,Android 4.4設(shè)備遇到權(quán)限問(wèn)題,不通過(guò)addFlags這種方式解決?
因?yàn)閍ddFlags主要用于setData,setDataAndType以及setClipData(注意:4.4時(shí),并沒(méi)有將ACTION_IMAGE_CAPTURE轉(zhuǎn)為setClipData實(shí)現(xiàn))這種方式。
所以addFlags方式對(duì)于ACTION_IMAGE_CAPTURE在5.0以下是無(wú)效的,所以需要使用grantUriPermission,如果是正常的通過(guò)setData分享的uri,使用addFlags是沒(méi)有問(wèn)題的(可以寫個(gè)簡(jiǎn)單的例子測(cè)試下,兩個(gè)app交互,通過(guò)content://)。
五、總結(jié)下
終于將知識(shí)點(diǎn)都涵蓋到了~
總結(jié)下,使用content://替代file://,主要需要FileProvider的支持,而因?yàn)镕ileProvider是ContentProvider的子類,所以需要在AndroidManifest.xml中注冊(cè);而又因?yàn)樾枰獙?duì)真實(shí)的filepath進(jìn)行映射,所以需要編寫一個(gè)xml文檔,用于描述可使用的文件夾目錄,以及通過(guò)name去映射該文件夾目錄。
對(duì)于權(quán)限,有兩種方式:
- 方式一為Intent.addFlags,該方式主要用于針對(duì)intent.setData,setDataAndType以及setClipData相關(guān)方式傳遞uri的。
- 方式二為grantUriPermission來(lái)進(jìn)行授權(quán)
相比來(lái)說(shuō)方式二較為麻煩,因?yàn)樾枰付繕?biāo)應(yīng)用包名,很多時(shí)候并不清楚,所以需要通過(guò)PackageManager進(jìn)行查找到所有匹配的應(yīng)用,全部進(jìn)行授權(quán)。不過(guò)更為穩(wěn)妥~
方式一較為簡(jiǎn)單,對(duì)于intent.setData,setDataAndType正常使用即可,但是對(duì)于setClipData,由于5.0前后Intent#migrateExtraStreamToClipData,代碼發(fā)生變化,需要注意~
好了,看到現(xiàn)在是不是覺(jué)得適配7.0挺麻煩的,其實(shí)一點(diǎn)都不麻煩,下面給大家總結(jié)一種快速適配的方式。
六、快速完成適配
(1)新建一個(gè)module
創(chuàng)建一個(gè)library的module,在其AndroidManifest.xml中完成FileProvider的注冊(cè),代碼編寫為:
<application>
<provider
android:name="android.support.v4.content.FileProvider"
android:authorities="${applicationId}.android7.fileprovider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/file_paths" />
</provider>
</application>
注意一點(diǎn),android:authorities不要寫死,因?yàn)樵搇ibrary最終可能會(huì)讓多個(gè)項(xiàng)目引用,而android:authorities是不可以重復(fù)的,如果兩個(gè)app中定義了相同的,則后者無(wú)法安裝到手機(jī)中(authority conflict)。
同樣的的編寫file_paths~
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
<root-path
name="root"
path="" />
<files-path
name="files"
path="" />
<cache-path
name="cache"
path="" />
<external-path
name="external"
path="" />
<external-files-path
name="external_file_path"
path="" />
<external-cache-path
name="external_cache_path"
path="" />
</paths>
最后再編寫一個(gè)輔助類,例如:
public class FileProvider7 {
public static Uri getUriForFile(Context context, File file) {
Uri fileUri = null;
if (Build.VERSION.SDK_INT >= 24) {
fileUri = getUriForFile24(context, file);
} else {
fileUri = Uri.fromFile(file);
}
return fileUri;
}
public static Uri getUriForFile24(Context context, File file) {
Uri fileUri = android.support.v4.content.FileProvider.getUriForFile(context,
context.getPackageName() + ".android7.fileprovider",
file);
return fileUri;
}
public static void setIntentDataAndType(Context context,
Intent intent,
String type,
File file,
boolean writeAble) {
if (Build.VERSION.SDK_INT >= 24) {
intent.setDataAndType(getUriForFile(context, file), type);
intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
if (writeAble) {
intent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
}
} else {
intent.setDataAndType(Uri.fromFile(file), type);
}
}
}
可以根據(jù)自己的需求添加方法。
好了,這樣我們的一個(gè)小庫(kù)就寫好了~~
(2)使用
如果哪個(gè)項(xiàng)目需要適配7.0,那么只需要這樣引用這個(gè)庫(kù),然后只需要改動(dòng)一行代碼即可完成適配啦,例如:
拍照
public void takePhotoNoCompress(View view) {
Intent takePictureIntent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
if (takePictureIntent.resolveActivity(getPackageManager()) != null) {
String filename = new SimpleDateFormat("yyyyMMdd-HHmmss", Locale.CHINA)
.format(new Date()) + ".png";
File file = new File(Environment.getExternalStorageDirectory(), filename);
mCurrentPhotoPath = file.getAbsolutePath();
Uri fileUri = FileProvider7.getUriForFile(this, file);
takePictureIntent.putExtra(MediaStore.EXTRA_OUTPUT, fileUri);
startActivityForResult(takePictureIntent, REQUEST_CODE_TAKE_PHOTO);
}
}
只需要改動(dòng)
Uri fileUri = FileProvider7.getUriForFile(this, file);
即可。
安裝apk
同樣的修改setDataAndType為:
FileProvider7.setIntentDataAndType(this,
intent, "application/vnd.android.package-archive", file, true);
即可。
ok,繁瑣的重復(fù)性操作終于簡(jiǎn)化為一行代碼啦~
源碼地址: