modify grpc+http generation code

Author: zhufuyi

cmd/protoc-gen-go-gin/Makefile

@@ -25,6 +25,16 @@ service:
 	  --plugin=./protoc-gen-go-gin* \
 	  api/v1/*.proto
 
+
+mix:
+	@go build
+	protoc --proto_path=. --proto_path=./third_party \
+	  --go_out=. --go_opt=paths=source_relative \
+	  --go-gin_out=. --go-gin_opt=paths=source_relative --go-gin_opt=plugin=mix \
+	  --go-gin_opt=moduleName=yourModuleName --go-gin_opt=serverName=yourServerName \
+	  --plugin=./protoc-gen-go-gin* \
+	  api/v1/*.proto
+
 router-mr:
 	@go build
 	protoc --proto_path=. --proto_path=./third_party \
@@ -53,6 +63,15 @@ service-mr:
 	  --plugin=./protoc-gen-go-gin* \
 	  api/v1/*.proto
 
+mix-mr:
+	@go build
+	protoc --proto_path=. --proto_path=./third_party \
+	  --go_out=. --go_opt=paths=source_relative \
+	  --go-gin_out=. --go-gin_opt=paths=source_relative --go-gin_opt=plugin=mix \
+	  --go-gin_opt=moduleName=yourModuleName --go-gin_opt=serverName=yourServerName --go-gin_opt=suitedMonoRepo=true \
+	  --plugin=./protoc-gen-go-gin* \
+	  api/v1/*.proto
+
 fmt:
 	gofmt -s -w .
 

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

@@ -10,15 +10,23 @@ import (
 )
 
 // GenerateFiles generate handler logic, router, error code files.
-func GenerateFiles(file *protogen.File) ([]byte, []byte, []byte) {
+func GenerateFiles(file *protogen.File, isMixType bool) ([]byte, []byte, []byte) {
 	if len(file.Services) == 0 {
 		return nil, nil, nil
 	}
 
 	pss := parse.GetServices(file)
-	logicContent := genHandlerLogicFile(pss)
-	routerFileContent := genRouterFile(pss)
-	errCodeFileContent := genErrCodeFile(pss)
+
+	var logicContent, routerFileContent, errCodeFileContent []byte
+
+	if !isMixType {
+		logicContent = genHandlerLogicFile(pss)
+		routerFileContent = genRouterFile(pss)
+		errCodeFileContent = genErrCodeFile(pss)
+	} else {
+		logicContent = genMixLogicFile(pss)
+		routerFileContent = genMixRouterFile(pss)
+	}
 
 	return logicContent, routerFileContent, errCodeFileContent
 }
@@ -38,6 +46,16 @@ func genErrCodeFile(fields []*parse.PbService) []byte {
 	return cf.execute()
 }
 
+func genMixLogicFile(fields []*parse.PbService) []byte {
+	mlf := &mixLogicFields{PbServices: fields}
+	return mlf.execute()
+}
+
+func genMixRouterFile(fields []*parse.PbService) []byte {
+	mrf := &mixRouterFields{PbServices: fields}
+	return mrf.execute()
+}
+
 type handlerLogicFields struct {
 	PbServices []*parse.PbService
 }
@@ -75,6 +93,30 @@ func (f *errCodeFields) execute() []byte {
 	return handleSplitLineMark(data)
 }
 
+type mixLogicFields struct {
+	PbServices []*parse.PbService
+}
+
+func (f *mixLogicFields) execute() []byte {
+	buf := new(bytes.Buffer)
+	if err := mixLogicTmpl.Execute(buf, f); err != nil {
+		panic(err)
+	}
+	return handleSplitLineMark(buf.Bytes())
+}
+
+type mixRouterFields struct {
+	PbServices []*parse.PbService
+}
+
+func (f *mixRouterFields) execute() []byte {
+	buf := new(bytes.Buffer)
+	if err := mixRouterTmpl.Execute(buf, f); err != nil {
+		panic(err)
+	}
+	return handleSplitLineMark(buf.Bytes())
+}
+
 var splitLineMark = []byte(`// ---------- Do not delete or move this split line, this is the merge code marker ----------`)
 
 func handleSplitLineMark(data []byte) []byte {

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

@@ -21,6 +21,15 @@ func init() {
 		panic(err)
 	}
 
+	mixLogicTmpl, err = template.New("mixLogic").Parse(mixLogicTmplRaw)
+	if err != nil {
+		panic(err)
+	}
+	mixRouterTmpl, err = template.New("mixRouter").Parse(mixRouterTmplRaw)
+	if err != nil {
+		panic(err)
+	}
+
 	rand.Seed(time.Now().UnixNano())
 }
 
@@ -138,8 +147,131 @@ func {{.LowerName}}Router(
 		groupPathMiddlewares,
 		singlePathMiddlewares,
 		iService,
+		serverNameExampleV1.With{{.Name}}Logger(logger.Get()),
 		serverNameExampleV1.With{{.Name}}HTTPResponse(),
+		serverNameExampleV1.With{{.Name}}ErrorToHTTPCode(
+			// Set some error codes to standard http return codes,
+			// by default there is already ecode.InternalServerError and ecode.ServiceUnavailable
+			// example:
+			// 	ecode.Forbidden, ecode.LimitExceed,
+		),
+	)
+}
+
+// you can set the middleware of a route group, or set the middleware of a single route, 
+// or you can mix them, pay attention to the duplication of middleware when mixing them, 
+// it is recommended to set the middleware of a single route in preference
+func {{.LowerName}}Middlewares(c *middlewareConfig) {
+	// set up group route middleware, group path is left prefix rules,
+	// if the left prefix is hit, the middleware will take effect, e.g. group route is /api/v1, route /api/v1/{{.LowerName}}/:id  will take effect
+	// c.setGroupPath("/api/v1/{{.LowerName}}", middleware.Auth())
+
+	// set up single route middleware, just uncomment the code and fill in the middlewares, nothing else needs to be changed
+{{- range .Methods}}
+	{{if eq .InvokeType 0}}{{if .Path}}//c.setSinglePath("{{.Method}}", "{{.Path}}", middleware.Auth()){{end}}{{end}}
+{{- end}}
+}
+
+// ---------- Do not delete or move this split line, this is the merge code marker ----------
+
+{{- end}}
+`
+
+	mixLogicTmpl    *template.Template
+	mixLogicTmplRaw = `// Code generated by https://github.com/zhufuyi/sponge
+
+package handler
+
+import (
+	"context"
+
+	serverNameExampleV1 "moduleNameExample/api/serverNameExample/v1"
+	"moduleNameExample/internal/service"
+)
+
+{{- range .PbServices}}
+
+var _ serverNameExampleV1.{{.Name}}Logicer = (*{{.LowerName}}Handler)(nil)
+
+type {{.LowerName}}Handler struct {
+	server serverNameExampleV1.{{.Name}}Server
+}
+
+// New{{.Name}}Handler create a handler
+func New{{.Name}}Handler() serverNameExampleV1.{{.Name}}Logicer {
+	return &{{.LowerName}}Handler{
+		server: service.New{{.Name}}Server(),
+	}
+}
+
+{{- range .Methods}}
+
+{{if eq .InvokeType 0}}{{if .Path}}{{.Comment}}
+func (h *{{.LowerServiceName}}Handler) {{.MethodName}}(ctx context.Context, req *serverNameExampleV1.{{.Request}}) (*serverNameExampleV1.{{.Reply}}, error) {
+	return h.server.{{.MethodName}}(ctx, req)
+}{{end}}{{end}}
+
+{{- end}}
+
+// ---------- Do not delete or move this split line, this is the merge code marker ----------
+
+{{- end}}
+`
+
+	mixRouterTmpl    *template.Template
+	mixRouterTmplRaw = `// Code generated by https://github.com/zhufuyi/sponge
+
+package routers
+
+import (
+	"context"
+
+	"github.com/gin-gonic/gin"
+	"google.golang.org/grpc/metadata"
+
+	"github.com/zhufuyi/sponge/pkg/gin/middleware"
+	"github.com/zhufuyi/sponge/pkg/logger"
+
+	serverNameExampleV1 "moduleNameExample/api/serverNameExample/v1"
+	"moduleNameExample/internal/handler"
+)
+
+func init() {
+	allMiddlewareFns = append(allMiddlewareFns, func(c *middlewareConfig) {
+{{- range .PbServices}}
+		{{.LowerName}}Middlewares(c)
+{{- end}}
+	})
+
+	allRouteFns = append(allRouteFns,
+		func(r *gin.Engine, groupPathMiddlewares map[string][]gin.HandlerFunc, singlePathMiddlewares map[string][]gin.HandlerFunc) {
+{{- range .PbServices}}
+			{{.LowerName}}Router(r, groupPathMiddlewares, singlePathMiddlewares, handler.New{{.Name}}Handler())
+{{- end}}
+		})
+}
+
+{{- range .PbServices}}
+
+func {{.LowerName}}Router(
+	r *gin.Engine,
+	groupPathMiddlewares map[string][]gin.HandlerFunc,
+	singlePathMiddlewares map[string][]gin.HandlerFunc,
+	iService serverNameExampleV1.{{.Name}}Logicer) {
+	ctxFn := func(c *gin.Context) context.Context {
+		md := metadata.New(map[string]string{
+			middleware.ContextRequestIDKey: middleware.GCtxRequestID(c),
+		})
+		return metadata.NewIncomingContext(c.Request.Context(), md)
+	}
+	serverNameExampleV1.Register{{.Name}}Router(
+		r,
+		groupPathMiddlewares,
+		singlePathMiddlewares,
+		iService,
 		serverNameExampleV1.With{{.Name}}Logger(logger.Get()),
+		serverNameExampleV1.With{{.Name}}RPCResponse(),
+		serverNameExampleV1.With{{.Name}}WrapCtx(ctxFn),
 		serverNameExampleV1.With{{.Name}}ErrorToHTTPCode(
 			// Set some error codes to standard http return codes,
 			// by default there is already ecode.InternalServerError and ecode.ServiceUnavailable

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

@@ -147,15 +147,15 @@ func {{.LowerName}}Router(
 		groupPathMiddlewares,
 		singlePathMiddlewares,
 		iService,
-		serverNameExampleV1.With{{.Name}}RPCResponse(),
 		serverNameExampleV1.With{{.Name}}Logger(logger.Get()),
+		serverNameExampleV1.With{{.Name}}RPCResponse(),
+		serverNameExampleV1.With{{.Name}}WrapCtx(ctxFn),
 		serverNameExampleV1.With{{.Name}}RPCStatusToHTTPCode(
 			// Set some error codes to standard http return codes,
 			// by default there is already ecode.StatusInternalServerError and ecode.StatusServiceUnavailable
 			// example:
 			// 	ecode.StatusUnimplemented, ecode.StatusAborted,
 		),
-		serverNameExampleV1.With{{.Name}}WrapCtx(ctxFn),
 	)
 }
 

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

@@ -21,6 +21,7 @@ import (
 const (
 	handlerPlugin = "handler"
 	servicePlugin = "service"
+	mixPlugin     = "mix" // code generated for the http+grpc approach
 
 	helpInfo = `
 # generate *_router.pb.go file
@@ -34,6 +35,10 @@ protoc --proto_path=. --proto_path=./third_party --go-gin_out=. --go-gin_opt=pat
 protoc --proto_path=. --proto_path=./third_party --go-gin_out=. --go-gin_opt=paths=source_relative --go-gin_opt=plugin=service \
   --go-gin_opt=moduleName=yourModuleName --go-gin_opt=serverName=yourServerName *.proto
 
+# generate *_router.pb.go, *.go(tmpl), *_router.go, *_rpc.go files
+protoc --proto_path=. --proto_path=./third_party --go-gin_out=. --go-gin_opt=paths=source_relative --go-gin_opt=plugin=mix \
+  --go-gin_opt=moduleName=yourModuleName --go-gin_opt=serverName=yourServerName *.proto
+
 # if you want the generated code to suited to mono-repo, you need to specify the parameter --go-gin_opt=suitedMonoRepo=true
 
 Tip:
@@ -52,6 +57,7 @@ Usage example:
 `
 )
 
+// nolint
 func main() {
 	var h bool
 	flag.BoolVar(&h, "h", false, "help information")
@@ -65,7 +71,7 @@ func main() {
 
 	var plugin, moduleName, serverName, logicOut, routerOut, ecodeOut string
 	var suitedMonoRepo bool
-	flags.StringVar(&plugin, "plugin", "", "plugin name, supported values: handler or service")
+	flags.StringVar(&plugin, "plugin", "", "plugin name, supported values: handler, service and mix")
 	flags.StringVar(&moduleName, "moduleName", "", "module name for plugin")
 	flags.StringVar(&serverName, "serverName", "", "server name for plugin")
 	flags.StringVar(&logicOut, "logicOut", "", "directory of logical template code generated by the plugin, "+
@@ -79,7 +85,7 @@ func main() {
 	}
 
 	options.Run(func(gen *protogen.Plugin) error {
-		handlerFlag, serviceFlag := false, false
+		handlerFlag, serviceFlag, mixFlag := false, false, false
 		pluginName := strings.ReplaceAll(plugin, " ", "")
 		dirName := "internal"
 		if suitedMonoRepo {
@@ -108,6 +114,15 @@ func main() {
 			if ecodeOut == "" {
 				ecodeOut = dirName + "/ecode"
 			}
+		case mixPlugin:
+			mixFlag = true
+			handlerFlag = true
+			if logicOut == "" {
+				logicOut = dirName + "/handler"
+			}
+			if routerOut == "" {
+				routerOut = dirName + "/routers"
+			}
 		case "":
 		default:
 			return fmt.Errorf("protoc-gen-go-gin: unknown plugin %q, only 'service' and 'handler' are supported", plugin)
@@ -126,14 +141,14 @@ func main() {
 			router.GenerateFile(gen, f)
 
 			if handlerFlag {
-				err := saveHandlerAndRouterFiles(f, moduleName, serverName, logicOut, routerOut, ecodeOut, suitedMonoRepo)
+				err := saveHandlerAndRouterFiles(f, moduleName, serverName, logicOut, routerOut, ecodeOut, suitedMonoRepo, mixFlag)
 				if err != nil {
-					continue // skip error, process the next protobuf file
+					return err
 				}
 			} else if serviceFlag {
 				err := saveServiceAndRouterFiles(f, moduleName, serverName, logicOut, routerOut, ecodeOut, suitedMonoRepo)
 				if err != nil {
-					continue // skip error, process the next protobuf file
+					return err
 				}
 			}
 		}
@@ -142,9 +157,9 @@ func main() {
 }
 
 func saveHandlerAndRouterFiles(f *protogen.File, moduleName string, serverName string,
-	logicOut string, routerOut string, ecodeOut string, suitedMonoRepo bool) error {
+	logicOut string, routerOut string, ecodeOut string, suitedMonoRepo bool, isMixType bool) error {
 	filenamePrefix := f.GeneratedFilenamePrefix
-	handlerLogicContent, routerContent, errCodeFileContent := handler.GenerateFiles(f)
+	handlerLogicContent, routerContent, errCodeFileContent := handler.GenerateFiles(f, isMixType)
 
 	filePath := filenamePrefix + ".go"
 	err := saveFile(moduleName, serverName, logicOut, filePath, handlerLogicContent, false, handlerPlugin, suitedMonoRepo)
@@ -158,10 +173,12 @@ func saveHandlerAndRouterFiles(f *protogen.File, moduleName string, serverName s
 		return err
 	}
 
-	filePath = filenamePrefix + "_http.go"
-	err = saveFileSimple(ecodeOut, filePath, errCodeFileContent, false)
-	if err != nil {
-		return err
+	if !isMixType {
+		filePath = filenamePrefix + "_http.go"
+		err = saveFileSimple(ecodeOut, filePath, errCodeFileContent, false)
+		if err != nil {
+			return err
+		}
 	}
 
 	return nil

cmd/sponge/commands/generate/handler-pb.go

@@ -182,6 +182,7 @@ func (g *handlerPbGenerator) generateCode() (string, error) {
 	default:
 		return "", errors.New("unsupported db driver: " + g.dbDriver)
 	}
+	ignoreFiles = append(ignoreFiles, "handler/userExample.go.service")
 
 	r.SetSubDirsAndFiles(subDirs)
 	r.SetIgnoreSubDirs(ignoreDirs...)
@@ -246,7 +247,7 @@ func (g *handlerPbGenerator) addFields(r replacer.Replacer) []replacer.Field {
 		},
 		{
 			Old: "userExampleNO       = 1",
-			New: fmt.Sprintf("userExampleNO = %d", rand.Intn(100)),
+			New: fmt.Sprintf("userExampleNO = %d", rand.Intn(99)+1),
 		},
 		{
 			Old: g.moduleName + "/pkg",