Получение улучшенных сообщений об ошибках в 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 и т.д.

Ответы

Ответ 1

да использование JsValue.as[T] в этом случае не является надежным:

res0 \ "p" возвращает JsUndefined, который затем применяется к неявному Reads[String], и он говорит "эй, что не строка"... Это правда, но не то, что вы ожидаете;)

лучший способ использования IMHO непосредственно 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.

Что касается сообщений как приятных строк, вы можете использовать локальное сообщение для сопоставления ключа. BTW, те сообщения об ошибках 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":[]}]}

Это просто исходная версия такого типа функций. Если вам нужен другой формат, я советую посмотреть на реализацию FlatJson и написать свой собственный.

Удачи;)