我之前一直在几个项目中使用 Retrofit,但现在我想做一些稍微不同的事情。我正在调用一个 api,它将我的响应包装在类似于以下的结构中:
{ // only for demo purposes. Probably errors and data will never be populated together
"body": {
"errors": {
"username": [
"Username is too short",
"Username already exists"
]
},
"data": {
"message": "User created."
}
}
}
我正在尝试将所有这些转换为一个通用类,它将为我包装该响应。我的想法是这样的
public class ApiResponse<T> {
private T data;
private Map<String, List<String>> errors;
public ApiResponse(T data, Map<String, List<String>> errors) {
this.data = data;
this.errors = errors;
}
}
哪里T
可以是任何类。
我尝试实现 JsonDeserializer<ApiResponse<T>>
基于我在互联网上找到的一些示例,但我无法理解如何使其尽可能自动工作并让 Retrofit 和 Gson 完成繁重的工作
我的转换器类如下:
public class ApiResponseDeserializer<T> implements JsonDeserializer<ApiResponse<T>> {
private Class clazz;
public ApiResponseDeserializer(Class clazz) {
this.clazz = clazz;
}
@Override
public ApiResponse deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
final JsonObject jsonObject = json.getAsJsonObject();
final JsonObject body = jsonObject.getAsJsonObject("body");
final JsonObject errors = body.getAsJsonObject("errors");
final JsonObject data = body.getAsJsonObject("data");
Map<String, List<String>> parsedErrors = new HashMap<>();
for(String key : errors.keySet()) {
List<String> errorsList = new ArrayList<>();
JsonArray value = errors.getAsJsonArray(key);
Iterator<JsonElement> valuesIterator = value.iterator();
while(valuesIterator.hasNext()) {
String error = valuesIterator.next().getAsString();
errorsList.add(error);
}
parsedErrors.put(key, errorsList);
}
T parsedData = context.deserialize(data, clazz);
return new ApiResponse<T>(parsedData, parsedErrors);
}
}
然后在构建我的改造客户端时
public static Retrofit getClient() {
if (okHttpClient == null) {
initOkHttp();
}
Gson gson = new GsonBuilder()
.registerTypeAdapter(ApiResponse.class, new ApiResponseDeserializer<>(......) // PROBLEM
.create();
if (retrofit == null) {
retrofit = new Retrofit.Builder()
.baseUrl(Const.API_BASE_URL)
.client(okHttpClient)
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.addConverterFactory(GsonConverterFactory.create(gson))
.build();
}
return retrofit;
}
但我觉得它不够通用,无法自动转换我的类。而且我也不知道该怎么暗示Gson
我的是什么类型的data
.
我的端点定义如下:
@POST("users/signup")
Single<ApiResponse<RegisterResponseData>> register(@Body RegisterRequest request);
但是我如何使用通用 Gson 类型适配器制作通用 Retrofit 实例,该适配器知道如何将我的响应转换为 ApiResponse<RegisterResponseData>
?并且知道data
响应中的属性应转换为 RegisterResponseData
类型的对象...
最佳答案
当您在 Retrofit 的客户端中指定返回类型时,它会作为 Type 传递给 Retrofit 的转换器,然后 Gson 接收该类型,这将是您的 ApiResponse<RegisterResponseData>
。从那时起,Gson 就会明白 data
类型为RegisterResponseData
并将生成您的模型对象。
不用你的 ApiResponseDeserializer
就试试吧你会看到它正在工作。
编辑: 在评论中回答您的其他问题:
如果你想跳过 json 中的“body”对象,你可以像这样编写包装对象:
public class ApiResponse<T> {
@SerializedName("body")
private ApiResponseBody<T> body;
public ApiResponse() {
}
public ApiResponse(ApiData<T> body) {
this.body = body;
}
}
public class ApiResponseBody<T> {
@SerializedName("data")
private T data;
@SerializedName("errors")
private Map<String, List<String>> errors;
public ApiResponseBody() {
}
public ApiResponseBody(T data, Map<String, List<String>> errors) {
this.data = data;
this.errors = errors;
}
}
并按常规方式使用
@POST("users/signup")
Single<ApiResponse<RegisterResponseData>> register(@Body RegisterRequest request);
关于java - 改造Gson自定义json通用转换器,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/58118698/