前言:
gorm是Golang语言中一款性能极好的ORM库,对开发人员相对是比较友好的。当然还有另外一个
xorm库也是比较出名的,感兴趣的也可以看看这个库,接下来主要介绍下
gorm
库的一些基本使用。
GORM介绍和快速入门
功能概览
- 全功能ORM(无限接近)
- 关联(Has One, Has Many, Belongs To, Many To Many, 多态)
- 钩子函数Hook(在创建/保存/更新/删除/查找之前或之后)
- 预加载
- 事务
- 复合主键
- SQL 生成器
- 数据库自动迁移
- 自定义日志
- 可扩展性, 可基于 GORM 回调编写插件
- 所有功能都被测试覆盖
- 开发者友好
安装
我们都知道,在golang中需要使用一些驱动包来对指定数据库进行操作,比如MySQL需要使用github.com/go-sql-driver/mysql
库,而Sqlite需要使用github.com/mattn/go-sqlite3
库来支持,不过好在gorm框架中对各个驱动包进行了简单包装,可以让我们在写程序时可以更方便的管理驱动库.
支持的数据库以及导入路径如下:
- mysql: http://github.com/jinzhu/gorm/dialects/mysql
- postgres: http://github.com/jinzhu/gorm/dialects/postgres
- sqlite: http://github.com/jinzhu/gorm/dialects/sqlite
- sqlserver: http://github.com/jinzhu/gorm/dialects/mssql
注意:
gorm框架只是简单封装了数据库的驱动包,在安装时仍需要下载原始的驱动包
# 由于在项目中使用mysql比较多,这里使用mysql进行数据存储
$ go get -u github.com/jinzhu/gorm
$ go get -u github.com/go-sql-driver/mysql
快速入门
# 使用docker快速创建一个本地可连接的mysql实例
$ docker run -itd -e MYSQL_ROOT_PASSWORD='bgbiao.top' --name go-orm-mysql -p 13306:3306 mysql:5.6
# 登陆mysql并创建一个测试库
$ docker exec -it go-orm-mysql mysql -uroot -pbgbiao.top
....
mysql> create database test_api;
Query OK, 1 row affected (0.00 sec)
mysql> show databases;
+--------------------+
| Database |
+--------------------+
| information_schema |
| mysql |
| performance_schema |
| test_api |
+--------------------+
4 rows in set (0.00 sec)
# 运行一个简单示例
$ cat gorm-mysql-example.go
package main
import (
"fmt"
"time"
"github.com/jinzhu/gorm"
_ "github.com/jinzhu/gorm/dialects/mysql"
)
// 定义一个数据模型(user表)
// 列名是字段名的蛇形小写(PassWd->pass_word)
type User struct {
Id uint `gorm:"AUTO_INCREMENT"`
Name string `gorm:"size:50"`
Age int `gorm:"size:3"`
Birthday *time.Time
Email string `gorm:"type:varchar(50);unique_index"`
PassWord string `gorm:"type:varchar(25)"`
}
var db *gorm.DB
func main() {
db,err := gorm.Open("mysql","root:bgbiao.top@(127.0.0.1:13306)/test_api?charset=utf8&parseTime=True&loc=Local")
if err != nil {
fmt.Errorf("创建数据库连接失败:%v",err)
}
defer db.Close()
// 自动迁移数据结构(table schema)
// 注意:在gorm中,默认的表名都是结构体名称的复数形式,比如User结构体默认创建的表为users
// db.SingularTable(true) 可以取消表名的复数形式,使得表名和结构体名称一致
db.AutoMigrate(&User{})
// 添加唯一索引
db.Model(&User{}).AddUniqueIndex("name_email", "id", "name","email")
// 插入记录
db.Create(&User{Name:"bgbiao",Age:18,Email:"bgbiao@bgbiao.top"})
db.Create(&User{Name:"xxb",Age:18,Email:"xxb@bgbiao.top"})
var user User
var users []User
// 查看插入后的全部元素
fmt.Printf("插入后元素:n")
db.Find(&users)
fmt.Println(users)
// 查询一条记录
db.First(&user,"name = ?","bgbiao")
fmt.Println("查看查询记录:",user)
// 更新记录(基于查出来的数据进行更新)
db.Model(&user).Update("name","biaoge")
fmt.Println("更新后的记录:",user)
// 删除记录
db.Delete(&user)
// 查看全部记录
fmt.Println("查看全部记录:")
db.Find(&users)
fmt.Println(users)
}
# 运行gorm实例
$ go run gorm-mysql-example.go
插入后元素:
[{1 bgbiao 18 <nil> bgbiao@bgbiao.top } {2 xxb 18 <nil> xxb@bgbiao.top }]
查看查询记录: {1 bgbiao 18 <nil> bgbiao@bgbiao.top }
更新后的记录: {1 biaoge 18 <nil> bgbiao@bgbiao.top }
查看全部记录:
[{2 xxb 18 <nil> xxb@bgbiao.top }]
GORM常用的功能函数
自动迁移
注意:
使用自动迁移模式将保持表的更新,但是不会更新索引以及现有列的类型或删除未使用的列
// 同时迁移多个模型
db.AutoMigrate(&User{}, &Product{}, &Order{})
// 创建表时增加相关参数
// 比如修改表的字符类型CHARSET=utf8
db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{})
检查表
// 检查模型是否存在
db.HasTable(&User{})
// 检查表是否存在
db.HasTable("use