如何使用 retrofit 2 一起发送文件和其他参数

Question

我正在寻找如何将文件和其他参数一起发送到服务器的示例。

我必须发送服务器 JSON

{
    "title": "title",
    "file": "uploaded file instance",
    "location": {
        "lat": 48.8583,
        "lng": 2.29232,
        "place": "Eiffel Tower"
    }
}

如何创建 Retrofit 来处理这种情况？

如果文件是字符串，我知道如何处理。如果文件是文件对象，我不知道该怎么做。

Answer 1

使用 gson 并为该位置创建一个模型 class。

将以下依赖项添加到您的 build.gradle。

compile 'com.squareup.retrofit2:converter-gson:2.0.0'
compile 'com.google.code.gson:gson:2.5'

创建一个模型来表示位置。

public class Location {

    double lat;
    double lng;
    String location;

    public Location(double lat, double lon, String place) {
        this.lat = lat;
        this.lon = long;
        this.place = place;
    } 

}

如果有效负载字段的变量名称与端点的实际所需名称不匹配，您将需要添加注释 @SerializedName([expected name])

例如：

import com.google.gson.annotations.SerializedName;

public class Location {

    @SerializedName("lat")
    double latitude;
    @SerializedName("lng")
    double longitude;
    @SerializedName("place")
    String location;

    public Location(double lat, double lon, String place) {
        latitude = lat;
        longitude = long;
        location = place;
    } 

}

定义api接口。

public interface Api {

    @POST("upload/")
    @Multipart
    Call<ResponseBody> uploadFile(@Part("title") RequestBody title,
                                  @Part MultipartBody.Part imageFile,
                                  @Part("location") Location location
    );

}

创建一个 Retrofit 实例并调用 api.

File file;
// create retrofit instance
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://baseurl.com/api/")
        .addConverterFactory(GsonConverterFactory.create())
        .build();
// create api instance
Api api = retrofit.create(Api.class);
// create call object
Call<ResponseBody> uploadFileCall = api.uploadFile(
        RequestBody.create(MediaType.parse("text/plain"), "title"),
        MultipartBody.Part.createFormData(
            "file",
            file.getName(),
            RequestBody.create(MediaType.parse("image"), file)),
        new Location(48.8583, 2.29232, "Eiffel Tower"));
// sync call
try {
    ResponseBody responseBody = uploadFileCall.execute().body();
} catch (IOException e) {
    e.printStackTrace();
}
// async call
uploadFileCall.enqueue(new Callback<ResponseBody>() {
    @Override
    public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
        if (response.isSuccessful()) {
            // TODO
        }
    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {
        // TODO
    }
});

如果您不使用图像文件，则需要更改 MediaType.parse() 调用。

您可以类似地创建自定义响应类型对象并用它替换 ResponseBody 以接收反序列化的结果对象。

如果可行，请告诉我。显然我没有机会在您的确切场景中进行测试，但我相当有信心这应该有效。我唯一不是 100% 的部分是 @Part("location") Location location 是否应该是 @Body("location") Location location

Answer 2

截至 02.2020 @Abtin Gramian 的很棒，除了 RequestBody.create() 和 MediaType.parse() 已弃用 在 Kotlin 中，所以你必须使用：

file.asRequestBody("image".toMediaTypeOrNull())

而不是：

RequestBody.create(MediaType.parse("image"), file)

此外，我不得不手动编写以下内容：

import okhttp3.MediaType.Companion.toMediaTypeOrNull
import okhttp3.RequestBody.Companion.asRequestBody

如何使用 retrofit 2 一起发送文件和其他参数

how to use retrofit 2 to send file and other params together

android

android-networking

retrofit

retrofit2