Golang【gorm】模型

前面入门案例中&＃xff0c;我们定义了 User 结构体用来和数据表 users 做映射&＃xff0c;User 结构体&＃xff0c;我们称之为数据模型&＃xff0c;在 gorm 框架中&＃xff0c;操作数据库需要预先定义模型。

底层都是使用的 golang 的 database 标准库&＃xff0c;利用反射原理&＃xff0c;执行读写操作时&＃xff0c;将结构体翻译为 sql 语句&＃xff0c;并将结果转化为对应的模型。

1 模型定义商品表

CREATE TABLE &＃96;goods&＃96; (&＃96;id&＃96; INT (10) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT &＃39;自增ID&＃xff0c;商品Id&＃39;,&＃96;name&＃96; VARCHAR (30) NOT NULL COMMENT &＃39;商品名&＃39;,&＃96;price&＃96; DECIMAL (10, 2) UNSIGNED NOT NULL COMMENT &＃39;商品价格&＃39;,&＃96;type_id&＃96; INT (10) UNSIGNED NOT NULL COMMENT &＃39;商品类型Id&＃39;,&＃96;createtime&＃96; INT (10) NOT NULL DEFAULT 0 COMMENT &＃39;创建时间&＃39;,PRIMARY KEY (&＃96;id&＃96;)
) ENGINE &＃61; INNODB DEFAULT CHARSET &＃61; utf8mb4


将上述表翻译为模型后&＃xff0c;如下&＃xff1a;

type Good struct {Id int //表字段名为&＃xff1a;idName string //表字段名为&＃xff1a;namePrice float64 //表字段名为&＃xff1a;priceTypeId int //表字段名为&＃xff1a;type_idCreateTime int64 &＃96;gorm:"column:createtime"&＃96; //表字段名为&＃xff1a;createtime
}


默认 gorm 对 struct 字段名使用 Snake Case 命名风格转换成 mysql 表字段名(需要转换成小写字母)。

Snake Case 命名风格&＃xff0c;就是各个单词之间用下划线&＃xff08;_&＃xff09;分隔&＃xff0c;例如&＃xff1a; CreateTime的Snake Case风格命名为 create_time。

同时默认情况下&＃xff0c;使用 ID 做为其主键&＃xff0c;使用结构体名称的 Snake Case 风格的复数形式做为表名&＃xff0c;使用 CreatedAt、UpdatedAt 字段追踪创建、更新时间。

2 模型标签

标签定义&＃xff1a;

&＃96;gorm:"标签内容"&＃96;


标签定义部分&＃xff0c;多个标签定义可以使用分号&＃xff08;;&＃xff09;分隔。

gorm 常用标签如下&＃xff1a;

3 表名映射

复数表名&＃xff0c;比如结构体 User&＃xff0c;默认的表名为 users。会缓存表名。

实现 Tabler 接口 &＃xff08;TableName 不支持动态变化&＃xff0c;它会被缓存下来以便后续使用。&＃xff09;

type Tabler interface {TableName() string
}// TableName 会将 User 的表名重写为 &＃96;profiles&＃96;
func (User) TableName() string {return "profiles"
}


动态表名&＃xff0c;使用 Scopes。

func UserTable(user User) func (tx *gorm.DB) *gorm.DB {return func (tx *gorm.DB) *gorm.DB {if user.Admin {return tx.Table("admin_users")}return tx.Table("users")}
}db.Scopes(UserTable(user)).Create(&user)


临时表名

db.Table("deleted_users")


默认方式 - 推荐

type User struct {ID int64 // 主键//通过在字段后面的标签说明&＃xff0c;定义golang字段和表字段的关系//例如 &＃96;gorm:"column:username"&＃96; 标签说明含义是: Mysql表的列名&＃xff08;字段名)为usernameUsername string &＃96;gorm:"column:username"&＃96;Password string &＃96;gorm:"column:password"&＃96;//创建时间&＃xff0c;时间戳CreateTime int64 &＃96;gorm:"column:createtime"&＃96;
}// 设置表名
func (u User) TableName() string {return "users"
}


4 Model

GORM 定义一个 gorm.Model 结构体&＃xff0c;其包括字段 ID、CreatedAt、UpdatedAt、DeletedAt。

// gorm.Model 的定义
type Model struct {ID uint &＃96;gorm:"primaryKey"&＃96;CreatedAt time.TimeUpdatedAt time.TimeDeletedAt gorm.DeletedAt &＃96;gorm:"index"&＃96;
}


GORM 约定使用 CreatedAt、UpdatedAt 追踪创建/更新时间。如果定义了这种字段&＃xff0c;GORM 在创建、更新时会自动填充当前时间。

要使用不同名称的字段&＃xff0c;您可以配置 autoCreateTime、autoUpdateTime 标签。

如果想要保存 UNIX&＃xff08;毫/纳&＃xff09;秒时间戳&＃xff0c;而不是 time&＃xff0c;只需简单地将 time.Time 修改为 int 即可。

例子&＃xff1a;

type User struct {// 默认创建时间字段&＃xff0c; 在创建时&＃xff0c;// 如果该字段值为零值&＃xff0c;则使用当前时间填充CreatedAt time.Time // 默认更新时间字段&＃xff0c; // 在创建时该字段值为零值或者在更新时&＃xff0c;// 使用当前时间戳秒数填充UpdatedAt int // 自定义字段&＃xff0c; 使用时间戳填纳秒数充更新时间Updated int64 &＃96;gorm:"autoUpdateTime:nano"&＃96; // 自定义字段&＃xff0c; 使用时间戳毫秒数填充更新时间Updated int64 &＃96;gorm:"autoUpdateTime:milli"&＃96; // 自定义字段&＃xff0c; 使用时间戳秒数填充创建时间Created int64 &＃96;gorm:"autoCreateTime"&＃96;
}


可以将它嵌入到您的结构体中&＃xff0c;以包含这几个字段&＃xff0c;比如&＃xff1a;

type User struct {gorm.ModelName string
}// 等效于
type User struct {ID uint &＃96;gorm:"primaryKey"&＃96;CreatedAt time.TimeUpdatedAt time.TimeDeletedAt gorm.DeletedAt &＃96;gorm:"index"&＃96;Name string
}


对于正常的结构体字段&＃xff0c;你也可以通过标签 embedded 将其嵌入&＃xff0c;例如&＃xff1a;

type Author struct {Name stringEmail string
}type Blog struct {ID intAuthor Author &＃96;gorm:"embedded"&＃96;Upvotes int32
}
// 等效于
type Blog struct {ID int64Name stringEmail stringUpvotes int32
}


可以使用标签 embeddedPrefix 来为 db 中的字段名添加前缀&＃xff0c;例如&＃xff1a;

type Blog struct {ID intAuthor Author &＃96;gorm:"embedded;embeddedPrefix:author_"&＃96;Upvotes int32
}// 等效于
type Blog struct {ID int64AuthorName stringAuthorEmail stringUpvotes int32
}


5. 数据库连接

GORM 官方支持的数据库类型有&＃xff1a;

• MySQL
• PostgreSQL
• SQlite
• SQL Server

连接数据库主要是两个步骤&＃xff1a;

1、配置 DSN (Data Source Name)。
2、使用 gorm.Open 连接数据库。

5.1 DSN

gorm 库使用 dsn 作为连接数据库的参数&＃xff0c;dsn 翻译过来就叫数据源名称&＃xff0c;用来描述数据库连接信息。一般都包含数据库连接地址&＃xff0c;账号&＃xff0c;密码之类的信息。

格式&＃xff1a;

[username[:password]&＃64;][protocol[(address)]]/dbname[?param1&＃61;value1&...¶mN&＃61;valueN]


mysql 的 dsn 的一些例子&＃xff1a;

//mysql dsn格式
//涉及参数:
//username 数据库账号
//password 数据库密码
//host 数据库连接地址&＃xff0c;可以是Ip或者域名
//port 数据库端口
//Dbname 数据库名
username:password&＃64;tcp(host:port)/Dbname?charset&＃61;utf8&parseTime&＃61;True&loc&＃61;Local


//填上参数后的例子
//username &＃61; root
//password &＃61; 123456
//host &＃61; localhost
//port &＃61; 3306
//Dbname &＃61; gorm
//后面K/V键值对参数含义为&＃xff1a;
// charset&＃61;utf8 客户端字符集为utf8
// parseTime&＃61;true 支持把数据库datetime和date类型转换为golang的time.Time类型
// loc&＃61;Local 使用系统本地时区
root:123456&＃64;tcp(localhost:3306)/gorm?charset&＃61;utf8&parseTime&＃61;True&loc&＃61;Local


// gorm 设置 mysql 连接超时参数
//开发的时候经常需要设置数据库连接超时参数&＃xff0c;gorm是通过dsn的timeout参数配置
//例如&＃xff0c;设置10秒后连接超时&＃xff0c;timeout&＃61;10s
//下面是完成的例子
root:123456&＃64;tcp(localhost:3306)/gorm?charset&＃61;utf8&parseTime&＃61;True&loc&＃61;Local&timeout&＃61;10s


//设置读写超时时间
// readTimeout - 读超时时间&＃xff0c;0代表不限制
// writeTimeout - 写超时时间&＃xff0c;0代表不限制
root:123456&＃64;tcp(localhost:3306)/gorm?charset&＃61;utf8&parseTime&＃61;True&loc&＃61;Local&timeout&＃61;10s&readTimeout&＃61;30s&writeTimeout&＃61;60s


要支持完整的 UTF-8 编码&＃xff0c;您需要将 charset&＃61;utf8 更改为 charset&＃61;utf8mb4。

5.2 连接数据库

import ("gorm.io/driver/mysql""gorm.io/gorm"
)func main() {// 参考 https://github.com/go-sql-driver/mysql#dsn-data-source-name 获取详情dsn :&＃61; "user:pass&＃64;tcp(127.0.0.1:3306)/dbname?charset&＃61;utf8mb4&parseTime&＃61;True&loc&＃61;Local"db, err :&＃61; gorm.Open(mysql.Open(dsn), &gorm.Config{})
}


MySQL 驱动程序提供了 一些 高级配置 可以在初始化过程中使用&＃xff0c;例如&＃xff1a;

db, err :&＃61; gorm.Open(mysql.New(mysql.Config{// DSN data source nameDSN: "gorm:gorm&＃64;tcp(127.0.0.1:3306)/gorm?charset&＃61;utf8&parseTime&＃61;True&loc&＃61;Local", // string 类型字段的默认长度DefaultStringSize: 256, // 禁用 datetime 精度&＃xff0c;MySQL 5.6 之前的数据库不支持DisableDatetimePrecision: true,// 重命名索引时采用删除并新建的方式&＃xff0c;// MySQL 5.7 之前的数据库和 MariaDB 不支持重命名索引DontSupportRenameIndex: true, // 用 &＃96;change&＃96; 重命名列&＃xff0c;// MySQL 8 之前的数据库和 MariaDB 不支持重命名列DontSupportRenameColumn: true, // 根据当前 MySQL 版本自动配置SkipInitializeWithVersion: false,
}), &gorm.Config{})


GORM 允许通过 DriverName 选项自定义 MySQL 驱动&＃xff0c;例如&＃xff1a;

import (_ "example.com/my_mysql_driver""gorm.io/driver/mysql""gorm.io/gorm"
)db, err :&＃61; gorm.Open(mysql.New(mysql.Config{DriverName: "my_mysql_driver",DSN: "gorm:gorm&＃64;tcp(localhost:9910)/gorm?charset&＃61;utf8&parseTime&＃61;True&loc&＃61;Local", // data source name, 详情参考&＃xff1a;https://github.com/go-sql-driver/mysql#dsn-data-source-name
}), &gorm.Config{})


5.3 调试模式

db.Debug()


5.4 连接池配置

sqlDB, _ :&＃61; db.DB()//设置数据库连接池参数
//设置数据库连接池最大连接数
sqlDB.SetMaxOpenConns(100)
//连接池最大允许的空闲连接数&＃xff0c;
//如果没有sql任务需要执行的连接数大于20&＃xff0c;
//超过的连接会被连接池关闭
sqlDB.SetMaxIdleConns(20)