refactor!: 中间件添加 router 参数

用以区分当前路由项属于哪个路由

Author: caixw

examples/std/std_test.go

@@ -19,7 +19,7 @@ import (
 var (
 	_ http.Handler = &Router{}
 	_ http.Handler = &Routers{}
-	_ Middleware   = MiddlewareFunc(func(http.Handler, string, string) http.Handler { return nil })
+	_ Middleware   = MiddlewareFunc(func(_ http.Handler, _, _, _ string) http.Handler { return nil })
 )
 
 func TestRouter(t *testing.T) {

group/group.go

@@ -130,7 +130,7 @@ func (g *GroupOf[T]) Use(m ...types.MiddlewareOf[T]) {
 	for _, r := range g.routers {
 		r.r.Use(m...)
 	}
-	g.notFound = tree.ApplyMiddleware(g.notFound, "", "", m...)
+	g.notFound = tree.ApplyMiddleware(g.notFound, "", "", "", m...)
 
 	g.middleware = append(g.middleware, m...)
 }

group/host.go

@@ -24,7 +24,7 @@ type Hosts struct {
 func NewHosts(lock bool, domain ...string) *Hosts {
 	i := syntax.NewInterceptors()
 	f := func(types.Node) any { return nil }
-	t := tree.New(lock, i, nil, false, f, f)
+	t := tree.New("", lock, i, nil, false, f, f)
 	h := &Hosts{tree: t, i: i}
 	h.Add(domain...)
 	return h

internal/tree/method.go

@@ -98,19 +98,19 @@ func (n *node[T]) addMethods(h T, pattern string, ms []types.MiddlewareOf[T], me
 		}
 
 		if m == http.MethodGet {
-			n.handlers[http.MethodHead] = ApplyMiddleware(h, http.MethodHead, pattern, ms...)
+			n.handlers[http.MethodHead] = ApplyMiddleware(h, http.MethodHead, pattern, n.root.Name(), ms...)
 		}
 
-		n.handlers[m] = ApplyMiddleware(h, m, pattern, ms...)
+		n.handlers[m] = ApplyMiddleware(h, m, pattern, n.root.Name(), ms...)
 	}
 
 	// 查看是否需要添加 OPTIONS
 	if _, found := n.handlers[http.MethodOptions]; !found {
-		n.handlers[http.MethodOptions] = ApplyMiddleware(n.root.optionsBuilder(n), http.MethodOptions, pattern, ms...)
+		n.handlers[http.MethodOptions] = ApplyMiddleware(n.root.optionsBuilder(n), http.MethodOptions, pattern, n.root.Name(), ms...)
 	}
 
 	if _, found := n.handlers[methodNotAllowed]; !found {
-		n.handlers[methodNotAllowed] = ApplyMiddleware(n.root.methodNotAllowedBuilder(n), "", pattern, ms...)
+		n.handlers[methodNotAllowed] = ApplyMiddleware(n.root.methodNotAllowedBuilder(n), "", pattern, n.root.Name(), ms...)
 	}
 
 	n.buildMethods()

internal/tree/node.go

@@ -333,17 +333,17 @@ func (n *node[T]) checkAmbiguous(pattern string, hasNonString bool) (*node[T], b
 
 func (n *node[T]) applyMiddleware(ms ...types.MiddlewareOf[T]) {
 	for m, h := range n.handlers {
-		n.handlers[m] = ApplyMiddleware(h, m, n.Pattern(), ms...)
+		n.handlers[m] = ApplyMiddleware(h, m, n.Pattern(), n.root.Name(), ms...)
 	}
 
 	for _, c := range n.children {
 		c.applyMiddleware(ms...)
 	}
 }
 
-func ApplyMiddleware[T any](h T, method, pattern string, f ...types.MiddlewareOf[T]) T {
+func ApplyMiddleware[T any](h T, method, pattern, router string, f ...types.MiddlewareOf[T]) T {
 	for _, ff := range f {
-		h = ff.Middleware(h, method, pattern)
+		h = ff.Middleware(h, method, pattern, router)
 	}
 	return h
 }

internal/tree/test.go

@@ -19,13 +19,13 @@ import (
 
 // NewTestTree 返回以 http.Handler 作为参数实例化的 Tree
 func NewTestTree(a *assert.Assertion, lock, trace bool, i *syntax.Interceptors) *Tree[http.Handler] {
-	t := New(lock, i, http.NotFoundHandler(), trace, BuildTestNodeHandlerFunc(http.StatusMethodNotAllowed), BuildTestNodeHandlerFunc(http.StatusOK))
+	t := New("", lock, i, http.NotFoundHandler(), trace, BuildTestNodeHandlerFunc(http.StatusMethodNotAllowed), BuildTestNodeHandlerFunc(http.StatusOK))
 	a.NotNil(t)
 	return t
 }
 
 func BuildTestMiddleware(a *assert.Assertion, text string) types.MiddlewareOf[http.Handler] {
-	return types.MiddlewareFuncOf[http.Handler](func(next http.Handler, _, _ string) http.Handler {
+	return types.MiddlewareFuncOf[http.Handler](func(next http.Handler, _, _, _ string) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			next.ServeHTTP(w, r) // 先输出被包含的内容
 			_, err := w.Write([]byte(text))

internal/tree/tree.go

@@ -37,6 +37,8 @@ import (
 //	             |
 //	             +---- emails
 type Tree[T any] struct {
+	name string // 名称
+
 	methods map[string]int // 保存着每个请求方法在所有子节点上的数量。
 	node    *node[T]       // 空节点，正好用于处理 OPTIONS *。
 
@@ -50,13 +52,22 @@ type Tree[T any] struct {
 	methodNotAllowedBuilder types.BuildNodeHandleOf[T]
 }
 
-func New[T any](lock bool, i *syntax.Interceptors, notFound T, trace bool, methodNotAllowedBuilder, optionsBuilder types.BuildNodeHandleOf[T]) *Tree[T] {
+func New[T any](
+	name string,
+	lock bool,
+	i *syntax.Interceptors,
+	notFound T,
+	trace bool,
+	methodNotAllowedBuilder,
+	optionsBuilder types.BuildNodeHandleOf[T],
+) *Tree[T] {
 	s, err := i.NewSegment("")
 	if err != nil {
 		panic("发生了不该发生的错误，应该是 syntax.NewSegment 逻辑发生变化" + err.Error())
 	}
 
 	t := &Tree[T]{
+		name:    name,
 		methods: make(map[string]int, len(Methods)),
 		node:    &node[T]{segment: s, methodIndex: methodIndexMap[http.MethodOptions]},
 
@@ -79,6 +90,8 @@ func New[T any](lock bool, i *syntax.Interceptors, notFound T, trace bool, metho
 	return t
 }
 
+func (tree *Tree[T]) Name() string { return tree.name }
+
 // Add 添加路由项
 //
 // methods 可以为空，表示添所有支持的请求方法，其中的 HEAD 和 OPTIONS 不受控。
@@ -291,6 +304,6 @@ func (tree *Tree[T]) URL(buf *errwrap.StringBuilder, pattern string, ps map[stri
 
 // ApplyMiddleware 为已有的路由项添加中间件
 func (tree *Tree[T]) ApplyMiddleware(ms ...types.MiddlewareOf[T]) {
-	tree.notFound = ApplyMiddleware(tree.notFound, "", "", ms...)
+	tree.notFound = ApplyMiddleware(tree.notFound, "", "", tree.Name(), ms...)
 	tree.node.applyMiddleware(ms...)
 }

router.go

@@ -27,7 +27,6 @@ type (
 	//      Handle("/api/{version:\\d+}",h3, http.MethodGet, http.MethodPost) // 只匹配 GET 和 POST
 	//  http.ListenAndServe(router)
 	RouterOf[T any] struct {
-		name string
 		tree *tree.Tree[T]
 		call CallOf[T]
 
@@ -74,8 +73,7 @@ func NewRouterOf[T any](name string, call CallOf[T], notFound T, methodNotAllowe
 	}
 
 	r := &RouterOf[T]{
-		name: name,
-		tree: tree.New(opt.Lock, opt.Interceptors, notFound, opt.Trace, methodNotAllowedBuilder, optionsBuilder),
+		tree: tree.New(name, opt.Lock, opt.Interceptors, notFound, opt.Trace, methodNotAllowedBuilder, optionsBuilder),
 		call: call,
 
 		cors:        opt.CORS,
@@ -222,7 +220,7 @@ func (r *RouterOf[T]) ServeContext(w http.ResponseWriter, req *http.Request, ctx
 }
 
 // Name 路由名称
-func (r *RouterOf[T]) Name() string { return r.name }
+func (r *RouterOf[T]) Name() string { return r.tree.Name() }
 
 func (p *PrefixOf[T]) Handle(pattern string, h T, m []types.MiddlewareOf[T], methods ...string) *PrefixOf[T] {
 	m = slices.Concat(m, p.middleware)

router_test.go

@@ -268,7 +268,7 @@ func TestPrefix_Resource(t *testing.T) {
 	a.NotNil(def)
 
 	buildTestMiddleware := func(a *assert.Assertion, text string) types.MiddlewareOf[ctx.Handler] {
-		return types.MiddlewareFuncOf[ctx.Handler](func(next ctx.Handler, _, _ string) ctx.Handler {
+		return types.MiddlewareFuncOf[ctx.Handler](func(next ctx.Handler, _, _, _ string) ctx.Handler {
 			return ctx.HandlerFunc(func(ctx *ctx.CTX) {
 				next.Handle(ctx) // 先输出被包含的内容
 				_, err := ctx.W.Write([]byte(text))

types/types.go

@@ -116,16 +116,17 @@ type MiddlewareOf[T any] interface {
 	// next 路由项的处理函数；
 	// method 当前路由的请求方法；
 	// pattern 当前路由的匹配项；
+	// router 路由名称，即 [mux.RouterOf.Name] 的值；
 	//
 	// NOTE: method 和 pattern 在某些特殊的路由项中会有特殊的值：
 	//  - 404 method 和 pattern 均为空；
 	//  - 405 method 为空，pattern 正常；
-	Middleware(next T, method, pattern string) T
+	Middleware(next T, method, pattern, router string) T
 }
 
 // MiddlewareFuncOf 中间件处理函数
-type MiddlewareFuncOf[T any] func(T, string, string) T
+type MiddlewareFuncOf[T any] func(next T, method, pattern, router string) T
 
-func (f MiddlewareFuncOf[T]) Middleware(next T, method, pattern string) T {
-	return f(next, method, pattern)
+func (f MiddlewareFuncOf[T]) Middleware(next T, method, pattern, router string) T {
+	return f(next, method, pattern, router)
 }