RxHttp 完美適配Android 10/11 上傳/下載/進度監聽
一、前言
隨着Android 11的正式發佈，適配Android 10/11 分區存儲就更加的迫切了，由於Android 11開始，將強制開啓分區存儲，咱們就沒法再以絕對路徑的方式去讀寫非沙盒目錄下的文件，爲此，RxHttp 在2.4.0版本中就正式適配了分區存儲，而且，能夠很是優雅的實現文件上傳/下載/進度監聽，三步便可搞懂任意請求。java
老規矩，先看看請求三部曲
若是你想了解RxHttp更過功能，請查看如下系列文章react
RxHttp 2000+star，協程請求，僅需三步android
gradle依賴github
必須
//使用kapt依賴rxhttp-compiler時必須
apply plugin: 'kotlin-kapt'
android {
//必須，java 8或更高
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
dependencies {
implementation 'com.ljx.rxhttp:rxhttp:2.5.2'
implementation 'com.squareup.okhttp3:okhttp:4.9.0' //rxhttp v2.2.2版本起，須要手動依賴okhttp
kapt 'com.ljx.rxhttp:rxhttp-compiler:2.5.2' //生成RxHttp類，純Java項目，請使用annotationProcessor代替kapt
}
可選
android {
defaultConfig {
javaCompileOptions {
annotationProcessorOptions {
arguments = [
//使用asXxx方法時必須，告知RxHttp你依賴的rxjava版本，可傳入rxjava二、rxjava3
rxhttp_rxjava: 'rxjava3'，
rxhttp_package: 'rxhttp' //非必須，指定RxHttp類包名
]
}
}
}
}
dependencies {
implementation 'com.ljx.rxlife:rxlife-coroutine:2.0.1' //管理協程生命週期，頁面銷燬，關閉請求
//rxjava2 (RxJava2/Rxjava3二選一，使用asXxx方法時必須)
implementation 'io.reactivex.rxjava2:rxjava:2.2.8'
implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
implementation 'com.ljx.rxlife2:rxlife-rxjava:2.0.0' //管理RxJava2生命週期，頁面銷燬，關閉請求
//rxjava3
implementation 'io.reactivex.rxjava3:rxjava:3.0.6'
implementation 'io.reactivex.rxjava3:rxandroid:3.0.0'
implementation 'com.ljx.rxlife3:rxlife-rxjava:3.0.0' //管理RxJava3生命週期，頁面銷燬，關閉請求
//非必須，根據本身需求選擇 RxHttp默認內置了GsonConverter
implementation 'com.ljx.rxhttp:converter-fastjson:2.5.2'
implementation 'com.ljx.rxhttp:converter-jackson:2.5.2'
implementation 'com.ljx.rxhttp:converter-moshi:2.5.2'
implementation 'com.ljx.rxhttp:converter-protobuf:2.5.2'
implementation 'com.ljx.rxhttp:converter-simplexml:2.5.2'
}
二、Android 10/11 分區存儲
當咱們App的targetSdkVersion更改成28以上，而且運行在Android 10以上設備時，咱們沒法再以絕對路徑的方式，去讀寫非沙盒目錄下的文件，固然，若是App是覆蓋安裝（如：targetSdkVersion 28 覆蓋安裝爲 29），則會保持原來的訪問方式。json
requestLegacyExternalStorage屬性app
若是咱們的app將targetSdkVersion更改成28以上，且想保持原來的訪問方式，則須要在清單文件中將 requestLegacyExternalStorage 的值設置爲 true，以下：框架
<manifest ...>
<!-- This attribute is "false" by default on apps targeting
Android 10 or higher. -->
<application android:requestLegacyExternalStorage="true" ... >
...
</application>
</manifest>
此時，即可繼續以原來的方式去讀寫文件，然而，在Android 11上，Google又給了它新的含義，來看看官網的原話ide
也就是說，在Android 11設備上，targetSdkVersion爲29以上的app，將強制開啓分區存儲，requestLegacyExternalStorage屬性失效post
注意，只要同時知足以上兩個條件，不論是覆蓋安裝仍是requestLegacyExternalStorage = true，都會強制開啓分區存儲
分區存儲優點
-
對用戶來講，解決了文件亂放的現象
-
對於開發者來講，咱們無需寫權限，就能夠在分區目錄下建立文件，而且訪問本身建立的文件，不須要讀權限（訪問其它應用建立的文件，仍是須要讀權限）
新的文件訪問方式
此圖來源於做者[連續三屆村草]分享的Android 10(Q)/11(R) 分區存儲適配一文，感謝做者的總結
三、上傳
3.一、簡單上傳
在介紹Android 10文件上傳前，咱們先來看看Android 10以前是如何上傳文件的，以下：
//kotlin 協程
val result = RxHttp.postForm("/service/...")
.add("key", "value")
.addFile("file", File("xxx/1.jpg"))
.awaitString() //awaitXxx系列方法是掛斷方法
//RxJava
RxHttp.postForm("/service/...")
.add("key", "value")
.addFile("file", File("xxx/1.jpg"))
.asString()
.subscribe({
//成功回調
}, {
//異常回調
})
以上，咱們僅需調用 addFile方法添加文件對象便可，RxHttp提供了一系列addFile方法，列出幾個經常使用的，以下：
//添加單個文件 addFile(String, File) //添加多個文件，每一個文件對應相同的key addFile(String, List<? extends File> fileList) //添加多個文件，每一個文件對應不一樣的key addFile(Map<String, ? extends File> fileMap) //等等其它addFile方法
在Android 10，咱們須要經過Uri對象去上傳文件，在RxHttp中，經過addPart方法添加Uri對象，以下：
val context = getContext(); //獲取上下文對象
//獲取Uri對象，這裏爲了方便，隨便寫了一個Downlaod目錄下的Uri地址
val uri = Uri.parse("content://media/external/downloads/13417")
//kotlin 協程
val result = RxHttp.postForm("/service/...")
.add("key", "value")
.addPart(context, "file", uri)
.awaitString() //awaitXxx系列方法是掛斷方法
//RxJava
RxHttp.postForm("/service/...")
.add("key", "value")
.addPart(context, "file", uri)
.asString()
.subscribe({
//成功回調
}, {
//異常回調
})
一樣的，RxHttp內部提供了一系列addPart方法供你們選擇，列出幾個經常使用的，以下：
//添加單個Uri對象 addPart(Context, String, Uri) //添加多個Uri對象，每一個Uri對應相同的key addParts(Context，String, List<? extends Uri> uris) //添加多個Uri對象，每一個Uri對應不一樣的key addParts(Context context, Map<String, ? extends Uri> uriMap) //等等其它addPart方法
3.二、帶進度上傳
老規矩，看看Android 10以前是如何監聽上傳進度的，以下：
//kotlin 協程
val result = RxHttp.postForm("/service/...")
.add("key", "value")
.addFile("file", File("xxx/1.jpg"))
.upload(this) {//this爲當前協程CoroutineScope對象，用於控制回調線程
//上傳進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.awaitString() //awaitXxx系列方法是掛斷方法
//RxJava
RxHttp.postForm("/service/...")
.add("key", "value")
.addFile("file", File("xxx/1.jpg"))
.upload(AndroidSchedulers.mainThread()) {
//上傳進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.asString()
.subscribe({
//成功回調
}, {
//異常回調
})
相比於單純的上傳文件，咱們僅需額外調用upload操做符，傳入線程調度器及進度回調便可。
一樣的，對於Andorid 10，咱們僅須要將File對象換成Uri對象便可，以下：
val context = getContext(); //獲取上下文對象
//獲取Uri對象，這裏爲了方便，隨便寫了一個Downlaod目錄下的Uri地址
val uri = Uri.parse("content://media/external/downloads/13417")
//kotlin 協程
val result = RxHttp.postForm("/service/...")
.add("key", "value")
.addPart(context, "file", uri)
.upload(this) {//this爲當前協程CoroutineScope對象，用於控制回調線程
//上傳進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.awaitString() //awaitXxx系列方法是掛斷方法
//RxJava
RxHttp.postForm("/service/...")
.add("key", "value")
.addPart(context, "file", uri)
.upload(AndroidSchedulers.mainThread()) {
//上傳進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.asString()
.subscribe({
//成功回調
}, {
//異常回調
})
怎麼樣？是否是so easy!!
四、下載
下載較於上傳，要豐富不少，RxHttp內部提供類一系列下載方法來知足不一樣的需求，以下：
//kotlin
fun IRxHttp.toDownload(
destPath: String,
context: CoroutineContext? = null,
progress: (suspend (ProgressT<String>) -> Unit)? = null
)
fun IRxHttp.toDownload(
context: Context,
uri: Uri,
coroutineContext: CoroutineContext? = null,
progress: (suspend (ProgressT<Uri>) -> Unit)? = null
)
fun <T> IRxHttp.toDownload(
osFactory: OutputStreamFactory<T>,
context: CoroutineContext? = null,
progress: (suspend (ProgressT<T>) -> Unit)? = null
)
4.一、簡單下載
在Android 10以前，咱們僅需傳入一個本地文件路徑便可，以下：
val localPath = "/sdcard/.../xxx.apk"
//kotlin 協程
val result = RxHttp.get("/service/.../xxx.apk")
.toDownload(localPath)
.await() //這裏返回sd卡存儲路徑
//RxJava
RxHttp.get("/service/.../xxx.apk")
.asDownload(localPath)
.subscribe({
//成功回調，這裏返回sd卡存儲路徑
}, {
//異常回調
})
而到了Android 10，咱們須要自定義一個Android10DownloadFactory類，繼承UriFactory類，以下：
class Android10DownloadFactory @JvmOverloads constructor(
context: Context,
fileName: String,
queryUri: Uri? = null
) : UriFactory(context, queryUri, fileName) {
override fun getUri(response: Response): Uri {
return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
ContentValues().run {
put(MediaStore.MediaColumns.DISPLAY_NAME, fileName) //文件名
//取contentType響應頭做爲文件類型
put(MediaStore.MediaColumns.MIME_TYPE, response.body?.contentType().toString())
//下載到Download目錄
put(MediaStore.MediaColumns.RELATIVE_PATH, Environment.DIRECTORY_DOWNLOADS)
val uri = queryUri ?: MediaStore.Downloads.EXTERNAL_CONTENT_URI
context.contentResolver.insert(uri, this)
} ?: throw NullPointerException("Uri insert fail, Please change the file name")
} else {
Uri.fromFile(File(context.getExternalFilesDir(Environment.DIRECTORY_DOWNLOADS), displayName))
}
}
}
這裏簡單介紹下上面的代碼，本文後續會詳細介紹爲啥定義這樣一個類，以及如何構建一個Uri對象。
- 首先就是繼承
UriFactory抽象類，實現getUri(Response)方法 - 接着就在實現方法裏判斷SDK版本，Android 10以上，就經過
contentResolver構建Uri對象，不然就根據File對象構建Uri對象，這樣就能夠兼容到全部系統版本 - 最後返回
Uri對象便可
注：以上代碼，基本能夠知足大部分人的需求，如你有特殊需求，構建Uri的過程的做出簡單的修改便可
有了Android10DownloadFactory類，執行Android 10下載就會及其方便，以下：
val factory = Android10DownloadFactory(context, "test.apk")
//kotlin 協程
val uri = RxHttp.get("/service/.../xxx.apk")
.toDownload(factory)
.await() //這裏返回工廠類構建的Uri對象
//RxJava
RxHttp.get("/service/.../xxx.apk")
.asDownload(factory)
.subscribe({
//成功回調，這裏返回工廠類構建的Uri對象
}, {
//異常失敗
})
以上asDownload、toDownload方法都接收一個UriFactory類型參數，故咱們能夠直接傳入Android10DownloadFactory對象。
4.二、帶進度下載
對於帶進度下載，咱們只須要調用asDownload、toDownload方法時，傳入線程調度器及進度回調便可，以下：
Android 10以前
val localPath = "/sdcard/.../xxx.apk"
//kotlin 協程
val result = RxHttp.get("/service/.../xxx.apk")
.toDownload(localPath, Dispatchers.Main) {
//下載進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.await() //這裏返回sd卡存儲路徑
//RxJava
RxHttp.get("/service/.../xxx.apk")
.asDownload(localPath, AndroidSchedulers.mainThread()) {
//下載進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.subscribe({
//成功回調，這裏返回sd卡存儲路徑
}, {
//異常失敗
})
Android 10以上，傳入咱們定義的Android10DownloadFactory對象的同時，再傳入傳入線程調度器及進度監聽便可，以下：
val factory = Android10DownloadFactory(context, "test.apk")
//kotlin 協程
val uri = RxHttp.get("/service/.../xxx.apk")
.toDownload(factory, Dispatchers.Main) {
//下載進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.await() //這裏返回工廠類構建的Uri對象
//RxJava
RxHttp.get("/service/.../xxx.apk")
.asDownload(factory, AndroidSchedulers.mainThread()) {
//下載進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.subscribe({
//成功回調，這裏返回工廠類構建的Uri對象
}, {
//異常失敗
})
4.三、帶進度斷點下載
對於斷點下載，咱們須要調用一系列asAppendDownload、toAppendDownload方法，能夠把它們理解爲追加下載，實現以下：
Android 10以前
val localPath = "/sdcard/.../xxx.apk"
//kotlin 協程
val result = RxHttp.get("/service/.../xxx.apk")
.toAppendDownload(localPath, Dispatchers.Main) {
//下載進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.await() //這裏返回sd卡存儲路徑
//RxJava
RxHttp.get("/service/.../xxx.apk")
.asAppendDownload(localPath, AndroidSchedulers.mainThread()) {
//下載進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.subscribe({
//成功回調，這裏返回sd卡存儲路徑
}, {
//異常失敗
})
在Android 10上，有一點須要注意的是，咱們在構建Android10DownloadFactory對象時，須要傳入第三個參數queryUri，能夠把它理解爲要查詢的文件夾，斷點下載，RxHttp內部會根據文件名在指定的文件夾下查找對應的文件，獲得當前文件的長度，也就是斷點位置，從而告訴服務端從哪裏開始下載，以下：
val queryUri = MediaStore.Downloads.EXTERNAL_CONTENT_URI
//在Download目錄下查找test.apk文件
val factory = Android10DownloadFactory(context, "test.apk", queryUri)
//kotlin 協程
val uri = RxHttp.get("/service/.../xxx.apk")
.toAppendDownload(factory, Dispatchers.Main) {
//下載進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.await() //這裏返回工廠類構建的Uri對象
//RxJava
RxHttp.get("/service/.../xxx.apk")
.asAppendDownload(factory, AndroidSchedulers.mainThread()) {
//下載進度回調,0-100，僅在進度有更新時纔會回調
val currentProgress = it.progress //當前進度 0-100
val currentSize = it.currentSize //當前已上傳的字節大小
val totalSize = it.totalSize //要上傳的總字節大小
}
.subscribe({
//成功回調，這裏返回工廠類構建的Uri對象
}, {
//異常失敗
})
五、如何構建Uri對象？
在上面代碼中，咱們自定義了Android10DownloadFactory類，其中最爲關鍵的代碼就是如何構建一個Uri對象，接下來，就教你們如何去構建一個Uri，立刻開始，以下：
public Uri getUri(Context context) {
ContentValues values = new ContentValues();
//一、配置文件名
values.put(MediaStore.MediaColumns.DISPLAY_NAME, "1.jpg");
//二、配置文件類型
values.put(MediaStore.MediaColumns.MIME_TYPE, "image/jpeg")
//三、配置存儲目錄
values.put(MediaStore.MediaColumns.RELATIVE_PATH, Environment.DIRECTORY_DCIM);
//四、將配置好的對象插入到某張表中，最終獲得Uri對象
return context.getContentResolver().insert(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, values);
}
-
第一步，配置文件名稱，這個就沒啥好說的了
-
第二步，配置文件類型，每一個文件都應該有一個類型描述，這樣，後續查找時，就能夠根據這個類型去查找出同一類型的文件，如:查找相冊，此屬性是可選的，若是不配置，後續就沒法根據類型查找到這個文件
-
第三步，配置存儲目錄，這個是相對路徑，總共有10個目錄可選，以下：
Environment.DIRECTORY_DOCUMENTS對應路徑：/storage/emulated/0/Documents/Environment.DIRECTORY_DOWNLOADS對應路徑：/storage/emulated/0/Download/Environment.DIRECTORY_DCIM對應路徑：/storage/emulated/0/DCIM/Environment.DIRECTORY_PICTURES對應路徑：/storage/emulated/0/Pictures/Environment.DIRECTORY_MOVIES對應路徑：/storage/emulated/0/Movies/Environment.DIRECTORY_ALARMS對應路徑：/storage/emulated/0/Alrams/Environment.DIRECTORY_MUSIC對應路徑：/storage/emulated/0/Music/Environment.DIRECTORY_NOTIFICATIONS對應路徑：/storage/emulated/0/Notifications/Environment.DIRECTORY_PODCASTS對應路徑：/storage/emulated/0/Podcasts/Environment.DIRECTORY_RINGTONES對應路徑：/storage/emulated/0/Ringtones/
若是須要在以上目錄下，建立子目錄，則傳入的時候，直接帶上便可，以下
values.put(MediaStore.MediaColumns.RELATIVE_PATH, Environment.DIRECTORY_DCIM + "/RxHttp");
-
第四步，插入到對應的表中，總共有5張表可選，以下：
- 存儲圖片：
MediaStore.Images.Media.EXTERNAL_CONTENT_URI - 存儲視頻：
MediaStore.Video.Media.EXTERNAL_CONTENT_URI - 存儲音頻：
MediaStore.Audio.Media.EXTERNAL_CONTENT_URI - 存儲任意文件：
MediaStore.Downloads.EXTERNAL_CONTENT_URI - 存儲任意文件：
MediaStore.Files.getContentUri(MediaStore.VOLUME_EXTERNAL)
- 存儲圖片：
須要特殊說明下，以上5張表中，只能存入對應文件類型的信息，如咱們不能將音頻文件信息，插入到MediaStore.Images.Media.EXTERNAL_CONTENT_URI圖片表中，插入時，系統會直接拋出異常
注意事項
以上5張表中，除了對插入的文件類型有限制外，還對要插入的相對路徑有限制，如，咱們將一個apk文件下載/storage/emulated/0/Download/RxHttp/目錄下，並插入到圖片表中，以下：
public Uri getUri(Context context) {
ContentValues values = new ContentValues();
values.put(MediaStore.MediaColumns.DISPLAY_NAME, "1.apk");
values.put(MediaStore.MediaColumns.RELATIVE_PATH, Environment.DIRECTORY_DOWNLOADS + "/RxHttp");
return context.getContentResolver().insert(MediaStore.Images.Media.EXTERNAL_CONTENT_URI, values);
}
當執行到insert操做時，系統將會直接報錯，報錯信息以下:
Primary directory Download not allowed for content://media/external/images/media; allowed directories are [DCIM, Pictures]
大體意思就是，Download目錄不容許插入到MediaStore.Images.Media.EXTERNAL_CONTENT_URI表中，該表只容許插入DCIM和Pictures目錄
六、小結
開源不易，寫文章更不易，喜歡的話，還需勞煩你們給本文點個贊，能夠的話，再給個star，我將感激涕零，🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏
相關文章
- 1. Android 史上最優雅的實現文件上傳、下載及進度的監聽
- 2. 文件上傳、下載進度監聽 angular
- 3. Android網絡開源庫-Retrofit(二) 文件上傳、下載及進度監聽
- 4. 【封裝】使用okHttp發送網絡請求及上傳下載進度監聽
- 5. Spring MVC 監聽文件上傳進度，實現上傳進度條
- 6. 完美解決android軟鍵盤監聽
- 7. 一行代碼實現Okhttp,Retrofit,Glide下載上傳進度監聽
- 8. Android OkHttp + Retrofit 下載文件與進度監聽
- 9. Android 屏幕完美適配方案
- 10. Android多屏適配完美方案
- 更多相關文章...
- • PHP 文件上傳 - PHP教程
- • MySQL下載步驟詳解 - MySQL教程
- • IDEA下SpringBoot工程配置文件沒有提示
- • Flink 數據傳輸及反壓詳解
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
最新文章
- 1. 融合阿里雲，牛客助您找到心儀好工作
- 2. 解決jdbc(jdbctemplate)在測試類時不報錯在TomCatb部署後報錯
- 3. 解決PyCharm GoLand IntelliJ 等 JetBrains 系列 IDE無法輸入中文
- 4. vue+ant design中關於圖片請求不顯示的問題。
- 5. insufficient memory && Native memory allocation (malloc) failed
- 6. 解決IDEA用Maven創建的Web工程不能創建Java Class文件的問題
- 7. [已解決] Error: Cannot download ‘https://start.spring.io/starter.zip?
- 8. 在idea讓java文件夾正常使用
- 9. Eclipse啓動提示「subversive connector discovery」
- 10. 帥某-技巧-快速轉帖博主文章（article_content）
歡迎關注本站公眾號,獲取更多信息
相關文章