Go语言微服务框架 - 4.初识GORM库

--- micro_web_service            项目目录
 |-- gen                            从idl文件夹中生成的文件，不可手动修改
    |-- idl                             对应idl文件夹
       |-- demo                             对应idl/demo服务
          |-- demo.pb.go                        demo.proto的基础结构
          |-- demo.pb.gw.go                     demo.proto的HTTP接口，对应gRPC-Gateway
          |-- demo_grpc.pb.go                   demo.proto的gRPC接口代码
 |-- idl                            原始的idl定义
    |-- demo                            业务package定义
       |-- demo.proto                       protobuffer的原始定义
 |-- internal                       项目的内部代码，不对外暴露
    |-- config                          配置相关的文件夹
       |-- viper.go                         viper的相关加载逻辑
    |-- dao                             新增：Data Access Object层
       |-- order.go                         新增：示例的一个Order对象，订单表
    |-- mysql                           新增：MySQL连接
       |-- init.go                          新增：初始化连接到MySQL的工作
    |-- server                          服务器的实现
       |-- demo.go                          server中对demo这个服务的接口实现
       |-- server.go                        server的定义，须实现对应服务的方法
     |-- zlog                            封装日志的文件夹
        |-- zap.go                           zap封装的代码实现
 |-- buf.gen.yaml                   buf生成代码的定义
 |-- buf.yaml                       buf工具安装所需的工具
 |-- gen.sh                         buf生成的shell脚本
 |-- go.mod                         Go Module文件
 |-- main.go                        项目启动的main函数

// 推荐使用方式：定义一个结构体，填充字段
user := User{Name: "Jinzhu", Age: 18, Birthday: time.Now()}
result := db.Create(&user)

// 不推荐：指定要创建的字段名，也就是user中部分生效，很容易产生迷惑
// 更建议新建一个user结构体进行创建
db.Select("Name", "Age", "CreatedAt").Create(&user)

// 批量创建同推荐
var users = []User{{Name: "jinzhu1"}, {Name: "jinzhu2"}, {Name: "jinzhu3"}}
db.Create(&users)

// 不推荐：钩子相关的特性，类似于数据库里的trigger，隐蔽而迷惑，不易维护
func (u *User) BeforeCreate(tx *gorm.DB) (err error){}

// 不推荐：用Map硬编码创建记录，改动成本大
db.Model(&User{}).Create(map[string]interface{}{
  "Name": "jinzhu", "Age": 18,
})

// 争议点：gorm.Model中预定了数据库中的四个字段，是否应该把它引入到模型的定义中
// 我个人不太喜欢将这四个字段强定义为数据库表中的字段名
type Model struct {
 ID        uint `gorm:"primarykey"`
 CreatedAt time.Time
 UpdatedAt time.Time
 DeletedAt DeletedAt `gorm:"index"`
}

// 不推荐： 我个人不太建议使用First/Last这种和原生SQL定义不一致的语法，扩展性也不好
// 在这种情况下，我更建议采用Find+Order+Limit这样的组合方式，通用性也更强
db.First(&user)
db.Last(&user)

// 推荐：Find支持返回多个记录，是最常用的方法，但需要结合一定的限制
result := db.Find(&users)

// 不推荐：条件查询的字段名采用hard code，体验不好
db.Where("name = ?", "jinzhu").First(&user)
db.Where(map[string]interface{}{"name": "jinzhu", "age": 20}).Find(&users)

// 推荐：结合结构体的方式定义，体验会好很多
// 但是，上面这种方法不支持结构体中Field为默认值的情况，如0，''，false等
// 所以，更推荐采用下面这种方式，虽然会带来一定的hard code，但能指定要查询的结构体名称。
db.Where(&User{Name: "jinzhu", Age: 20}).First(&user)
db.Where(&User{Name: "jinzhu"}, "name", "Age").Find(&users)

// 推荐：指定排序
db.Order("age desc, name").Find(&users)

// 推荐：限制查询范围，结合Find
db.Limit(10).Offset(5).Find(&users)

// 不推荐：单字段的更新，不常用
db.Model(&User{}).Where("active = ?", true).Update("name", "hello")

// 不推荐：指定主键的多字段更新，但不支持默认类型
db.Model(&user).Updates(User{Name: "hello", Age: 18, Active: false})

// 不推荐：指定主键的多字段的更新，但字段多了硬编码很麻烦
db.Model(&user).Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false})

// 推荐：指定主键的多字段的更新，指定要更新的字段，*为全字段
db.Model(&user).Select("Name", "Age").Updates(User{Name: "new_name", Age: 0})
db.Model(&user).Select("*").Update(User{Name: "jinzhu", Role: "admin", Age: 0})

// 推荐：指定更新方式的多字段的更新
db.Model(User{}).Where("role = ?", "admin").Updates(User{Name: "hello", Age: 18})

db.Delete(&email)