adjust code

Author: zhufuyi

api/serverNameExample/v1/userExample.proto

@@ -125,19 +125,26 @@ 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) 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.
-// (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\""];
-// (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\""].
+/*
+Notes for defining message fields:
+    1. Suggest using camel case style naming for message field names, such as firstName, lastName, etc.
+    2. If the message field name ending in 'id', it is recommended to use xxxID naming format, such as userID, orderID, etc.
+    3. Add validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules, such as:
+        uint64 id = 1 [(validate.rules).uint64.gte  = 1];
+
+If used to generate code that supports the HTTP protocol, notes for defining message fields:
+    1. 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\""];
+    2. 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\""].
+    3. If the message field name contain underscores(such as 'field_name'), it will cause a problem
+        where the JSON field names of the Swagger request parameters are different from those of the
+        GRPC JSON tag names. There are two solutions: Solution 1, remove the underline from the
+         message field name. Option 2, use the tool 'protoc-go-inject-tag' to modify the JSON tag name,
+         such as: string first_name = 1 ; // @gotags: json:"firstName"
+*/
 
 
 enum GenderType {

pkg/conf/parse.go

@@ -46,23 +46,14 @@ func Parse(configFile string, obj interface{}, reloads ...func()) error {
 }
 
 // ParseConfigData parse data to struct
-func ParseConfigData(data []byte, format string, obj interface{}, reloads ...func()) error {
+func ParseConfigData(data []byte, format string, obj interface{}) error {
 	viper.SetConfigType(format)
 	err := viper.ReadConfig(bytes.NewBuffer(data))
 	if err != nil {
 		return err
 	}
 
-	err = viper.Unmarshal(obj)
-	if err != nil {
-		return err
-	}
-
-	if len(reloads) > 0 {
-		watchConfig(obj, reloads...)
-	}
-
-	return nil
+	return viper.Unmarshal(obj)
 }
 
 // listening for profile updates

pkg/conf/parse_test.go

@@ -73,26 +73,15 @@ func TestParseErr(t *testing.T) {
 func TestParseConfigData(t *testing.T) {
 	conf := make(map[string]interface{})
 
-	reloads := []func(){
-		func() {
-			fmt.Println("close and reconnect mysql")
-			fmt.Println("close and reconnect redis")
-		},
+	data, err := os.ReadFile("test.yml")
+	if err != nil {
+		t.Error(err)
+		return
 	}
-
-	data, _ := os.ReadFile("test.yml")
-	err := ParseConfigData(data, "yaml", &conf, reloads...)
+	err = ParseConfigData(data, "yaml", &conf)
 	if err != nil {
 		t.Error(err)
 		return
 	}
-
-	time.Sleep(time.Second)
-	content, _ := os.ReadFile("test.yml")
-	contentChange := append(content, byte('#'))
-	time.Sleep(time.Millisecond * 100)
-	_ = os.WriteFile("test.yml", contentChange, 0666) // change file
-	time.Sleep(time.Millisecond * 100)
-	_ = os.WriteFile("test.yml", content, 0666) // recovery documents
-	time.Sleep(time.Millisecond * 100)
+	t.Log(Show(conf))
 }

pkg/errcode/http_error.go

@@ -97,8 +97,13 @@ func (e *Error) WithDetails(details ...string) *Error {
 	return newError
 }
 
+// RewriteMsg rewrite error message
+func (e *Error) RewriteMsg(msg string) *Error {
+	return &Error{code: e.code, msg: msg}
+}
+
 // WithOutMsg out error message
-// Deprecated: in Err or ErrToHTTP parameter msg can be used to replace the original message.
+// Deprecated: use RewriteMsg instead
 func (e *Error) WithOutMsg(msg string) *Error {
 	return &Error{code: e.code, msg: msg}
 }

pkg/errcode/http_error_test.go

@@ -55,6 +55,7 @@ func TestNewError(t *testing.T) {
 	errorsCodes = append(errorsCodes,
 		DataLoss.WithDetails("foo", "bar"),
 		DataLoss.WithOutMsg("foobar"),
+		DataLoss.RewriteMsg("foobar2"),
 		NewError(1010, "unknown"),
 	)
 

pkg/gin/middleware/logging.go

@@ -12,7 +12,7 @@ import (
 
 var (
 	// Print body max length
-	defaultMaxLength = 40
+	defaultMaxLength = 300
 
 	// default zap log
 	defaultLogger, _ = zap.NewProduction()

pkg/sql2code/parser/template.go

@@ -123,8 +123,15 @@ service {{.TName}} {
   rpc ListByLastID(List{{.TableName}}ByLastIDRequest) returns (List{{.TableName}}ByLastIDReply) {}
 }
 
-// Some notes on defining fields under message:
-// Fill in the validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules
+
+/*
+Notes for defining message fields:
+    1. Suggest using camel case style naming for message field names, such as firstName, lastName, etc.
+    2. If the message field name ending in 'id', it is recommended to use xxxID naming format, such as userID, orderID, etc.
+    3. Add validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules, such as:
+        uint64 id = 1 [(validate.rules).uint64.gte  = 1];
+*/
+
 
 // protoMessageCreateCode
 
@@ -227,8 +234,15 @@ service {{.TName}} {
   rpc List(List{{.TableName}}Request) returns (List{{.TableName}}Reply) {}
 }
 
-// Some notes on defining fields under message:
-// Fill in the validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules
+
+/*
+Notes for defining message fields:
+    1. Suggest using camel case style naming for message field names, such as firstName, lastName, etc.
+    2. If the message field name ending in 'id', it is recommended to use xxxID naming format, such as userID, orderID, etc.
+    3. Add validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules, such as:
+        uint64 id = 1 [(validate.rules).uint64.gte  = 1];
+*/
+
 
 // protoMessageCreateCode
 
@@ -472,19 +486,26 @@ service {{.TName}} {
 }
 
 
-// Some notes on defining fields under message:
-// (1) Fill in the validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules
-// (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.
-// (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\""];
-// (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\""].
+/*
+Notes for defining message fields:
+    1. Suggest using camel case style naming for message field names, such as firstName, lastName, etc.
+    2. If the message field name ending in 'id', it is recommended to use xxxID naming format, such as userID, orderID, etc.
+    3. Add validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules, such as:
+        uint64 id = 1 [(validate.rules).uint64.gte  = 1];
+
+If used to generate code that supports the HTTP protocol, notes for defining message fields:
+    1. 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\""];
+    2. 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\""].
+    3. If the message field name contain underscores(such as 'field_name'), it will cause a problem
+        where the JSON field names of the Swagger request parameters are different from those of the
+        GRPC JSON tag names. There are two solutions: Solution 1, remove the underline from the
+         message field name. Option 2, use the tool 'protoc-go-inject-tag' to modify the JSON tag name,
+         such as: string first_name = 1 ; // @gotags: json:"firstName"
+*/
 
 
 // protoMessageCreateCode
@@ -692,19 +713,26 @@ service {{.TName}} {
 }
 
 
-// Some notes on defining fields under message:
-// (1) Fill in the validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules
-// (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.
-// (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\""];
-// (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\""].
+/*
+Notes for defining message fields:
+    1. Suggest using camel case style naming for message field names, such as firstName, lastName, etc.
+    2. If the message field name ending in 'id', it is recommended to use xxxID naming format, such as userID, orderID, etc.
+    3. Add validate rules https://github.com/envoyproxy/protoc-gen-validate#constraint-rules, such as:
+        uint64 id = 1 [(validate.rules).uint64.gte  = 1];
+
+If used to generate code that supports the HTTP protocol, notes for defining message fields:
+    1. 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\""];
+    2. 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\""].
+    3. If the message field name contain underscores(such as 'field_name'), it will cause a problem
+        where the JSON field names of the Swagger request parameters are different from those of the
+        GRPC JSON tag names. There are two solutions: Solution 1, remove the underline from the
+         message field name. Option 2, use the tool 'protoc-go-inject-tag' to modify the JSON tag name,
+         such as: string first_name = 1 ; // @gotags: json:"firstName"
+*/
 
 
 // protoMessageCreateCode