Play Framework 2.2.1 / 控制器应该如何处理 JSON 格式的 queryString

Question

我的客户端在 JSON 对象中执行包含数据 (queryString) 的服务器调用，如下所示：

?q={"title":"Hello"}   //non encoded for the sample but using JSON.stringify actually

检索title 和Hello 字符串的有效方法是什么？

我试过这个：

val params = request.queryString.map {case(k,v) => k->v.headOption}

返回Tuple：(q,Some({"title":"hello"}))

我可以进一步提取来检索值（虽然我需要手动将 JSON 对象映射到 Scala 对象），但我想知道是否有更简单和更短的方法。

有什么想法吗？

Answer 1

首先，如果您打算仅从请求中提取 q 参数并且不打算通过 route 这样做，您可以直接获取它：

val q: Option[String] = request.getQueryString("q")

接下来您必须将其解析为 JSON 对象：

import play.api.libs.json._
val jsonObject: Option[JsValue] = q.map(raw: String => json.parse(raw))

您应该能够检查jsonObject 包含的组件：

val title: Option[String] = jsonObject.flatMap { json: JsValue =>
  (json \ "title").asOpt[String]
}

简而言之，省略可以使用 for 理解的类型，如下所示：

val title = for {
  q <- request.getQueryString("q")
  json <- Try(Json.parse(q)).toOption
  titleValue <- (json \ "title").asOpt[String]
} yield titleValue

Try 定义在scala.util 中，基本上捕获异常并将其包装成可处理的形式。

我必须承认，上一个版本在解析原始 JSON 字符串期间只是忽略了异常，并将它们等同于“未设置标题查询”。 这不是了解实际问题的最佳方法。

在我们的生产代码中，我们使用隐式快捷方式将 None 和 JsError 包装为 Failure：

val title: Try[String] = for {
  q <- request.getQueryString("q") orFailWithMessage "Query not defined"
  json <- Try(Json.parse(q))
  titleValue <- (json \ "title").validate[String].asTry
} yield titleValue

停留在Try monad 中，我们可以获得有关哪里出错的信息，并且可以将这些信息提供给用户。

orFailWithMessage 基本上是 Option 的隐式包装器，它将使用指定的消息将其转换为 Succcess 或 Failure。

JsResult.asTry 也只是一个 pimped JsResult，它也是 Success 或 Failure。