改造 Gson 自定义 json 通用转换器

Question

我之前在几个项目中一直使用 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."
    }
  }
}

我正在尝试将所有这些转换为通用的 class，它将为我包装该响应。我的想法是

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 可以是任何 class.

我尝试根据我在 Internet 上找到的一些示例实现 JsonDeserializer<ApiResponse<T>>，但我无法全神贯注于如何使其尽可能自动工作，让 Retrofit 和 Gson 来完成繁重的工作提升我的转换器class如下：

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;
    }

但我觉得它不够通用，无法自动转换我的 classes。而且我也不知道我应该如何提示 Gson 我的 data.

类型

我的端点定义如下：

@POST("users/signup")
Single<ApiResponse<RegisterResponseData>> register(@Body RegisterRequest request);

但是我如何使用知道如何将我的响应转换为 ApiResponse<RegisterResponseData> 的通用 Gson 类型适配器创建一个通用 Retrofit 实例？并且知道响应中的 data 属性应该转换为 RegisterResponseData...

类型的对象

Answer 1

当您在 Retrofit 的客户端中指定 return 类型时，它会作为类型传递给 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);

改造 Gson 自定义 json 通用转换器

Retrofit Gson custom json generic converter

java

android

json

gson

retrofit2