Retrofit @Multipart@PartMap@Part組合的一種用法

James-Tom發表於2020-10-26

1、應用場景

有這樣一個需求:要實現附件與字串引數同時提交請求。
附件可能是多個,字串引數也可能是多個。

2、實現

2.1、api的宣告寫法

只實現多檔案上傳,處理方式如下:

	@Multipart
    @POST("api/uploadFile")
    fun uploadFiles(
        @Part parts: List<MultipartBody.Part>
    ): Call<ResponseBody>

實現多檔案上傳及多字串引數組合形式,處理方式如下:

	@Multipart
    @POST("api/uploadRecord")
    fun uploadRecord(
        @PartMap inspectionBean: Map<String, @JvmSuppressWildcards RequestBody>,
        @Part imgs: List<MultipartBody.Part>,
        @Part videos: List<MultipartBody.Part>
    ): Call<ResponseBody>

2.2、實際呼叫

實現多檔案上傳及多字串引數組合形式,實際呼叫如下:

    //selectedImageFilePaths 組裝檔案物件列表
    private var selectedImageFilePaths: ArrayList<File> = ArrayList()
    private var selectedVideoFilePaths: ArrayList<File> = ArrayList()

	val map = HashMap<String, RequestBody>()
	         map["id"] = toRequestBody(bean!!.id)
	         map["content"] = toRequestBody(bean!!.content)
	         
	val result :ResponseBody = uploadRecord(
            map,
            filesToMultipartBodyParts("imgs", selectedImageFilePaths)!!,
            filesToMultipartBodyParts("videos", selectedVideoFilePaths)!!,
            deleteFiles
        )
    //輸出
  	val jsonStr = String(result.bytes())
  	println(jsonStr)

toRequestBody子函式:

 	private fun toRequestBody(value: String): RequestBody {
        return RequestBody.create(MediaType.parse("text/plain"), value)
    }

filesToMultipartBodyParts子函式(將File轉成MultipartBody.Part):

   private fun filesToMultipartBodyParts(
        name: String,
        files: List<File>
    ): List<MultipartBody.Part>? {
        if (files == null) {
            return null
        }
        val parts: MutableList<MultipartBody.Part> =
            ArrayList(files.size)
        for (file in files) {
            val requestBody = RequestBody.create(MediaType.parse("*/*"), file)
            val part =
                MultipartBody.Part.createFormData(name, file.name, requestBody)
            parts.add(part)
        }
        return parts
    }

在api宣告處我們需要的引數是RequestBody型別的,所以需要將字串轉成RequestBody型別,子函式作用也在於此。

3、總結

關鍵字:
@PartMap:
不支援直接與@FormUrlEncoded同時使用,所以需要單獨注意字串編碼問題,主要是採用@PartMap是採用"binary"方式進行傳輸的。
支援多個ResponseBody方式傳輸。
@Part:單個ResponseBody方式傳輸。
RequestBody:存放請求資訊的物件,如header等資訊
MultipartBody.Part:多檔案上傳時要求的格式,繼承RequestBody這個類。
@JvmSuppressWildcards:用來註解類和方法,使得被標記元素的泛型引數不會被編譯成萬用字元,kotlin需要新增。

相關文章