如何基于Scala Play库实现JSON向后兼容读取？（适配FeatureList类featureRequired字段新旧格式）

完全可以通过自定义Play JSON格式化器来解决这个新旧格式兼容的问题，这也是处理这类版本兼容场景最灵活的方式。下面我给你详细的实现步骤和代码示例：

1. 先明确你的Case类结构 #

假设你的FeatureList类大致是这样的（其他字段用占位符示意）：

case class FeatureList(
  id: Int,
  name: String,
  // ... 其他20个字段省略 ...
  featureRequired: Boolean,
  // ... 其他字段省略 ...
)

2. 自定义兼容的JSON格式化器 #

我们需要为FeatureList编写一个自定义的Format，重点处理featureRequired字段的读写逻辑：

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

object FeatureList {
  // 先定义一个辅助的Reads，处理featureRequired的两种格式
  private val featureRequiredReads: Reads[Boolean] = 
    // 尝试读取新格式：对象类型，提取thisfeatureRequired字段转Boolean
    (__ \ "thisfeatureRequired").read[String].map {
      case "Yes" => true
      case "No" => false
    } orElse
    // 失败则尝试旧格式：直接读取字符串转Boolean
    Reads.StringReads.map {
      case "Yes" => true
      case "No" => false
    }

  // 定义featureRequired的Writes，这里默认输出新格式（如果需要输出旧格式可以调整）
  private val featureRequiredWrites: Writes[Boolean] = Writes { isRequired =>
    Json.obj(
      "thisfeatureRequired" -> (if (isRequired) "Yes" else "No"),
      "featureDetails" -> "" // 这里可以根据业务需求填充默认值或实际数据
    )
  }

  // 组合成FeatureList的完整Format
  implicit val format: Format[FeatureList] = (
    (__ \ "id").format[Int] and
    (__ \ "name").format[String] and
    // ... 其他20个字段的format依次写在这里 ...
    (__ \ "featureRequired").format[Boolean](featureRequiredReads, featureRequiredWrites) and
    // ... 其他字段的format依次写在这里 ...
  )(FeatureList.apply, unlift(FeatureList.unapply))
}

3. 关键逻辑解释 #

• 读取兼容：通过orElse方法，先尝试解析新格式的对象结构，如果解析失败（比如遇到旧格式的字符串），自动降级到旧格式的解析逻辑，完美实现向后兼容。
• 写入控制：这里默认写入新格式的对象结构，如果你的业务需要保留旧格式写入，只需要把featureRequiredWrites改成直接输出字符串即可：

  private val featureRequiredWrites: Writes[Boolean] = Writes { isRequired =>
    JsString(if (isRequired) "Yes" else "No")
  }
  

4. 测试验证 #

你可以用以下测试案例验证兼容性：

// 旧格式JSON
val oldJson = Json.parse("""{"id":1,"name":"Test","featureRequired":"Yes"}""")
val oldFeatureList = oldJson.as[FeatureList]
println(oldFeatureList.featureRequired) // 输出true

// 新格式JSON
val newJson = Json.parse("""{"id":1,"name":"Test","featureRequired":{"thisfeatureRequired":"No","featureDetails":"Some details"}}""")
val newFeatureList = newJson.as[FeatureList]
println(newFeatureList.featureRequired) // 输出false

// 写入测试（输出新格式）
val testList = FeatureList(1, "Test", featureRequired = true)
val outputJson = Json.toJson(testList)
println(outputJson) // 输出{"id":1,"name":"Test","featureRequired":{"thisfeatureRequired":"Yes","featureDetails":""}}

这样就能同时支持新旧格式的JSON读取，并且可以灵活控制输出格式啦！

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