gorm介绍

什么是orm？

Object-Relationl Mapping，即对象关系映射，这里的Relationl指的是关系型数据库

它的作用是在关系型数据库和对象之间作一个映射，这样，我们在具体的操作数据库的时候，就不需要再去和复杂的SQL语句打交道，只要像平时操作对象一样操作它就可以了 。

gorm

1.Golang写的，GitHub上活跃度很高的orm库

2.特点：

• 全功能ORM;
• 关联(包含一个，包含多个，属于，多对多，多种包含);
• Callbacks(创建/保存/更新/删除/查找之前/之后);
• 预加载;
• 事务
• 复合主键
• SQL Builder
• 自动迁移
• 日志
• 可扩展，编写基于GORM回调的插件
• 每个功能都有测试
• 开发人员友好

安装

go get -u gorm.io/gorm
go get -u gorm.io/driver/sqlite

官方文档

http://gorm.book.jasperxu.com/

连接数据库

GORM 官方支持的数据库类型有： MySQL, PostgreSQL, SQlite, SQL Server
gorm连接数据库

mysql

import (
  "gorm.io/driver/mysql"
  "gorm.io/gorm"
)

func main() {
  // 参考 https://github.com/go-sql-driver/mysql#dsn-data-source-name 获取详情
  dsn := "user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
  db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
}

模型定义

模型定义

模型是标准的 struct，由 Go 的基本数据类型、实现了 Scanner 和 Valuer 接口的自定义类型及其指针或别名组成

例如：

type User struct {
  ID           uint
  Name         string
  Email        *string
  Age          uint8
  Birthday     *time.Time
  MemberNumber sql.NullString
  ActivatedAt  sql.NullTime
  CreatedAt    time.Time
  UpdatedAt    time.Time
}

模型名和表名的映射关系

• 规则
  • 第一个大写字母变为小写
  • 遇到其他大写字母变为小写并且在前面加下划线
  • 连着的几个大写字母，只有第一个遵循上面的两条规则，其他的大写字母转为小写，不加下划线，遇到小写，前面的第一个大写字母变小写并加下划线
  • 复数形式
• 举例
  • User => users 首字母小写，复数
  • UserInfo => user_infos
  • DBUserInfo => db_user_infos
  • DBXXXXUserInfo => dbxxxx_user_infos

在默认表名上加其他规则

// 在默认表名前加sys_前缀

gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string  {
    return "sys_" + defaultTableName;
}

自定义表名：

func (模型) TableName() string{
    return "新的表名"
}

结构体字段名和列名的对应规则

规则 * 列名是字段名的蛇形小写
举例

• Name --> name
• CreatedTime --> create_time
  可以通过gorm标签指定列名，AnimalId int64 gorm:"column:beast_id"

gorm.Model

基本模型定义gorm.Model，包括字段ID，CreatedAt，UpdatedAt，DeletedAt

只需要在自己的模型中指定gorm.Model匿名字段，即可使用上面的四个字段

• gorm.Model.go

package gorm

import "time"

// Model a basic GoLang struct which includes the following fields: ID, CreatedAt, UpdatedAt, DeletedAt
// It may be embedded into your model or you may build your own model without it
//    type User struct {
//      gorm.Model
//    }
type Model struct {
	ID        uint `gorm:"primarykey"`
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt DeletedAt `gorm:"index"`
}

// 添加字段 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`
type User struct {
    gorm.Model
    Name string
}

• ID：主键自增长
• CreatedAt：用于存储记录的创建时间
• UpdatedAt：用于存储记录的修改时间
• DeletedAt：用于存储记录的删除时间

表操作

package main

import (
	"fmt"
	"gorm.io/driver/mysql"
	"gorm.io/gorm" 
)

type User struct {
	Id   int
	Name string
	Age  int
	Addr string
	Pic  string
}

func main() {
	dsn := "root:root123@tcp(127.0.0.1:3306)/test_gorm?charset=utf8mb4&parseTime=True&loc=Local"
	db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
	if err != nil {
		panic(err)
	}
	// 自动迁移
	db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{})

	// 增
	db.Create(&User{
		Name: "张三",
		Age:  18,
		Addr: "北京市",
		Pic:  "/static/img.png",
	})

	// 查
	var user User
	db.First(&user)
	fmt.Println(user) // {1 张三 18 北京市 /static/img.png}

	// 改
	user.Name = "lisi"
	db.Save(&user)
	fmt.Println(user) // {1 lisi 18 北京市 /static/img.png}

	// 删
	db.Delete(&user)
}

自动迁移

自动迁移仅仅会创建表，添加缺少列和索引，并且不会改变现有列的类型或删除未使用的列以保护数据

db.AutoMigrate(&User{}, &Product{}, &Order{})

// 创建表时添加表后缀
db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{})` 

高级选项

结构体标签gorm的使用

type User struct {
  Name string `gorm:"<-:create"` // 允许读和创建
  Name string `gorm:"<-:update"` // 允许读和更新
  Name string `gorm:"<-"`        // 允许读和写（创建和更新）
  Name string `gorm:"<-:false"`  // 允许读，禁止写
  Name string `gorm:"->"`        // 只读（除非有自定义配置，否则禁止写）
  Name string `gorm:"->;<-:create"` // 允许读和写
  Name string `gorm:"->:false;<-:create"` // 仅创建（禁止从 db 读）
  Name string `gorm:"-"`  // 读写操作均会忽略该字段
}

创建/更新时间追踪（纳秒、毫秒、秒、Time）

GORM 约定使用 CreatedAt、UpdatedAt 追踪创建/更新时间。如果您定义了这种字段，GORM 在创建、更新时会自动填充 当前时间
要使用不同名称的字段，您可以配置 autoCreateTim、autoUpdateTim 标签
如果您想要保存 UNIX（毫/纳）秒时间戳，而不是 time，您只需简单地将 time.Time 修改为 int 即可

type User struct {
  CreatedAt time.Time // 在创建时，如果该字段值为零值，则使用当前时间填充
  UpdatedAt int       // 在创建时该字段值为零值或者在更新时，使用当前时间戳秒数填充
  Updated   int64 `gorm:"autoUpdateTime:nano"` // 使用时间戳填纳秒数充更新时间
  Updated   int64 `gorm:"autoUpdateTime:milli"` // 使用时间戳毫秒数填充更新时间
  Created   int64 `gorm:"autoCreateTime"`      // 使用时间戳秒数填充创建时间
}

字段标签

声明 model 时，tag 是可选的，GORM 支持以下 tag： tag 名大小写不敏感，但建议使用 camelCase 风格

多个属性值之间用分号分隔(英文的;):gorm:"size:64;not null"