时间戳

首页 > 解决方案 > 使用 Retrofit 2 上传对象数组中的文件

android - 使用 Retrofit 2 上传对象数组中的文件

问题描述

我使用 Retrofit2，我需要使用这样file的对象数组上传各种文件Media：

{
   "state" = "done",
   "medias" = [
     {
      "file" = THE_FILE1
     },
     {
      "file" = THE_FILE2
     },
     {
      "file" = THE_FILE3
     }
   ]
}

这是我的功能Interface：

@Multipart
@POST("api/exercice/{id}")
fun submitExercice(
    @Path("id") id: Int,
    @Header("Authorization") token: String,
    @Body data: AnswerExercice
): Call<Void>

这是我的目标Media：

    data class AnswerExercice(
    val state: String = "done",
    val medias: List<Media>
) : Serializable {
    data class Media(
        @Part val file: MultipartBody.Part
    ) : Serializable
}

但我有这个错误：

@Body 参数不能与表单或多部分编码一起使用。（参数#3）

我哪里做得不好？

这就是 API 文档所说的： 达

结果必须是这样的： 在此处输入图像描述

标签： androidretrofit2

解决方案

解决方案 1
如果您想完全按照您提到的结构发送数据，您应该将文件内容转换为Base64并将它们包装在可序列化的类中并将其作为正文发布。这是包装类的示例：

data class AnswerExerciceBase64(val state: String, val medias: List<Media>) : Serializable

data class Media(val file: Base64File) : Serializable

class Base64File(file: File) : Serializable {

    val name: String
    val content: String

    init {
        name = file.name
        content = Base64.encodeToString(FileInputStream(file).readBytes(), Base64.DEFAULT)
    }
}

你Api是这样的：

@POST("api/exercice/{id}")
fun submitExercice(
        @Path("id") id: Int,
        @Header("Authorization") token: String,
        @Body data: AnswerExerciceBase64
): Call<Void>

然后发布到服务器的数据将如下所示：

{
    "state": "this is state",
    "medias": [{
        "file": {
            "content": "Base64 file content",
            "name": "f1.txt"
        }
    }, {
        "file": {
            "content": "Base64 file content",
            "name": "f2.txt"
        }
    }, {
        "file": {
            "content": "Base64 file content",
            "name": "f3.txt"
        }
    }]
}

这种方法非常接近您想要的，但您应该知道您必须自己在服务器端解码文件内容，因此您需要在服务器端付出更多努力。


解决方案2
最好使用multipart/form-data上传文件和数据。基于“是否可以在多部分 POST 中有嵌套的 MultipartEntities 或 FormBodyPart？” 问题及其答案multipart/form-data具有扁平结构并且没有层次结构，因此您不能拥有所需的数据结构，但您仍然可以Api通过单个对象传递所有输入。
根据这篇文章，你可以在一个列表中发送多个文件，所以如果你Api是这样的

@Multipart
@POST("post")
fun submitExercice(@Part data: List<MultipartBody.Part>): Call<ResponseBody>

然后您将能够上传多个文件。您只需要创建一个列表MultipartBody.Part并将您的文件添加到其中，如下所示：

list.add(MultipartBody.Part.createFormData(name, fileName, RequestBody.create(mediaType, file)))

现在您必须将state参数添加到此列表中。你可以这样做：

list.add(MultipartBody.Part.createFormData("state", state))

我开发了一个类来处理所有这些东西。你可以使用它。

class AnswerExerciceList(state: String) : ArrayList<MultipartBody.Part>() {

    init {
        add(MultipartBody.Part.createFormData("state", state))
    }

    fun addFile(name: String, fileName: String, mediaType: MediaType?, file: File) {
        add(MultipartBody.Part.createFormData(name, fileName,
                RequestBody.create(mediaType, file)))
    }
}

您可以创建此类的实例，添加文件，然后将其submitExercice作为输入传递给 Api 方法。

更新
此答案基于您的 Api 文档。我测试了我的答案，你在问题中提到的例子https://postman-echo.com和结果是一样的。请尝试以下代码片段： Api

@Multipart
@POST("api/exercice/{id}")
fun submitExercice(@Path("id") id: Int,
                   @Header("Authorization") authorization: String,
                   @Part("answer") answer: String,
                   @Part medias: List<MultipartBody.Part>,
                   @Part("state") state: String): Call<ResponseBody>

媒体类

data class Media(val urlVidel: String, val file: File?, val mediaType: MediaType?) {
    companion object {
        fun mediaListToMultipart(mediaList: List<Media>): List<MultipartBody.Part> {
            val list = ArrayList<MultipartBody.Part>()
            for (i in mediaList.indices) {
                mediaList[i].let {
                    if (!TextUtils.isEmpty(it.urlVidel))
                        list.add(MultipartBody.Part.createFormData("medias[$i][urlVideo]", it.urlVidel))
                    if (it.file != null) {
                        val requestFile = RequestBody.create(
                                it.mediaType,
                                it.file
                        )
                        list.add(MultipartBody.Part.createFormData("medias[$i][file]", it.file.getName(), requestFile))
                    }
                }
            }
            return list
        }
    }
}

然后像这样调用 Api：

ApiHelper.Instance.submitExercice(1, "Authorization Token", "Answer", Media.mediaListToMultipart(mediaList), "State").enqueue(callback)

推荐阅读