为了提供一个完整的工作示例,我将假设一个这样的案例类:
case class Test(foo: Int, bar: String)
还有一些这样的请求:
import com.twitter.finagle.http.{ Method, Request, RequestBuilder }
import com.twitter.io.{ Buf, Reader }
val queryParamPost = Request(Method.Post, "/test?foo=1&bar=whatever")
val testJsonBuf = Buf.Utf8("""{ "foo": 1, "bar": "whatever" }""")
val bodyPost = RequestBuilder().url("http://localhost:8080/test").buildPost(testJsonBuf)
现在,当您编写以下内容时……</p>
import io.finch._
val testParams: Endpoint[Test] = Endpoint.derive[Test].fromParams
val test: Endpoint[Test] = post("test" ? testParams) { test: Test =>
Created(test)
}
发生的事情是 Finch 使用泛型派生(由 Shapeless 提供支持)来确定(在编译时)如何将查询参数解析为Test
. 然后,您可以像这样测试端点:
import io.finch.circe._
import io.circe.generic.auto._
test.toService.apply(queryParamPost).onSuccess { response =>
println(s"$response: ${ response.contentString }")
}
这将打印:
Response("HTTP/1.1 Status(201)"): {"foo":1,"bar":"whatever"}
在这里,我使用Circe的通用派生来自动将“创建的”编码Test
为响应的 JSON。
您还可以使用 Circe 为请求正文派生一个阅读器:
val testBody: Endpoint[Test] = body.as[Test]
val test2: Endpoint[Test] = post("test" :: testBody) { test: Test =>
Created(test)
}
这与上面几乎完全相同test
,但我们使用body
的是获取Endpoint[String]
将读取请求正文的内容,然后as
指定我们希望将内容解析为 JSON 并解码为Test
值。我们可以像这样测试这个新版本:
test2.toService.apply(bodyPost).onSuccess { response =>
println(s"$response: ${ response.contentString }")
}
我们将再次得到我们期望的答案。
一般来说,当您想读取传入请求的某种信息时,您将使用Endpoint
Finch 提供的 basic 之一(请参阅文档以获得更完整的列表),然后使用as
,map
等方法把Endpoint
它变成你需要的形状。