[英]Decoding JSON values in circe where the key is not known at compile time
假设我一直在使用这样的JSON:
{ "id": 123, "name": "aubergine" }
通过将其解码为Scala案例类,如下所示:
case class Item(id: Long, name: String)
这与circe的泛型推导一样正常:
scala> import io.circe.generic.auto._, io.circe.jawn.decode
import io.circe.generic.auto._
import io.circe.jawn.decode
scala> decode[Item]("""{ "id": 123, "name": "aubergine" }""")
res1: Either[io.circe.Error,Item] = Right(Item(123,aubergine))
现在假设我想在表示中添加本地化信息:
{ "id": 123, "name": { "localized": { "en_US": "eggplant" } } }
我不能通过泛型派生直接使用这样的case类:
case class LocalizedString(lang: String, value: String)
...因为语言标签是键,而不是字段。 我怎么能这样做,最好没有太多的样板?
您可以通过几种不同的方式将单例JSON对象解码为类似LocalizedString
的案例类。 最简单的是这样的:
import io.circe.Decoder
implicit val decodeLocalizedString: Decoder[LocalizedString] =
Decoder[Map[String, String]].map { kvs =>
LocalizedString(kvs.head._1, kvs.head._2)
}
这样做的缺点是在空JSON对象上抛出异常,并且对于存在多个字段的情况,行为未定义。 你可以修复这样的问题:
implicit val decodeLocalizedString: Decoder[LocalizedString] =
Decoder[Map[String, String]].map(_.toList).emap {
case List((k, v)) => Right(LocalizedString(k, v))
case Nil => Left("Empty object, expected singleton")
case _ => Left("Multiply-fielded object, expected singleton")
}
然而,这可能是低效的,特别是如果你有可能最终尝试解码真正大的JSON对象(它们将被转换为映射,然后是对的列表,只是失败。)。
如果你担心性能,你可以这样写:
import io.circe.DecodingFailure
implicit val decodeLocalizedString: Decoder[LocalizedString] = { c =>
c.value.asObject match {
case Some(obj) if obj.size == 1 =>
val (k, v) = obj.toIterable.head
v.as[String].map(LocalizedString(k, _))
case None => Left(
DecodingFailure("LocalizedString; expected singleton object", c.history)
)
}
}
但是,这解码了单例对象本身,并且在我们想要的表示中,我们有一个{"localized": { ... }}
包装器。 我们可以在最后添加一条额外的线:
implicit val decodeLocalizedString: Decoder[LocalizedString] =
Decoder.instance { c =>
c.value.asObject match {
case Some(obj) if obj.size == 1 =>
val (k, v) = obj.toIterable.head
v.as[String].map(LocalizedString(k, _))
case None => Left(
DecodingFailure("LocalizedString; expected singleton object", c.history)
)
}
}.prepare(_.downField("localized"))
这适用于我们更新的Item
类的一般派生实例:
import io.circe.generic.auto._, io.circe.jawn.decode
case class Item(id: Long, name: LocalizedString)
然后:
scala> val doc = """{"id":123,"name":{"localized":{"en_US":"eggplant"}}}"""
doc: String = {"id":123,"name":{"localized":{"en_US":"eggplant"}}}
scala> val Right(result) = decode[Item](doc)
result: Item = Item(123,LocalizedString(en_US,eggplant))
定制编码器更直接:
import io.circe.{Encoder, Json, JsonObject}, io.circe.syntax._
implicit val encodeLocalizedString: Encoder.AsObject[LocalizedString] = {
case LocalizedString(k, v) => JsonObject(
"localized" := Json.obj(k := v)
)
}
然后:
scala> result.asJson
res11: io.circe.Json =
{
"id" : 123,
"name" : {
"localized" : {
"en_US" : "eggplant"
}
}
}
这种方法适用于任何数量的“动态”字段 - 您可以将输入转换为Map[String, Json]
或JsonObject
并直接使用键值对。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.