go-zero对数据库的操作

一、go-zerro中结合gorm来操作mysql数据库

• 1、这里我这就直接结合gorm-gen的方式来实现数据库操作,关于gorm-gen可以参考官网

• 2、创建一个数据库，并且创建一个表

  -- ------------------------
  -- 用户表
  -- ------------------------
  DROP TABLE IF EXISTS `user`;
  CREATE TABLE `user` (`id` int(11) NOT NULL PRIMARY KEY AUTO_INCREMENT  COMMENT '主键id',`username` varchar(50) not null  COMMENT '用户名',`password` varchar(100) not null COMMENT '密码',`status` tinyint(4) DEFAULT '1' COMMENT '状态,0表示禁止,1表示正常',`created_at` timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) COMMENT '创建时间',`updated_at` timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6) COMMENT '更新时间',`deleted_at` timestamp(6) NULL DEFAULT NULL COMMENT '软删除时间'
  ) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin COMMENT = "用户表";
  

• 3、安装gorm需要的依赖包

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

• 4、在根目录下创建一个generator.go文件，由数据库文件生成对应的实体类和dao文件

  package mainimport ("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("cannot establish db connection: %w", err))}// 构造生成器实例g := gen.NewGenerator(gen.Config{// 相对执行`go run`时的路径, 会自动创建目录OutPath:      "./internal/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})// 设置目标 dbg.UseDB(db)// 自定义字段的数据类型// 统一数字类型为int64,兼容protobuf和thriftdataMap := 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`, 表字段数据类型为: DATETIMEautoUpdateTimeField := 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()
  }
  

• 5、执行上面的文件，并且在/internal/model文件夹下创建一个BaseEntity.go自定义数据类型的类

  package modelimport ("bytes""database/sql/driver""errors""fmt""github.com/shopspring/decimal""time"
  )type Decimal = decimal.Decimal// LocalTime 自定义数据类型1开始
  type LocalTime struct {time.Time
  }func (t LocalTime) MarshalJSON() ([]byte, error) {//格式化秒seconds := t.UnixNano() / 1e6 // 毫秒时间if seconds > 0 {return []byte(fmt.Sprintf("%d", seconds)), nil} else {return []byte("-1"), nil}
  }func (t LocalTime) Value() (driver.Value, error) {var zeroTime time.Timeif t.Time.UnixNano() == zeroTime.UnixNano() {return nil, nil}return t.Time, nil
  }func (t *LocalTime) Scan(v interface{}) error {value, ok := v.(time.Time)if ok {*t = LocalTime{Time: value}return nil}return fmt.Errorf("can not convert %v to timestamp", v)
  }// LocalTime 自定义数据类型1结束// JSON 自定义JSON数据类型
  type JSON []bytefunc (j JSON) Value() (driver.Value, error) {if j.IsNull() {return nil, nil}return string(j), nil
  }
  func (j *JSON) Scan(value interface{}) error {if value == nil {*j = nilreturn nil}s, ok := value.([]byte)if !ok {errors.New("invalid Scan Source")}*j = append((*j)[0:0], s...)return nil
  }
  func (m JSON) MarshalJSON() ([]byte, error) {if m == nil {return []byte("null"), nil}return m, nil
  }
  func (m *JSON) UnmarshalJSON(data []byte) error {if m == nil {return errors.New("null point exception")}*m = append((*m)[0:0], data...)return nil
  }
  func (j JSON) IsNull() bool {return len(j) == 0 || string(j) == "null"
  }
  func (j JSON) Equals(j1 JSON) bool {return bytes.Equal([]byte(j), []byte(j1))
  }/**
  var ticketIdList = make([]int64, 0)fmt.Println(reflect.TypeOf(scoreProject.TicketIDList), "????")value, _ := scoreProject.TicketIDList.MarshalJSON()if err := json.Unmarshal(value, &ticketIdList); err != nil {utils.Fail(ctx, "你传递的scoreProjectId错误")return}
  */

• 6、创建一个user.api的文件

  // 直接从实体类中拷贝过来
  type UserResponse {ID        int64  `json:"id"`        // 主键idUsername  string `json:"username"`  // 用户名Password  string `json:"password"`  // 密码Status    int64  `json:"status"`    // 状态,0表示禁止,1表示正常CreatedAt int64  `json:"createdAt"` // 创建时间UpdatedAt int64  `json:"updatedAt"` // 更新时间
  }@server(prefix: /api/users
  )
  service users {@handler userget /user returns (UserResponse)
  }//转换的脚本: goctl api go -api user.api -dir .
  

• 7、配置mysql的连接

  • etc/user.yaml中添加

    # 数据库配置
    MysqlConfig:DataSource: root:123456@tcp(127.0.0.1:3306)/beego?charset=utf8mb4&parseTime=true&loc=Local

  • config/config.go文件中添加配置

    package configimport "github.com/zeromicro/go-zero/rest"type Config struct {rest.RestConf// 数据库配置MysqlConfig struct {DataSource string}
    }
    

  • 创建一个文件internal/database/mysqlDb.go的文件用来连接数据库

    package databaseimport (_ "github.com/go-sql-driver/mysql""gorm.io/driver/mysql""gorm.io/gorm""gorm.io/gorm/logger""gorm.io/gorm/schema"
    )func NewMysqlDB(dataSource string) *gorm.DB {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("连接数据库失败")}return db
    }// TODO 文档地址: https://gorm.io/zh_CN/docs/

  • 在internal/svc/servicecontext.go中配置数据库连接

    package svcimport ("gorm.io/gorm""zero_demo04/internal/config""zero_demo04/internal/database"
    )type ServiceContext struct {Config  config.ConfigMySqlDb *gorm.DB
    }func NewServiceContext(c config.Config) *ServiceContext {return &ServiceContext{Config:  c,MySqlDb: database.NewMysqlDB(c.MysqlConfig.DataSource),}
    }
    

• 8、直接查询数据

  func (l *UserLogic) User() (resp *types.UserResponse, err error) {// todo: add your logic here and delete this lineuserEntity := &model.UserEntity{}l.svcCtx.MySqlDb.First(&userEntity)return &types.UserResponse{ID:       userEntity.ID,Username: userEntity.Username,Status:   userEntity.Status,}, nilreturn
  }
  

  或者使用下面的方式来查询

  func (l *UserLogic) User() (resp *types.UserResponse, err error) {// todo: add your logic here and delete this lineuserEntity, _ := dao.Use(l.svcCtx.MySqlDb).UserEntity.WithContext(l.ctx).First()if userEntity == nil {fmt.Println("查询失败")return}return &types.UserResponse{ID:       userEntity.ID,Username: userEntity.Username,Status:   userEntity.Status,}, nilreturn
  }
  

• 9、返回数组

  • 定义api文件

    // 直接从实体类中拷贝过来
    type UserResponse {ID        int64  `json:"id"`        // 主键idUsername  string `json:"username"`  // 用户名Password  string `json:"password"`  // 密码Status    int64  `json:"status"`    // 状态,0表示禁止,1表示正常CreatedAt int64  `json:"createdAt"` // 创建时间UpdatedAt int64  `json:"updatedAt"` // 更新时间
    }@server(prefix: /api/users
    )
    service users {@handler userget /user returns ([]UserResponse)
    }
    

  • 查询语句

    func (l *UserLogic) User() (resp []types.UserResponse, err error) {// todo: add your logic here and delete this lineuserEntityList, err := dao.Use(l.svcCtx.MySqlDb).UserEntity.WithContext(l.ctx).Find()var result = make([]types.UserResponse, 0)copier.Copy(&result, userEntityList)return result, nil
    }
    

二、连接redis

• 1、在配置文件中添加配置项

  # redis配置
  RedisConfig:Host: localhostPort: 6379Pass: ""Tls: false
  

• 2、在config.go文件中添加配置

  RedisConfig struct {Host stringPort intPass stringTls  bool
  }
  

• 3、在database/redisDb.go中添加配置

  package databaseimport ("fmt""github.com/go-redis/redis/v8"
  )func NewRedisDB(host, pass string, port int) *redis.Client {redisDb := redis.NewClient(&redis.Options{Addr:     fmt.Sprintf("%s:%d", host, port),Password: pass,DB:       0,})return redisDb
  }
  

• 4、在servicecontext.go文件中补充

  type ServiceContext struct {Config  config.ConfigMySqlDb *gorm.DBRedisDb *redis.Client
  }func NewServiceContext(c config.Config) *ServiceContext {return &ServiceContext{Config:  c,MySqlDb: database.NewMysqlDB(c.MysqlConfig.DataSource),RedisDb: database.NewRedisDB(c.RedisConfig.Host, c.RedisConfig.Pass, c.RedisConfig.Port),}
  }
  

• 5、直接获取数据

  redisName := l.svcCtx.RedisDb.Get(l.ctx, "name")
  fmt.Println(redisName, "====")