11

假设我有以下案例类需要使用 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会将 s 编码None为null（另请参见此问题）。但是如何在每个字段的基础上控制这个设置呢？

4

2 回答 2

18

做到这一点的最好方法可能只是为半自动派生的编码器添加一个后处理步骤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 对象中删除您想要的任何空值字段（这里我只是删除b1in B）。

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

于 2017-02-21T15:00:22.150 回答
2

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

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

implicit val entityEncoder: Encoder[Entity] = dropNulls(deriveEncoder)
于 2020-02-20T15:49:56.500 回答