Go语言微服务框架 - 12.ORM层的自动抽象与自定义方法的扩展

--- micro_web_service            项目目录
 |-- gen                            从idl文件夹中生成的文件，不可手动修改
    |-- idl                             对应idl文件夹
       |-- demo                             对应idl/demo服务，包括基础结构、HTTP接口、gRPC接口
      |-- order                            对应idl/order服务，同上
     |-- swagger.json                    openapiv2的接口文档
 |-- idl                            原始的idl定义
    |-- demo                            业务package定义，protobuffer的原始定义
    |-- order                           业务order定义，同时干
 |-- internal                       项目的内部代码，不对外暴露
    |-- config                          配置相关的文件夹，viper的相关加载逻辑
    |-- dao                             Data Access Object层，是model层的实现
    |-- gormer                          从pkg/gormer中生成的相关代码，不允许更改
    |-- model                           修改：model层基本定义由gormer自动生成
    |-- mysql                           修改：MySQL连接，支持日志打印
    |-- server                          服务器的实现，对idl中定义服务的具体实现
    |-- service                         service层，作为领域实现的核心部分
     |-- zlog                            封装zap日志的代码实现
  |-- pkg                            开放给第三方的工具库
     |-- gormer                          gormer二进制工具，用于生成Gorm相关Dao层代码
 |-- buf.gen.yaml                   buf生成代码的定义，新增参数校验逻辑
 |-- buf.yaml                       buf工具安装所需的工具，从v1beta升到v1
 |-- gen.sh                         生成代码的脚本：buf+gormer
 |-- go.mod                         Go Module文件
 |-- gormer.yaml                    将gormer中的参数移动到这里
 |-- main.go                        项目启动的main函数
 |-- swagger.sh                     生成openapiv2的相关脚本

// *.go 自动生成的代码，标准方法
type OrderModel interface {
 AddOrder(ctx context.Context, order *gormer.Order) (err error)
 QueryOrders(ctx context.Context, pageNumber, pageSize int, condition *gormer.OrderOptions) (orders []gormer.Order, err error)
 CountOrders(ctx context.Context, condition *gormer.OrderOptions) (count int64, err error)
 UpdateOrder(ctx context.Context, updated, condition *gormer.OrderOptions) (err error)
 DeleteOrder(ctx context.Context, condition *gormer.OrderOptions) (err error)
 
 // Implement Your Method in ext model
 OrderExtModel
}

// *_ext.go 扩展方法
type OrderExtModel interface {
}

// 如果extFile已经存在，则不要覆盖
if _, err = os.Stat(extFile); err != nil {
  // 创建ext文件的代码
}

var _ model.OrderModel = NewOrderRepo(nil)

// 1 - 操作SQL时，将ctx传入其中，用来传递一些通用参数，如traceid
func (repo *OrderRepo) AddOrder(ctx context.Context, order *gormer.Order) (err error) {
 repo.db.WithContext(ctx).
  Table(gormer.OrderTableName).
  Create(order)
 err = repo.db.Error
 return
}

// 2 - 在操作数据库后，注册对应的插件afterLog，用来打印SQL日志
func InitGorm(user, password, addr string, dbname string) (err error) {
 dsn := fmt.Sprintf("%s:%s@tcp(%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
  user, password, addr, dbname)
 GormDB, err = gorm.Open(mysql.Open(dsn), &gorm.Config{})
 
 // 结束后
 _ = GormDB.Callback().Create().After("gorm:after_create").Register(callBackLogName, afterLog)
 _ = GormDB.Callback().Query().After("gorm:after_query").Register(callBackLogName, afterLog)
 _ = GormDB.Callback().Delete().After("gorm:after_delete").Register(callBackLogName, afterLog)
 _ = GormDB.Callback().Update().After("gorm:after_update").Register(callBackLogName, afterLog)
 _ = GormDB.Callback().Row().After("gorm:row").Register(callBackLogName, afterLog)
 _ = GormDB.Callback().Raw().After("gorm:raw").Register(callBackLogName, afterLog)
 return
}

const callBackLogName = "zlog"

func afterLog(db *gorm.DB) {
 err := db.Error
 ctx := db.Statement.Context
 
 sql := db.Dialector.Explain(db.Statement.SQL.String(), db.Statement.Vars...)
 if err != nil {
  zlog.WithTrace(ctx).Errorf("sql=%s || error=%v", sql, err)
  return
 }
 zlog.WithTrace(ctx).Infof("sql=%s", sql)
}