GO学习记录 —— 创建一个GO项目

---

前言

代码地址

下载地址：https://github.com/Lee-ZiMu/Golang-Init.git

一、项目介绍

1、使用Gin框架来创建项目
2、使用viper读取配置文件
3、使用gorm连接MySQL、生成结构体
4、使用redigo连接redis
5、包含异常处理、jwt、日志、ws的初始化或使用

二、目录介绍

其中业务代码部分可以拆分为多个业务模块

其中业务代码部分：

公共组件部分

三、创建过程

1.引入Gin框架、创建main

Gin文档地址：https://www.topgoer.com/gin%E6%A1%86%E6%9E%B6/

package mainimport ("github.com/gin-gonic/gin"viperInit "github.com/spf13/viper""hy_heymate/api/route""hy_heymate/common/cron""hy_heymate/common/logger""hy_heymate/config/viper""hy_heymate/database"
)func main() {r := gin.Default()// 读取配置文件viper.Init("../config/config.yaml")// 初始化日志logger.Init()// 连接mysql数据库database.ConnectToMySQL()// 连接redisdatabase.ConnectToRedis()// 加载路由route.LoadRouters(r)// 定时cron.Cron()r.Run(":" + viperInit.GetString("server.port"))}

2.加载配置文件

package viperimport ("fmt""github.com/fsnotify/fsnotify""github.com/spf13/viper"
)func Init(configPath string) {//制定配置文件的路径viper.SetConfigFile(configPath)// 读取配置信息err := viper.ReadInConfig()if err != nil {// 读取配置信息失败panic(fmt.Errorf("配置文件读取失败，错误信息:%v", err))}//监听修改viper.WatchConfig()//为配置修改增加一个回调函数viper.OnConfigChange(func(in fsnotify.Event) {fmt.Println("配置文件修改了...")})
}

3.连接MySQL、redis

连接mysql

package databaseimport ("fmt"viperInit "github.com/spf13/viper""gorm.io/driver/mysql""gorm.io/gorm""gorm.io/gorm/logger""gorm.io/gorm/schema""hy_heymate/common/file""hy_heymate/gen/query""log""os""time"
)var db = new(gorm.DB)func ConnectToMySQL() {// 创建日志文件夹if err := file.MkdirAll(viperInit.GetString("mysql.logpath")); err != nil {panic(err)}logFile, err := os.Create(viperInit.GetString("mysql.logpath") + "db.log")if err != nil {panic(err)}sqlStr := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?%s",viperInit.GetString("mysql.username"),viperInit.GetString("mysql.password"),viperInit.GetString("mysql.host"),viperInit.GetInt("mysql.port"),viperInit.GetString("mysql.dbname"),viperInit.GetString("mysql.conf"),)db, err = gorm.Open(mysql.Open(sqlStr), &gorm.Config{Logger: logger.New(log.New(logFile, "\n", log.LstdFlags),logger.Config{SlowThreshold: time.Second,Colorful:      true,LogLevel:      logger.Info,}),NamingStrategy: schema.NamingStrategy{SingularTable: true},})if err != nil {panic(fmt.Errorf("mysql连接失败，错误信息：%s", err))}sqlDB, _ := db.DB()sqlDB.SetMaxIdleConns(viperInit.GetInt("mysql.maxIdleConns"))                                      // 最大连接数sqlDB.SetMaxOpenConns(viperInit.GetInt("mysql.maxOpenConns"))                                      // 最大打开连接数sqlDB.SetConnMaxLifetime(time.Duration(viperInit.GetInt64("mysql.vonnMaxLifetime")) * time.Second) // 设置可以重用连接的最大时间量query.SetDefault(db)}func Get() *gorm.DB {return db
}

连接redis

package databaseimport ("fmt""github.com/gomodule/redigo/redis"viperInit "github.com/spf13/viper""time"
)var (RedisClient *redis.Pool
)func ConnectToRedis() {host := viperInit.GetString("redis.host")port := viperInit.GetString("redis.port")//username := viperInit.GetString("redis.username")//password := viperInit.GetString("redis.password")MaxIdle := viperInit.GetInt("redis.MaxIdle")MaxActive := viperInit.GetInt("redis.MaxActive")IdleTimeout := viperInit.GetInt("redis.IdleTimeout")pool := &redis.Pool{MaxIdle:     MaxIdle,                                  // 最大空闲连接数MaxActive:   MaxActive,                                // 最大活跃连接数IdleTimeout: time.Duration(IdleTimeout) * time.Second, // 空闲连接超时时间Dial: func() (redis.Conn, error) {c, err := redis.Dial("tcp", host+":"+port)if err != nil {panic(fmt.Errorf("redis连接失败，错误信息：%s", err))}return c, err},}RedisClient = pool
}

4.创建结构体

package mainimport ("fmt"viperInit "github.com/spf13/viper""gorm.io/driver/mysql""gorm.io/gen""gorm.io/gorm""hy_heymate/config/viper"
)func main() {// 读取配置文件viper.Init("../config/config.yaml")// 连接mysql数据库sqlStr := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?%s",viperInit.GetString("mysql.username"),viperInit.GetString("mysql.password"),viperInit.GetString("mysql.host"),viperInit.GetInt("mysql.port"),viperInit.GetString("mysql.dbname"),viperInit.GetString("mysql.conf"),)var err errordb, err := gorm.Open(mysql.Open(sqlStr), &gorm.Config{})if err != nil {panic(fmt.Errorf("mysql连接失败，错误信息：%s", err))}// 生成实例g := gen.NewGenerator(gen.Config{// 相对执行`go run`时的路径, 会自动创建目录OutPath: "./query",// WithDefaultQuery 生成默认查询结构体(作为全局变量使用), 即`Q`结构体和其字段(各表模型)// WithoutContext 生成没有context调用限制的代码供查询// WithQueryInterface 生成interface形式的查询代码(可导出), 如`Where()`方法返回的就是一个可导出的接口类型Mode: gen.WithDefaultQuery | gen.WithQueryInterface,// 表字段可为 null 值时, 对应结体字段使用指针类型FieldNullable: true, // generate pointer when field is nullable// 表字段默认值与模型结构体字段零值不一致的字段, 在插入数据时需要赋值该字段值为零值的, 结构体字段须是指针类型才能成功, 即`FieldCoverable:true`配置下生成的结构体字段.// 因为在插入时遇到字段为零值的会被GORM赋予默认值. 如字段`age`表默认值为10, 即使你显式设置为0最后也会被GORM设为10提交.// 如果该字段没有上面提到的插入时赋零值的特殊需要, 则字段为非指针类型使用起来会比较方便.FieldCoverable: false, // generate pointer when field has default value, to fix problem zero value cannot be assign: https://gorm.io/docs/create.html#Default-Values// 模型结构体字段的数字类型的符号表示是否与表字段的一致, `false`指示都用有符号类型FieldSignable: false, // detect integer field's unsigned type, adjust generated data type// 生成 gorm 标签的字段索引属性FieldWithIndexTag: false, // generate with gorm index tag// 生成 gorm 标签的字段类型属性FieldWithTypeTag: true, // generate with gorm column type tag})// 设置目标 dbg.UseDB(db)// 自定义字段的数据类型// 统一数字类型为int64,兼容protobufdataMap := map[string]func(detailType gorm.ColumnType) (dataType string){"tinyint":   func(detailType gorm.ColumnType) (dataType string) { return "int64" },"smallint":  func(detailType gorm.ColumnType) (dataType string) { return "int64" },"mediumint": func(detailType gorm.ColumnType) (dataType string) { return "int64" },"bigint":    func(detailType gorm.ColumnType) (dataType string) { return "int64" },"int":       func(detailType gorm.ColumnType) (dataType string) { return "int64" },}// 要先于`ApplyBasic`执行g.WithDataTypeMap(dataMap)// 自定义模型结体字段的标签// 将特定字段名的 json 标签加上`string`属性,即 MarshalJSON 时该字段由数字类型转成字符串类型//jsonField := gen.FieldJSONTagWithNS(func(columnName string) (tagContent string) {//	toStringField := `balance, `//	if strings.Contains(toStringField, columnName) {//		return columnName + ",string"//	}//	return columnName//})// 将非默认字段名的字段定义为自动时间戳和软删除字段;// 自动时间戳默认字段名为:`updated_at`、`created_at, 表字段数据类型为: INT 或 DATETIME// 软删除默认字段名为:`deleted_at`, 表字段数据类型为: DATETIME//autoUpdateTimeField := gen.FieldGORMTag("update_time", "column:update_time;type:int unsigned;autoUpdateTime")//autoCreateTimeField := gen.FieldGORMTag("create_time", "column:create_time;type:int unsigned;autoCreateTime")//softDeleteField := gen.FieldType("delete_time", "soft_delete.DeletedAt")// 模型自定义选项组//fieldOpts := []gen.ModelOpt{jsonField, autoCreateTimeField, autoUpdateTimeField, softDeleteField}// 创建模型的结构体,生成文件在 model 目录; 先创建的结果会被后面创建的覆盖// 这里创建个别模型仅仅是为了拿到`*generate.QueryStructMeta`类型对象用于后面的模型关联操作中//User := g.GenerateModel("user")// 创建全部模型文件, 并覆盖前面创建的同名模型allModel := g.GenerateAllTable()// 创建有关联关系的模型文件// 可以用于指定外键//Score := g.GenerateModel("score",//	append(//		fieldOpts,//		// user 一对多 address 关联, 外键`uid`在 address 表中//		gen.FieldRelate(field.HasMany, "user", User, &field.RelateConfig{GORMTag: "foreignKey:UID"}),//	)...,//)// 创建模型的方法,生成文件在 query 目录; 先创建结果不会被后创建的覆盖//g.ApplyBasic(User)g.ApplyBasic(allModel...)g.Execute()}

5.错误处理、返回响应处理

在service层对错误进行处理

在controller返回给ginresult

在ginResult处理
如果错误是我们定义的错误，那么返回给用户，如果不是则返回通用错误 ServeError

package resultimport ("fmt""github.com/gin-gonic/gin""github.com/pkg/errors""go.uber.org/zap""hy_heymate/common/errType""hy_heymate/common/logger""net/http"
)func GinResult(c *gin.Context, data interface{}, err error) {if err == nil {// 成功返回c.JSON(http.StatusOK, Success(data))return}// 打印错误日志到控制台log, _ := zap.NewDevelopment()log.Error(fmt.Sprintf("操作失败，错误信息：%s", err))// 错误返回errcode := errType.ServeErrorerrmsg := errType.GetErrorMsg(errType.ServeError)causeErr := errors.Cause(err) // err类型e, ok := causeErr.(*errType.CodeError)if ok { // 自定义错误类型// 自定义CodeErrorerrcode = e.GetErrCode()errmsg = e.GetErrMsg()}logger.Errorf("http-error: %v", err)c.JSON(http.StatusOK, Error(errcode, errmsg))}

定义的错误如下，可根据业务需求添加