G0第23章：GORM基本示例、GORM Model定义、主键、表名、列名的约定

04 GORM基本示例

注意:
本文以MySQL数据库为例，讲解GORM各项功能的主要使用方法。
往下阅读本文前，你需要有一个能够成功连接上的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"
	"gorm.io/driver/mysql"
	"gorm.io/gorm"
)
// UserInfo --> 数据表
type UserInfo struct {
	ID uint
	Name string
	Gender string
	Hobby string
}

func main() {
	dsn := "root:DENGni1314@tcp(127.0.0.1:3306)/test?charset=utf8mb4&parseTime=True&loc=Local"
	db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
	if err != nil {
		fmt.Println("database open failed ,err=", err)
		return
	}
	//创建表 自动迁移 （把结构体和数据表进行对应 ）
	db.AutoMigrate(&UserInfo{})

	//创建数据行
	//u1 := UserInfo{1,"天意","男","裸泳"}
	//db.Create(&u1)

	// 查询，将查询出来的数据赋值到u，要更改u所以要加指针
	var u UserInfo
	db.First(&u)  //查询表中的第一条数据保存到u中
	fmt.Printf("u:%#v\n",u)

	// 更新
	db.Model(&u).Update("hobby","money")

	// 删除
	db.Delete(&u)

	var U UserInfo
	db.First(&U)
	fmt.Printf("U:%#v\n",U)
}

02 GORM MODEL模型定义

在使用GORM工具时，通常我们需要再代码中定义模型（model）与数据库中的数据表进行映射，在GORM中模型（Models）通常是正常定义的结构体、基本的go类型或他们的指针。同时也支持 sql.Scanner 及 driver.Valuer 接口。

gorm.Medel

为了方便模型定义，GORM内置了一个 gorm.Model 结构体。 gorm.Model 是一个包含了 ID.CreatAt , UpdatedAt， DeleteAt，四个字段的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
}

之所以使用 *string 而不是 stirng 默认所有字段的零值, 比如 0, ‘’, false 或者其它 零值，不给值，默认使用 mysql 中的 Default 值，使用指针可以避免这种情况。

模型定义示例

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）

示例

06 主键、表名、列名的约定

主键（Primary Key）

GORM默认会使用名为ID的字段作为表的主键。

type User struct{
	ID string // 名为"ID"的字段会默认作为表的主键
	Name string
}
//使用 “AniamID”作为主键
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"
  }
}

也可以通过Table()指定表名：

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 stirng //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) // ‘CreateAt’将会是当前时间

// 可以使用Update 方法来改变 CreateAt的值
db.Model(&user).Update("CreateAt", time.Now())

UpdatedAt

如果模型有UpdatedAt字段，该字段的值将会是每次更新记录的时间。

db.Save(&user) // UpdateAt 将会是当前时间
db.Model(&user).Update("name", "tianyi") //`UpdatedAt`将会是当前时间

DeletedAt

软删除

如果模型有DeletedAt字段，调用Delete删除该记录时，将会设置DeletedAt字段为当前时间，而不是直接将记录从数据库中删除。