Retrofit: как быть, когда структура ответа сервера меняется?

Question

[Степан]

Привет!

Разбираюсь с API, подробного описания к которому нет.
К примеру, GET-запрос к серверу: _https:_//server.net/getdetails/?ctn=4950000001
Если всё ОК, вернётся ответ с кодом 200:

• если номер не переводился между операторами:
  

{"code": "495", "num": "0000001", "full_num": "4950000001", "operator": "МГТС", "region": "г. Москва"}

• если была смена оператора с сохранением номера:
  

{"code": "900", "num": "5555555", "full_num": "9005555555", "operator": "ВымпелКом", "old_operator": "СИМ ТЕЛЕКОМ", "region": "г. Москва * Московская область"}

, добавляется параметр old_operator.

Если что-то не так с входными данными, вернётся ответ с кодом 404.
В теле ответа будет:

• это:
  

{"info": "Неверный формат номера: 49500000", "example": ["[phone]", "74959898533", "84959898533", "4959898533"]}

• это:
  

{"info": "Номер не найден. Проверьте код города: 000", "example": ["3XX", "4XX", "8XX", "9XX"]}

• или это:
  

{"info": "Неверный формат запроса, ctn обязательный параметр", "example": "https://server.net/getdetails/?ctn=[phone]"}

Как обрабатывать ответ сервера с помощью Retrofit? Возможно ли это?
Насколько я понял, он (Retrofit) создаёт из ответа объект, с которым потом я могу работать.
Как быть в случае, если меняется и сам ответ сервера (код, содержимое), так и формат правильного JSON-ответа?

Answer 1

[Денис Загаевский]

Да с этим можно жить. Сам Ретрофит не конвертит ответ в json, для этого ему проставляется addConverterFactory(factory). Нужно написать кастомный адаптер для той библиотеки конвертации json, которую ты используешь(примеры про Gson). Из ответа придется понимать, что именно пришло и возвращать соответствующий объект.

Comments

[Степан]

Будет ли корректным описание двух конструкторов под разные варианты ответа сервера? Имеется ли в этом смысл?
Помогут ли аннотации в описании свойств класса? Что будет, если у свойства будет аннотация , например, @SerializedName("old_operator"), а в JSON-ответе самой "переменной" не будет?
Можно ли с помощью Retrofit узнать, с каким кодом ответил сервер (200/404)? Или это нужно делать своими силами?

P.S. Вы отметили свой ответ решением?

[Денис Загаевский]

Степан, у коллбека есть метод onResponse, куда приходит Response, из которого можно взять status code.
Имеется смысл сделать разные классы под разные ответы, иначе получится просто месиво из всех возможных вариантов, и ты замучаешься это разгребать.
Что будет зависит от твоего json-конвертера, скорее всего будет null в этом поле.

[Степан]

К сожалению, особо понятнее не стало...

Я это вижу так: "месиво из всех возможных вариантов" будет представлять собой два класса, отличающихся одним свойством. Я и этого хочу избежать. И хочу избежать создания объекта класса "PhoneNumber" в принципе, если пришёл ответ к кодом 404.

Накидал вот такую структуру класса:

public class PhoneNumber {

    private String code;
    private String num;
    private String full_num;
    private String operator;
    private String old_operator;
    private String region;
    private String number;

    //Если у номера не было смены оператора
    public PhoneNumber (String code, String num, String full_num, String operator, String region) {
        this.code = code;
        this.num = num;
        this.full_num = full_num;
        this.operator = operator;
        this.old_operator = null;
        this.region = region;
    }

    //Если номер ПЕРЕХОДИЛ от одного оператора к другому (добавляется old_operator)
    public PhoneNumber (String code, String num, String full_num, String operator, String old_operator, String region) {
        this.code = code;
        this.num = num;
        this.full_num = full_num;
        this.operator = operator;
        this.old_operator = old_operator;
        this.region = region;
    }
...

Всё работало через HttpURLConnection.
Решил переписать с Ретрофитом, но пока не могу с ним разобраться...

[Денис Загаевский]

Степан, очевидно с HttpUrlConnection ты раскладывал поля руками. Ты до сих пор не написал, какую именно либу ты используешь для конвертирорвания Json'a. В принципе, в любой можно написать кастомный TypeAdapter, в котором ты примерно так же будешь руками раскладывать свои поля. Хочешь сделать один класс со всеми(опциональными) полями, сделай так.
Ты уже сходил почитать про Gson по ссылке, которую я давал?
Ты выяснил, как пользоваться addConverterFactory?
Ты почитал про метод onResponse?

[Степан]

Ты до сих пор не написал, какую именно либу ты используешь для конвертирорвания Json'a.

Я не использовал либы. Я писал так:

...
if (response != null && !response.isEmpty()){
                try {
                    JSONObject jsonObject = new JSONObject(response);
                    p = new PhoneNumber(jsonObject.getString("full_num"),
                                                    jsonObject.getString("operator"),
                                                    jsonObject.getString("region"));
...

После чего решил почитать, как делать "по-взрослому". Узнал про Retrofit, но ещё не успел им воспользоваться. Пока что мне это даётся нелегко.
Статью про gson я прочитал, логика работы в целом ясна (когда читаешь), пока разбираю на более простых примерах...

[Денис Загаевский]

Степан, это не масштабируется. Бери gson/moshi/jackson, станет жить лучше

[Степан]

Вроде немного разобрался. Использую gson для преобразования из JSON-строки в объект.
Решил пойти таким путём: создал два класса. Один используется в случае успешного ответа (когда возвращается информация о самом номере):

{"code": "495", "num": "0000001", "full_num": "4950000001", "operator": "МГТС", "region": "г. Москва"}

или

{"code": "900", "num": "5555555", "full_num": "9005555555", "operator": "ВымпелКом", "old_operator": "СИМ ТЕЛЕКОМ", "region": "г. Москва * Московская область"}

а другой - в случае ответа с информацией об ошибке:

{"info": "Неверный формат номера: 49500000", "example": ["[phone]", "74959898533", "84959898533", "4959898533"]}

{"info": "Номер не найден. Проверьте код города: 000", "example": ["3XX", "4XX", "8XX", "9XX"]}

{"info": "Неверный формат запроса, ctn обязательный параметр", "example": "https://server.net/getdetails/?ctn=[phone]"}

В случае onResponse используется объект "Номер", а в случае onErrorResponse - объект "Ошибка".
Текущий результат можно посмотреть здесь: https://github.com/StepanMe/PhoneInfo