写点什么

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

评论 1 条评论

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

如何通过YashanDB做到企业数据的透明化管理

数据库砖家

如何选择YashanDB数据库的开发环境?

数据库砖家

如何选择适合自己企业的YashanDB数据库托管服务?

数据库砖家

完整解读YashanDB数据库的架构与设计理念

数据库砖家

如何运用YashanDB进行客户数据分析与洞察?

数据库砖家

始终追赶技术潮流,YashanDB如何保持竞争力?

数据库砖家

在AI时代挖掘新需求:从WhatsApp多设备API项目看用户真实诉求

qife122

API开发 自动化工具

Burp Suite JSON美化扩展

qife122

安全测试 burp

实现快速查询的YashanDB数据库配置与调优方法

数据库砖家

学习YashanDB数据库的数据完整性保证机制

数据库砖家

引领数据革命:YashanDB数据库的创新应用

数据库砖家

秋招上岸必备60道Java面试场景题及其答案。

程序员高级码农

Java 程序员

Coco AI 实战(二):摄入MongoDB 数据

极限实验室

mongodb CocoAI

PID控制算法理论学习基础——单级PID控制

芯动大师

PID

为文字预测建立数学模型

江南一点雨

大数据-39 Redis 源码编译安装 启动 redis-server redis-cli

武子康

Java redis 大数据 分布式

ROG 绝神 RO姬x初音未来版电竞显示器与双模新品BW2025首秀!

新消费日报

IDM(Internet Download Manager)下载器的安装激活与换机方法

阿拉灯神丁

网络加速 下载器 IDM 下载工具

如何通过YashanDB支持远程办公中的数据访问

数据库砖家

实战讲解YashanDB数据库的索引创建与查询优化

数据库砖家

账户删除漏洞暴露聊天记录,研究员获1000美元奖金 - Nextcloud隐私漏洞分析与修复

qife122

网络安全 Nextcloud

Guitar Pro 8 中文免费版下载,Guitar Pro 激活码序列号领取,Guitar Pro 8永久免费使用教程

阿拉灯神丁

吉他学习 Guitar Pro8 Mac乐谱制作软件 音乐创作软件

springboot项目集成dolphinscheduler调度器 可拖拽spark任务管理

刘大猫

人工智能 算法 DolphinScheduler 调度器 大模型

实践YashanDB数据库安全控制的有效方法

数据库砖家

学习如何有效管理YashanDB数据库数据

数据库砖家

什么是数据库同步软件?为什么要关注数据库同步技术?

镜舟科技

实时数据 StarRocks 数据库同步软件 数据流动 异构数据源

吉利银河A7预售10.38万元起,首搭雷神AI电混2.0,油耗低至2L

极客天地

低代码——开发效率的加速器

秃头小帅oi

PIRF 438:Conspiracy Theories – Wait, what

Echo!!!

English

如何通过YashanDB增强数据处理的灵活性与扩展性?

数据库砖家

如何选择合适的硬件来优化YashanDB的运行?

数据库砖家

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