RxHttp 完美適配Android 10/11 上傳/下載/進度監聽

1、前言

隨着Android 11的正式發布，適配Android 10/11 分區存儲就更加的迫切了，因為Android 11開始，將強制開啟分區存儲，我們就無法再以絕對路徑的方式去讀寫非沙盒目錄下的文件，為此，RxHttp 在2.4.0版本中就正式適配了分區存儲，並且，可以非常優雅的實現文件上傳/下載/進度監聽，三步即可搞懂任意請求。

老規矩，先看看請求三部曲

如果你想了解RxHttp更過功能，請查看以下系列文章

RxHttp 2000+star，協程請求，僅需三步

RxHttp 讓你眼前一亮的Http請求框架

gradle依賴

必須

//使用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版本，可傳入rxjava2、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'
}

2、Android 10/11 分區存儲

當我們App的targetSdkVersion更改為28以上，並且運行在Android 10以上設備時，我們無法再以絕對路徑的方式，去讀寫非沙盒目錄下的文件，當然，如果App是覆蓋安裝（如：targetSdkVersion 28 覆蓋安裝為 29），則會保持原來的訪問方式。

requestLegacyExternalStorage屬性

如果我們的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又給了它新的含義，來看看官網的原話

也就是說，在Android 11設備上，targetSdkVersion為29以上的app，將強制開啟分區存儲，requestLegacyExternalStorage屬性失效

注意，只要同時滿足以上兩個條件，不管是覆蓋安裝還是requestLegacyExternalStorage = true，都會強制開啟分區存儲

分區存儲優勢

• 對用戶來說，解決了文件亂放的現象

• 對於開發者來說，我們無需寫權限，就可以在分區目錄下創建文件，並且訪問自己創建的文件，不需要讀權限（訪問其它應用創建的文件，還是需要讀權限）

新的文件訪問方式

此圖來源於作者[連續三屆村草]分享的Android 10(Q)/11(R) 分區存儲適配一文，感謝作者的總結

3、上傳

3.1、簡單上傳

在介紹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.2、帶進度上傳

老規矩，看看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!!

4、下載

下載較於上傳，要豐富很多，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.1、簡單下載

在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.2、帶進度下載

對於帶進度下載，我們只需要調用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.3、帶進度斷點下載

對於斷點下載，我們需要調用一系列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對象              
    }, {                
        //異常失敗                       
    }) 

5、如何構建Uri對象？

在上面代碼中，我們自定義了Android10DownloadFactory類，其中最為關鍵的代碼就是如何構建一個Uri對象，接下來，就教大家如何去構建一個Uri，馬上開始，如下：

public Uri getUri(Context context) {  
    ContentValues values = new ContentValues();
    //1、配置文件名                                                          
    values.put(MediaStore.MediaColumns.DISPLAY_NAME, "1.jpg");
    //2、配置文件類型
    values.put(MediaStore.MediaColumns.MIME_TYPE, "image/jpeg")
    //3、配置存儲目錄
    values.put(MediaStore.MediaColumns.RELATIVE_PATH, Environment.DIRECTORY_DCIM); 
    //4、將配置好的對象插入到某張表中，最終得到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目錄

6、小結

開源不易，寫文章更不易，喜歡的話，還需勞煩大家給本文點個贊，可以的話，再給個star，我將感激不盡，🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏