ORM框架
什么是ORM
ORM优缺点
GORM介绍
Github GORM
中文官方网站
安装
go get -u github.com/jinzhu/gorm
连接数据库
连接不同的数据库都需要导入对应数据的驱动程序,GORM已经包装了一些驱动程序,只需要按如下方式导入需要的数据库驱动即可:
import _ "github.com/jinzhu/gorm/dialects/mysql"
// import _ "github.com/jinzhu/gorm/dialects/postgres"
// import _ "github.com/jinzhu/gorm/dialects/sqlite"
// import _ "github.com/jinzhu/gorm/dialects/mssql"
连接MySQL
import (
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/mysql"
)
func main() {
db, err := gorm.Open("mysql", "user:password@(localhost)/dbname?charset=utf8mb4&parseTime=True&loc=Local")
defer db.Close()
}
连接PostgreSQL
基本代码同上,注意引入对应 postgres
驱动并正确指定 gorm.Open()
参数。
import (
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/postgres"
)
func main() {
db, err := gorm.Open("postgres", "host=myhost port=myport user=gorm dbname=gorm password=mypassword")
defer db.Close()
}
连接Sqlite3
基本代码同上,注意引入对应 sqlite
驱动并正确指定 gorm.Open()
参数。
import (
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/sqlite"
)
func main() {
db, err := gorm.Open("sqlite3", "/tmp/gorm.db")
defer db.Close()
}
连接SQL Server
基本代码同上,注意引入对应 mssql
驱动并正确指定 gorm.Open()
参数。
import (
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/mssql"
)
func main() {
db, err := gorm.Open("mssql", "sqlserver://username:password@localhost:1433?database=dbname")
defer db.Close()
}
GORM基本示例
以MySQL数据库为例,讲解GORM各项功能的主要使用方法。
Docker快速创建MySQL实例
如果没有安装MySQL,可以使用一下命令快速运行一个MySQL8.0.19实例,当然前提是要有docker环境…
在本地的 13306
端口运行一个名为 mysql8019
,root用户名密码为 root1234
的MySQL容器环境:
docker run --name mysql8019 -p 13306:3306 -e MYSQL_ROOT_PASSWORD=root1234 -d mysql:8.0.19
在另外启动一个 MySQL Client
连接上面的MySQL环境,密码为上一步指定的密码 root1234
:
docker run -it --network host --rm mysql mysql -h127.0.0.1 -P13306 --default-character-set=utf8mb4 -uroot -p
创建数据库
在使用GORM前手动创建数据库 db1
:
CREATE DATABASE db1;
GORM操作MySQL
使用GORM连接上面的 db1
进行创建、查询、更新、删除操作。
package main
import (
"fmt"
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/mysql"
)
// UserInfo --> 数据表
type UserInfo struct {
ID uint
Name string
Gender string
Hobby string
}
func main() {
// 连接MySQL数据库
db, err := gorm.Open("mysql", "root:SHANG6688@(127.0.0.1:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
if err != nil {
panic(err)
}
defer db.Close()
// 创建表 自动迁移(把结构体和数据表进行对应)
db.AutoMigrate(&UserInfo{})
// 创建数据行
//u1 := UserInfo{1, "七米", "男", "蛙泳"}
//db.Create(&u1)
// 查询
var u UserInfo
db.First(&u) // 查询表中第一条数据保存到u中
fmt.Printf("u:%#v\n", u)
// 更新
db.Model(&u).Update("hobby", "双色球")
// 删除
db.Delete(&u)
}
GORM Model定义
在使用ORM工具时,通常需要在代码中定义模型(Models)与数据库中的数据表进行映射,在GORM中模型(Models)通常是正常定义的结构体、基本的go类型或它们的指针。 同时也支持 sql.Scanner
及 driver.Valuer
接口(interfaces)。
gorm.Model
为了方便模型定义,GORM内置了一个 gorm.Model
结构体。gorm.Model
是一个包含了ID, CreatedAt
, UpdatedAt
, DeletedAt
四个字段的Golang结构体。
// gorm.Model 定义
type Model struct {
ID uint `gorm:"primary_key"`
CreatedAt time.Time
UpdatedAt time.Time
DeletedAt *time.Time
}
可以将它嵌入到自己的模型中:
// 将 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`字段注入到`User`模型中
type User struct {
gorm.Model
Name string
}
当然也可以完全自己定义模型:
// 不使用gorm.Model,自行定义模型
type User struct {
ID int
Name string
}
模型定义示例
// 定义模型
type User struct {
gorm.Model // 内嵌gorm.Model
Name string
Age sql.NullInt64 // 零值类型
Birthday *time.Time
Email string `gorm:"type:varchar(100);unique_index"`
Role string `gorm:"size:255"` // 设置字段大小为255
MemberNumber *string `gorm:"unique;not null"` // 设置会员号(member number)唯一并且不为空
Num int `gorm:"AUTO_INCREMENT"` // 设置 num 为自增类型
Address string `gorm:"index:addr"` // 给address字段创建名为addr的索引
IgnoreMe int `gorm:"-"` // 忽略本字段
结构体标记(tags)
使用结构体声明模型时,标记(tags)是可选项。gorm支持以下标记:
支持的结构体标记(Struct tags)
关联相关标记(tags)
主键、表名、列名的约定
主键(Primary Key)
GORM 默认会使用名为ID的字段作为表的主键。
type User struct {
ID string // 名为`ID`的字段会默认作为表的主键
Name string
}
// 使用`AnimalID`作为主键
type Animal struct {
AnimalID int64 `gorm:"primary_key"`
Name string
Age int64
}
表名(Table Name)
表名默认就是结构体名称的复数,例如:
type User struct {} // 默认表名是 `users`
// 将 User 的表名设置为 `profiles`
func (User) TableName() string {
return "profiles"
}
func (u User) TableName() string {
if u.Role == "admin" {
return "admin_users"
} else {
return "users"
}
}
// 禁用默认表名的复数形式,如果置为 true,则 `User` 的默认表名是 `user`
db.SingularTable(true)
也可以通过 Table()
指定表名:
// 使用User结构体创建名为`deleted_users`的表
db.Table("deleted_users").CreateTable(&User{})
var deleted_users []User
db.Table("deleted_users").Find(&deleted_users)
SELECT * FROM deleted_users;
db.Table("deleted_users").Where("name = ?", "jinzhu").Delete()
DELETE FROM deleted_users WHERE name = 'jinzhu';
GORM还支持更改默认表名称规则:
gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string {
return "prefix_" + defaultTableName;
}
列名(Column Name)
列名由字段名称进行下划线分割来生成
type User struct {
ID uint // column name is `id`
Name string // column name is `name`
Birthday time.Time // column name is `birthday`
CreatedAt time.Time // column name is `created_at`
}
可以使用结构体tag指定列名:
type Animal struct {
AnimalId int64 `gorm:"column:beast_id"` // set column name to `beast_id`
Birthday time.Time `gorm:"column:day_of_the_beast"` // set column name to `day_of_the_beast`
Age int64 `gorm:"column:age_of_the_beast"` // set column name to `age_of_the_beast`
}
时间戳跟踪
CreatedAt
如果模型有 CreatedAt
字段,该字段的值将会是初次创建记录的时间。
db.Create(&user) // `CreatedAt`将会是当前时间
// 可以使用`Update`方法来改变`CreateAt`的值
db.Model(&user).Update("CreatedAt", time.Now())
UpdatedAt
如果模型有 UpdatedAt
字段,该字段的值将会是每次更新记录的时间。
db.Save(&user) // `UpdatedAt`将会是当前时间
db.Model(&user).Update("name", "jinzhu") // `UpdatedAt`将会是当前时间
DeletedAt
如果模型有 DeletedAt
字段,调用 Delete
删除该记录时,将会设置 DeletedAt
字段为当前时间,而不是直接将记录从数据库中删除。
示例
package main
import (
"database/sql"
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/mysql"
"time"
)
// UserInfo --> 数据表
type UserInfo struct {
ID uint
Name string
Gender string
Hobby string
}
// 定义模型
type User struct {
gorm.Model // 内嵌gorm.Model
Name string
Age sql.NullInt64 `gorm:"column:user_age"` // 零值类型
Birthday *time.Time
Email string `gorm:"type:varchar(100);unique_index"`
Role string `gorm:"size:255"` // 设置字段大小为255
MemberNumber *string `gorm:"unique;not null"` // 设置会员号(member number)唯一并且不为空
Num int `gorm:"AUTO_INCREMENT"` // 设置 num 为自增类型
Address string `gorm:"index:addr"` // 给address字段创建名为addr的索引
IgnoreMe int `gorm:"-"` // 忽略本字段
}
type Animal struct {
AnimalID int64 `gorm:"primary_key"`
Name string
Age int64
}
func (Animal) TableName() string {
return "qimi"
}
func main() {
// 修改默认的表名规则
gorm.DefaultTableNameHandler = func(db *gorm.DB, defaultTableName string) string {
return "SMS_" + defaultTableName
}
// 连接MySQL数据库
db, err := gorm.Open("mysql", "root:SHANG6688@(127.0.0.1:3306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
if err != nil {
panic(err)
}
defer db.Close()
db.SingularTable(true) // 禁用复数
db.AutoMigrate(&User{})
db.AutoMigrate(&Animal{})
// 使用User结构体创建名叫 xiaowangzi 的表
db.Table("xiaowangzi").CreateTable(&User{})
}