如何使用 zio-json 而不是 null 将 None 编码为缺少的 json 字段？答案

【问题标题】：How can I encode None to missing json field using zio-json instead of null?如何使用 zio-json 而不是 null 将 None 编码为缺少的 json 字段？
【发布时间】：2022-01-26 12:23:42
【问题描述】：

假设我有一个带有可选字段nickName 和编解码器的案例类，如下所示：

final case class Person(name: String, nickName: Option[String])

object Person {
  implicit val personCodec: JsonCodec[Person] = DeriveJsonCodec.gen
}

我想使用zio-json (v1.5.0) 对其进行编码并得到以下结果：

{"name":"SomeName"}

这是我的测试：

encoder.encodeJson(Person("SomeName", None), None).toString shouldBe """{"name":"SomeName"}""".stripMargin

看起来像 zio-json 编码 None 和 null 并且我得到了测试错误：

Expected :"{"name":"SomeName"[]}"
Actual   :"{"name":"SomeName"[,"nickName":null]}"

我检查了代码，找到了 Option https://github.com/zio/zio-json/blob/52d007ee22f214d12e1706b016f149c3243c632c/zio-json/shared/src/main/scala/zio/json/encoder.scala#L188-L202 的编码器

知道如何将其编码为缺少的 JSON 字段吗？

【问题讨论】：

它在 zio-json 0.2.0-M3 上按预期工作。此外，最新的里程碑对序列化有很多性能改进。

标签： scala zio zio-json

【解决方案1】：

注意：我不熟悉 sith zio-json，可能有另一种方式，比如配置来实现同样的事情。

鉴于您链接的代码示例，您可以通过复制大部分代码但修改来轻松编写一个不写任何东西的编码器：

def unsafeEncode(oa: Option[A], indent: Option[Int], out: Write): Unit = oa match {
  case None    => () // out.write("null")
  case Some(a) => A.unsafeEncode(a, indent, out)
}

【讨论】：

是的，我没找到让zio-json使用自定义编码器的方法