前言
存儲適配系列文章:
Android-存儲基礎
Android-10、11-存儲完全適配(上)
Android-10、11-存儲完全適配(下)
Android-FileProvider-輕松掌握
上篇文章分析了Android 10.0版本前后存儲訪問方式的變更,本篇將著重分析如何來具體適配Android 10.0、11.0。
通過本篇文章,你將了解到:
1、MediaStore 基本知識
2、通過Uri讀取和寫入文件
3、通過Uri 獲取圖片和插入相冊
4、Android 11.0 權限申請
5、Android 10/11 存儲適配建議
1、MediaStore 基本知識
再次回顧存儲區域劃分:
上篇已經分析得出結論,Android 10.0 存儲訪問方式變更地方在于:
自帶外部存儲-共享存儲空間和自帶外部存儲-其它目錄
以上兩個地方不能通過路徑直接訪問文件,而是需要通過Uri訪問。
共享存儲空間
共享存儲空間存放的是圖片、視頻、音頻等文件,這些資源是公用的,所有App都能夠訪問它們。
系統里有external.db數據庫,該數據庫里有files表,該表里存放著共享文件的諸多信息,如圖片有寬高,經緯度、存放路徑等,視頻寬高、時長、存放路徑等。而文件真正存放的地方在于共享存儲空間。
1、保存圖片到相冊
當App1保存圖片到相冊時,簡單流程如下:
1、將路徑信息寫入數據庫里,并獲取Uri
2、通過Uri構造輸出流
3、將該圖片保存在/sdcard/Pictures/目錄下
2、從相冊獲取圖片
當App2從相冊獲取圖片時,簡單流程如下:
1、先查詢數據庫,找到對應的圖片Cursor
2、從Cursor里構造Uri
3、從Uri構造輸入流讀取圖片
以上以圖片為例簡單分析了共享存儲空間文件的寫入與讀取,實際上對于視頻、音頻步驟亦是如此。
MediaStore作用
共享存儲空間里存放著圖片、視頻、音頻、下載的文件,App獲取或者插入文件的時候怎么區分這些類型呢?
這個時候就需要MediaStore,來看看MediaStore.java
可以看出其內部有Audio、Images等內部類,這些內部類里記錄著files表的各個字段名,通過構造這些參數就可以插入相應的字段值以及獲取對應的字段值。
MediaStore 實際上就是相當于給各個字段起了別名,我們編碼的時候更容易記住與使用:
//列舉一些字段:
//圖片類型
MediaStore.Images.Media.MIME_TYPE
//音頻時長
MediaStore.Audio.Media.DURATION
//視頻時長
MediaStore.Video.Media.DURATION
//等等,還有很多
MediaStore和Uri聯系
比如想要查詢共享存儲空間里的圖片文件:
Cursor cursor = contentResolver.query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, null, null, null, null);
MediaStore.Images.Media.EXTERNAL_CONTENT_URI 意思是指定查詢文件的類型是圖片,并構造成Uri對象,Uri實現了Parcelable,能夠在進程間傳遞。
接收方(另一個進程收到后),匹配Uri,解析出對應的字段,進行具體的操作。
當然,MediaStore是系統提供的方便操作共享存儲空間的類,若是自己寫ContentProvider,則也可以自定義類似MediaStore的類用來標記自己的數據庫表的字段。
2、通過Uri讀取和寫入文件
既然不能通過路徑直接訪問文件,那么來看看如何通過Uri訪問文件。在上篇文章里提到過:Uri可以通過MediaStore或者SAF獲取。(此處需要注意的是:雖然也可以通過文件路徑直接構造Uri,但是此種方式構造的Uri是沒有權限訪問文件的)
先來看看通過SAF獲取Uri。
從Uri讀取文件
現在/sdcard/目錄下存在一個文件名為:mytest.txt。
該文件內容是:
傳統的直接讀取mytest.txt方法:
//從文件讀取
private void readFile(String filePath) {
if (TextUtils.isEmpty(filePath))
return;
try {
File file = new File(filePath);
FileInputStream fileInputStream = new FileInputStream(file);
BufferedInputStream bis = new BufferedInputStream(fileInputStream);
byte[] readContent = new byte[1024];
int readLen = 0;
while (readLen != -1) {
readLen = bis.read(readContent, 0, readContent.length);
if (readLen > 0) {
String content = new String(readContent);
Log.d("test", "read content:" + content.substring(0, readLen));
}
}
fileInputStream.close();
} catch (Exception e) {
}
}
開啟分區存儲功能后,這種方法是不可取的,會報權限錯誤。
而mytest.txt不屬于共享存儲空間的文件,是屬于其它目錄的,因此不能通過MediaStore獲取,只能通過SAF獲取,如下:
private void startSAF() {
Intent intent = new Intent(Intent.ACTION_OPEN_DOCUMENT);
intent.addCategory(Intent.CATEGORY_OPENABLE);
//指定選擇文本類型的文件
intent.setType("text/plain");
startActivityForResult(intent, 100);
}
@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
super.onActivityResult(requestCode, resultCode, data);
if (requestCode == 100) {
//選中返回的文件信息封裝在Uri里
Uri uri = data.getData();
openUriForRead(uri);
}
}
拿到Uri后,用來構造輸入流讀取文件。
private void openUriForRead(Uri uri) {
if (uri == null)
return;
try {
//獲取輸入流
InputStream inputStream = getContentResolver().openInputStream(uri);
byte[] readContent = new byte[1024];
int len = 0;
do {
//讀文件
len = inputStream.read(readContent);
if (len != -1) {
Log.d("test", "read content:" + new String(readContent).substring(0, len));
}
} while (len != -1);
inputStream.close();
} catch (Exception e) {
Log.d("test", e.getLocalizedMessage());
}
}
最終輸出:
由此可以看出,mytest.txt屬于"其它目錄"下的文件,因此需要通過SAF訪問,SAF返回Uri,通過Uri構造InputStream即可讀取文件。
從Uri寫入文件
繼續來看看寫的過程,現在需要往mytest.txt寫入內容。
同樣的,還是需要通過SAF拿到Uri,拿到Uri后構造輸出流:
private void openUriForWrite(Uri uri) {
if (uri == null) {
return;
}
try {
//從uri構造輸出流
OutputStream outputStream = getContentResolver().openOutputStream(uri);
//待寫入的內容
String content = "hello world I'm from SAF\n";
//寫入文件
outputStream.write(content.getBytes());
outputStream.flush();
outputStream.close();
} catch (Exception e) {
Log.d("test", e.getLocalizedMessage());
}
}
最后來看看文件是否寫入成功,通過SAF再次讀取mytest.txt,發現正好是之前寫入的內容,說明寫入成功。
3、通過Uri 獲取圖片和插入相冊
上面列舉出了其它目錄下文件的讀寫,方法是通過SAF拿到Uri。
SAF好處是:
系統提供了文件選擇器,調用者只需要指定想要讀寫的文件類型,比如文本類型、圖片類型、視頻類型等,選擇器就會過濾出相應文件以供選擇。接入方便,選擇簡單。
想想另一種場景:
想要自己實現相冊選擇器,那么就需要獲得共享存儲空間下的文件信息。此種場景下使用SAF是無法做到的。
因此問題的關鍵是:如何批量獲得共享存儲空間下圖片/視頻的信息?
答案是:ContentResolver+ContentProvider+MediaStore(ContentProvider對于調用者是透明的)。
以圖片為例,分析插入與查詢方式。
插入相冊
來看看圖片的插入過程:
//fileName為需要保存到相冊的圖片名
private void insert2Album(InputStream inputStream, String fileName) {
if (inputStream == null)
return;
ContentValues contentValues = new ContentValues();
contentValues.put(MediaStore.Images.ImageColumns.DISPLAY_NAME, fileName);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
//RELATIVE_PATH 字段表示相對路徑-------->(1)
contentValues.put(MediaStore.Images.ImageColumns.RELATIVE_PATH, Environment.DIRECTORY_PICTURES);
} else {
String dstPath = Environment.getExternalStorageDirectory() + File.separator + Environment.DIRECTORY_PICTURES
+ File.separator + fileName;
//DATA字段在Android 10.0 之后已經廢棄
contentValues.put(MediaStore.Images.ImageColumns.DATA, dstPath);
}
//插入相冊------->(2)
Uri uri = getContentResolver().insert(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, contentValues);
//寫入文件------->(3)
write2File(uri, inputStream);
}
重點說明三個點:
(1)
Android 10.0之前,MediaStore.Images.ImageColumns.DATA 字段記錄的是圖片的絕對路徑,而Android 10.0(含)之后,DATA 被廢棄,取而代之的是使用MediaStore.Images.ImageColumns.RELATIVE_PATH,表示相對路徑。比如指定RELATIVE_PATH為Environment.DIRECTORY_PICTURES,表示之后的圖片將會放到Environment.DIRECTORY_PICTURES目錄下。
(2)
調用ContentResolver里的方法插入相冊。
MediaStore.Images.Media.EXTERNAL_CONTENT_URI 指的是插入圖片表。
ContentValues 以Map的形式記錄了待寫入的字段值。
插入后返回Uri。
(3)
以上兩步僅僅只是往數據庫里增加一條記錄,該記錄指向的新文件是空的,需要將圖片寫入到新文件。
而新文件位于/sdcard/Pictures/目錄下,該目錄是不能直接通過路徑訪問的,因此需要通過第二步返回的Uri進行訪問。
//uri 關聯著待寫入的文件
//inputStream 表示原始的文件流
private void write2File(Uri uri, InputStream inputStream) {
if (uri == null || inputStream == null)
return;
try {
//從Uri構造輸出流
OutputStream outputStream = getContentResolver().openOutputStream(uri);
byte[] in = new byte[1024];
int len = 0;
do {
//從輸入流里讀取數據
len = inputStream.read(in);
if (len != -1) {
outputStream.write(in, 0, len);
outputStream.flush();
}
} while (len != -1);
inputStream.close();
outputStream.close();
} catch (Exception e) {
Log.d("test", e.getLocalizedMessage());
}
}
可以看出,目標文件關聯的Uri有了,還需要原始的輸入文件。
測試上述的插入方法:
private void testInsert() {
String picName = "mypic.jpg";
try {
File externalFilesDir = getExternalFilesDir(null);
File file = new File(externalFilesDir, picName);
FileInputStream fis = new FileInputStream(file);
insert2Album(fis, picName);
} catch (Exception e) {
Log.d("test", e.getLocalizedMessage());
}
}
其中,原始文件(圖片)存放于自帶外部存儲-App私有目錄,如下:
需要注意的是:
1、讀取原始文件需要權限,上述例子里的原始文件存放在自帶外部存儲-App私有目錄,因此本App可以使用路徑直接讀取
2、對于其他目錄則依然需要構造Uri讀取,如通過SAF獲取Uri
獲取圖片
同樣的,想要從系統相冊中獲取圖片,也需要通過Uri訪問。
private void queryImageFromAlbum() {
Cursor cursor = getContentResolver().query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, null,
null, null, null);
if (cursor != null) {
while (cursor.moveToNext()) {
//獲取唯一的id
long id = cursor.getLong(cursor.getColumnIndexOrThrow(MediaStore.MediaColumns._ID));
//通過id構造Uri
Uri uri = ContentUris.withAppendedId(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, id);
//解析uri
decodeUriForBitmap(uri);
}
}
}
private void decodeUriForBitmap(Uri uri) {
if (uri == null)
return;
try {
//構造輸入流
InputStream inputStream = getContentResolver().openInputStream(uri);
//解析Bitmap
Bitmap bitmap = BitmapFactory.decodeStream(inputStream);
if (bitmap != null)
Log.d("test", "bitmap width-width:" + bitmap.getWidth() + "-" + bitmap.getHeight());
} catch (Exception e) {
Log.d("test", e.getLocalizedMessage());
}
}
與插入相冊過程類似,同樣需要拿到Uri,再構造輸入流,從輸入流讀取文件(圖片內容)。
以上,通過Uri 獲取圖片和插入相冊分析完畢,共享存儲空間的其他文件類型如視頻、音頻、下載文件也是同樣的流程。
需要說明的是上述的ContentResolver .insert(xx)/ContentResolver.query(xx) 的參數取值還可以更豐富,但不是本篇重點,因此忽略了,實際使用過程中具體情況具體分析。
4、Android 11.0 權限申請
通過Uri訪問文件似乎已經滿足了Android 10.0適配要求,但是仔細想想還是有不足之處:
1、共享存儲空間只能通過MediaStore訪問,以前流行的訪問方式是直接通過路徑訪問。比如自己做的相冊管理器,先遍歷相冊拿到圖片/視頻的路徑,然后再解析成Bitmap展示,現在需要先拿到Uri,再解析成Bitmap,多少有些不方便。此外,也許你依賴的第三方庫是直接通過路徑訪問文件的,而三方庫又沒有及時更新適配分區存儲,可能就會導致用不了相應的功能。
2、SAF雖然能夠訪問其它目錄的文件,但是每次都需要跳轉到新的頁面去選擇,當想要批量展示文件的時候,比如自己做的文件管理器,就需要列出當前目錄下有哪些目錄/文件,這個時候需要有權限遍歷/sdcard/目錄。顯然,SAF并不能勝任此工作。
Android 11.0考慮到上面的問題,因此做了新的優化。
共享存儲空間-媒體文件訪問變更
媒體文件可以通過路徑直接訪問:
private void getImagePath(Context context) {
ContentResolver contentResolver = context.getContentResolver();
Cursor cursor = contentResolver.query(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, null, null, null, null);
while (cursor.moveToNext()) {
try {
//取出路徑
String path = cursor.getString(cursor.getColumnIndex(MediaStore.Images.ImageColumns.DATA));
Bitmap bitmap = BitmapFactory.decodeFile(path);
} catch (Exception e) {
Log.d("test", e.getLocalizedMessage());
}
break;
}
}
可以看出,之前在Android 10.0上被禁用的訪問方式,在Android 11.0上又被允許了,這就解決了上面的第一個問題。
需要注意的是:此種方式只允許讀文件,寫文件依然不行
Google 官方指導意見是:
雖然可以通過路徑直接訪問媒體文件,但是這些操作最終是被重定向到MediaStore API的,重定向過程可能會損耗一些性能,并且直接通過路徑訪問不一定比MediaStore API 訪問快。
總之建議非必要的話不要直接使用路徑訪問。
訪問所有文件
假若App開啟了分區存儲功能,當App運行在Android 10.0的設備上時,是沒法遍歷/sdcard/目錄的。而在Android 11.0上運行時是可以遍歷的,需要進行如下幾個步驟。
1、聲明管理權限
在AndroidManifest.xml添加權限聲明
<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
2、動態申請所有文件訪問權限
private void testAllFiles() {
//運行設備>=Android 11.0
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
//檢查是否已經有權限
if (!Environment.isExternalStorageManager()) {
//跳轉新頁面申請權限
startActivityForResult(new Intent(Settings.ACTION_MANAGE_ALL_FILES_ACCESS_PERMISSION), 101);
}
}
}
@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
super.onActivityResult(requestCode, resultCode, data);
//申請權限結果
if (requestCode == 101) {
if (Environment.isExternalStorageManager()) {
Toast.makeText(MainActivity.this, "訪問所有文件權限申請成功", Toast.LENGTH_SHORT).show();
//遍歷目錄
showAllFiles();
}
}
}
此處申請權限不是以對話框的形式提示用戶,而是跳轉到新的頁面,說明該權限的管理更嚴格。
3、遍歷目錄、讀寫文件
擁有權限后,就可以進行相應的操作了。
private void showAllFiles() {
File file = Environment.getExternalStorageDirectory();
File[] list = file.listFiles();
for (int i = 0; i < list.length; i++) {
String name = list[i].getName();
Log.d("test", "fileName:" + name);
}
}
文件管理器效果圖類似如下:
當然讀寫文件也不在話下了,比如往/sdcard/目錄下寫入文件:
private void testPublicFile() {
File rootFile = Environment.getExternalStorageDirectory();
try {
File file = new File(rootFile, "mytest.txt");
FileOutputStream fos = new FileOutputStream(file);
String content = "hello world\n";
fos.write(content.getBytes());
fos.flush();
fos.close();
} catch (Exception e) {
Log.d("test", e.getLocalizedMessage());
}
}
ACTION_MANAGE_ALL_FILES_ACCESS_PERMISSION 這個權限的名字看起來很唬人,感覺就像是能夠操作所有文件的樣子,這不就是打破了分區存儲的規則了嗎?其實不然:
即使擁有了該權限,依然不能訪問內部存儲和外部存儲-App私有目錄
需要說明的是:
1、Environment.isExternalStorageManager()、Build.VERSION_CODES.R 等需要編譯版本>=30才能編譯通過。
2、Google 提示當使用MANAGE_EXTERNAL_STORAGE 申請權限時,并且targetSdkVersion>=30,此種情況下App被禁止上架Google Play的,限制時間最早到2021年。因此,在此時間之前若是申請了MANAGE_EXTERNAL_STORAGE權限,最好不要升級targetSdkVersion到30以上。
5、Android 10/11 存儲適配建議
好了,通過分析Android 10/11存儲適配方式,了解到了不同的系統需要如何進行適配,此時就需要一個統一的適配方案了。
適配核心
分區存儲是核心,App自身產生的文件應該存放在自己的目錄下:
/sdcard/Android/data/packagename/ 和/data/data/packagename/
這兩個目錄本App無需申請訪問權限即可申請,其它App無法訪問本App的目錄。
適配共享存儲
共享存儲空間里的文件需要通過Uri構造輸入輸出流訪問,Uri獲取方式有兩種:MediaStore和SAF。
適配其它目錄
在Android 11上需要申請訪問所有文件的權限。
具體做法
第一步
在AndroidManifest.xml里添加如下字段:
權限聲明:
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />
在<application/>標簽下添加如下字段:
android:requestLegacyExternalStorage="true"
第二步
如果需要訪問共享存儲空間,則判斷運行設備版本是否大于等于Android6.0,若是則需要申請WRITE_EXTERNAL_STORAGE 權限。拿到權限后,通過Uri訪問共享存儲空間里的文件。
如果需要訪問其它目錄,則通過SAF訪問
第三步
如果想要做文件管理器、病毒掃描管理器等功能。則判斷運行設備版本是否大于等于Android 6.0,若是先需要申請普通的存儲權。若運行設備版本為Android 10.0,則可以直接通過路徑訪問/sdcard/目錄下文件(因為禁用了分區存儲);若運行設備版本為Android 11.0,則需要申請MANAGE_EXTERNAL_STORAGE 權限。
以上是Android 存儲權限適配的全部內容。
本篇基于Android 10.0 11.0 。 Android 10.0真機、Android 11.0模擬器
測試代碼
下個系列文章:線程&鎖相關知識。