router group

Author: zhufuyi

Makefile

@@ -176,6 +176,7 @@ clean:
 @rm -vrf cover.out
 @rm -vrf main.go serverNameExample_mixExample.gv
 @rm -vrf internal/ecode/*go.gen.*
+@rm -vrf internal/routers/*go.gen.*
 @rm -vrf internal/handller/*go.gen.*
 @rm -vrf internal/service/*go.gen.*
 @rm -rf serverNameExample-binary.tar.gz

api/serverNameExample/v1/userExample_router.pb.go

@@ -70,7 +70,7 @@ make run
 
 <br>
 
-💡 如果不想使用ui界面，可以使用sponge命令行生成代码，命令行帮组信息里面有丰富的示例，有一些生成代码命令比使用UI界面更便捷。
+💡 如果不想使用ui界面，可以使用sponge命令行生成代码，命令行帮助信息里面有丰富的示例，有一些生成代码命令比使用UI界面更便捷。
 
 <br>
 

assets/readme-cn.md

@@ -90,17 +90,17 @@ import (
 )
 
 func init() {
-rootRouterFns = append(rootRouterFns, func(r *gin.Engine) {
+apiV1RouterFns = append(apiV1RouterFns, func(prePath string, group *gin.RouterGroup) {
 {{- range .PbServices}}
-{{.LowerName}}Router(r, handler.New{{.Name}}Handler())
+{{.LowerName}}Router(prePath, group, handler.New{{.Name}}Handler())
 {{- end}}
 })
 }
 
 {{- range .PbServices}}
 
-func {{.LowerName}}Router(r *gin.Engine, iService serverNameExampleV1.{{.Name}}Logicer) {
-serverNameExampleV1.Register{{.Name}}Router(r, iService,
+func {{.LowerName}}Router(prePath string, group *gin.RouterGroup, iService serverNameExampleV1.{{.Name}}Logicer) {
+serverNameExampleV1.Register{{.Name}}Router(prePath, group, iService,
 serverNameExampleV1.With{{.Name}}RPCResponse(),
 serverNameExampleV1.With{{.Name}}Logger(logger.Get()),
 )

cmd/protoc-gen-go-gin/internal/generate/handler/template.go

@@ -58,7 +58,7 @@ func With{{$.Name}}Logger(zapLog *zap.Logger) {{$.Name}}Option {
 }
 }
 
-func Register{{$.Name}}Router(iRouter gin.IRouter, iLogic {{$.Name}}Logicer, opts ...{{$.Name}}Option) {
+func Register{{$.Name}}Router(prePath string, iRouter gin.IRouter, iLogic {{$.Name}}Logicer, opts ...{{$.Name}}Option) {
 o := &{{$.LowerName}}Options{}
 o.apply(opts...)
 
@@ -70,6 +70,7 @@ func Register{{$.Name}}Router(iRouter gin.IRouter, iLogic {{$.Name}}Logicer, opt
 }
 
 r := &{{$.LowerName}}Router {
+prePath: prePath,
 iRouter: iRouter,
 iLogic: iLogic,
 iResponse: o.responser,
@@ -79,17 +80,36 @@ func Register{{$.Name}}Router(iRouter gin.IRouter, iLogic {{$.Name}}Logicer, opt
 }
 
 type {{$.LowerName}}Router struct {
+prePath string
 iRouter gin.IRouter
 iLogic {{$.Name}}Logicer
 iResponse errcode.Responser
 zapLog *zap.Logger
 }
 
 func (r *{{$.LowerName}}Router) register() {
-{{range .Methods}}r.iRouter.Handle("{{.Method}}", "{{.Path}}", r.{{ .HandlerName }})
+{{range .Methods}}r.iRouter.Handle("{{.Method}}", r.cutPrePath("{{.Path}}"), r.{{ .HandlerName }})
 {{end}}
 }
 
+func (r *{{$.LowerName}}Router) cutPrePath(path string)string{
+if r.prePath==""||r.prePath=="/"{
+return path
+}
+size:=len(r.prePath)
+if len(path)<=size{
+return path
+}
+if r.prePath==path[:size]{
+cutPath:=path[size:]
+if cutPath[0]!='/'{
+cutPath="/"+cutPath
+}
+return cutPath
+}
+return path
+}
+
 {{range .Methods}}
 func (r *{{$.LowerName}}Router) {{ .HandlerName }} (c *gin.Context) {
 req := &{{.Request}}{}

cmd/protoc-gen-go-gin/internal/generate/router/template.go

@@ -83,17 +83,17 @@ import (
 )
 
 func init() {
-rootRouterFns = append(rootRouterFns, func(r *gin.Engine) {
+apiV1RouterFns = append(apiV1RouterFns, func(prePath string, group *gin.RouterGroup) {
 {{- range .PbServices}}
-{{.LowerName}}Router(r, service.New{{.Name}}Client())
+{{.LowerName}}Router(prePath, group, service.New{{.Name}}Client())
 {{- end}}
 })
 }
 
 {{- range .PbServices}}
 
-func {{.LowerName}}Router(r *gin.Engine, iService serverNameExampleV1.{{.Name}}Logicer) {
-serverNameExampleV1.Register{{.Name}}Router(r, iService,
+func {{.LowerName}}Router(prePath string, group *gin.RouterGroup, iService serverNameExampleV1.{{.Name}}Logicer) {
+serverNameExampleV1.Register{{.Name}}Router(prePath, group, iService,
 serverNameExampleV1.With{{.Name}}RPCResponse(),
 serverNameExampleV1.With{{.Name}}Logger(logger.Get()),
 )

cmd/protoc-gen-go-gin/internal/generate/service/template.go

@@ -134,7 +134,7 @@ func saveHandlerAndRouterFiles(f *protogen.File, moduleName string, serverName s
 }
 
 filePath = filenamePrefix + "_handler.pb.go"
-err = saveFile(moduleName, serverName, routerOut, filePath, routerContent, true, handlerPlugin)
+err = saveFile(moduleName, serverName, routerOut, filePath, routerContent, false, handlerPlugin)
 if err != nil {
 return err
 }
@@ -160,7 +160,7 @@ func saveServiceAndRouterFiles(gen *protogen.Plugin, f *protogen.File, moduleNam
 }
 
 filePath = filenamePrefix + "_service.pb.go"
-err = saveFile(moduleName, serverName, routerOut, filePath, routerContent, true, servicePlugin)
+err = saveFile(moduleName, serverName, routerOut, filePath, routerContent, false, servicePlugin)
 if err != nil {
 return err
 }

cmd/protoc-gen-go-gin/main.go

@@ -20,8 +20,10 @@ import (
 )
 
 var (
-apiV1RouterFns []func(*gin.RouterGroup) // router functions
+apiV1RouterFns []func(*gin.RouterGroup) // group router functions
 // if you have other group routes you can define them here
+// example:
+// myPrePathRouterFns []func(prePath string, engine *gin.RouterGroup)
 )
 
 // NewRouter create a new router
@@ -80,9 +82,11 @@ func NewRouter() *gin.Engine {
 // access path /swagger/index.html
 r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
 
-// register routers
+// register routers, middleware support
 registerRouters(r, "/api/v1", apiV1RouterFns)
 // if you have other group routes you can add them here
+// example:
+// registerRouters(r, "/myGroupPath", myGroupPathRouterFns, middleware.Auth())
 
 return r
 }

internal/routers/routers.go

@@ -18,8 +18,12 @@ import (
 "github.com/gin-gonic/gin/binding"
 )
 
+// nolint
 var (
-rootRouterFns []func(engine *gin.Engine) // root routing group, used by rpc gateway
+apiV1RouterFns_pbExample []func(prePath string, engine *gin.RouterGroup) // group router functions
+// if you have other group routes you can define them here
+// example:
+// myPrePathRouterFns []func(prePath string, engine *gin.RouterGroup)
 )
 
 // NewRouter_pbExample create a new router
@@ -76,10 +80,20 @@ func NewRouter_pbExample() *gin.Engine { //nolint
 // access path /apis/swagger/index.html
 swagger.CustomRouter(r, "apis", docs.ApiDocs)
 
-// registration/Prefix Routing Groups
-for _, fn := range rootRouterFns {
-fn(r)
-}
+// register routers, middleware support
+registerRouters_pbExample(r, "/api/v1", apiV1RouterFns_pbExample)
+// if you have other group routes you can add them here
+// example:
+// registerRouters(r, "/myPrePath", myPrePathRouterFns, middleware.Auth())
 
 return r
 }
+
+// nolint
+func registerRouters_pbExample(r *gin.Engine, prePath string,
+routerFns []func(prePath string, engine *gin.RouterGroup), handlers ...gin.HandlerFunc) {
+rg := r.Group(prePath, handlers...)
+for _, fn := range routerFns {
+fn(prePath, rg)
+}
+}

internal/routers/routers_pbExample.go

@@ -38,7 +38,8 @@ func TestNewRouter_pbExample(t *testing.T) {
 func Test_userExampleServiceRouter(t *testing.T) {
 gin.SetMode(gin.ReleaseMode)
 r := gin.Default()
-userExampleServiceRouter(r, &mockGw{})
+rg := r.Group("")
+userExampleServiceRouter("", rg, &mockGw{})
 }
 
 type mockGw struct{}