四种Golang实现middleware框架的方式小结

更新时间：2024年03月24日 08:26:58 作者：Alex

middleware是一般框架里面常用的形式,比如web框架、rpc框架等,本文为大家详细介绍了四种实现middleawre的方式,感兴趣的可以了解一下

写在前面

middleware是一般框架里面常用的形式，比如web框架、rpc框架，通过middleware在流量入口和出口做一些公共事情，包括鉴权、日志、埋点、统计、限流、参数处理、异常处理等等。

在工作中经常会用到，在阅读web框架（gin,beego）的时候也会遇到，今天总结一下middleware有哪些实现方式。

方案一：数组递归调用

package middleware

import "context"

// 处理函数
type Handler func(ctx context.Context,
	msg string) error

// 插件类型
type MiddleWareFunc func(ctx context.Context,
	msg string, next Handler) error

type MiddlewareManager struct {
	handler     Handler
	middlewares []MiddleWareFunc
}

func NewMiddlewareManager(handler Handler) *MiddlewareManager {
	return &MiddlewareManager{
		handler: handler,
	}
}

func (m *MiddlewareManager) Register(middlewares ...MiddleWareFunc) {
	m.middlewares = append(m.middlewares, middlewares...)
}

func (m *MiddlewareManager) Exec(ctx context.Context, msg string) error {
	handlerFunc := func(ctx context.Context, msg string, next Handler) error {
		return m.handler(ctx, msg)
	}
	m.middlewares = append(m.middlewares, handlerFunc)

	callChain := m.mkCallChain(m.middlewares)
	return callChain(ctx, msg)
}

func (m *MiddlewareManager) mkCallChain(
	middlewares []MiddleWareFunc) Handler {
	if len(middlewares) <= 0 {
		return nil
	}

	return func(ctx context.Context, msg string) error {
		return middlewares[0](ctx, msg, m.mkCallChain(middlewares[1:]))
	}
}

在MiddlewareManager结构体中定义业务处理函数handler和插件数组middlewares,在执行函数Exec里面，将业务处理函数handler封装成一个middleware放到middlewares后面，然后递归调用内部函数mkCallChain。这个内部函数mkCallChain返回的是一个函数，将所有middleware一层一层包裹起来，最终callChain := m.mkCallChain(m.middlewares)得到的是一个调用链。

这段代码有点绕，需要细品。

测试方案一

	// 方案一
	fmt.Println("===方案一 begin")
	m1 := middleware.NewMiddlewareManager(HandlerMsg)
	m1.Register(middleware.TimeCostMW, middleware.FilterMW, middleware.LoggerMW)
	if err := m1.Exec(context.Background(), "hello chain"); err != nil {
		panic(err)
	}
	fmt.Println("===方案一 end")

结果

===方案一 begin
TimeCost before
FinlterMW begin
LoggerMW before
HandlerMsg: hello chain
LoggerMW end
FinlterMW end
TimeCostMW:cost 1000428754
===方案一 end

方案二：顺序实现

package middlewarecontext

type MiddleWareFunc func(ctx *MyContext) error

type MyContext struct {
	middlewares []MiddleWareFunc
	idx         int
	maxIdx      int
}

func NewMyContext() *MyContext {
	return &MyContext{
		middlewares: make([]MiddleWareFunc, 0),
	}
}

// 执行下一个middleware
func (m *MyContext) Next() error {
	if m.idx < m.maxIdx-1 {
		m.idx += 1
		return m.middlewares[m.idx](m)
	}

	return nil
}

// 终止middleware
func (m *MyContext) Abort() {
	m.idx = m.maxIdx
}

func (m *MyContext) Register(middlewares ...MiddleWareFunc) {
	m.middlewares = append(m.middlewares, middlewares...)
	m.maxIdx = len(m.middlewares)
}

func (m *MyContext) Exec() error {
	// 从第一个middleware开始执行
	return m.middlewares[0](m)
}

核心代码是这段

type MyContext struct {
	middlewares []MiddleWareFunc
	idx         int
	maxIdx      int
}

自己定义一个context将所有middleware作为数组放在context中，执行Exec()的时候就执行第一个middleware，并且将context传进去。其他middlewaer中通过调用Next()函数来触发下一个middleware。

这种方式看起来逻辑简单，容易理解。gin框架的middleware就是这样实现的。这个方式是作者对gin框架的middleware的总结和抽象。

测试方案二

	fmt.Println("===方案二 begin")
	m2 := middlewarecontext.NewMyContext()
	m2.Register(
		middlewarecontext.TimeCostMW,
		middlewarecontext.FilterMW,
		middlewarecontext.LoggerMW)
	if err := m2.Exec(); err != nil {
		panic(err)
	}
	fmt.Println("===方案二 end")

结果

===方案二 begin
TimeCost before
FinlterMW begin
LoggerMW before
LoggerMW end
FinlterMW end
TimeCostMW:cost 1000588399
===方案二 end

方式三：链式调用

package middlewarechain

import "context"

type Handler func(ctx context.Context) error

type MiddleWareFunc func(ctx context.Context, next Handler) Handler

这段代码逻辑很简单，它就是将上一个middleweare作为next参数传到当前middleware，形成链式调用。

看到这个定义你会不会觉得很奇怪，怎么这么点代码？

是的，它的代码就是这么少。有句话说的好“哪有什么岁月静好,不过是有人替你负重前行,生活从来都不容易”，定义的地方代码少了，调用的时候肯定就复杂了。

下面看看测试用例

	fmt.Println("===方案三 begin")
	ctx := context.Background()
	m3 := middlewarechain.TimeCostMW(ctx, func(ctx context.Context) error {
		PrintMsg("test")
		return nil
	})
	m4 := middlewarechain.FilterMW(ctx, m3)
	m5 := middlewarechain.LoggerMW(ctx, m4)
	if err := m5(ctx); err != nil {
		fmt.Println(err)
	}
	fmt.Println("===方案三 end")

结果

===方案三 begin
LoggerMW before
FinlterMW begin
TimeCost before
PrintMsg:test
TimeCostMW:cost 6130
FinlterMW end
LoggerMW end
===方案三 end

可见，在定义middleweare的时候，要将上一个middleeware传入当前middleeware的定义。跟其他几种方案相比，其实它就是将middleware的注册去掉了，没有地方维护所有的middleware。

方案四：for循环实现

package middlewarefor

import "context"

type Handler func(ctx context.Context) error

type Middleware func(next Handler) Handler

type MiddlewareManager struct {
	middlewares []Middleware
}

func NewMiddlewareManager(middlewares ...Middleware) *MiddlewareManager {
	return &MiddlewareManager{
		middlewares: middlewares,
	}
}

func (m *MiddlewareManager) Register(middlewares ...Middleware) {
	m.middlewares = append(m.middlewares, middlewares...)
}

func (m *MiddlewareManager) Exec(ctx context.Context) error {
	handler := defaultHandler
	for i := range m.middlewares {
		handler = m.middlewares[len(m.middlewares)-i-1](handler)
	}

	return handler(ctx)
}

func defaultHandler(ctx context.Context) error {
	return nil
}

它跟方案一很像，都是定义一个MiddlewareManager结构体，内部维护一个middlewares数组，在调用Exec的时候，循环执行middlewares

测试方案四

	fmt.Println("===方案四 begin")
	ctx = context.Background()
	middleware4 := middlewarefor.NewMiddlewareManager(
		middlewarefor.RecoveryMW,
		middlewarefor.LoggerMW,
		middlewarefor.TimeCostMW,
	)

	middleware4.Exec(ctx)
	fmt.Println("===方案四 end")

结果

===方案四 begin
2023/01/15 15:27:09 [RecoveryMW] befor
2023/01/15 15:27:09 [LoggerMW] befor
2023/01/15 15:27:09 [TimeCostMW] cost:0.000000s
2023/01/15 15:27:09 [LoggerMW] end
2023/01/15 15:27:09 [RecoveryMW] end
===方案四 end

总结

上面四种方案，都能实现middleware，好坏不予评价，你喜欢用哪种方式就用哪种。

本文及github上的代码实现主要是用于学习和总结，如果你想用某种方式到自己的项目中，直接复制过去就行，不建议引用本代码仓库。

github代码仓库：github.com/ZBIGBEAR/middleware

到此这篇关于四种Golang实现middleware框架的方式小结的文章就介绍到这了,更多相关Go middleware框架内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

golang使用sync.Once实现懒加载的用法和坑点详解
这篇文章主要为大家详细介绍了golang使用sync.Once实现懒加载的用法和坑点,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
2023-11-11
详解Go语言如何使用标准库sort对切片进行排序
Sort 标准库提供了对基本数据类型的切片和自定义类型的切片进行排序的函数。今天主要分享的内容是使用 Go 标准库 sort 对切片进行排序，感兴趣的可以了解一下
2022-12-12
go build 通过文件名后缀实现不同平台的条件编译操作
这篇文章主要介绍了go build 通过文件名后缀实现不同平台的条件编译操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-12-12
Golang中下划线(_)的不错用法分享
golang中的下划线表示忽略变量的意思，也没有产生新的变量，但是后面的表达式依然会被执行,本文为大家整理了golang中下划线的一些不错的用法，需要的可以参考下
2023-05-05
一文搞懂Golang文件操作增删改查功能(基础篇)
这篇文章主要介绍了一文搞懂Golang文件操作增删改查功能(基础篇),Golang 可以认为是服务器开发语言发展的趋势之一，特别是在流媒体服务器开发中，已经占有一席之地，今天我们不聊特别深奥的机制和内容，就来聊一聊 Golang 对于文件的基本操作
2021-04-04
Go应该如何实现二级缓存
本文主要介绍了Go二级缓存，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-08-08
Go语言中的基础数据类型使用实例
这篇文章主要为大家介绍了Go中的基础数据类型使用示例解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04
深入浅出Golang中的sync.Pool
sync.Pool是可伸缩的，也是并发安全的，其大小仅受限于内存大小。本文主要为大家介绍一下Golang中sync.Pool的原理与使用，感兴趣的小伙伴可以了解一下
2023-03-03
修改并编译golang源码的操作步骤
这篇文章主要介绍了修改并编译golang源码的操作步骤，本文给大家介绍的非常详细,需要的朋友可以参考下
2021-07-07
Go语言使用Zap轻松搞定结构化日志
在 Go 语言中,有许多日志库可供选择,但在性能和灵活性方面,Zap 是其中的佼佼者,下面我们就来看看Go 项目中如何使用 Zap 进行结构化日志记录吧
2024-11-11