报名参加CloudWeGo黑客松,奖金直推双丰收! 了解详情
写点什么

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

评论 1 条评论

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

98位企业技术高管入学百度AICA 大模型带来AI人才三大能力要求

飞桨PaddlePaddle

人工智能 百度 paddle 百度飞桨

云原生MYSQL数据库架构分享

谐云

MySQL 云原生

自动化回归测试平台 AREX 0.4.0 版本发布

AREX 中文社区

开源 自动化测试 接口测试

红队攻防之快速打点

权说安全

网络攻防

代码随想录训练营Day04 - 链表(下)

jjn0703

基于eBPF技术的可观测实践探索

谐云

云原生

什么是KubeEdge?

谐云

kuberedge kurbernetes

传统网络环境应付不了企业发展需求,华为云下载加速解决方案体验如何?

YG科技

WebAssembly:让Istio变得更强大

谐云

istio WebAssenbly

落地领域大模型应知必会 (1) :主要微调方法总览

Baihai IDP

人工智能 白海科技 大语言模型 大模型微调 领域大模型

浅谈kubernetes存储—glusterfs故障排查

谐云

kuberedge

内卷时代如何上云,华为云Web及移动App上云又有何亮点?

YG科技

“科创中国”大湾区青年百人会论坛成功举办

飞桨PaddlePaddle

人工智能 百度 paddle 百度飞桨

在 Go 中如何实现类似 Python 中的 with 上下文管理器

江湖十年

Go 后端

微服务架构概览图

wiflish

微服务 微服务架构 架构治理

AI、机器学习、大模型、生成式AI和安全

啸天

人工智能 机器学习 安全 大模型 ChatGPT

华为云下载加速解决方案:让您的下载更快更稳定

YG科技

ChatGLM2-6B环境搭建

IT蜗壳-Tango

MySQL笔记之Checkpoint机制

互联网工科生

MySQL 高可用 CheckPoint

华为云SparkPack:成长型企业的数字化转型利器

YG科技

什么是WebAssembly及其必要性

谐云

WebAssenbly

Databend v1.2 版本发布!Data + AI

Databend

IoTLink版本更新V1.34.0

山东云则信息科技

Java Vue 后端 物联网 前段

基于多尺度图神经网络的流场预测,实现精度与速度的平衡

飞桨PaddlePaddle

人工智能 百度 paddle 飞桨 百度飞桨

福昕软件与国广传媒达成战略合作,共促AI技术创新发展

新消费日报

从低谷逆转,数字化转型企业可以信任华为云SparkPack

YG科技

业财一体,精细管控丨华为云SparkPack助力成长型企业数字化转型

YG科技

企业数字化办公,华为云WeLink为何能脱颖而出

轶天下事

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