custom response in handler

Author: zhufuyi

api/serverNameExample/v1/userExample.proto

@@ -124,15 +124,18 @@ service userExample {
   }
 }
 
+
 // Some notes on defining fields under message:
 // (1) Fill in the validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules
-// (2) When using the protoc-gen-openapiv2 plugin, if the defined fields are snake case,
-//      you must add annotations for snake case names, such as string foo_bar = 1 [json_name = "foo_bar"],
+// (2) Suggest using camel hump naming for message field names, and for names ending in 'id',
+//      use xxxID naming format, such as userID, orderID, etc.
+// (3) When using the protoc-gen-openapiv2 plugin, if the defined fields are snake case,
+//      you must add annotations for snake case names, such as string fieldName = 1 [json_name = "field_name"],
 //      to ensure that the front end and back end JSON naming is consistent.
-// (3) If the route contains the path parameter, such as /api/v1/userExample/{id}, the defined
+// (4) If the route contains the path parameter, such as /api/v1/userExample/{id}, the defined
 //      message  must contain the name of the path parameter and the name should be
 //      added with a new tag, such as int64 id = 1 [(tagger.tags) = "uri:\"id\""];
-// (4) If the request url is followed by a query parameter, such as /api/v1/getUserExample?name=Tom,
+// (5) If the request url is followed by a query parameter, such as /api/v1/getUserExample?name=Tom,
 //      a form tag must be added when defining the query parameter in the message,
 //      such as string name = 1 [(tagger.tags) = "form:\"name\""].
 

api/serverNameExample/v1/userExample_router.pb.go

@@ -14,6 +14,7 @@ import (
 const (
 	stringsPkg         = protogen.GoImportPath("strings")
 	contextPkg         = protogen.GoImportPath("context")
+	errorsPkg          = protogen.GoImportPath("errors")
 	errcodePkg         = protogen.GoImportPath("github.com/zhufuyi/sponge/pkg/errcode")
 	middlewarePkg      = protogen.GoImportPath("github.com/zhufuyi/sponge/pkg/gin/middleware")
 	zapPkg             = protogen.GoImportPath("go.uber.org/zap")
@@ -35,8 +36,8 @@ func GenerateFile(gen *protogen.Plugin, file *protogen.File) *protogen.Generated
 	g.P("package ", file.GoPackageName)
 	g.P()
 
-	g.P("// import packages: ", stringsPkg.Ident(" "), contextPkg.Ident(" "), errcodePkg.Ident(" "),
-		middlewarePkg.Ident(" "), zapPkg.Ident(" "), ginPkg.Ident(" "))
+	g.P("// import packages: ", stringsPkg.Ident(" "), contextPkg.Ident(" "), errorsPkg.Ident(" "),
+		errcodePkg.Ident(" "), middlewarePkg.Ident(" "), zapPkg.Ident(" "), ginPkg.Ident(" "))
 	g.P()
 
 	for _, s := range file.Services {

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

@@ -197,6 +197,9 @@ func (r *{{$.LowerName}}Router) withMiddleware(method string, path string, fn gi
 
 	out, err := r.iLogic.{{.Name}}(ctx, req)
 	if err != nil {
+		if errors.Is(err, errcode.SkipResponse) {
+			return
+		}
 		r.iResponse.Error(c, err)
 		return
 	}

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

@@ -34,3 +34,5 @@ var (
 	Unimplemented      = errcode.Unimplemented
 	DataLoss           = errcode.DataLoss
 )
+
+var SkipResponse = errcode.SkipResponse

internal/ecode/systemCode_http.go

@@ -37,3 +37,6 @@ var (
 func Any(key string, val interface{}) errcode.Detail {
 	return errcode.Any(key, val)
 }
+
+// StatusSkipResponse is only use for grpc-gateway
+var StatusSkipResponse = errcode.SkipResponse

internal/ecode/systemCode_rpc.go

@@ -1,6 +1,7 @@
 package errcode
 
 import (
+	"errors"
 	"net/http"
 	"strconv"
 	"strings"
@@ -10,6 +11,9 @@ import (
 	"google.golang.org/grpc/status"
 )
 
+// SkipResponse skip response
+var SkipResponse = errors.New("skip response") //nolint
+
 // Responser response interface
 type Responser interface {
 	Success(ctx *gin.Context, data interface{})

pkg/errcode/response.go

@@ -172,6 +172,9 @@ func TestParseCodeAndMsgError(t *testing.T) {
 	}
 	code, msg := parseCodeAndMsg2(st.String())
 	t.Log("strings: ", code, msg)
+
+	st, _ = status.FromError(SkipResponse)
+	t.Log(st.Code(), st.Message())
 }
 
 var mcReg = regexp.MustCompile(`code\s*=\s*(\d+),\s*msg\s*=\s*(.+)`)