如何配置spray-json的解析选项以实现非严格反序列化？

刚好对spray-json的配置比较熟悉，来给你梳理一下这些需求的实现方式：

1. 解析未知字段时报错（对应Jackson的FAIL_ON_UNKNOWN_PROPERTIES） #

spray-json默认会忽略JSON中存在但case class没有的字段，如果要让这种情况抛出异常，只需要修改解析器的Settings，把ignoreUnknownFields设为false：

import spray.json._

// 定义严格的解析设置
val strictParseSettings = JsonParser.Settings(ignoreUnknownFields = false)

// 示例Case Class和Protocol
case class User(id: Int, name: String)
object UserProtocol extends DefaultJsonProtocol {
  implicit val userFormat: RootJsonFormat[User] = jsonFormat2(User)
}
import UserProtocol._

// 测试：包含未知字段的JSON会抛出DeserializationException
val invalidJson = """{"id": 1, "name": "Alice", "age": 30}"""
try {
  val user = JsonParser(invalidJson, strictParseSettings).convertTo[User]
} catch {
  case e: DeserializationException => println(s"解析错误：${e.getMessage}") // 会输出包含"age"字段未知的错误
}

2. 处理不完整JSON（缺失必填字段的场景） #

spray-json默认会对缺失case class必填字段的JSON抛出DeserializationException。如果希望给缺失字段设置默认值，有两种方式：

方式一：给Case Class字段添加默认值 #

这种方式最简单，只要case class的字段有默认值，spray-json会自动用默认值填充缺失的字段：

case class User(id: Int, name: String = "匿名用户")
object UserProtocol extends DefaultJsonProtocol {
  implicit val userFormat: RootJsonFormat[User] = jsonFormat2(User)
}

// 测试：缺失name字段的JSON会自动填充默认值
val incompleteJson = """{"id": 2}"""
val user = JsonParser(incompleteJson).convertTo[User] // 得到User(2, "匿名用户")

方式二：自定义JsonFormat #

如果不想修改case class的默认值，可以自定义解析逻辑，灵活处理缺失字段：

case class User(id: Int, name: String)
object UserProtocol extends DefaultJsonProtocol {
  implicit val userFormat: RootJsonFormat[User] = new RootJsonFormat[User] {
    override def write(user: User): JsValue = JsObject(
      "id" -> JsNumber(user.id),
      "name" -> JsString(user.name)
    )

    override def read(json: JsValue): User = json.asJsObject.getFields("id", "name") match {
      case Seq(JsNumber(id), JsString(name)) => User(id.toInt, name)
      case Seq(JsNumber(id), _) => User(id.toInt, "默认名称") // 处理name缺失的情况
      case _ => throw new DeserializationException("JSON格式不符合User要求")
    }
  }
}

3. 忽略未知字段（对应Jackson的IGNORE_UNKNOWN_PROPERTIES） #

这个是spray-json的默认行为，如果你需要显式确认，可以在Settings中设置ignoreUnknownFields = true：

val lenientParseSettings = JsonParser.Settings(ignoreUnknownFields = true)
val jsonWithExtraFields = """{"id": 3, "name": "Bob", "email": "bob@example.com"}"""
val user = JsonParser(jsonWithExtraFields, lenientParseSettings).convertTo[User] // 成功解析，忽略email字段

4. 其他常用解析配置选项 #

除了上面的场景，spray-json还支持很多类似Jackson的配置，比如：

• allowUnquotedFields: Boolean：允许JSON字段名不带引号（对应Jackson的ALLOW_UNQUOTED_FIELD_NAMES），默认false
• allowSingleQuotes: Boolean：允许用单引号代替双引号（对应Jackson的ALLOW_SINGLE_QUOTES），默认false
• allowTrailingCommas: Boolean：允许JSON末尾有多余的逗号（对应Jackson的ALLOW_TRAILING_COMMA），默认false
• maxDepth: Int：限制JSON的最大嵌套深度，防止栈溢出，默认值是1000

示例配置：

val flexibleSettings = JsonParser.Settings(
  ignoreUnknownFields = true,
  allowSingleQuotes = true,
  allowTrailingCommas = true,
  maxDepth = 500
)

// 可以解析这种格式不规范的JSON
val quirkyJson = """{'id': 4, 'name': 'Charlie',}"""
val user = JsonParser(quirkyJson, flexibleSettings).convertTo[User]

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