写点什么

如何用 Go 语言写出好用的 Http 中间件?

  • 2019-08-23
  • 本文字数:2507 字

    阅读完需:约 8 分钟

如何用 Go 语言写出好用的 Http 中间件?

当我们用 Go 语言编写较为复杂的服务时,一个永恒的话题就是中间件。这个话题在网上被一遍一遍又一遍地讨论着。归根结底,中间件应该允许我们:


  1. 拦截 ServeHTTP 调用,并执行任意代码。

  2. 在持续的链上对请求/响应流做变更。

  3. 中断中间件链条,或继续下一个中间件拦截器,最终到真正的请求处理程序上面。


这些听起来跟express.js 中间件很相似。我们研究了许多资料,发现了一些已经存在的解决方案,这些方案跟我们想要的非常吻合,但他们要么有不必要的额外功能,要么需求不对我们的胃口。很明显,我们可以基于express.js编写中间件,安装这个干净整洁的组件之后,20 行以下代码就可以实现一个轻量级的 API

抽象

设计抽象时,首先我们要考虑的就是,如何写中间件函数(从现在起,可以称它为拦截器)。


答案很明显:


它们看起来就像 http.HandlerFunc,带一个额外的参数 next,程序进行下一步的处理。这使得任何人都可以像编写简单函数一样,类似 http.HandlerFunc 这样来编写拦截器,做他们想做的,并能按照他们的意愿传递控制权。


接下来我们要考虑的就是,如何将拦截器挂到http.Handlerhttp.HandlerFunc上。想要达成这个目标,首先要做的就是定义MiddlewareHandlerFunc,简单来说就是http.HandlerFunc的一种类型(例如,type MiddlewareHandlerFunc http.HandlerFunc)。这将让我们在http.HandlerFunc的基础之上,构建一个更好的 API。现在给出一个http.HandlerFunc,我们想要的链式 API 大概是这样:


func HomeRouter(w http.ResponseWriter, r *http.Request) {    // Handle your request}
// ...// Some where when installing Hanlderchain := MiddlewareHandlerFunc(HomeRouter). Intercept(NewElapsedTimeInterceptor()). Intercept(NewRequestIdInterceptor())
// Install it like regular HttpHandlermux.Path("/home").HandlerFunc(http.HandlerFunc(chain))
复制代码


http.HandlerFunc转换成MiddlewareHandlerFunc,并通过调用Intercept方法来安装拦截器。Intercept的返回类型又是一个MiddlewareHandlerFunc,允许我们再次调用Intercept


如果使用Intercept架构,非常值得注意的一点就是执行的先后顺序。因为调用chain(responseWriter, request)实际上就是间接调用上一个拦截器,并将其停止,即从拦截器的尾部回到处理程序的首部。这非常有意义,因为正在拦截调用;所以你应该在父程序前执行拦截。

简化

虽然逆向链式系统让抽象变得更清晰,但大多时候都会有一个预编译拦截数组,可以在不同的处理程序中被复用。另外,当我们把中间件定义为数组时,更倾向按执行顺序去声明这些数组,而不是终止的顺序。我们把这个数组拦截器称作:MiddlewareChain。我们想要的中间件链大概是这样:


注意,这些中间件将按照链中出现的顺序调用,即RequestIDInterceptorElapsedTimeInterceptor。这增加了代码的重用性和可读性。

实现

一旦设计好了抽象内容,实现起来就会很顺利:


/*Copyright (c) 2019 DoorDashPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.*/package middleware
import "net/http"
// MiddlewareInterceptor intercepts an HTTP handler invocation, it is passed both response writer and request// which after interception can be passed onto the handler function.type MiddlewareInterceptor func(http.ResponseWriter, *http.Request, http.HandlerFunc)
// MiddlewareHandlerFunc builds on top of http.HandlerFunc, and exposes API to intercept with MiddlewareInterceptor.// This allows building complex long chains without complicated struct manipulationtype MiddlewareHandlerFunc http.HandlerFunc

// Intercept returns back a continuation that will call install middleware to intercept// the continuation call.func (cont MiddlewareHandlerFunc) Intercept(mw MiddlewareInterceptor) MiddlewareHandlerFunc { return func(writer http.ResponseWriter, request *http.Request) { mw(writer, request, http.HandlerFunc(cont)) }}
// MiddlewareChain is a collection of interceptors that will be invoked in there index ordertype MiddlewareChain []MiddlewareInterceptor
// Handler allows hooking multiple middleware in single call.func (chain MiddlewareChain) Handler(handler http.HandlerFunc) http.Handler { curr := MiddlewareHandlerFunc(handler) for i := len(chain) - 1; i >= 0; i-- { mw := chain[i] curr = curr.Intercept(mw) }
return http.HandlerFunc(curr)}
复制代码


这样一来,20 行(不包括注释)的代码,就能构建一个很不错的中间件库。在裸机上,这几行抽象代码连贯性也是令人惊叹的。这能让我们有条不紊地编写出流畅的 Http 中间件链。希望这几行 Go 语言代码也能给你带来好的中间件体验。


原文链接:


https://doordash.engineering/2019/07/22/writing-delightful-http-middlewares-in-go


2019-08-23 09:007273

评论 1 条评论

发布
用户头像
代码是不完整的,照搬都可以漏。。。
2019-08-27 10:46
回复
没有更多了
发现更多内容

火山引擎数智平台ByteHouse入围稀土掘金《Top10年度创新产品》

字节跳动数据平台

大数据 云原生 Clickhouse

云原生观测性--OpenTelemetry 之实战篇

Daocloud 道客

云原生 可观测性 OpenTelemetry

预告| 2月24日不见不散!开源治理专场约定你

OpenI启智社区

人工智能 开源社区 开发者大会 开源治理 OpenI启智社区

镇江有具有资质的等保测评机构吗?在哪里?

行云管家

等保 等级保护 等保测评 镇江

实时数仓Hologres新一代弹性计算组实例技术揭秘

阿里云大数据AI技术

大数据 实时数仓 弹性计算 企业号 2 月 PK 榜

NFT链游开发实现DAPP系统落地

薇電13242772558

NFT 链游

React源码分析6-hooks源码

goClient1992

React

react源码中的协调与调度

flyzz177

React

前端leetcde算法面试套路之二叉树

js2030code

JavaScript LeetCode

流批一体架构在快手的实践和思考

Apache Flink

大数据 flink 实时计算

预告| 亮点抢先看!第四届OpenI/O启智开发者大会主论坛24日启幕!

OpenI启智社区

人工智能 开发者大会 算力网络 OpenI启智社区

直播预告 | 嵌入式BI如何将数据分析真正融入业务流程

葡萄城技术团队

ChatGPT背后:从0到1,OpenAI的创立之路

OneFlow

人工智能 深度学习 openai ChatGPT

React源码分析7-state计算流程和优先级

goClient1992

React

优质的双机热备软件厂家是哪家?咨询电话多少?

行云管家

高可用 双机热备 双机热备软件

预告|第四届OpenI/O启智开发者大会NLP大模型论坛强势来袭!

OpenI启智社区

人工智能 NLP 大模型 开发者大会 OpenI启智社区 ChatGPT

react源码中的hooks

flyzz177

React

时代背景下的 ChatGPT,到底能帮助开发者做什么呢?

泰罗凹凸曼

JavaScript ChatGPT

react源码中的fiber架构

flyzz177

React

大咖齐聚!OpenHarmony技术峰会豪华嘉宾阵容揭晓

OpenHarmony开发者

OpenHarmony

前端leetcde算法面试套路之双指针

js2030code

JavaScript LeetCode

预告|因“AI”而“深” 第四届OpenI/O 启智开发者大会高校开源专场25日开启!

OpenI启智社区

人工智能 开源 OpenI启智社区

保持热爱,奔赴山海:Apache Calcite PMC 之路

字节跳动开源

flink 开源 技术 社区 Apache Calcite

有趣,在WSL2上运行VSCode

吴脑的键客

vscode WSL2

ChatGPT能做什么?(内附体验攻略)

FinFish

AI工程化 ChatGPT

别错过!4C首发直播,上届全国总冠军带你入门赛题

飞桨PaddlePaddle

计算机 飞桨 PaddlePaddle

混沌工程之 ChaosBlade 故障注入百宝箱

柠檬汁Code(binbin0325)

源码分析 混沌工程 故障注入 ChaosBlade Chaos

React源码分析5-commit

goClient1992

React

实践篇(三):如何有效评审软件架构图?

京东科技开发者

架构 后端 软件架构 企业号 2 月 PK 榜 架构评审

用javascript分类刷leetcode22.字典树(图文视频讲解)

js2030code

JavaScript LeetCode

Teradata 离场,企业数据分析平台如何应对变革?

Kyligence

数据分析 指标中台

如何用 Go 语言写出好用的 Http 中间件?_编程语言_Zohaib Sibte Hassan_InfoQ精选文章