我将通过这篇著述胪陈一下如何用Swift搭建一个HTTP代理作事器。本文将使用Hummingbird[1]行为作事端的基本HTTP框架【CXAZ-024】藤原ひとみ レズバトル 4時間 feat.愛原さえ 早瀬和香,以及使用AsyncHTTPClient[2]行为Swift的HTTP客户端来肯求观点作事。
什么是代理作事器代理作事器是一个搭载在客户端和另一个作事端(后头咱们成为观点作事端)的中间作事器,它从客户端转发音信到观点作事端,而且从观点作事端赢得反应信息传回给客户端。在转发音信之前,它不错以某种方式处理这些音信,相同,它也不错处理复返的反应。
让咱们试着构建一个在本文中,咱们将构建一个只将HTTP数据包转发到观点作事的代理作事器。您不错在这里找到本文的示例代码。
创建样式咱们使用Hummingbird模板样式[3] 咫尺最低版块适配 Swift5.5 行为咱们作事的驱动模板。读者不错遴荐clone这个存储库,或者奏凯点击Github样式主页上use this template按钮来创建咱们我方的存储库。用这个模板样式创建一个作事端而且启动它,不错使用一些规章台选项和文献来成立咱们的期骗。详见here[4]
增多 AsyncHTTPClient咱们将把AsyncHTTPClient行为依赖加入Package.swift以便咱们后头来使用
dependencies: 【CXAZ-024】藤原ひとみ レズバトル 4時間 feat.愛原さえ 早瀬和香[ ... .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.6.0"), ],
然后在观点依赖也添加一下
targets: [ .executableTarget(name: "App", dependencies: [ ... .product(name: "AsyncHTTPClient", package: "async-http-client"), ],
咱们将把HTTPClient行为HBApplicatipn的延迟。这么简略咱们料理HTTPClient的生命周期以及在HTTPClient删除前调用syncShutdown步伐。
extension HBApplication { var httpClient: HTTPClient { get { self.extensions.get(\.httpClient) } set { self.extensions.set(\.httpClient, value: newValue) { httpClient in try httpClient.syncShutdown() }} } }
当HBApplication关闭本相识调用set内部的闭包。这意味着咱们当咱们援用了HBApplication,即使不使用HTTPClient,咱们也有权限去调用它
增多 middleware[中间件]咱们将把咱们的代理作事器行为中间件。中间件将赢得一个肯求,然后将它发送到观点作事器而且从观点作事器赢得反应信息。底下使咱们驱动版块的中间件,它需要HTTPClient和观点作事器的URL两个参数。
struct HBProxyServerMiddleware: HBMiddleware { let httpClient: HTTPClient let target: String func apply(to request: HBRequest, next: HBResponder) -> EventLoopFuture<HBResponse> { return httpClient.execute( request: request, eventLoop: .delegateAndChannel(on: request.eventLoop), logger: request.logger ) } }
咫尺咱们有了HTTPClient和HBProxyServerMiddleware中间件,咱们将它们加入成立文献HBApplication.configure。然后建设咱们代理作事地址为http://httpbin.org
func configure(_ args: AppArguments) throws { self.httpClient = HTTPClient(eventLoopGroupProvider: .shared(self.eventLoopGroup)) self.middleware.add(HBProxyServerMiddleware(httpClient: self.httpClient, target: "http://httpbin.org")) }调度类型
当咱们完成上头的样子,构建会知道失败。因为咱们还需要调度Hummingbird和AsyncHTTPClient之间的请乞降反应类型。同期咱们需要吞并观点作事的URL到肯求里。
肯求调度为了将Hummingbird HBRequest移动为AsyncHTTPClient HTTPClient.Request,
原因: 咱们领先需要整理可能仍在加载的HBRequest的body信息,调度经由是异步的
贬责有缱绻:是以它需要复返一个包含后头调度肃除的EventLoopFuture,让咱们将调度函数放到HBRequest内部
extension HBRequest { func ahcRequest(host: String) -> EventLoopFuture<HTTPClient.Request> { // consume request body and then construct AHC Request once we have the // result. The URL for the request is the target server plus the URI from // the `HBRequest`. return self.body.consumeBody(on: self.eventLoop).flatMapThrowing { buffer in return try HTTPClient.Request( url: host + self.uri.description, method: self.method, headers: self.headers, body: buffer.map { .byteBuffer($0) } ) } } }反应信息装换
从HTTPClient.Response到HBResponse的调度特地简易
extension HTTPClient.Response { var hbResponse: HBResponse { return .init( status: self.status, headers: self.headers, body: self.body.map { HBResponseBody.byteBuffer($0) } ?? .empty ) } }
咱们咫尺将这两个调度样子加入HBProxyServerMiddleware的apply函数中。同期加入一些日记打印信息
func apply(to request: HBRequest, next: HBResponder) -> EventLoopFuture<HBResponse> { // log request request.logger.info("Forwarding \(request.uri.path)") // convert to HTTPClient.Request, execute, convert to HBResponse return request.ahcRequest(host: target).flatMap { ahcRequest in httpClient.execute( request: ahcRequest, eventLoop: .delegateAndChannel(on: request.eventLoop), logger: request.logger ) }.map { response in return response.hbResponse } }
咫尺应该不错平淡编译了。中间件将整理HBRequest的肯求体,将它移动为HTTPRequest.Request,然后使用HTTPClient将肯求转发给观点作事器。赢得的反应信息会移动为HBResponse复返给期骗。
运行期骗,翻开网页翻开localhost:8080。咱们应该能看到咱们之前建设代理的httpbin.org网页信息
Streaming[流]上头的建设不曲直常理思。它会恭候请务实足加载,然后才将肯求转发给观点作事端。同理反应转发亦然需要恭候反应实足加载后才会转发。这缩小了音信发送的成果,相同会导致肯求占用辽远内存或者反应信息很大。
美女车模咱们不错通过流式传输请乞降反应负载来改造这少许。一朝咱们有了它的头部,就动手将肯求发送到观点作事,并在接纳到主体部分时对其进行流式处理。访佛地,一朝咱们有了它的头,在另一个标的动手发送反应。打消对好意思满肯求或反应的恭候将普及代理作事器的性能。
如若客户端和代理之间的通讯以及代理和观点作事之间的通讯以不同的速率运行,咱们仍然会碰到内存问题。如若咱们接纳数据的速率比处理数据的速率快,数据就会动手备份。为了幸免这种情况发生,咱们需要大概施加背压以罢手读取稀奇的数据,直到咱们处理了裕如多的内存中的数据。有了这个,咱们不错将代理使用的内存量保抓在最低收尾。
流式肯求流式传输肯求负载是一个特地简易的经由。内容上,它简化了构造 HTTPClient.Request 的经由因为咱们不需要恭候请务实足加载。咱们如何构造 HTTPClient.Request 主体将基于好意思满的 HBRequest 是否照旧在内存中。如若咱们复返流肯求,则会自动期骗背压,因为 Hummingbird 作事器框架会为咱们扩充此操作。
func ahcRequest(host: String, eventLoop: EventLoop) throws -> HTTPClient.Request { let body: HTTPClient.Body? switch self.body { case .byteBuffer(let buffer): body = buffer.map { .byteBuffer($0) } case .stream(let stream): body = .stream { writer in // as we consume buffers from `HBRequest` we write them to // the `HTTPClient.Request`. return stream.consumeAll(on: eventLoop) { byteBuffer in writer.write(.byteBuffer(byteBuffer)) } } } return try HTTPClient.Request( url: host + self.uri.description, method: self.method, headers: self.headers, body: body ) }流式反应
流式反应需要一个罢职 HTTPClientResponseDelegate 的class. 这将在 HTTPClient 反应可用时立即从反应中接纳数据。反应正文是 ByteBuffers 样子. 咱们不错将这些 ByteBuffers 提供给 HBByteBufferStreamer. 咱们求教的 HBResponse 是由这些流构造,而不是静态的 ByteBuffer。
如若咱们将肯求流与反应流代码采集起来,咱们的最终的 apply 函数应该是这么的
func apply(to request: HBRequest, next: HBResponder) -> EventLoopFuture<HBResponse> { do { request.logger.info("Forwarding \(request.uri.path)") // create request let ahcRequest = try request.ahcRequest(host: target, eventLoop: request.eventLoop) // create response body streamer. maxSize is the maximum size of object it can process // maxStreamingBufferSize is the maximum size of data the streamer is allowed to have // in memory at any one time let streamer = HBByteBufferStreamer(eventLoop: request.eventLoop, maxSize: 2048*1024, maxStreamingBufferSize: 128*1024) // HTTPClientResponseDelegate for streaming bytebuffers from AsyncHTTPClient let delegate = StreamingResponseDelegate(on: request.eventLoop, streamer: streamer) // execute request _ = httpClient.execute( request: ahcRequest, delegate: delegate, eventLoop: .delegateAndChannel(on: request.eventLoop), logger: request.logger ) // when delegate receives head then signal completion return delegate.responsePromise.futureResult } catch { return request.failure(error) } }
你会翔实到在上头的代码中咱们不恭候httpClient.execute. 这是因为如若咱们这么作念了,该函数将在陆续之前恭候通盘这个词反应主体在内存中。咱们但愿立即处理反应,因此咱们向委用添加了一个promise: 一朝咱们收到头部信息,就和会过保存头部细则和流到HBResponse来杀青。EventLoopFuture这个 promise的是咱们从apply函数传回的。
我莫得在StreamingResponseDelegate这里包含代码,但您不错在好意思满的示例代码中[5]找到它。
示例代码添加该示例代码[6]可能在上头的基础上作念了部分修改。
默许绑定地址端口是 8081 而不是 8080。大多数 Hummingbird 示例在 8080 上运行,因此要在这些示例驾御使用代理,它需要绑定到不同的端口。 我添加了一个位置选项,它允许咱们只转发来自特定基本 URL 的肯求 我为观点和位置添加了号召行选项,因此不错在不重建期骗轨范的情况下改动这些选项 我删除了 host 标题或肯求,以便不错用正确的值填写 如若提供了 content-length 标头,则在调度流肯求时,我将其传递给 HTTPClient 流送器,以确保 content-length 为观点作事器的肯求正确建设标头。 备择有缱绻咱们不错使用 HummingbirdCore 代替 Hummingbird 行为代理作事器。这将提供一些稀奇的性能,因为它会删除稀奇的代码层,但会捐躯生动性。添加任何稀奇的路由或中间件需要作念更多的职责。我有只使用HummingbirdCore代理作事器的示例代码在这里[7]。
诚然,另一种遴荐是使用 Vapor。我思在 Vapor 中的杀青看起来与上头描摹的相配相似,应该不会太难。不外我会把它留给别东说念主。
参考府上[1]Hummingbird: https://github.com/hummingbird-project/hummingbird
[2]AsyncHTTPClient: https://github.com/swift-server/async-http-client
[3]Hummingbird模板样式: https://github.com/hummingbird-project/template
[4]here: https://opticalaberration.com/2021/12/hummingbird-template.html
[5]示例代码中: https://github.com/hummingbird-project/hummingbird-examples/blob/main/proxy-server/Sources/App/Middleware/StreamingResponseDelegate.swift
[6]示例代码: https://github.com/hummingbird-project/hummingbird-examples/tree/main/proxy-server
[7]在这里: https://github.com/hummingbird-project/hummingbird-examples/tree/main/proxy-server-core