init

Author: tiancheng92

.gitignore

@@ -0,0 +1,17 @@
+.vscode/
+.idea/
+vendor/
+
+test.go
+
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+*.out
+*.test
+
+.go-version
+
+.DS_Store

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 TianCheng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,46 @@
+# Gin Example With Generic - Gin Example 的泛型实现
+### 代码目录结构
+```text
+├── cmd                             // 程序入口
+├── config                          // 读取配置文件方法
+├── config_file                     // 配置文件
+├── controller                      // 控制器层
+│   └── api                         // 控制器层的api
+│       ├── universal               // 通用api（404、健康检测等接口）
+│       └── v1                      // 具体的api
+├── generic                         // 泛型实现
+│   ├── controller.go               // 控制器层的泛型实现
+│   ├── model.go                    // 重写gorm的Model结构体（为了实现特定方法）
+│   ├── paginate.go                 // 分页器
+│   ├── repository.go               // 数据库操作的泛型实现
+│   ├── request.go                  // 请求体的接口
+│   └── service.go                  // service层的泛型实现
+├── pkg                             // 通用包
+│   ├── ecode                       // 错误码
+│   ├── errors                      // 重写pkg/errors包（结合错误码）
+│   ├── http                        // 对Gin的一些方法的封装
+│   │   ├── bind                    // 数据绑定
+│   │   ├── middleware              // 中间件
+│   │   │   ├── cross_domain        // 跨域
+│   │   │   ├── handle_error        // 统一的错误处理
+│   │   │   └── logging             // 日志（access log）
+│   │   └── render                  // 数据渲染
+│   ├── json                        // json序列化（fast）
+│   ├── log                         // 日志（app log）
+│   ├── mysql                       // mysql连接函数
+│   └── validator                   // 参数校验
+├── router                          // 路由
+├── server                          // 服务
+├── service                         // 服务层
+├── store                           // 数据层
+│   ├── db_engine.go                // 数据库引擎
+│   ├── model                       // 模型
+│   └── repository                  // 数据库操作
+├── tools                           // 第三方工具（ecode生成）
+└── types                           // 类型
+    ├── config                      // 配置文件结构体
+    ├── const.go                    // 常量 
+    ├── paginate                    // 分页结构体
+    ├── request                     // 入参结构体
+    └── result                      // 返回结构体
+```

cmd/cmd.go

@@ -0,0 +1,55 @@
+package main
+
+import (
+	"fmt"
+	"gin_example_with_generic/config"
+	"gin_example_with_generic/pkg/log"
+	"gin_example_with_generic/pkg/validator"
+	"gin_example_with_generic/server"
+	"gin_example_with_generic/store"
+	"github.com/spf13/cobra"
+	_ "go.uber.org/automaxprocs"
+	"math/rand"
+	"os"
+	"time"
+)
+
+//go:generate swag fmt -g ../server/server.go
+
+//go:generate swag init -g ../server/server.go -o ../docs --parseDependency --parseInternal --generatedTime --parseDepth 4
+
+//go:generate codegen -type=int ../pkg/ecode
+
+var (
+	configPath string
+	rootCmd    *cobra.Command
+)
+
+func init() {
+	rootCmd = &cobra.Command{
+		Use:     "gin_example_with_generic",
+		Version: "v1.0.0",
+		Short:   "gin example",
+		Long:    "gin example with generic",
+		Run: func(cmd *cobra.Command, args []string) {
+			config.Init(configPath)
+			// 初始化appLog
+			log.Init(config.GetConf().Log.Level)
+			// 参数校验国际化
+			validator.Init(config.GetConf().I18n.Locale)
+			// 初始化默认数据库
+			store.InitDefaultDB()
+			// 启动Web服务
+			server.Run()
+		},
+	}
+	rootCmd.PersistentFlags().StringVarP(&configPath, "config_path", "f", "./config_file/local.yaml", "config of the Gin Example")
+}
+
+func main() {
+	rand.Seed(time.Now().UTC().UnixNano())
+	if err := rootCmd.Execute(); err != nil {
+		_, _ = fmt.Fprintln(os.Stderr, err)
+		os.Exit(1)
+	}
+}

config/config.go

@@ -0,0 +1,24 @@
+package config
+
+import (
+	"gin_example_with_generic/types/config"
+	"github.com/spf13/viper"
+)
+
+var (
+	configInfo *config.Config
+)
+
+func Init(path string) {
+	viper.SetConfigFile(path)
+	if err := viper.ReadInConfig(); err != nil {
+		panic(err)
+	}
+	if err := viper.Unmarshal(&configInfo); err != nil {
+		panic(err)
+	}
+}
+
+func GetConf() *config.Config {
+	return configInfo
+}

config_file/local.yaml

@@ -0,0 +1,17 @@
+Mysql:
+  DBHost: "127.0.0.1"
+  DBPort: "3306"
+  DBName: "gin_example"
+  DBUser: "root"
+  DBPassword: ""
+
+Server:
+  Mode: "debug"
+  ServicePort: "8080"
+  ServiceHost: "0.0.0.0"
+
+Log:
+  Level: "debug"
+
+I18n:
+  Locale: "zh" # zh en ja

controller/api/universal/error_route.go

@@ -0,0 +1,13 @@
+package universal
+
+import (
+	"gin_example_with_generic/pkg/ecode"
+	"gin_example_with_generic/pkg/errors"
+	"gin_example_with_generic/pkg/http/render"
+	"github.com/gin-gonic/gin"
+)
+
+// NoRoute no route handler
+func NoRoute(ctx *gin.Context) {
+	render.Response(ctx, errors.WithCode(ecode.ErrPageNotFound, "Page not found"))
+}

controller/api/universal/health.go

@@ -0,0 +1,11 @@
+package universal
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+)
+
+func HealthCheck(ctx *gin.Context) {
+	ctx.Status(http.StatusOK)
+}

controller/api/v1/country.go

@@ -0,0 +1,21 @@
+package v1
+
+import (
+	"gin_example_with_generic/generic"
+	"gin_example_with_generic/service"
+	"gin_example_with_generic/store/model"
+	"gin_example_with_generic/types/request"
+	"gorm.io/gorm"
+)
+
+type CountryController struct {
+	generic.Controller[request.Country, model.Country]
+}
+
+func NewCountryController(db *gorm.DB) *CountryController {
+	return &CountryController{
+		generic.Controller[request.Country, model.Country]{
+			service.NewCountryService(db),
+		},
+	}
+}

controller/api/v1/user.go

@@ -0,0 +1,32 @@
+package v1
+
+import (
+	"gin_example_with_generic/generic"
+	"gin_example_with_generic/pkg/http/render"
+	"gin_example_with_generic/service"
+	"gin_example_with_generic/store/model"
+	"gin_example_with_generic/types/request"
+	"github.com/gin-gonic/gin"
+	"gorm.io/gorm"
+)
+
+type UserController struct {
+	generic.Controller[request.User, model.User]
+	UserService service.UserInterface
+}
+
+func NewUserController(db *gorm.DB) *UserController {
+	userService := service.NewUserService(db)
+	return &UserController{
+		generic.Controller[request.User, model.User]{userService},
+		userService,
+	}
+}
+
+func (u *UserController) ListByName(ctx *gin.Context) {
+	res, err := u.UserService.ListByName(ctx, ctx.Param("name"))
+	if err != nil {
+		render.Response(ctx, err)
+	}
+	render.Response(ctx, res)
+}