使用 json4s 序列化可选值类实例时出现问题

Question

我正在尝试使用 json4s 将具有可选值类字段的案例类序列化为 JSON。到目前为止，我无法正确呈现可选的值类字段(请参阅下面的示例代码段(。

我尝试了json-native和json-jackson库，结果是相同的。

这是一个简短的独立测试

import org.json4s.DefaultFormats
import org.scalatest.FunSuite
import org.json4s.native.Serialization._
class JsonConversionsTest extends FunSuite {
implicit val jsonFormats = DefaultFormats
test("optional value-class instance conversion") {
val json = writePretty(Foo(Option(Id(123)), "foo-name", Option("foo-opt"), Id(321)))
val actual =
"""
|{
|  "id":{
|    "value":123
|  },
|  "name":"foo-name",
|  "optField":"foo-opt",
|  "nonOptId":321
|}
|""".stripMargin.trim
assert(json === actual)
val correct =
"""
|{
|  "id": 123,
|  "name":"foo-name",
|  "optField":"foo-opt",
|  "nonOptId":321
|}
|""".stripMargin.trim
assert(json !== correct)
}
}
case class Id(value: Int) extends AnyVal
case class Foo(id: Option[Id], name: String, optField: Option[String], nonOptId: Id)

我使用的是 scala 2.12 和最新的json4s-native版本：

"org.json4s" %% "json4s-native" % "3.6.7"

Answer 1

它看起来与此问题非常相似，似乎没有修复或评论。

自定义序列化程序将节省您的一天。

object IdSerializer extends CustomSerializer[Id] ( format => (
{ case JInt(a)  => Id(a.toInt) },
{ case a: Id => JInt(a.value) }
))
implicit val formats = DefaultFormats + IdSerializer
val json = writePretty(Foo(Option(Id(123)), "foo-name", Option("foo-opt"), Id(321)))

Answer 2

在任何情况下，尝试其他选项，例如使用 jsoniter-scala。它比 json4 安全高效得多，尤其是在美化 JSON 的序列化中。

添加/替换依赖项：

libraryDependencies ++= Seq(
"com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-core"   % "0.55.2" % Compile,
"com.github.plokhotnyuk.jsoniter-scala" %% "jsoniter-scala-macros" % "0.55.2" % Provided // required only in compile-time
)

派生顶级数据结构的编解码器，并使用它来序列化为字符串：

import com.github.plokhotnyuk.jsoniter_scala.macros._
import com.github.plokhotnyuk.jsoniter_scala.core._
case class Id(value: Int) extends AnyVal
case class Foo(id: Option[Id], name: String, optField: Option[String], nonOptId: Id)
implicit val codec: JsonValueCodec[Foo] = JsonCodecMaker.make(CodecMakerConfig())
val json = writeToString(Foo(Option(Id(123)), "foo-name", Option("foo-opt"), Id(321)), WriterConfig(indentionStep = 2))
val correct =
"""{
|  "id": 123,
|  "name": "foo-name",
|  "optField": "foo-opt",
|  "nonOptId": 321
|}""".stripMargin
assert(json == correct)

还有更有效的选项可以立即存储到字节数组，java.nio.ByteBuffer或java.io.OutputStream中。