update code and docs

Author: zhufuyi

1_web-gin-CRUD/.golangci.yml

@@ -12,7 +12,6 @@ run:
   # default value is empty list, but default dirs are skipped independently
   # from this option's value (see skip-dirs-use-default).
   skip-dirs:
-    - pkg
     - docs
     - api
   # which files to skip: they will be analyzed, but issues from them
@@ -39,7 +38,7 @@ linters:
   # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
   disable-all: true
   enable:
-    - golint
+    - revive
     - goimports
     - gofmt
     - unused
@@ -66,6 +65,59 @@ linters:
 
 
 linters-settings:
+  revive:
+    rules:
+      - name: argument-limit
+        arguments: [ 8 ]
+      - name: atomic
+      - name: bare-return
+      - name: blank-imports
+      - name: bool-literal-in-expr
+      - name: call-to-gc
+      - name: confusing-naming
+      - name: confusing-results
+      - name: constant-logical-expr
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: deep-exit
+      - name: defer
+      - name: dot-imports
+      - name: duplicated-imports
+      - name: early-return
+      - name: empty-block
+      #- name: empty-lines
+      - name: error-naming
+      - name: error-return
+      - name: error-strings
+      - name: errorf
+      - name: function-result-limit
+        arguments: [ 3 ]
+      - name: identical-branches
+      - name: if-return
+      - name: import-shadowing
+      - name: increment-decrement
+      - name: indent-error-flow
+      - name: modifies-parameter
+      - name: modifies-value-receiver
+      - name: package-comments
+      - name: range
+      - name: range-val-address
+      - name: range-val-in-closure
+      - name: receiver-naming
+      - name: redefines-builtin-id
+      - name: string-of-int
+      - name: struct-tag
+      - name: superfluous-else
+      - name: time-naming
+      - name: unconditional-recursion
+      - name: unexported-naming
+      - name: unnecessary-stmt
+      - name: unreachable-code
+      - name: unused-parameter
+      - name: var-declaration
+      - name: var-naming
+      - name: waitgroup-by-value
+
   dogsled:
     # checks assignments with too many blank identifiers; default is 2
     max-blank-identifiers: 2
@@ -126,10 +178,6 @@ linters-settings:
     # it's a comma-separated list of prefixes
     local-prefixes: user
 
-  golint:
-    # minimal confidence for issues, default is 0.8
-    min-confidence: 0.8
-
   gomnd:
     settings:
       mnd:

1_web-gin-CRUD/Makefile

@@ -3,24 +3,7 @@ SHELL := /bin/bash
 PROJECT_NAME := "user"
 PKG := "$(PROJECT_NAME)"
 PKG_LIST := $(shell go list ${PKG}/... | grep -v /vendor/ | grep -v /api/)
-#GO_FILES := $(shell find . -name '*.go' | grep -v /vendor/ | grep -v _test.go)
-
-
-.PHONY: install
-# installation of dependent tools
-install:
-	go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
-	go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
-	go install github.com/envoyproxy/protoc-gen-validate@latest
-	go install github.com/srikrsna/protoc-gen-gotag@latest
-	go install user/cmd/protoc-gen-go-gin@latest
-	go install user/cmd/protoc-gen-go-rpc-tmpl@latest
-	go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
-	go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
-	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
-	go install github.com/swaggo/swag/cmd/swag@latest
-	go install github.com/ofabry/go-callvis@latest
-	go install golang.org/x/pkgsite/cmd/pkgsite@latest
+
 
 
 .PHONY: mod
@@ -60,12 +43,6 @@ cover:
 	go tool cover -html=cover.out
 
 
-.PHONY: docs
-# generate swagger docs, the host address can be changed via parameters, e.g. make docs HOST=192.168.3.37
-docs: mod fmt
-	@bash scripts/swag-docs.sh $(HOST)
-
-
 .PHONY: graph
 # generate interactive visual function dependency graphs
 graph:
@@ -75,10 +52,16 @@ graph:
 	@rm -f main.go user.gv
 
 
+.PHONY: docs
+# generate swagger docs, only for ⓵ Web services created based on sql, the host address can be changed via parameters, e.g. make docs HOST=192.168.3.37
+docs: mod fmt
+	@bash scripts/swag-docs.sh $(HOST)
+
+
 .PHONY: proto
-# generate *.pb.go codes from *.proto files
+# generate *.go and template code by proto files, if you do not refer to the proto file, the default is all the proto files in the api directory. you can specify the proto file, multiple files are separated by commas, e.g. make proto FILES=api/user/v1/user.proto. only for ⓶ Microservices created based on sql, ⓷ Web services created based on protobuf, ⓸ Microservices created based on protobuf, ⓹ GRPC gateway service created based on protobuf
 proto: mod fmt
-	@bash scripts/protoc.sh
+	@bash scripts/protoc.sh $(FILES)
 
 
 .PHONY: proto-doc
@@ -91,9 +74,7 @@ proto-doc:
 # build user for linux amd64 binary
 build:
 	@echo "building 'user', linux binary file will output to 'cmd/user'"
-	@cd cmd/user && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GOPROXY=https://goproxy.cn,direct go build
-
-
+	@cd cmd/user && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build
 
 
 
@@ -109,12 +90,30 @@ run-nohup:
 	@bash scripts/run-nohup.sh $(CMD)
 
 
-.PHONY: docker-image
+.PHONY: binary-package
+# packaged binary files
+binary-package: build
+	@bash scripts/binary-package.sh
+
+
+.PHONY: deploy-binary
+# deploy binary to remote linux server, e.g. make deploy-binary USER=root PWD=123456 IP=192.168.1.10
+deploy-binary: binary-package
+	@expect scripts/deploy-binary.sh $(USER) $(PWD) $(IP)
+
+
+.PHONY: image-build-local
 # build image for local docker, tag=latest, use binary files to build
-docker-image: build
+image-build-local: build
 	@bash scripts/image-build-local.sh
 
 
+.PHONY: deploy-docker
+# deploy service to local docker, if you want to update the service, run the make deploy-docker command again.
+deploy-docker: image-build-local
+	@bash scripts/deploy-docker.sh
+
+
 .PHONY: image-build
 # build image for remote repositories, use binary files to build, e.g. make image-build REPO_HOST=addr TAG=latest
 image-build:
@@ -127,12 +126,6 @@ image-build2:
 	@bash scripts/image-build2.sh $(REPO_HOST) $(TAG)
 
 
-.PHONY: image-build-rpc-test
-# build rpc test image for remote repositories, e.g. make image-build-rpc-test REPO_HOST=addr TAG=latest
-image-build-rpc-test:
-	@bash scripts/image-rpc-test.sh $(REPO_HOST) $(TAG)
-
-
 .PHONY: image-push
 # push docker image to remote repositories, e.g. make image-push REPO_HOST=addr TAG=latest
 image-push:
@@ -145,22 +138,28 @@ deploy-k8s:
 	@bash scripts/deploy-k8s.sh
 
 
-.PHONY: deploy-docker
-# deploy service to local docker, you must first run 'make docker-image' to generate a docker image, if you want to stop the server, pass the parameter stop, e.g. make deploy-docker CMD=stop
-deploy-docker:
-	@bash scripts/deploy-docker.sh $(CMD)
+.PHONY: image-build-rpc-test
+# build grpc test image for remote repositories, e.g. make image-build-rpc-test REPO_HOST=addr TAG=latest
+image-build-rpc-test:
+	@bash scripts/image-rpc-test.sh $(REPO_HOST) $(TAG)
 
 
-.PHONY: binary-package
-# packaged binary files
-binary-package: build
-	@bash scripts/binary-package.sh
+.PHONY: patch
+# patch some dependent code, such as types.proto, mysql initialization code. e.g. make patch TYPE=types-pb , make patch TYPE=mysql-init
+patch:
+	@bash scripts/patch.sh $(TYPE)
 
 
-.PHONY: deploy-binary
-# deploy binary, e.g. make deploy-binary USER=root PWD=123456 IP=192.168.1.10
-deploy-binary: binary-package
-	@expect scripts/deploy-binary.sh $(USER) $(PWD) $(IP)
+.PHONY: copy-proto
+# copy proto file from the grpc server directory, multiple directories separated by commas. e.g. make copy-proto SERVER=yourServerDir
+copy-proto:
+	@sponge patch copy-proto --server-dir=$(SERVER)
+
+
+.PHONY: update-config
+# update internal/config code base on yaml file
+update-config:
+	@sponge config --server-dir=.
 
 
 .PHONY: clean
@@ -169,10 +168,10 @@ clean:
 	@rm -vrf cmd/user/user
 	@rm -vrf cover.out
 	@rm -vrf main.go user.gv
-	@rm -vrf internal/ecode/*go.gen.*
-	@rm -vrf internal/routers/*go.gen.*
-	@rm -vrf internal/handler/*go.gen.*
-	@rm -vrf internal/service/*go.gen.*
+	@rm -vrf internal/ecode/*.go.gen*
+	@rm -vrf internal/routers/*.go.gen*
+	@rm -vrf internal/handler/*.go.gen*
+	@rm -vrf internal/service/*.go.gen*
 	@rm -rf user-binary.tar.gz
 	@echo "clean finished"
 
@@ -184,7 +183,7 @@ help:
 	@echo ' make [target]'
 	@echo ''
 	@echo 'Targets:'
-	@awk '/^[a-zA-Z\-\_0-9]+:/ { \
+	@awk '/^[a-zA-Z\-_0-9]+:/ { \
 	helpMessage = match(lastLine, /^# (.*)/); \
 		if (helpMessage) { \
 			helpCommand = substr($$1, 0, index($$1, ":")-1); \

1_web-gin-CRUD/README.md

@@ -2,9 +2,14 @@
 
 <br>
 
+
+**Import [sql](https://github.com/zhufuyi/sponge_examples/blob/main/1_web-gin-CRUD/test/sql/user.sql) into mysql before you start.**
+
+<br>
+
 ### Quickly create a web project
 
-Enter the Sponge UI interface, click on the left menu bar 【sql】--> 【Web type】-->【Create web project】, fill in some parameters to generate the complete project code for the web service.
+Enter the Sponge UI interface, click on the left menu bar 【SQL】→【Create web project】, fill in some parameters to generate the complete project code for the web service.
 
 The web service code is mainly composed of commonly used libraries such as [gin](https://github.com/gin-gonic/gin), [gorm](https://github.com/go-gorm/gorm), [go-redis](https://github.com/go-redis/redis), and also includes swagger documentation, test code, common service governance function code, build deployment scripts, etc.
 
@@ -28,7 +33,7 @@ Open [http://localhost:8080/swagger/index.html](http://localhost:8080/swagger/in
 
 ### Batch add CRUD code embedded in web service
 
-Enter the Sponge UI interface, click on the left menu bar 【sql】--> 【Web type】-->【Generate handler CRUD code】, select any number of tables to generate code, then move the generated CRUD code to the web service directory to complete batch addition of CURD interfaces in the web service without changing any code.
+Enter the Sponge UI interface, click on the left menu bar 【Public】→【Generate handler CRUD code】, select any number of tables to generate code, then move the generated CRUD code to the web service directory to complete batch addition of CURD interfaces in the web service without changing any code.
 
 ![web-http-handler](https://raw.githubusercontent.com/zhufuyi/sponge_examples/main/assets/en_web-http-handler.png)
 
@@ -43,3 +48,9 @@ make run
 ```
 
 Open [http://localhost:8080/swagger/index.html](http://localhost:8080/swagger/index.html) in your browser to see the newly added CRUD interfaces.
+
+<br>
+
+More detailed development documentation https://go-sponge.com/web-development-mysql
+
+<br>

1_web-gin-CRUD/build/README.md

@@ -1,3 +1,6 @@
+// Package initial is the package that starts the service to initialize the service, including
+// the initialization configuration, service configuration, connecting to the database, and
+// resource release needed when shutting down the service.
 package initial
 
 import (
@@ -29,11 +32,14 @@ func Config() {
 	cfg := config.Get()
 
 	// initializing log
-	_, _ = logger.Init(
+	_, err := logger.Init(
 		logger.WithLevel(cfg.Logger.Level),
 		logger.WithFormat(cfg.Logger.Format),
 		logger.WithSave(cfg.Logger.IsSave),
 	)
+	if err != nil {
+		panic(err)
+	}
 
 	// initializing database
 	model.InitMysql()