go-zero中正确使用gorm

一、基础的配置

• 1、安装依赖包

  go get -u gorm.io/gen
  go get -u gorm.io/driver/mysql
  

• 2、配置mysql的连接信息

  # mysql的配置
  MysqlConfig:
    driverName: mysql
    host: localhost
    port: 3306
    database: beego
    username: root
    password: "123456"
    charset: utf8mb4
    loc: Asia/Shanghai
  

• 3、修改配置文件internal\config\config.go

  package config
  
  import "github.com/zeromicro/go-zero/rest"
  
  type Config struct {
  	rest.RestConf
  	// 使用redis
  	RedisConfig struct {
  		Host string
  		Port int
  		Pass string
  		Tls  bool
  	}
  
  	// 使用mysql
  	MysqlConfig struct {
  		DriverName string
  		Host       string
  		Port       int
  		Database   string
  		Username   string
  		Password   string
  		Charset    string
  		Loc        string
  	}
  }
  

• 4、定义一个文件internal\database\mysqlDb.go

  package database
  
  import (
  	"fmt"
  	_ "github.com/go-sql-driver/mysql"
  	"gorm.io/driver/mysql"
  	"gorm.io/gorm"
  	"gorm.io/gorm/logger"
  	"gorm.io/gorm/schema"
  	"net/url"
  )
  
  func NewMysqlDB(username, password, host, port, database, charset, loc string) *gorm.DB {
  	// 字符串拼接
  	dataSource := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?charset=%s&parseTime=true&loc=%s",
  		username,
  		password,
  		host,
  		port,
  		database,
  		charset,
  		url.QueryEscape(loc),
  	)
  	db, err := gorm.Open(mysql.Open(dataSource), &gorm.Config{
  		Logger:                                   logger.Default.LogMode(logger.Info),
  		DisableForeignKeyConstraintWhenMigrating: true, // 自动创建表的时候不创建外键
  		SkipDefaultTransaction:                   false,
  		NamingStrategy: schema.NamingStrategy{ // 自动创建表时候表名的配置
  			SingularTable: true,
  			// 全部的表名前面加前缀
  			//TablePrefix: "mall_",
  		},
  	})
  	if err != nil {
  		panic("连接数据库失败")
  	}
  	// 这个要等生成dao再来配置,不配置也可以
  	//dao.SetDefault(db)
      fmt.Println("mysql启动成功...")
  	return db
  }
  
  // TODO 文档地址: https://gorm.io/zh_CN/docs/
  

• 5、在internal\svc\servicecontext.go中使用mysql的配置

  package svc
  
  import (
  	"github.com/go-redis/redis/v8"
  	"github.com/zeromicro/go-zero/rest"
  	"go_zero_demo06/internal/config"
  	"go_zero_demo06/internal/database"
  	"go_zero_demo06/internal/middleware"
  	"gorm.io/gorm"
  	"strconv"
  )
  
  type ServiceContext struct {
  	Config         config.Config
  	AuthMiddleware rest.Middleware
  	RedisDb        *redis.Client
  	MysqlDb        *gorm.DB
  }
  
  func NewServiceContext(c config.Config) *ServiceContext {
  	redisDb := database.NewRedisDB(c.RedisConfig.Host, c.RedisConfig.Pass, c.RedisConfig.Port)
  	mysqlDb := database.NewMysqlDB(c.MysqlConfig.Username, c.MysqlConfig.Password, c.MysqlConfig.Host, strconv.Itoa(c.MysqlConfig.Port), c.MysqlConfig.Database, c.MysqlConfig.Charset, c.MysqlConfig.Loc)
  	return &ServiceContext{
  		Config:         c,
  		AuthMiddleware: middleware.NewAuthMiddleware(redisDb).Handle,
  		RedisDb:        redisDb,
  		MysqlDb:        mysqlDb,
  	}
  }
  

• 6、启动程序查看是否连接mysql

二、数据的增删改查操作

• 1、这里使用gorm-gen来操作,参考官网

• 2、项目根目录下创建一个generator.go

  package main
  
  import (
  	"fmt"
  	"gorm.io/driver/mysql"
  	"gorm.io/gen"
  	"gorm.io/gen/field"
  	"gorm.io/gorm"
  	"strings"
  )
  
  // Case2Camel 下划线转驼峰(大驼峰)
  func Case2Camel(name string) string {
  	name = strings.Replace(name, "_", " ", -1) // 根据_来替换成
  	name = strings.Title(name)                 // 全部大写
  	return strings.Replace(name, " ", "", -1)  // 删除空格
  }
  
  // LowerCamelCase 转换为小驼峰
  func LowerCamelCase(name string) string {
  	name = Case2Camel(name)
  	return strings.ToLower(name[:1]) + name[1:]
  }
  func main() {
  	const dsn = "root:123456@(localhost:3306)/beego?charset=utf8mb4&parseTime=True&loc=Local"
  
  	// 连接数据库
  	db, err := gorm.Open(mysql.Open(dsn))
  	if err != nil {
  		panic(fmt.Errorf("连接数据库失败: %w", err))
  	}
  
  	// 构造生成器实例
  	g := gen.NewGenerator(gen.Config{
  		// 相对执行`go run`时的路径, 会自动创建目录
  		OutPath:      "./dao",   //curd代码的输出路径
  		ModelPkgPath: "./model", //model代码的输出路径
  
  		// WithDefaultQuery 生成默认查询结构体(作为全局变量使用), 即`Q`结构体和其字段(各表模型)
  		// WithoutContext 生成没有context调用限制的代码供查询
  		// WithQueryInterface 生成interface形式的查询代码(可导出), 如`Where()`方法返回的就是一个可导出的接口类型
  		Mode: gen.WithDefaultQuery | gen.WithoutContext | gen.WithQueryInterface,
  
  		// 表字段可为 null 值时, 对应结体字段使用指针类型
  		FieldNullable: false, // 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
  	})
  	// 设置目标 db
  	g.UseDB(db)
  
  	// 自定义字段的数据类型
  	// 统一数字类型为int64,兼容protobuf和thrift
  	dataMap := 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" },
  		"json":      func(detailType gorm.ColumnType) (dataType string) { return "JSON" }, // 自定义时间
  		//"timestamp": func(detailType gorm.ColumnType) (dataType string) { return "LocalTime" }, // 自定义时间
  		"decimal": func(detailType gorm.ColumnType) (dataType string) { return "Decimal" }, // 金额类型全部转换为第三方库,github.com/shopspring/decimal
  	}
  	// 要先于`ApplyBasic`执行
  	g.WithDataTypeMap(dataMap)
  
  	// 给生成的结构体扩展自己要的名字
  	g.WithModelNameStrategy(func(tableName string) (modelName string) {
  		return Case2Camel(strings.ToUpper(tableName[:1]) + tableName[1:] + "Entity")
  	})
  	// 自定义模型结体字段的标签
  	// 将特定字段名的 json 标签加上`string`属性,即 MarshalJSON 时该字段由数字类型转成字符串类型
  	jsonField := gen.FieldJSONTagWithNS(func(columnName string) (tagContent string) {
  		if strings.Contains(`deleted_at`, columnName) {
  			return "-"
  		}
  		return LowerCamelCase(columnName) // 下划线转小驼峰
  	})
  	// 将非默认字段名的字段定义为自动时间戳和软删除字段;
  	// 自动时间戳默认字段名为:`updated_at`、`created_at, 表字段数据类型为: INT 或 DATETIME
  	// 软删除默认字段名为:`deleted_at`, 表字段数据类型为: DATETIME
  	autoUpdateTimeField := gen.FieldGORMTag("updated_at", func(tag field.GormTag) field.GormTag {
  		return map[string][]string{
  			"column":  {"updated_at"},
  			"comment": {"更新时间"},
  		}
  	})
  	autoCreateTimeField := gen.FieldGORMTag("created_at", func(tag field.GormTag) field.GormTag {
  		return map[string][]string{
  			"column":  {"created_at"},
  			"comment": {"创建时间"},
  		}
  	})
  	softDeleteField := gen.FieldType("deleted_at", "gorm.DeletedAt")
  	// 模型自定义选项组
  	fieldOpts := []gen.ModelOpt{jsonField, autoCreateTimeField, autoUpdateTimeField, softDeleteField}
  	//fieldOpts := []gen.ModelOpt{jsonField, softDeleteField}
  
  	// 创建模型的结构体,生成文件在 model 目录; 先创建的结果会被后面创建的覆盖
  	// 这里创建个别模型仅仅是为了拿到`*generate.QueryStructMeta`类型对象用于后面的模型关联操作中
  	//User := g.GenerateModel("user")
  	// 如果传递了表名的时候就单独创建单独的表
  	allModel := g.GenerateAllTable(fieldOpts...)
  	// 创建有关联关系的模型文件
  	// 可以用于指定外键
  	//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()
  }
  

• 3、由mysql来生成数据模型

• 4、修改文件internal\database\mysqlDb.go,纯属为了书写方便

  dao.SetDefault(db)
  

• 5、直接使用查询数据

  // 不开启dao.SetDefault(db)的操作方式如此
  userEntities, err := dao.Use(l.svcCtx.MysqlDb).UserEntity.WithContext(l.ctx).Find()
  fmt.Println(utils.MapToJson(userEntities), "111")
  // 开启dao.SetDefault(db)的时候可以直接这样
  userEntities, err := dao.UserEntity.WithContext(l.ctx).Find()
  fmt.Println(utils.MapToJson(userEntities), "111")