Moshi: анализ одного объекта или списка объектов (котлин)

Я создаю приложение, которое может извлекать объект Warning из API, который я не контролирую, и при этом они не хотят удалять это поведение, с которым я пытаюсь обойти.

Я хотел бы иметь возможность анализировать либо один объект Warning, либо объект List<Warning>. (Поскольку API возвращает либо 1 объект, если имеется только 1, либо> 1 список объектов.)

Вопрос

Как я могу проанализировать объект как список напрямую или проанализировать его с помощью Moshi?

Данные, которые я получаю, выглядят так:

{
  # List<Warning>
  "warnings": [{...}, {...}]
}

или вот так:

{
  # Warning
  "warnings": {...}
}

Я прочитал и нашел некоторые источники по этой теме, но нет примеров, и я не уверен, что делать дальше ... так что любые указатели будут очень признательны.

Попытка

Изначально я пытался установить автогенерированный адаптер моши, думая, что смогу построить на нем, но я не мог понять, что происходит, так что это меня ни к чему не привело. Но я все равно включил сгенерированный код на тот случай, если он все еще может быть полезен для задачи.

Изменить: это то, что у меня есть в настоящее время, хотя мне не очень нравится тот факт, что для работы требуется экземпляр Moshi.

Решение

Обобщенный подход с фабрикой

Я попытался перенести адаптер, который Эрик написал, на kotlin, поскольку с тех пор я понял, что более общий подход лучше, чем Эрик указывает в своем ответе. Как только это сработает, я перепишу части этого поста, чтобы сделать его более понятным, теперь это немного запутано, я прошу прощения за это.

РЕДАКТИРОВАТЬ: в итоге я использовал решение, предложенное Эриком в другом потоке, но перенесенное на Kotlin.

Адаптер с заводом

class SingleToArrayAdapter(
    val delegateAdapter: JsonAdapter<List<Any>>,
    val elementAdapter: JsonAdapter<Any>
) : JsonAdapter<Any>() {

    companion object {
        val INSTANCE = SingleToArrayAdapterFactory()
    }

    override fun fromJson(reader: JsonReader): Any? =
        if (reader.peek() != JsonReader.Token.BEGIN_ARRAY) {
            Collections.singletonList(elementAdapter.fromJson(reader))
        } else delegateAdapter.fromJson(reader)

    override fun toJson(writer: JsonWriter, value: Any?) =
        throw UnsupportedOperationException("SingleToArrayAdapter is only used to deserialize objects")

    class SingleToArrayAdapterFactory : JsonAdapter.Factory {
        override fun create(type: Type, annotations: Set<Annotation>, moshi: Moshi): JsonAdapter<Any>? {
            val delegateAnnotations = Types.nextAnnotations(annotations, SingleToArray::class.java)
            if (delegateAnnotations == null) return null
            if (Types.getRawType(type) != List::class.java) throw IllegalArgumentException("Only lists may be annotated with @SingleToArray. Found: $type")
            val elementType = Types.collectionElementType(type, List::class.java)
            val delegateAdapter: JsonAdapter<List<Any>> = moshi.adapter(type, delegateAnnotations)
            val elementAdapter: JsonAdapter<Any> = moshi.adapter(elementType)

            return SingleToArrayAdapter(delegateAdapter, elementAdapter)
        }
    }
}

Квалификатор

Примечание: мне пришлось добавить Target(FIELD).

@Retention(RUNTIME)
@Target(FIELD)
@JsonQualifier
annotation class SingleToArray

использование

Отметьте поле, которое вы хотите убедиться, что оно проанализировано как список, с помощью @SingleToArray.

data class Alert(
    @SingleToArray
    @Json(name = "alert")
    val alert: List<Warning>
)

и не забудьте добавить адаптер в свой экземпляр moshi:

val moshi = Moshi.Builder()
            .add(SingleToArrayAdapter.INSTANCE)
            .build()

Связанные вопросы / темы:


person sphrak    schedule 16.11.2018    source источник


Ответы (1)


API возвращает либо 1 объект, если имеется только 1, либо> 1 список объектов.

Создайте адаптер, который сначала проверяет, получаете ли вы массив. Вот именно то, что вам нужно . Он включает квалификатор, поэтому вы можете применять его только к спискам, которые могут иметь такое поведение для отдельных элементов. @SingleToArray List<Warning>.

Есть еще один пример работы с несколькими форматами здесь для дальнейшего чтения.

person Eric Cochran    schedule 19.11.2018
comment
Эрик, спасибо за ваш ответ - ссылки, которые вы разместили, действительно то, что я ищу, и в итоге я получил что-то в этом роде, однако мне кажется, что я все еще что-то упускаю. Я обновил свой ответ с помощью текущего кода адаптера, который я использую, он работает, но кажется грязным ... что вы думаете? - person sphrak; 19.11.2018
comment
Используйте JsonAdapter.Factory, и вам не нужно будет передавать экземпляр Moshi. - person Eric Cochran; 19.11.2018
comment
Я попытался использовать Factory, чтобы избежать экземпляра moshi, но каким-то образом это полностью изменило поведение адаптера, но я думаю, что я близок, мне, вероятно, просто не хватает чего-то тривиального. Тем временем я добавил код для справки. - person sphrak; 21.11.2018
comment
В конце концов я заставил его работать, забыл очистить проект между сборками. Я благодарю вас и также принял ваш ответ, поскольку в конечном итоге я использовал именно его :) - person sphrak; 26.11.2018