Question

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等。

Answer 1

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

res0 \ "p"返回JsUndefined，然后将其应用于隐式Reads[String]，并显示“嘿那不是字符串”......这是真的，但不是您所期望的;）

恕我直言Reads直接使用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实现并编写自己的格式。

玩得开心;）

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

1 个答案: