Circe从蛇案例密钥中解析json

Question

我有以下案例课：

final case class Camel(firstName: String, lastName: String, waterPerDay: Int)

和circe配置：

object CirceImplicits {

  import io.circe.syntax._
  import io.circe.generic.semiauto._
  import io.circe.{Encoder, Decoder, Json}
  import io.circe.generic.extras.Configuration

  implicit val customConfig: Configuration =
    Configuration.default.withSnakeCaseMemberNames.withDefaults
  implicit lazy val camelEncoder: Encoder[Camel] = deriveEncoder
  implicit lazy val camelDecoder: Decoder[Camel] = deriveDecoder
}

这是可以的，当测试这一点时：

val camel = Camel(firstName = "Camelbek", lastName = "Camelov", waterPerDay = 30)

private val camelJ = Json.obj(
    "firstName" -> Json.fromString("Camelbek"),
    "lastName" -> Json.fromString("Camelov"),
    "waterPerDay" -> Json.fromInt(30)
)

"Decoder" must "decode camel types" in {
    camelJ.as[Camel] shouldBe Right(camel)
}

但这个测试没有通过：

val camel = Camel(firstName = "Camelbek", lastName = "Camelov", waterPerDay = 30)

private val camelJ = Json.obj(
    "first_name" -> Json.fromString("Camelbek"),
    "last_name" -> Json.fromString("Camelov"),
    "water_per_day" -> Json.fromInt(30)
)

"Decoder" must "decode camel types" in {
    camelJ.as[Camel] shouldBe Right(camel)
}

如何正确配置circe以便能够在蛇的情况下解析带有密钥的json？

我在使用circe版本的0.10.0

Answer 1

解决方案1

Circe从case类实例中获取字段名，并使用游标遍历JSON，尝试获取每个字段名的值，并尝试将其转换为所需的类型。

这意味着你的解码器不能同时处理这两种情况。

解决这个问题的方法是编写两个解码器：

1. 基本解码器(deriveEncoder将工作)
2. 编码器，它使用HCursor在JSON中导航并获取蛇案例密钥

val decoderDerived: Decoder[Camel] = deriveDecoder
val decoderCamelSnake: Decoder[Camel] = (c: HCursor) =>
    for {
      firstName <- c.downField("first_name").as[String]
      lastName <- c.downField("last_name").as[String]
      waterPerDay <- c.downField("water_per_day").as[Int]
    } yield {
      Camel(firstName, lastName, waterPerDay)
    }

然后，您可以使用Decoder#or将这两个解码器组合成一个。

implicit val decoder: Decode[Camel] = decoderDerived or decoderCamelSnake

Decoder#or将尝试使用第一个解码器进行解码，如果它失败，那么它将尝试第二个解码器。

解决方案2

如果您只接受camel_case输入，那么您可以使用来自"io.circe" %% "circe-generic-extras" % circeVersion包的@ConfiguredJsonCodec。请注意，要使用此注释，您还需要包括天堂编译器插件。

addCompilerPlugin(
  "org.scalamacros" % "paradise" % "2.1.1" cross CrossVersion.full
)

@ConfiguredJsonCodec
case class User(
  firstName: String,
  lastName: String
)

object User {
  implicit val customConfig: Configuration = Configuration.default.withSnakeCaseMemberNames
}

val userJson = User("John", "Doe").asJson
println(userJson)
// { "first_name" : "John", "last_name" : "Doe" } 

val decodedUser = decode[User](userJson.toString)
println(decodedUser)
// Right(User("John", "Doe"))

另外，请注意，您不需要编写自定义解码器和编码器派生程序，因为该配置为您提供了该功能。

Answer 2

另一种无需注释的解决方案：

case class Camel(firstName: String, lastName: String)

object Camel extends AutoDerivation {
  implicit val config: Configuration = Configuration.default.withSnakeCaseMemberNames
  implicit val decoder: Decoder[Camel] = exportDecoder[Camel].instance
  implicit val encoder: Encoder[Camel] = exportEncoder[Camel].instance
}

  val json = Camel("aaa", "bbb").asJson.noSpaces
  val obj  = decode[Camel](json)