从 Play JSON API 获取更好的错误消息

Play JSON API 生成的错误消息类型示例：

scala> import play.api.libs.json._
import play.api.libs.json._

scala> Json.obj("k" -> Json.obj("m" -> 7))
res0: play.api.libs.json.JsObject = {"k":{"m":7}}

scala> (res0 \ "p").as[String]
play.api.libs.json.JsResultException: JsResultException(errors:List((,List(ValidationError(validate.error.expected.jsstring,WrappedArray())))))
    at play.api.libs.json.JsValue$$anonfun$2.apply(JsValue.scala:67)
    at play.api.libs.json.JsValue$$anonfun$2.apply(JsValue.scala:67)
    at play.api.libs.json.JsResult$class.fold(JsResult.scala:69)
    at play.api.libs.json.JsError.fold(JsResult.scala:10)
    at play.api.libs.json.JsValue$class.as(JsValue.scala:65)
    at play.api.libs.json.JsUndefined.as(JsValue.scala:98)
    at .<init>(<console>:12)
    at .<clinit>(<console>)
    at .<init>(<console>:7)
    // gazillion lines more

scala> (res0 \ "k" \ "m").as[String]
play.api.libs.json.JsResultException: JsResultException(errors:List((,List(ValidationError(validate.error.expected.jsstring,WrappedArray())))))
    at play.api.libs.json.JsValue$$anonfun$2.apply(JsValue.scala:67)
    at play.api.libs.json.JsValue$$anonfun$2.apply(JsValue.scala:67)
    at play.api.libs.json.JsResult$class.fold(JsResult.scala:69)
    at play.api.libs.json.JsError.fold(JsResult.scala:10)
    at play.api.libs.json.JsValue$class.as(JsValue.scala:65)
    at play.api.libs.json.JsNumber.as(JsValue.scala:108)
    at .<init>(<console>:12)
    at .<clinit>(<console>)
    at .<init>(<console>:7)
    // gazillion lines more

有没有办法从这个 API 中获取更好的错误消息？例如，上述两种情况的错误消息可能类似于No value found at JsPath \ "p", Value found at JsPath \ "k" \ "m" cannot be read as type String etc.

是的，使用JsValue.as[T]在这种情况下并不稳健：

res0 \ "p"回报JsUndefined然后应用于隐式Reads[String]它说“嘿，这不是一个字符串”......这是真的，但不是你所期望的；）

恕我直言，使用更好的方法Reads on JsPath直接地：

scala> ((__ \ "p").read[String]).reads(res0)
res7: play.api.libs.json.JsResult[String] = JsError(List((/p,List(ValidationError(validate.error.missing-path,WrappedArray())))))

scala> ((__ \ "k" \ "m").read[String]).reads(res0)
res8: play.api.libs.json.JsResult[String] = JsError(List((/k/m,List(ValidationError(validate.error.expected.jsstring,WrappedArray())))))

这里你有一个关于丢失路径的更好的消息。 它甚至会通知 JsError 中第一个参数中缺少的路径。

对于好的字符串消息，您可以使用本地消息来映射密钥。 顺便说一句，这些 Json 错误消息相对于 Play 中的其他错误消息（例如 Forms）来说并不完全标准化。我认为我们会在 Play 的未来版本中对其进行改进。

最后，当你想向客户端发送Json验证错误时，有一个辅助函数JsError与使用JsResult.recoverTotal

scala> ((__ \ "k" \ "m").read[String]).reads(res0).recoverTotal( e => JsError.toFlatJson(e) )
res11: java.io.Serializable = {"obj.k.m":[{"msg":"validate.error.expected.jsstring","args":[]}]}

这只是此类函数的原始版本。如果您需要其他格式，我建议查看 toFlatJson 实现并编写您自己的格式。

玩得开心 ;）