写点什么

如何用 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:007072

评论 1 条评论

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

Go语言很难吗?为什么 Go 岗位这么少?

伤感汤姆布利柏

Go 后端 低代码 Go 面试题 面经 后端 大厂

大模型训练的得力助手

百度开发者中心

大模型 #人工智能 LLM

诚邀报名|谭中意邀您共论“大模型应用开发之道”

开放原子开源基金会

Java 开源 程序员 开发者 算法

基于DotNetty实现一个接口自动发布工具 - 通信实现

EquatorCoco

git Netty WPF

又一次了,该认真考虑“混合多云”了!

京东科技开发者

云计算 云服务 混合多云

人工智能与智能化测试Workshop

测吧(北京)科技有限公司

测试

人工智能 | 自学习:数据科学的新潮流

测吧(北京)科技有限公司

测试

分布式基础概念-分布式缓存[3]

派大星

分布式 Java 面试题

灵活易用的即时通讯组件设计思路和最佳实践

融云 RongCloud

ios 设计 即时通讯 API Global IM UIkit

Docker镜像构建:技术深度解析与实践

树上有只程序猿

Docker 镜像

石原子科技荣登「2024 中国企业服务云图」,引领数据价值在线化革命,助力企业省心省钱更安全

StoneDB

MySQL 数据库 HTAP StoneDB

掌握这些,轻松管理BusyBox:如何交叉编译和集成BusyBox

EquatorCoco

嵌入式 嵌入式应用 busybox

人工智能 | 优化模型训练的利器——训练集、验证集和测试集

测吧(北京)科技有限公司

测试

人工智能 | 精准数据划分:提升模型性能的关键一步

测吧(北京)科技有限公司

测试

人工智能 | 优化模型性能的关键一步——深入理解训练集、验证集和测试集

测吧(北京)科技有限公司

测试

人工智能 | 数据闭环构建技巧:确保模型稳定性和数据质量

测吧(北京)科技有限公司

测试

高效微调大模型的新方法

百度开发者中心

nlp 大模型 #人工智能

人工智能发展脉络:从专家系统到机器学习的历史演进

测吧(北京)科技有限公司

测试

人工智能 | 数据与特征:解析模型如何依赖信息解决实际问题

测吧(北京)科技有限公司

测试

人工智能 | 深入理解评估指标——优化模型性能的关键

测吧(北京)科技有限公司

测试

别让错误的SQL变更毁了你的数据!那该如何审核变更SQL?

NineData

sql 数据 开发 变更 NineData

融云 CEO 董晗获评甲子光年「2023 中国数字经济创新人物」

融云 RongCloud

互联网 通信 数字经济 wicc 光年20

构建卓越的人工智能产品:全方位的质量保障与测试

测吧(北京)科技有限公司

测试

JS小技巧,如何去重对象数组?

高端章鱼哥

JavaScript js

2024年API安全趋势预测

互联网工科生

API API 安全

人工智能 | 精细解读人工智能评估指标——深入了解模型的强项与弱项

测吧(北京)科技有限公司

测试

人工智能 | 分布式造数工具中的Spark应用实践:快速生成大规模测试数据

测吧(北京)科技有限公司

测试

软件测试/人工智能|人工智能与智能化测试Workshop

霍格沃兹测试开发学社

如何使用京东商品详情 API 获取用户评价最多的商品详情?

技术冰糖葫芦

API 开发

在线教育如何通过小程序打造业务新引擎

Geek_2305a8

人工智能 | Spark在分布式造数工具中的应用:构建大规模测试数据的新境界

测吧(北京)科技有限公司

测试

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