Модифицированный пользовательский json конвертер Gson - PullRequest
0 голосов
/ 26 сентября 2019

Раньше я работал с 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 выполнять тяжелую работу в классе My Converter следующим образом:

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, который знает, как преобразовать мой ответ в ApiResponse<RegisterResponseData>?И знает, что свойство data из ответа должно быть преобразовано в объект типа RegisterResponseData ...

1 Ответ

1 голос
/ 26 сентября 2019

Когда вы указываете тип возврата в клиенте Retrofit, он передается конвертеру Retrofit как тип, а затем Gson получает этот тип, который будет вашим ApiResponse<RegisterResponseData>.С этого момента Gson поймет, что data имеет тип RegisterResponseData и будет производить объект вашей модели.

Просто попробуйте его без ApiResponseDeserializer, и вы увидите, что он работает.

Редактировать: Отвечая на ваш дополнительный вопрос в комментариях:

Если вы хотите пропустить свой объект "body" в json, вы можете написать свой объект-обертку так:

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);
...