具有递归类定义的 Json 隐式格式

Posted 2023-03-16

【中文标题】具有递归类定义的 Json 隐式格式

【英文标题】：Json implicit format with recursive class definition

【发布时间】：2015-08-23 02:21:40

【问题描述】：

我定义了一个递归类：

case class SettingsRepository(id: Option[BSONObjectID],
                          name: Option[String],
                          children: Option[List[SettingsRepository]])

JSON 隐式格式如下：

implicit val repositoryFormat = Json.format[SettingsRepository]

我该如何解决这个编译错误？ ：

No implicit format for Option[List[models.practice.SettingsRepository]] available.
In /path/to/the/file.scala:95

95 implicit val repositoryFormat = Json.format[SettingsRepository] 

我试图定义一个惰性读取/写入/格式包装器，但没有成功... 有人知道这样做的干净方法吗？

【参考方案1】：

正如您所发现的，您不能在此处使用 JSON inception 宏，但您可以编写自己的 Format（请注意，为了完整工作，我已将 BSONObjectID 替换为 Long示例）：

import play.api.libs.functional.syntax._
import play.api.libs.json._

case class SettingsRepository(
  id: Option[Long],
  name: Option[String],
  children: Option[List[SettingsRepository]]
)

implicit val repositoryFormat: Format[SettingsRepository] = (
  (__ \ 'id).formatNullable[Long] and
  (__ \ 'name).formatNullable[String] and
  (__ \ 'children).lazyFormatNullable(implicitly[Format[List[SettingsRepository]]])
)(SettingsRepository.apply, unlift(SettingsRepository.unapply))

诀窍是提供显式类型注释并使用implicitly 而不仅仅是lazyFormatNullable 上的类型参数。

【参考方案2】：

对于其他来这里寻找轻微变体的人，我们在 Format 类中覆盖 reads 和 writes（如 API 文档中的 example given），您可以声明对所需对象的惰性引用：

  lazy val tweetFormat: Format[Tweet] = TweetFormat
  implicit object UserFormat extends Format[User] 
  //...
  

  //...
  implicit object TweetFormat extends Format[Tweet] 
  //...

【参考方案3】：

只是一个更新。这已经修复了很长时间。例如，在play-json 2.3.9 版本中，这是Maven 上最旧的版本，以下工作：

import play.api.libs.json._

case class SettingsRepository(id: Option[Int],
                              name: Option[String],
                              children: Option[List[SettingsRepository]])

implicit val repositoryFormat = Json.format[SettingsRepository]

val s = SettingsRepository(Some(2), Some("name"), Some(List(SettingsRepository(Some(1), Some(""), None))))
println(Json.toJsObject(s))

和输出：

"id":2,"name":"name","children":["id":1,"name":""]

代码在Scastie 运行。