feat(net/ghttp): add GetMetaTag function to retrieve metadata value for HandlerItem (#4206)

net/ghttp/ghttp.go

@@ -64,11 +64,11 @@ type (
 		Handler          *HandlerItem // The handler.
 		Server           string       // Server name.
 		Address          string       // Listening address.
-		Domain           string       // Bound domain.
+		Domain           string       // Bound domain, eg: example.com
 		Type             HandlerType  // Route handler type.
 		Middleware       string       // Bound middleware.
-		Method           string       // Handler method name.
+		Method           string       // Handler method name, eg: get, post.
-		Route            string       // Route URI.
+		Route            string       // Route URI, eg: /api/v1/user/{id}.
 		Priority         int          // Just for reference.
 		IsServiceHandler bool         // Is a service handler.
 	}

net/ghttp/ghttp_request_param_handler.go

@@ -6,8 +6,6 @@
 
 package ghttp
 
-import "github.com/gogf/gf/v2/util/gmeta"
-
 // GetHandlerResponse retrieves and returns the handler response object and its error.
 func (r *Request) GetHandlerResponse() interface{} {
 	return r.handlerResponse
@@ -17,25 +15,3 @@ func (r *Request) GetHandlerResponse() interface{} {
 func (r *Request) GetServeHandler() *HandlerItemParsed {
 	return r.serveHandler
 }
-
-// GetMetaTag retrieves and returns the metadata value associated with the given key from the request struct.
-// The meta value is from struct tags from g.Meta/gmeta.Meta type.
-// For example:
-//
-//	type GetMetaTagReq struct {
-//	    g.Meta `path:"/test" method:"post" summary:"meta_tag" tags:"meta"`
-//	    // ...
-//	}
-//
-// r.GetServeHandler().GetMetaTag("summary") // returns "meta_tag"
-// r.GetServeHandler().GetMetaTag("method")  // returns "post"
-func (h *HandlerItemParsed) GetMetaTag(key string) string {
-	if h == nil || h.Handler == nil {
-		return ""
-	}
-	metaValue := gmeta.Get(h.Handler.Info.Type.In(1), key)
-	if metaValue != nil {
-		return metaValue.String()
-	}
-	return ""
-}

net/ghttp/ghttp_server_router_serve.go

@@ -18,6 +18,7 @@ import (
 	"github.com/gogf/gf/v2/internal/intlog"
 	"github.com/gogf/gf/v2/internal/json"
 	"github.com/gogf/gf/v2/text/gregex"
+	"github.com/gogf/gf/v2/util/gmeta"
 )
 
 // handlerCacheItem is an item just for internal router searching cache.
@@ -252,34 +253,34 @@ func (s *Server) searchHandlers(method, path, domain string) (parsedItems []*Han
 }
 
 // MarshalJSON implements the interface MarshalJSON for json.Marshal.
-func (item HandlerItem) MarshalJSON() ([]byte, error) {
+func (h *HandlerItem) MarshalJSON() ([]byte, error) {
-	switch item.Type {
+	switch h.Type {
 	case HandlerTypeHook:
 		return json.Marshal(
 			fmt.Sprintf(
 				`%s %s:%s (%s)`,
-				item.Router.Uri,
+				h.Router.Uri,
-				item.Router.Domain,
+				h.Router.Domain,
-				item.Router.Method,
+				h.Router.Method,
-				item.HookName,
+				h.HookName,
 			),
 		)
 	case HandlerTypeMiddleware:
 		return json.Marshal(
 			fmt.Sprintf(
 				`%s %s:%s (MIDDLEWARE)`,
-				item.Router.Uri,
+				h.Router.Uri,
-				item.Router.Domain,
+				h.Router.Domain,
-				item.Router.Method,
+				h.Router.Method,
 			),
 		)
 	default:
 		return json.Marshal(
 			fmt.Sprintf(
 				`%s %s:%s`,
-				item.Router.Uri,
+				h.Router.Uri,
-				item.Router.Domain,
+				h.Router.Domain,
-				item.Router.Method,
+				h.Router.Method,
 			),
 		)
 	}
@@ -289,3 +290,34 @@ func (item HandlerItem) MarshalJSON() ([]byte, error) {
 func (h *HandlerItemParsed) MarshalJSON() ([]byte, error) {
 	return json.Marshal(h.Handler)
 }
+
+// GetMetaTag retrieves and returns the metadata value associated with the given key from the request struct.
+// The meta value is from struct tags from g.Meta/gmeta.Meta type.
+func (h *HandlerItem) GetMetaTag(key string) string {
+	if h == nil {
+		return ""
+	}
+	metaValue := gmeta.Get(h.Info.Type.In(1), key)
+	if metaValue != nil {
+		return metaValue.String()
+	}
+	return ""
+}
+
+// GetMetaTag retrieves and returns the metadata value associated with the given key from the request struct.
+// The meta value is from struct tags from g.Meta/gmeta.Meta type.
+// For example:
+//
+//	type GetMetaTagReq struct {
+//	    g.Meta `path:"/test" method:"post" summary:"meta_tag" tags:"meta"`
+//	    // ...
+//	}
+//
+// r.GetServeHandler().GetMetaTag("summary") // returns "meta_tag"
+// r.GetServeHandler().GetMetaTag("method")  // returns "post"
+func (h *HandlerItemParsed) GetMetaTag(key string) string {
+	if h == nil || h.Handler == nil {
+		return ""
+	}
+	return h.Handler.GetMetaTag(key)
+}

net/ghttp/ghttp_z_unit_feature_router_standard_test.go

@@ -21,7 +21,7 @@ import (
 	"github.com/gogf/gf/v2/util/guid"
 )
 
-func Test_Router_Handler_Strict_WithObject(t *testing.T) {
+func Test_Router_Handler_Standard_WithObject(t *testing.T) {
 	type TestReq struct {
 		Age  int
 		Name string
@@ -137,7 +137,7 @@ func (ControllerForHandlerWithObjectAndMeta2) Test4(ctx context.Context, req *Te
 	}, nil
 }
 
-func Test_Router_Handler_Strict_WithObjectAndMeta(t *testing.T) {
+func Test_Router_Handler_Standard_WithObjectAndMeta(t *testing.T) {
 	s := g.Server(guid.S())
 	s.Use(ghttp.MiddlewareHandlerResponse)
 	s.Group("/", func(group *ghttp.RouterGroup) {
@@ -159,7 +159,7 @@ func Test_Router_Handler_Strict_WithObjectAndMeta(t *testing.T) {
 	})
 }
 
-func Test_Router_Handler_Strict_Group_Bind(t *testing.T) {
+func Test_Router_Handler_Standard_Group_Bind(t *testing.T) {
 	s := g.Server(guid.S())
 	s.Use(ghttp.MiddlewareHandlerResponse)
 	s.Group("/api/v1", func(group *ghttp.RouterGroup) {
@@ -300,7 +300,7 @@ func Test_Custom_Slice_Type_Attribute(t *testing.T) {
 	})
 }
 
-func Test_Router_Handler_Strict_WithGeneric(t *testing.T) {
+func Test_Router_Handler_Standard_WithGeneric(t *testing.T) {
 	type TestReq struct {
 		Age int
 	}
@@ -397,7 +397,7 @@ func (c *ParameterCaseSensitiveController) Path(
 	return &ParameterCaseSensitiveControllerPathRes{Path: req.Path}, nil
 }
 
-func Test_Router_Handler_Strict_ParameterCaseSensitive(t *testing.T) {
+func Test_Router_Handler_Standard_ParameterCaseSensitive(t *testing.T) {
 	s := g.Server(guid.S())
 	s.Use(ghttp.MiddlewareHandlerResponse)
 	s.Group("/", func(group *ghttp.RouterGroup) {
@@ -534,3 +534,40 @@ func Test_NullString_Issue3465(t *testing.T) {
 
 	})
 }
+
+type testHandlerItemGetMetaTagReq struct {
+	g.Meta `path:"/test" method:"get" sm:"hello" tags:"示例"`
+}
+type testHandlerItemGetMetaTagRes struct{}
+
+type testHandlerItemGetMetaTag struct {
+}
+
+func (t *testHandlerItemGetMetaTag) Test(ctx context.Context, req *testHandlerItemGetMetaTagReq) (res *testHandlerItemGetMetaTagRes, err error) {
+	return nil, nil
+}
+
+func TestHandlerItem_GetMetaTag(t *testing.T) {
+	s := g.Server(guid.S())
+	s.Use(ghttp.MiddlewareHandlerResponse)
+	s.Group("/", func(group *ghttp.RouterGroup) {
+		group.Bind(new(testHandlerItemGetMetaTag))
+	})
+	s.SetDumpRouterMap(false)
+	s.Start()
+	defer s.Shutdown()
+
+	time.Sleep(100 * time.Millisecond)
+	gtest.C(t, func(t *gtest.T) {
+		routes := s.GetRoutes()
+		for _, route := range routes {
+			if !route.IsServiceHandler {
+				continue
+			}
+			t.Assert(route.Handler.GetMetaTag("path"), "/test")
+			t.Assert(route.Handler.GetMetaTag("method"), "get")
+			t.Assert(route.Handler.GetMetaTag("sm"), "hello")
+			t.Assert(route.Handler.GetMetaTag("tags"), "示例")
+		}
+	})
+}