GORM入門指南

gorm是一個使用Go語言撰寫的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基本示例

注意:

1. 本文以MySQL資料庫為例，講解GORM各項功能的主要使用方法，
2. 往下閱讀本文前，你需要有一個能夠成功連接上的MySQL資料庫實體，

Docker快速創建MySQL實體

很多同學如果不會安裝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() {
	db, err := gorm.Open("mysql", "root:root1234@(127.0.0.1:13306)/db1?charset=utf8mb4&parseTime=True&loc=Local")
	if err!= nil{
		panic(err)
	}
	defer db.Close()

	// 自動遷移
	db.AutoMigrate(&UserInfo{})

	u1 := UserInfo{1, "七米", "男", "籃球"}
	u2 := UserInfo{2, "沙河娜扎", "女", "足球"}
	// 創建記錄
	db.Create(&u1)
	db.Create(&u2)
	// 查詢
	var u = new(UserInfo)
	db.First(u)
	fmt.Printf("%#v\n", u)

	var uu UserInfo
	db.Find(&uu, "hobby=?", "足球")
	fmt.Printf("%#v\n", uu)

	// 更新
	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
  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欄位為當前時間，而不是直接將記錄從資料庫中洗掉，

標籤：Go

上一篇：GORM CRUD指南

下一篇：Go語言中的單例模式（翻譯）