播放框架，从请求中解析 json 数组

Question

如何将 json 对象数组解析为 scala List 或 Array？

现在我有一个解析单个对象的代码：

{"id":1,"name":"example1"}

这是代码：

def exampleAction = Action.async(parse.json) { implicit request =>
    for {
        id <- (request.body \ "id").asOpt[Int]
        name <- (request.body \ "name").asOpt[String]
    } yield {
        (exampleService.create(Example(id, name)) map { n => Created("Id of Object Added : " + n) }).recoverWith {
            case e => Future {
                InternalServerError("There was an error at the server")
            }
        }
    }.getOrElse(Future { BadRequest("Wrong json format") })
}

但是我应该如何改变它来解析这样的 json 请求：

{[{"id":1,"name":"example1"},{"id":2,"name":"example2"}]}

我猜函数map应该在某处使用。

Answer 1

您的控制器不必担心验证和映射特定的类字段，这是模型的工作。假设您似乎正在使用 Example 案例类，您可以使用 Play 提供的 Json.reads 宏轻松创建 Reads[Example]。隐含的Reads 应该放在相应类的伴生对象中，这样就可以从任何地方获取隐含的。如果需要，您还可以通过阅读 documentation 创建更多自定义 Reads，但现在我们将坚持基础知识。

import play.api.libs.json._

case class Example(id: Int, name: String)

object Example {
  implicit val reads: Reads[Example] = Json.reads[Example]
}

然后，在您的控制器中，您可以使用JsValue#validate[A] 尝试一次反序列化整个模型。这样做会返回一个JsResult[A]，它可以是保存反序列化模型的JsSuccess[A]，也可以是JsError。我们可以fold结果来处理这两种情况。

def exampleAction = Action.async(parse.json) { implicit request =>
  request.body.validate[Example].fold(
    error => Future.successful(InternalServerError("JSON did not validate.")),
    example => {
      // Do something with the case class
      exampleService.create(example).map { 
        // ...
      } recoverWith {
        // ...
      }
    }
  )
}

现在，您可以通过更改轻松更改上述控制器以处理数组而不是单个模型：

request.body.validate[List[Example]]

在fold 方法的第二部分，您将获得一个可以使用的List[Example]。

---

请注意，在您的错误情况下，不要使用Future { ... } 来包装基本上不会阻塞任何内容的常量值，而是可以将它们包装在Future.successful(...) 中以避免将琐碎的工作分派给ExecutionContext。

Answer 2

借用 Michael 的回答，我们可以通过使用 parse.json that is parameterized in its type 的版本进一步简化控制器代码。

假设Reads 存在：

import play.api.libs.json._

case class Example(id: Int, name: String)

object Example {
  implicit val reads: Reads[Example] = Json.reads[Example]
}

要处理 Example 对象的 json 数组，您可以简单地使用 parse.json[List[Example]] 作为正文解析器，然后 request.body 将成为 List[Example]：

def exampleAction = Action.async(parse.json[List[Example]]) { implicit request =>
  val examples: List[Example] = request.body

  // ...
}

如果发布到此端点的正文不是示例对象的有效 json 数组，Play 将自动返回 400 Bad Request。

Answer 3

我尝试按照接受的答案和 greggz' 来写信，但无法让它们编译。

不过，我正在根据 gregghz 的答案构建一个答案。所以......你肯定需要像他一样制作案例类和伴随对象：

import play.api.libs.json._

case class Example(id: Int, name: String)

object Example {
  implicit val reads: Reads[Example] = Json.reads[Example]
}

但是你的控制器方法可以更简单，特别是如果你不想搞乱异步。这对我有用，因为我从客户端发送 HTML form，获取每个 input 并仅将其发送回此方法。这种方式可能存在缺陷，我很高兴在 cmets 中听到它们，但您所要做的就是：

def exampleAction = Action {
    implicit request: Request[AnyContent] => {
      val jsonBody = request.body.asJson
      val myContent : List[Example] = jsonBody.get.as[List[Example]]
      // ... do rest of work here
      Ok("Json parsed")
    }
  }