Go 语言编程 — gorm 的数据完整性约束

目录

前言

本文基于 PostgreSQL 和 GORM 1.9 版本。GORM v2 对下文中的不足进行了优化。

全新的 Migrator：允许为关系创建数据库外键，更智能的 AutoMigrate，支持约束、检查器，增强索引支持。

实体完整性（主键约束）

每个关系（表）至少存在一个主键（Primary Key），主键值必须唯一，且不允许为 NULL。

type Product struct {
	gorm.Model
    Code 	string `gorm:"primary_key"`
    Price 	uint
    ...
}

grom.Model 是 GORM 内建的 Struct，用于实现软删除，如下：

type Model struct {
    ID uint `gorm:"primary_key"`
    CreatedAt time.Time
    UpdatedAt time.Time
    DeletedAt *time.Time `sql:"index"`
}

可见，Model Struct Product 具有两个 primary_key：CONSTRAINT products_pkey PRIMARY KEY (code, id)。

因此，GORM 实现了完全的实体完整性支持，即可以支持字段主键，也可以支持联合主键。

用户定义完整性（非空约束、唯一约束、检查约束和默认值）

又称为域完整性。指数据库表中的列必须满足某种特定的数据类型或约束，包括：字段类型、值域、小数位数、CHECK、FOREIGN KEY 约束和 DEFAULT、 NOT NULL。它们有的定义在字段上，有的定义在表上。例如：FOREIGN KEY 约束在 PostgresSQL 中，就是在表级别定义的；而字段类型、长度、小数位数就是在字段上定义的。

GORM 通过 Struct Tag 来支持用户定义完整性：

`gorm:"xxx"`

xxx 可以使用 type、size、precision、not null、default 等 Tags 类型。

其中 Check 约束需要使用到 sql tag，例如：

UserID uint `sql:"type:integer check(code!='')"`

它会被定义到表上：

ALTER TABLE public.products
    ADD CONSTRAINT products CHECK (code <> ''::text);

参照完整性（外键约束）

通过定义 Model Struct 创建了一个 products belongs to user 的 Belong to 一对一关系。

// 主表
type User struct {
    gorm.Model
    Code string `gorm:"primary_key"`
    Name string
}

// 从表
type Product struct {
    gorm.Model
    Code 	string `gorm:"primary_key"`
    Price 	uint
    UserID 	uint
    User 	User
}

AutoMigrate 的时候会执行 SQL 语句创建 products（从）表：

CREATE TABLE "products" 
(
	"code" text,
	"price" integer,
	"user_id" integer,
	"id" serial,
	"created_at" timestamp with time zone,
	"updated_at" timestamp with time zone,
	"deleted_at" timestamp with time zone , 
	PRIMARY KEY ("id")
)

可见，GORM 没有添加任何约束。按照 GORM 的文档，这就是 belongs to 的标准定义，它不添加外键约束。

尝试显式的指定 foreignkey Tag：

type Product struct {
    Code 	string 	`gorm:"primary_key"`
    Price 	uint
    UserID 	uint
    User 	User	`gorm:"foreignkey:UserID;association_foreignkey:ID"`
    gorm.Model
}

type User struct {
    Code 	string `gorm:"primary_key"`
    Name 	string
    gorm.Model
}

执行的 SQL 是：

CREATE TABLE "products" 
(
	"code" text,
	"price" integer,
	"user_id" integer,
	"id" serial,
	"created_at" timestamp with time zone,
	"updated_at" timestamp with time zone,
	"deleted_at" timestamp with time zone , 
	PRIMARY KEY ("id")
)	 

可见，GORM 还是没有添加任何外键约束。

因此，可以确定 GORM 的 foreignkey、association_foreignkey tag 并不会添加外键约束。

尝试显式指定 GORM 的 sql tag 来添加外键约束：

type Product struct {
    Code 	string	`gorm:"primary_key"`
    Price 	uint
    UserID 	uint 	`sql:"type:integer REFERENCES users(id) on update no action on delete no action"` // no action 模式外键约束
    User 	User 	`gorm:"foreignkey:UserID;association_foreignkey:ID"`
    gorm.Model
}

type User struct {
    Code string `gorm:"primary_key"`
    Name string
    gorm.Model
}

执行的 SQL 语句：

CREATE TABLE "products"
(
	"code" text,
	"price" integer,
	"user_id" integer REFERENCES users(id) on update no action on delete no action,
	"id" serial,"created_at" timestamp with time zone,
	"updated_at" timestamp with time zone,
	"deleted_at" timestamp with time zone , 
	PRIMARY KEY ("id")
)

可见，从表的外键约束被定义了。也就是说 GORM 1.9 版本如果希望创建表时定义外键（References，参照），那么就需要使用到 sql tag。

注意，sql tag 与 gorm tag 有区别，前者需要硬编码相应的数据库 TableName和 ColumnName，而后者就只需要你使用结构体和其成员名即可。

除了 no action 模式之外，sql tag 同样支持：

• CASCADE（级联）约束方式

UserID uint `sql:"type:integer REFERENCES users(id) on update cascade on delete cascade"`

• SET NULL（设空）约束方式
• RESTRICT（禁止）方式：在 PostgreSQl 中与 no action 具有类似的语义。

另外，使用 sql tag 还可以使用 constraint xxx 自定义外键约束名，即引用名称：

UserID uint `sql:"type:integer constraint ref_name REFERENCES users(id) on update no action on delete no action"`

同样的，GORM 也支持联合外键，这时候就需要使用到 GORM 提供的接口了：

db.Model(&Product{}).AddForeignKey( "user_id,user_code", "users(id,code)", "no action", "no action")

执行 SQL 语句：

CONSTRAINT products_user_id_user_code_users_id_code_foreign FOREIGN KEY (user_code, user_id)
	REFERENCES public.users (code, id) MATCH SIMPLE ON UPDATE NO ACTION ON DELETE NO ACTION

关联关系

一对一、一对多关联，多对多关联不属于完整性范畴，即：RDBMS 不会自动完成数据完整性检查，包括引用的可用性检查，数据的一致性检查等，这些工作都需要有应用层业务逻辑来实现。所以，在逻辑代码中也不需要实现任何完整性约束定义，因此 Model Struct 里也无需添加额外的约束。

一对一、一对多关联

type User struct {
    gorm.Model
    Code 	 string `gorm:"primary_key"`
    Name 	 string
    Products []Product
}

type Product struct {
    gorm.Model
    Code 	string `gorm:"primary_key"`
    Price 	uint
    UserID uint
}

这是典型的一对多定义，users 表无需添加约束字段，product 表也只需要添加 user_id 字段作为外键。这里可以省略，也可以显式的定义 gorm tag：foreignkey 或 association_foreignkey，例如：

type User struct {
    gorm.Model
    Code 	 string 	`gorm:"primary_key"`
    Name 	 string
    Products []Product  `gorm:"foreignkey:UserID"`
}

多对多关联

在关系型数据库中，多对多关系需要一张中间表。

type User struct {
    gorm.Model
    Code 	 string 	`gorm:"primary_key"`
    Name 	 string
    Products []Product  `gorm:"many2many:user_language"`
}

type Product struct {
    gorm.Model
    Code 	string `gorm:"primary_key"`
    Price 	uint
}

会执行 SQL：

CREATE TABLE "user_language"
(
	"user_id" integer,
	"product_id" integer,
	PRIMARY KEY ("user_id","product_id")
)

GORM 会自动创建一张 user_language 连接表（Join Table）。products、users 表的主键，被联合作为 user_language 表的主键。GORM 也会自动的完成 user_id 和 product_id 作为外键的关联。但正如上述所言，外键约束是不会自动完成的。

示例

// 文章表
type Article struct {
	ID 			int 		`json:"id"`
	Title 		string 		`json:"title"`
	CategoryId 	int 		`json:"category_id"`
	Category 	Category 	`json:"category";gorm:"foreignkey:CategoryID"` // 一对多关系
	Tag 		[]Tag 		`gorm:"many2many:article_tag" json:"tag"` // 多对多关系
}

// 文章_标签多对多中间表
// 默认的，article_id 字段对应 article 表 id，tag_id 字段对应 tag 表 id
type ArticleTag struct {
	ID 			int 	`json:"id"`
	ArticleId 	string 	`json:"article_id"`
	TagId 		string 	`json:"tag_id"`
}

// 标签表
type Tag struct {
	ID 		int 	`json:"id" `
  	TagName string 	`json:"tag_name"`
}

// 分类表
type Category struct {
	ID 			 int 	`json:"id"`
	CategoryName string `json:"category_name"`
	Status 		 int 	`json:"status"`
}

• 查一列：

func (a *Article) ListArticle(title string) (Article, error) {
	query := database.GormPool

	var article Article
	query.Where("title like ?", "%"+title+"%").First(&article)
	fmt.Println(article)

	err := query.Model(&article).
		Related(&article.Category).
		Related(&article.Tag, "tag").
		Find(&article).Error

	if err != nil && err != gorm.ErrRecordNotFound {
		return article, nil
	}
	
	return article, err
}

通过 Related 方法，可以查找 belongs to、has one、has many、many to many 关系。

查找一列时，首先是需要先把特定的一条 Article 查询到，然后根据 Article 定义中指定的 CategoryID 去查找 Category 和 Tag。

• 查多列表：

func (a *Article) ListArticle(title string) (articles []Article, err error) {
	query := database.GormPool
    
    err = query.Model(articles).
        Where("title like ?", "%"+title+"%").
        Preload("Category").
        Preload("Tag").Find(&articles).Error
    
    if err != nil && err != gorm.ErrRecordNotFound {
        return
    }
    return
}

查看多列时，使用 Preload 方法可以完成多表关系的预加载，然后再自动执行选择（WHERE）运算。