在Scala Play框架中，如何将含ObjectId的类转换为JSON？

嘿，我之前也碰到过一模一样的问题！核心原因是Play Json的自动格式化宏Json.format[T]只能处理自带隐式Format支持的类型，而MongoDB的ObjectId并不是Scala样例类，也没有内置的Play Json适配，所以得手动给它写个自定义的Format才行。

下面是具体的解决步骤：

1. 导入必要的包 #

先确保你已经导入了Play Json核心包和MongoDB的ObjectId：

import play.api.libs.json._
import org.mongodb.scala.bson.ObjectId

2. 为ObjectId编写自定义隐式Format #

我们可以借助ObjectId的字符串转换能力来实现序列化和反序列化：

implicit val objectIdFormat: Format[ObjectId] = new Format[ObjectId] {
  // 序列化：把ObjectId转成JSON字符串
  override def writes(oId: ObjectId): JsValue = JsString(oId.toString)

  // 反序列化：从JSON字符串解析回ObjectId
  override def reads(json: JsValue): JsResult[ObjectId] = json match {
    case JsString(str) => 
      try {
        JsSuccess(new ObjectId(str))
      } catch {
        case _: IllegalArgumentException => JsError("无效的ObjectId格式")
      }
    case _ => JsError("ObjectId需要字符串类型的JSON值")
  }
}

如果喜欢更简洁的写法，也可以拆分Reads和Writes再组合：

// 序列化规则
implicit val objectIdWrites: Writes[ObjectId] = Writes(oId => JsString(oId.toString))
// 反序列化规则，先校验字符串是否合法
implicit val objectIdReads: Reads[ObjectId] = Reads {
  case JsString(str) if ObjectId.isValid(str) => JsSuccess(new ObjectId(str))
  case JsString(_) => JsError("无效的ObjectId格式")
  case _ => JsError("ObjectId需要字符串类型的JSON值")
}
// 组合成完整的Format
implicit val objectIdFormat: Format[ObjectId] = Format(objectIdReads, objectIdWrites)

3. 正常生成Branch的Format #

有了上面的隐式objectIdFormat，Play的宏就能自动识别ObjectId的格式支持了，直接生成Branch的Format完全没问题：

case class Branch(_id: ObjectId, rootcommit: Option[ObjectId], name: String, commits: List[ObjectId])

implicit val branchFormat: Format[Branch] = Json.format[Branch]

为什么直接用Json.format[ObjectId]不行？ #

因为Json.format[T]这个宏依赖目标类型是Scala样例类（或者具备对应的unapply方法），而ObjectId是Mongo提供的Java风格类，没有Scala样例类的unapply方法，所以宏没法自动生成它的Format，必须手动实现适配逻辑。

内容的提问来源于stack exchange，提问作者julienfr112