四種Golang實現(xiàn)middleware框架的方式小結(jié)

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

middleware是一般框架里面常用的形式,比如web框架、rpc框架等,本文為大家詳細(xì)介紹了四種實現(xiàn)middleawre的方式,感興趣的可以了解一下

寫在前面

middleware是一般框架里面常用的形式，比如web框架、rpc框架，通過middleware在流量入口和出口做一些公共事情，包括鑒權(quán)、日志、埋點、統(tǒng)計、限流、參數(shù)處理、異常處理等等。

在工作中經(jīng)常會用到，在閱讀web框架（gin,beego）的時候也會遇到，今天總結(jié)一下middleware有哪些實現(xiàn)方式。

方案一：數(shù)組遞歸調(diào)用

package middleware

import "context"

// 處理函數(shù)
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結(jié)構(gòu)體中定義業(yè)務(wù)處理函數(shù)handler和插件數(shù)組middlewares,在執(zhí)行函數(shù)Exec里面，將業(yè)務(wù)處理函數(shù)handler封裝成一個middleware放到middlewares后面，然后遞歸調(diào)用內(nèi)部函數(shù)mkCallChain。這個內(nèi)部函數(shù)mkCallChain返回的是一個函數(shù)，將所有middleware一層一層包裹起來，最終callChain := m.mkCallChain(m.middlewares)得到的是一個調(diào)用鏈。

這段代碼有點繞，需要細(xì)品。

測試方案一

	// 方案一
	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")

結(jié)果

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

方案二：順序?qū)崿F(xiàn)

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),
	}
}

// 執(zhí)行下一個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開始執(zhí)行
	return m.middlewares[0](m)
}

核心代碼是這段

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

自己定義一個context將所有middleware作為數(shù)組放在context中，執(zhí)行Exec()的時候就執(zhí)行第一個middleware，并且將context傳進(jìn)去。其他middlewaer中通過調(diào)用Next()函數(shù)來觸發(fā)下一個middleware。

這種方式看起來邏輯簡單，容易理解。gin框架的middleware就是這樣實現(xiàn)的。這個方式是作者對gin框架的middleware的總結(jié)和抽象。

測試方案二

	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")

結(jié)果

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

方式三：鏈?zhǔn)秸{(diào)用

package middlewarechain

import "context"

type Handler func(ctx context.Context) error

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

這段代碼邏輯很簡單，它就是將上一個middleweare作為next參數(shù)傳到當(dāng)前middleware，形成鏈?zhǔn)秸{(diào)用。

看到這個定義你會不會覺得很奇怪，怎么這么點代碼？

是的，它的代碼就是這么少。有句話說的好“哪有什么歲月靜好,不過是有人替你負(fù)重前行,生活從來都不容易”，定義的地方代碼少了，調(diào)用的時候肯定就復(fù)雜了。

下面看看測試用例

	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")

結(jié)果

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

可見，在定義middleweare的時候，要將上一個middleeware傳入當(dāng)前middleeware的定義。跟其他幾種方案相比，其實它就是將middleware的注冊去掉了，沒有地方維護(hù)所有的middleware。

方案四：for循環(huán)實現(xiàn)

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結(jié)構(gòu)體，內(nèi)部維護(hù)一個middlewares數(shù)組，在調(diào)用Exec的時候，循環(huán)執(zhí)行middlewares

測試方案四

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

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

結(jié)果

===方案四 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