[英]Uploading a file in an array of object using Retrofit 2
我使用 Retrofit2,我需要使用对象Media
数组中的file
上传各种文件,如下所示:
{
"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)
我做的不好吗?
解决方案 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"
}
}]
}
这种方法非常接近你想要的,但你应该知道你必须自己在服务器端解码文件内容,所以你需要在服务器端做更多的工作。
方案二
最好使用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)
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.