Scala PlayJson Cyclic Reference

时间:2016-06-23 10:56:00

标签: json scala playframework-2.0 play-json

上下文

我有一个案例类,它是层次结构中的一个项目,它本身就是这样的:

async/reduce

我想要一个PlayJson Format

通常,您可以这样做:

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

但这不起作用。

为什么?

PlayJson使用Scala宏为case类生成implicit lazy val formatter = Json.format[MyCaseClass] ,它将遍历所有字段,当它到达字段Format时,它将查找{{1}的现有格式化程序它还没有构建,以编译错误结束:

children

问题

最好的解决方法是什么?
这是PlayJson格式宏的已知问题吗?

1 个答案:

答案 0 :(得分:5)

这可以在play-json docsrecursive 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))

由于在这种情况下ReadsWrites是对称的,您可以将整个内容创建为单个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))