scala - Circe:强制可选字段为 `null`

Question

有没有办法将单个 None 字段序列化为“null”？

例如:

// When None, I'd like to serialize only f2 to `null`
case class Example(f1: Option[Int], f2: Option[Int])
val printer = Printer.noSpaces.copy(dropNullValues = true)

Example(None, None).asJson.pretty(printer) === """{"f2":null}"""

Answer 1

您可以通过将过滤器映射到编码器的输出(可以使用 Encoder.forProductN 等导出、定义)来非常简单地完成此操作:

import io.circe.{ Json, ObjectEncoder }
import io.circe.generic.semiauto.deriveEncoder

case class Example(f1: Option[Int], f2: Option[Int])

val keepSomeNulls: ((String, Json)) => Boolean = {
  case ("f1", v) => !v.isNull
  case (_, _) => true
}

implicit val encodeExample: ObjectEncoder[Example] =
  deriveEncoder[Example].mapJsonObject(_.filter(keepSomeNulls))

然后:

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

scala> Example(Some(1), Some(2)).asJson.noSpaces
res0: String = {"f1":1,"f2":2}

scala> Example(Some(1), None).asJson.noSpaces
res1: String = {"f1":1,"f2":null}

scala> Example(None, Some(2)).asJson.noSpaces
res2: String = {"f2":2}

scala> Example(None, None).asJson.noSpaces
res3: String = {"f2":null}

请注意，将打印机配置为删除 null 值仍会删除此处的 "f2": null。这是我认为一般情况下最好将空值的保存完全由打印机负责的部分原因，但在这种情况下，空值字段的存在或不存在显然在语义上是有意义的，因此您可以必须混合级别。