android - Moshi:解析单个对象或对象列表 (kotlin)

Question

问题

如何解析单个 Warning对象或 Warning 的列表使用 Moshi 来自 API 的对象 ( List<Warning> ) ？

作为单个警告的响应:

{
  "warnings": {...}
}

作为警告列表的响应:

{
  "warnings": [{...}, {...}]
}

反复试验

试图塞进一个自动生成的 Moshi适配器。试图在此基础上构建但失败了。

解决方案

工厂的通用方法

我尝试将 Eric 编写的适配器从 Java 翻译成 Kotlin，因为我意识到更通用的方法更好，就像 Eric 在他的回复中指出的那样。

一旦成功，我将修改这篇文章以使其更易于理解。抱歉，现在有点乱。

编辑:我最终使用了 solution Eric 在另一个线程中建议(翻译成 Kotlin)。

带工厂的适配器

package org.domain.name

import com.squareup.moshi.JsonAdapter
import com.squareup.moshi.JsonQualifier
import com.squareup.moshi.JsonReader
import com.squareup.moshi.JsonWriter
import com.squareup.moshi.Moshi
import com.squareup.moshi.Types
import java.util.Collections
import java.lang.reflect.Type
import kotlin.annotation.AnnotationRetention.RUNTIME
import kotlin.annotation.AnnotationTarget.FIELD

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

    companion object {
        val factory = 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) ?: return null
            if (Types.getRawType(type) !== List::class.java) throw IllegalArgumentException("Only List can 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.factory)
    .build()

引用

• Parse JSON key that is either object or array of object
• Moshi Determine if JSON is array or single object
• https://github.com/square/moshi

Answer 1

the API returns either 1 object if there is only 1 or > 1 a list of objects.

创建一个适配器，它可以查看您是否首先获得了一个数组。 Here正是你想要的。它包含一个限定符，因此您只能将它应用于可能对单个项目具有此行为的列表。 @SingleToArray List<Warning> .

还有一个处理多种格式的例子here进一步阅读。