使用 circe 将 Scala None 编码为 JSON 值

Question

假设我有以下 case 类需要使用 circe 序列化为 JSON 对象：

@JsonCodec
case class A(a1: String, a2: Option[String])

@JsonCodec
case class B(b1: Option[A], b2: Option[A], b3: Int)

现在我需要将val b = B(None, Some(A("a", Some("aa")), 5)编码为 JSON 但我希望能够控制它是否输出为

{
  "b1": null,
  "b2": {
          "a1": "a",
          "a2": "aa"
        },
  "b3": 5
}

或者

{
  "b2": {
          "a1": "a",
          "a2": "aa"
        },
  "b3": 5
}

使用Printer的dropNullKeys配置，例如b.asJson.noSpaces.copy(dropNullKeys = true)将导致从输出中省略None s，而将其设置为false会将None s 编码为null （ 另请参阅此问题）。 但是如何在每个字段的基础上控制此设置？

Answer 1

最好的方法可能只是为B的半自动衍生编码器添加一个后处理步骤：

import io.circe.{ Decoder, JsonObject, ObjectEncoder }
import io.circe.generic.JsonCodec
import io.circe.generic.semiauto.{ deriveDecoder, deriveEncoder }

@JsonCodec
case class A(a1: String, a2: Option[String])
case class B(b1: Option[A], b2: Option[A], b3: Int)

object B {
  implicit val decodeB: Decoder[B] = deriveDecoder[B]
  implicit val encodeB: ObjectEncoder[B] = deriveEncoder[B].mapJsonObject(
    _.filter {
      case ("b1", value) => !value.isNull
      case _ => true
    }
  )
}

进而：

scala> import io.circe.syntax._
import io.circe.syntax._

scala> B(None, None, 1).asJson.noSpaces
res0: String = {"b2":null,"b3":1}

您可以调整过滤器的参数以从 JSON 对象中删除您想要的任何空值字段（这里我只是删除B b1 ）。

值得注意的是，目前您无法将@JsonCodec注释和伴生对象中显式定义的实例结合起来。 这不是注释的固有限制——我们可以在宏扩展期间检查伴生对象是否有“覆盖”实例，但这样做会使实现变得更加复杂（现在它非常简单）。 解决方法非常简单（只需显式使用deriveDecoder ），但当然我们很乐意考虑一个问题，要求支持混合和匹配@JsonCodec和显式实例。

Answer 2

Circe 在Json上添加了一个dropNullValues方法，它使用了上面提到的 Travis Brown 。

def dropNulls[A](encoder: Encoder[A]): Encoder[A] =
    encoder.mapJson(_.dropNullValues)

implicit val entityEncoder: Encoder[Entity] = dropNulls(deriveEncoder)