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}

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

Circe：强制可选字段为“null”

Circe: force an optional field to `null`

scala

circe