gorm是一个使用Go语言编写的ORM框架。文档齐全，对开发者友好，支持主流数据库。
gorm介绍
中文官方网站内含十分齐全的中文文档，有了它你甚至不需要再继续向下阅读本文。
安装
go get -u github.com/jinzhu/gorm
连接数据库
连接不同的数据库都需要导入对应数据的驱动程序，GORM已经贴心的为我们包装了一些驱动程序，只需要按如下方式导入需要的数据库驱动即可：
1import _ "github.com/jinzhu/gorm/dialects/mysql" 2// import _ "github.com/jinzhu/gorm/dialects/postgres" 3// import _ "github.com/jinzhu/gorm/dialects/sqlite" 4// import _ "github.com/jinzhu/gorm/dialects/mysql"
连接MySQL
1import ( 2 "github.com/jinzhu/gorm" 3 _ "github.com/jinzhu/gorm/dialects/mysql" 4) 5 6func main() { 7 db, err := gorm.Open("mysql", "user:password@(localhost)/dbname?charset=utf8mb4&parseTime=True&loc=Local") 8 defer db.Close() 9}
连接PostgreSQL
基本代码同上，注意引入对应postgres驱动并正确指定gorm.Open()参数。
1import ( 2 "github.com/jinzhu/gorm" 3 _ "github.com/jinzhu/gorm/dialects/postgres" 4) 5 6func main() { 7 db, err := gorm.Open("postgres", "host=myhost port=myport user=gorm dbname=gorm password=mypassword") 8 defer db.Close() 9}
连接Sqlite3
基本代码同上，注意引入对应sqlite驱动并正确指定gorm.Open()参数。
1import ( 2 "github.com/jinzhu/gorm" 3 _ "github.com/jinzhu/gorm/dialects/sqlite" 4) 5 6func main() { 7 db, err := gorm.Open("sqlite3", "/tmp/gorm.db") 8 defer db.Close() 9}
连接SQL Server
基本代码同上，注意引入对应mysql驱动并正确指定gorm.Open()参数。
1import ( 2 "github.com/jinzhu/gorm" 3 _ "github.com/jinzhu/gorm/dialects/mysql" 4) 5 6func main() { 7 db, err := gorm.Open("mysql", "sqlserver://username:password@localhost:1433?database=dbname") 8 defer db.Close() 9}
GORM基本示例
创建数据库
在使用GORM前手动创建数据库db1：
CREATE DATABASE db1;
GORM操作MySQL
使用GORM连接上面的db1进行创建、查询、更新、删除操作。
1package main 2 3import ( 4 "fmt" 5 "github.com/jinzhu/gorm" 6 _ "github.com/jinzhu/gorm/dialects/mysql" 7) 8 9// UserInfo 用户信息 10type UserInfo struct { 11 ID uint 12 Name string 13 Gender string 14 Hobby string 15} 16 17 18func main() { 19 db, err := gorm.Open("mysql", "root:root1234@(127.0.0.1:13306)/db1?charset=utf8mb4&parseTime=True&loc=Local") 20 if err!= nil{ 21 panic(err) 22 } 23 defer db.Close() 24 25 // 自动迁移 26 db.AutoMigrate(&UserInfo{}) 27 28 u1 := UserInfo{1, "无情", "男", "篮球"} 29 u2 := UserInfo{2, "老王", "女", "足球"} 30 // 创建记录 31 db.Create(&u1) 32 db.Create(&u2) 33 // 查询 34 var u = new(UserInfo) 35 db.First(u) 36 fmt.Printf("%#v\n", u) 37 38 var uu UserInfo 39 db.Find(&uu, "hobby=?", "足球") 40 fmt.Printf("%#v\n", uu) 41 42 // 更新 43 db.Model(&u).Update("hobby", "双色球") 44 // 删除 45 db.Delete(&u) 46}
GORM Model定义
在使用ORM工具时，通常需要在代码中定义模型（Models）与数据库中的数据表进行映射，在GORM中模型（Models）通常是正常定义的结构体、基本的go类型或它们的指针。 同时也支持sql.Scanner及driver.Valuer接口（interfaces）。
gorm.Model
为了方便模型定义，GORM内置了一个gorm.Model结构体。gorm.Model是一个包含了ID, CreatedAt, UpdatedAt, DeletedAt四个字段的Golang结构体。
1// gorm.Model 定义 2type Model struct { 3 ID uint `gorm:"primary_key"` 4 CreatedAt time.Time 5 UpdatedAt time.Time 6 DeletedAt *time.Time 7}
将它嵌入到自己的模型中：
1// 将 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`字段注入到`User`模型中 2type User struct { 3 gorm.Model 4 Name string 5}
当然你也可以完全自己定义模型：
1// 不使用gorm.Model，自行定义模型 2type User struct { 3 ID int 4 Name string 5}
模型定义示例
1type User struct { 2 gorm.Model ////内嵌模型 3 Name string 4 Age sql.NullInt64 ////零值类型 5 Birthday *time.Time 6 Email string `gorm:"type:varchar(100);unique_index"` //字符串类型，唯一索引 7 Role string `gorm:"size:255"` // 设置字段大小为255 8 MemberNumber *string `gorm:"unique;not null"` // 设置（member number）唯一并且不为空 9 Num int `gorm:"AUTO_INCREMENT"` // 设置 num 为自增类型 10 Address string `gorm:"index:addr"` // 给address字段创建名为addr的索引 11 IgnoreMe int `gorm:"-"` // 忽略本字段 12}
结构体标记（tags）
使用结构体声明模型时，标记（tags）是可选项。gorm支持以下标记:
支持的结构体标记（Struct tags）
| 结构体标记（Tag） | 描述 |
|---|---|
| Column | 指定列名 |
| Type | 指定列数据类型 |
| Size | 指定列大小, 默认值255 |
| PRIMARY_KEY | 将列指定为主键 |
| UNIQUE | 将列指定为唯一 |
| DEFAULT | 指定列默认值 |
| PRECISION | 指定列精度 |
| NOT NULL | 将列指定为非 NULL |
| AUTO_INCREMENT | 指定列是否为自增类型 |
| INDEX | 创建具有或不带名称的索引, 如果多个索引同名则创建复合索引 |
| UNIQUE_INDEX | 和 INDEX 类似，只不过创建的是唯一索引 |
| EMBEDDED | 将结构设置为嵌入 |
| EMBEDDED_PREFIX | 设置嵌入结构的前缀 |
| - | 忽略此字段 |
关联相关标记（tags）
| 结构体标记（Tag） | 描述 |
|---|---|
| MANY2MANY | 指定连接表 |
| FOREIGNKEY | 设置外键 |
| ASSOCIATION_FOREIGNKEY | 设置关联外键 |
| POLYMORPHIC | 指定多态类型 |
| POLYMORPHIC_VALUE | 指定多态值 |
| JOINTABLE_FOREIGNKEY | 指定连接表的外键 |
| ASSOCIATION_JOINTABLE_FOREIGNKEY | 指定连接表的关联外键 |
| SAVE_ASSOCIATIONS | 是否自动完成 save 的相关操作 |
| ASSOCIATION_AUTOUPDATE | 是否自动完成 update 的相关操作 |
| ASSOCIATION_AUTOCREATE | 是否自动完成 create 的相关操作 |
| ASSOCIATION_SAVE_REFERENCE | 是否自动完成引用的 save 的相关操作 |
| PRELOAD | 是否自动完成预加载的相关操作 |
主键、表名、列名的约定
主键（Primary Key）
GORM 默认会使用名为ID的字段作为表的主键。
1type User struct { 2 ID string // 名为`ID`的字段会默认作为表的主键 3 Name string 4} 5 6// 使用`AnimalID`作为主键 7type Animal struct { 8 AnimalID int64 `gorm:"primary_key"` 9 Name string 10 Age int64 11}
表名（Table Name）
表名默认就是结构体名称的复数，例如：
1type User struct {} // 默认表名是 `users` 2 3// 将 User 的表名设置为 `profiles` 4func (User) TableName() string { 5 return "profiles" 6} 7 8func (u User) TableName() string { 9 if u.Role == "admin" { 10 return "admin_users" 11 } else { 12 return "users" 13 } 14} 15 16// 禁用默认表名的复数形式，如果置为 true，则 `User` 的默认表名是 `user` 17db.SingularTable(true)
也可以通过Table()指定表名：
1// 使用User结构体创建名为`deleted_users`的表 2db.Table("deleted_users").CreateTable(&User{}) 3 4var deleted_users []User 5db.Table("deleted_users").Find(&deleted_users) 6//// SELECT * FROM deleted_users; 7 8db.Table("deleted_users").Where("name = ?", "jinzhu").Delete() 9//// DELETE FROM deleted_users WHERE name = 'jinzhu';
GORM还支持更改默认表名称规则：
1gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string { 2 return "prefix_" + defaultTableName; 3}
列名（Column Name）
列名由字段名称进行下划线分割来生成
1type User struct { 2 ID uint // column name is `id` 3 Name string // column name is `name` 4 Birthday time.Time // column name is `birthday` 5 CreatedAt time.Time // column name is `created_at` 6}
可以使用结构体tag指定列名：
1type Animal struct { 2 AnimalId int64 `gorm:"column:beast_id"` // set column name to `beast_id` 3 Birthday time.Time `gorm:"column:day_of_the_beast"` // set column name to `day_of_the_beast` 4 Age int64 `gorm:"column:age_of_the_beast"` // set column name to `age_of_the_beast` 5}
时间戳跟踪
CreatedAt
如果模型有 CreatedAt字段，该字段的值将会是初次创建记录的时间。
1db.Create(&user) // `CreatedAt`将会是当前时间 2 3// 可以使用`Update`方法来改变`CreateAt`的值 4db.Model(&user).Update("CreatedAt", time.Now())
UpdatedAt
如果模型有UpdatedAt字段，该字段的值将会是每次更新记录的时间。
1db.Save(&user) // `UpdatedAt`将会是当前时间 2 3db.Model(&user).Update("name", "jinzhu") // `UpdatedAt`将会是当前时间
DeletedAt
如果模型有DeletedAt字段，调用Delete删除该记录时，将会设置DeletedAt字段为当前时间，而不是直接将记录从数据库中删除。