json - Scala PlayJson循环引用

上下文

我有一个案例类，它是层次结构中的一个项目，它这样引用自身:

case class Node(
  name:     String,
  children: Option[Seq[Node]] = None
)

我想要一个PlayJson Format 。

通常，您可以执行以下操作:

implicit lazy val formatter = Json.format[MyCaseClass]

但这是行不通的。

为什么？

PlayJson使用Scala宏为case类生成Format，它将遍历所有字段，当它到达children字段时，它将寻找尚未构建的Node的现有格式化程序，以编译错误结束:

No implicit format for Option[Seq[Node]] available.
[error]   implicit lazy val formatter = Json.format[Node]

问题

解决此问题的最佳方法是什么？
这是PlayJson格式宏的已知问题吗？

最佳答案

这是可以在play-json docs中的recursive types下找到的内容:

import play.api.libs.functional.syntax._
import play.api.libs.json.{Reads, Writes, _}

case class Node(name: String, children: Option[Seq[Node]] = None)

implicit lazy val nodeReads: Reads[Node] = (
  (__ \ "name").read[String] and
  (__ \ "children").lazyReadNullable(Reads.seq[Node](nodeReads))
)(Node)

implicit lazy val nodeWrites: Writes[Node] = (
  (__ \ "name").write[String] and
  (__ \ "children").lazyWriteNullable(Writes.seq[Node](nodeWrites))
)(unlift(Node.unapply))

由于在这种情况下Reads和Writes是对称的，因此您可以将整个内容创建为单个Format:

implicit lazy val nodeFormat: Format[Node] = (
  (__ \ "name").format[String] and
  (__ \ "children").lazyFormatNullable(Reads.seq[Node](nodeFormat), Writes.seq[Node](nodeFormat))
)(Node.apply, unlift(Node.unapply))