Question

给定具有此签名的函数：

def parser[A](otherParser: BodyParser[A]): BodyParser[A]

如何在将请求正文传递给otherParser之前对请求正文进行检查和验证的方式编写函数？

为了简单起见，我们要说我要验证标题（＆＃34; Some-Header＆＃34;，或许）具有与主体完全匹配的值。所以如果我有这个动作：

def post(): Action(parser(parse.tolerantText)) { request =>
  Ok(request.body)
}

当我发出curl -H "Some-Header: hello" -d "hello" http://localhost:9000/post之类的请求时，它应该返回＆＃34;你好＆＃34;在状态为200的响应正文中。如果我的请求是curl -H "Some-Header: hello" -d "hi" http://localhost:9000/post，则应该返回400而没有正文。

这是我尝试过的。

此版本无法编译，因为otherParser(request).through(flow)希望flow输出ByteString。这里的想法是流程可以通过Either输出通知累加器是否继续处理。我不确定如何让累加器知道上一步的状态。

def parser[A](otherParser: BodyParser[A]): BodyParser[A] = BodyParser { request =>
  val flow: Flow[ByteString, Either[Result, ByteString], NotUsed] = Flow[ByteString].map { bytes =>
    if (request.headers.get("Some-Header").contains(bytes.utf8String)) {
      Right(bytes)
    } else {
      Left(BadRequest)
    }
  }

  val acc: Accumulator[ByteString, Either[Result, A]] = otherParser(request)

  // This fails to compile because flow needs to output a ByteString
  acc.through(flow)
}

我也试图使用过滤器。这个编译并且写入的响应主体是正确的。但是，它始终返回200 Ok响应状态。

def parser[A](otherParser: BodyParser[A]): BodyParser[A] = BodyParser { request =>
  val flow: Flow[ByteString, ByteString, akka.NotUsed] = Flow[ByteString].filter { bytes =>
    request.headers.get("Some-Header").contains(bytes.utf8String)
  }

  val acc: Accumulator[ByteString, Either[Result, A]] = otherParser(request)

  acc.through(flow)
}

Answer 1

我想出了一个使用GraphStageWithMaterializedValue的解决方案。这个概念来自Play's maxLength body parser。我在我的问题中首次尝试（没有编译）的主要区别在于，我应该使用物化值来传达有关处理状态的信息，而不是尝试改变流。虽然我创建了Flow[ByteString, Either[Result, ByteString], NotUsed]，但事实证明我需要的是Flow[ByteString, ByteString, Future[Boolean]]。

因此，我的parser函数最终看起来像这样：

def parser[A](otherParser: BodyParser[A]): BodyParser[A] = BodyParser { request =>
  val flow: Flow[ByteString, ByteString, Future[Boolean]] = Flow.fromGraph(new BodyValidator(request.headers.get("Some-Header")))

  val parserSink: Sink[ByteString, Future[Either[Result, A]]] = otherParser.apply(request).toSink

  Accumulator(flow.toMat(parserSink) { (statusFuture: Future[Boolean], resultFuture: Future[Either[Result, A]]) =>
    statusFuture.flatMap { success =>
      if (success) {
        resultFuture.map {
          case Left(result) => Left(result)
          case Right(a) => Right(a)
        }
      } else {
        Future.successful(Left(BadRequest))
      }
    }
  })
}

关键是这一行：

val flow: Flow[ByteString, ByteString, Future[Boolean]] = Flow.fromGraph(new BodyValidator(request.headers.get("Some-Header")))

一旦您能够创建此流程，其余类型就会落实到位。不幸的是BodyValidator非常冗长，感觉有点泛滥。在任何情况下，它都非常容易阅读。 GraphStageWithMaterializedValue期望您实现def shape: S（此处S为FlowShape[ByteString, ByteString]）以指定此图的输入类型和输出类型。它还希望您在这里定义def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, M)（M是Future[Boolean]）来定义图表应该实际执行的操作。这是BodyValidator的完整代码（我将在下面详细说明）：

class BodyValidator(expected: Option[String]) extends GraphStageWithMaterializedValue[FlowShape[ByteString, ByteString], Future[Boolean]] {
  val in = Inlet[ByteString]("BodyValidator.in")
  val out = Outlet[ByteString]("BodyValidator.out")

  override def shape: FlowShape[ByteString, ByteString] = FlowShape.of(in, out)

  override def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, Future[Boolean]) = {
    val status = Promise[Boolean]()
    val bodyBuffer = new ByteStringBuilder()

    val logic = new GraphStageLogic(shape) {
      setHandler(out, new OutHandler {
        override def onPull(): Unit = pull(in)
      })

      setHandler(in, new InHandler {
        def onPush(): Unit = {
          val chunk = grab(in)
          bodyBuffer.append(chunk)
          push(out, chunk)
        }

        override def onUpstreamFinish(): Unit = {
          val fullBody = bodyBuffer.result()
          status.success(expected.map(ByteString(_)).contains(fullBody))
          completeStage()
        }

        override def onUpstreamFailure(e: Throwable): Unit = {
          status.failure(e)
          failStage(e)
        }
      })
    }

    (logic, status.future)
  }
}

首先要创建Inlet和Outlet来设置图表的输入和输出

val in = Inlet[ByteString]("BodyValidator.in")
val out = Outlet[ByteString]("BodyValidator.out")

然后使用这些来定义shape。

def shape: FlowShape[ByteString, ByteString] = FlowShape.of(in, out)

在createLogicAndMaterializedValue内，您需要初始化您想要实现的值。在这里，我使用了一个可以在我从流中获取完整数据时可以解决的承诺。我还创建了一个ByteStringBuilder来跟踪迭代之间的数据。

val status = Promise[Boolean]()
val bodyBuffer = new ByteStringBuilder()

然后我创建一个GraphStageLogic来实际设置此图表在每个处理点的作用。正在设置两个处理程序。一个是InHandler，用于处理来自上游源的数据。另一个是OutHandler，用于处理要向下游发送的数据。在OutHandler中没有什么真正有趣的，所以我在这里忽略它，除了说为了避免IllegalStateException这是必要的锅炉板。 InHandler：onPush，onUpstreamFinish和onUpstreamFailure会覆盖三种方法。当从上游准备好新数据时，将调用onPush。在这个方法中，我只需抓取下一个数据块，将其写入bodyBuffer并将数据推送到下游。

def onPush(): Unit = {
  val chunk = grab(in)
  bodyBuffer.append(chunk)
  push(out, chunk)
}

当上游完成时（意外），将调用

onUpstreamFinish。这就是将正文与标题进行比较的业务逻辑。

override def onUpstreamFinish(): Unit = {
  val fullBody = bodyBuffer.result()
  status.success(expected.map(ByteString(_)).contains(fullBody))
  completeStage()
}

onUpstreamFailure已实施，以便在出现问题时，我也可以将物化未来标记为失败。

override def onUpstreamFailure(e: Throwable): Unit = {
  status.failure(e)
  failStage(e)
}

然后我只返回我创建的GraphStageLogic和status.future作为元组。

在Play 2.5中构建BodyParser

1 个答案: