Play Framework Scala中Json日期格式化及内部Case Class隐式Format问题

嘿，我太懂你这种被硬编码JSON转换折腾的痛苦了！Play Framework的JSON库其实自带了非常省心的解决方案，完全能替代那些繁琐的手动实现，咱们一步步把问题彻底解决：

Play提供的Json.format宏可以帮你自动推导case class的序列化/反序列化逻辑，不用再逐个字段写代码。关键是要确保内部嵌套的case class的隐式Format先被定义，且处于顶层case class的作用域内。

举个实际例子：
假设你有这样的case class结构：

// 内部嵌套的case class
case class UserProfile(username: String, email: String)
// 顶层case class，包含内部类和日期字段
case class User(id: Long, profile: UserProfile, createdAt: java.util.Date)

只需要在伴生对象里定义隐式Format即可：

import play.api.libs.json._

object User {
  // 先定义内部类的Format，因为User依赖它
  implicit val userProfileFormat: Format[UserProfile] = Json.format[UserProfile]
  // 顶层类的Format会自动复用内部类的隐式定义
  implicit val userFormat: Format[User] = Json.format[User]
}

如果内部类是嵌套在顶层类里面的（比如User.Profile），只需调整Format的类型引用：

case class User(id: Long, createdAt: java.util.Date) {
  case class Profile(username: String, email: String)
}

object User {
  // 明确指定是User.Profile的Format
  implicit val profileFormat: Format[User.Profile] = Json.format[User.Profile]
  implicit val userFormat: Format[User] = Json.format[User]
}

这样之后，你就能直接用Json.toJson(userInstance)把对象转成JSON，或者用Json.fromJson[User](jsonValue)把JSON转成对象，完全不用手动处理每个字段！

Play的默认Json.format宏不支持java.util.Date或Java 8的时间类（比如LocalDateTime），所以需要自定义隐式规则，或者用官方扩展库来处理。

方式一：自定义java.util.Date的Format #

如果你用的是java.util.Date，可以自己实现一个隐式Format，指定统一的日期字符串格式（比如ISO8601）：

import play.api.libs.json._
import java.util.Date
import java.text.SimpleDateFormat
import java.util.Locale

// 定义全局的日期格式隐式转换
implicit val dateFormat: Format[Date] = new Format[Date] {
  // 用ISO8601格式，你也可以改成自己需要的格式
  private val formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", Locale.ENGLISH)

  override def reads(json: JsValue): JsResult[Date] = json match {
    case JsString(dateStr) =>
      try {
        JsSuccess(formatter.parse(dateStr))
      } catch {
        case _: Exception => JsError(s"无效的日期格式，请使用ISO8601格式（如：2024-05-20T14:30:00.000Z）")
      }
    case _ => JsError("日期字段必须是字符串类型")
  }

  override def writes(date: Date): JsValue = {
    JsString(formatter.format(date))
  }
}

把这个隐式值放在作用域里（比如和case class的Format放在同一个伴生对象，或者单独的JSON工具类里），Json.format宏会自动使用它来处理日期字段。

方式二：用官方扩展处理Java 8时间类 #

如果你的项目用的是Java 8的LocalDateTime、ZonedDateTime等时间类，可以直接用Play提供的扩展库：

1. 先在build.sbt里添加依赖（版本要和你的Play版本对应，比如Play 2.8.x）：

libraryDependencies += "com.typesafe.play" %% "play-json-joda" % "2.8.20"

2. 然后导入对应的隐式转换：

import play.api.libs.json._
import play.api.libs.json.JodaWrites._
import play.api.libs.json.JodaReads._

这样Json.format宏就能自动处理Java 8的时间类型了，不用自己写转换逻辑。

为了提升代码可维护性，建议把所有的隐式Format集中放在一个单独的对象里，比如：

package com.yourproject.json

import play.api.libs.json._
import java.util.Date
import java.text.SimpleDateFormat
import java.util.Locale

object JsonFormats {
  // 日期格式定义
  private val dateFormatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", Locale.ENGLISH)

  implicit val dateFormat: Format[Date] = new Format[Date] {
    override def reads(json: JsValue): JsResult[Date] = json match {
      case JsString(s) => JsSuccess(dateFormatter.parse(s))
      case _ => JsError("日期必须是ISO8601格式的字符串")
    }

    override def writes(date: Date): JsValue = JsString(dateFormatter.format(date))
  }

  // 所有case class的Format都放在这里
  implicit val userProfileFormat: Format[UserProfile] = Json.format[UserProfile]
  implicit val userFormat: Format[User] = Json.format[User]
  // 其他case class的Format...
}

之后在需要使用JSON转换的地方，只需要导入这个对象：import com.yourproject.json.JsonFormats._，所有的隐式规则就都生效了，再也不用到处重复定义！

这样改造之后，你就能彻底抛弃那些繁琐的临时解决方案，代码会简洁很多，维护起来也轻松～

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