gorm.md · MLcore-Engine/MLcore-Engine

在 GORM 中，uniqueIndex、validate、many2many 等参数用于控制数据库字段的索引、约束、验证及表间关系的管理。下面是对这些参数的详细解释以及其他一些常用的 GORM 参数。

1. uniqueIndex

•	含义: uniqueIndex 用于指定字段在数据库中需要建立唯一索引。即，指定的字段值在数据库中不能重复。
	•	用法:

Username string `gorm:"uniqueIndex" json:"username"`

在这个例子中，Username 字段会在数据库中创建唯一索引，确保每个用户的 Username 都是唯一的。

•	注意: 如果你想为多个字段创建一个唯一的复合索引，可以使用 uniqueIndex 并提供索引的名称：

FirstName string `gorm:"uniqueIndex:idx_name"`
LastName  string `gorm:"uniqueIndex:idx_name"`

上面的代码会为 FirstName 和 LastName 共同创建一个复合的唯一索引，确保它们的组合值是唯一的。

2. validate

•	含义: validate 是一种用于数据验证的标签，通常与第三方库（例如 go-playground/validator）一起使用。它允许你为字段指定验证规则，例如最大长度、最小长度、电子邮件格式等。
	•	用法:

Username string `json:"username" validate:"max=12"`
Password string `json:"password" validate:"min=8,max=20"`
Email    string `json:"email" validate:"email"`

这里 Username 最大长度为 12，Password 长度必须在 8 到 20 之间，Email 必须符合电子邮件格式。

•	常用验证规则：
	•	required: 必须提供值
	•	min: 最小长度/值
	•	max: 最大长度/值
	•	email: 必须是有效的电子邮件格式
	•	url: 必须是有效的 URL

3. many2many

•	含义: many2many 用于定义多对多关系，指定关联表的名称。在多对多关系中，两个模型之间有一个中间表，这个参数用于指定那个中间表的名字。
	•	用法:

type User struct {
    Projects []Project `gorm:"many2many:user_projects;"` // 中间表名为 "user_projects"
}

type Project struct {
    Users []User `gorm:"many2many:user_projects;"` // 同样中间表名为 "user_projects"
}

这个例子表示 User 和 Project 之间有多对多的关系，并且使用了 user_projects 作为中间表。

•	注意: GORM 会自动生成中间表并管理外键。

4. 其他常用的 GORM 参数

(1) primaryKey

•	含义: 用于指定该字段是表的主键。
	•	用法:

ID uint `gorm:"primaryKey"`

(2) autoIncrement

•	含义: 该字段会自动递增，通常用于主键。
	•	用法:

ID uint `gorm:"primaryKey;autoIncrement"`

(3) index

•	含义: 为该字段创建普通索引。
	•	用法:

Username string `gorm:"index"`

(4) not null

•	含义: 强制该字段不能为 NULL。
	•	用法:

Password string `gorm:"not null"`

(5) default

•	含义: 设置字段的默认值。
	•	用法:

Role int `gorm:"default:1"`

(6) column

•	含义: 指定字段在数据库中的列名，如果字段名与数据库列名不一致时可以使用。
	•	用法:

GitHubId string `gorm:"column:github_id"`

(7) foreignKey 和 references

•	含义: 定义外键约束。foreignKey 指定当前表的字段作为外键，references 指定被引用的字段。
	•	用法:

type User struct {
    ID   uint
    Name string
}

type Order struct {
    UserID uint
    User   User `gorm:"foreignKey:UserID;references:ID"`
}

在这个例子中，Order 表的 UserID 字段是 User 表的外键，指向 User 表的 ID 字段。

(8) size

•	含义: 用于设置字符串类型字段的最大长度，主要影响数据库中 varchar 的长度。
	•	用法:

Username string `gorm:"size:255"`

(9) unique

•	含义: 在字段上创建唯一约束。
	•	用法:

Email string `gorm:"unique"`

(10) embedded

•	含义: 嵌入其他结构体，将嵌入的结构体字段作为当前表的一部分存储。
	•	用法:

type Address struct {
    Street string
    City   string
}

type User struct {
    Name    string
    Address Address `gorm:"embedded"`
}

在这个例子中，Address 结构体中的字段会被嵌入到 User 表中。

(11) preload

•	含义: 用于预加载关联表的数据，减少查询次数。
	•	用法:

db.Preload("Orders").Find(&users)

总结

•	索引相关: uniqueIndex、index、primaryKey、unique
	•	字段约束: not null、default、size
	•	关联关系: many2many、foreignKey、references、embedded
	•	验证规则: validate（需要第三方库支持）

这些常用参数使得 GORM 在数据库操作中更加灵活和强大。

唯一索引的作用

唯一索引（Unique Index）的主要作用是在数据库中确保某个字段或一组字段的值是唯一的，即不能出现重复的值。它不仅仅是为了保证数据的唯一性，还有以下几个作用：

1.	保证数据的唯一性:
	•	这是唯一索引最核心的功能，它确保数据库中某个字段（如用户名、邮箱）不会有重复的值。这对于某些业务逻辑至关重要，如用户注册时，用户名或电子邮件地址必须是唯一的。
	2.	提高查询效率:
	•	唯一索引除了保证唯一性之外，还能加速查询。因为索引让数据库能够更快地找到记录，而唯一索引的特性使得它在查找时更加高效。例如，当你通过索引字段进行搜索时，数据库可以快速定位结果。
	3.	强制约束和数据完整性:
	•	唯一索引相当于一种数据完整性约束（Integrity Constraint）。数据库会自动检查插入或更新操作，防止破坏唯一性规则。如果尝试插入重复的值，数据库会返回错误，避免错误数据的产生。

示例

type User struct {
    ID       uint   `gorm:"primaryKey"`
    Username string `gorm:"uniqueIndex" json:"username"`
    Email    string `gorm:"uniqueIndex" json:"email"`
}

在这个例子中，Username 和 Email 都具有唯一索引。这样可以保证用户名和电子邮件在数据库中的唯一性。

复合索引的作用

复合索引（Composite Index）是指在多个字段上创建一个索引，主要作用是在查询时同时使用多个字段进行过滤，以加速查询。

复合索引的使用场景

1.	多字段查询加速:
	•	当你需要经常通过多个字段的组合进行查询时，复合索引可以显著提高查询效率。例如，如果你经常根据 FirstName 和 LastName 的组合来查找用户，使用复合索引比单独的索引更高效。
	2.	优化范围查询:
	•	复合索引可以优化范围查询，比如查询某个范围内的日期和其他字段的组合。多个条件的过滤会让数据库在数据查找时变得更高效。
	3.	排序和分组优化:
	•	当你的查询需要对多个字段进行排序或分组时，复合索引也能提高性能。

复合索引的使用方式

在 GORM 中，复合索引的使用非常简单。你可以使用 Index 或 uniqueIndex 结合多个字段创建复合索引。复合索引要求多个字段的组合值必须是唯一的，而不要求单独的字段唯一。

复合索引的定义方法

假设你有一个用户表，用户可能具有相同的 FirstName 和 LastName，但不能有相同的 FirstName、LastName 和 Email 的组合。你可以这样定义复合索引：

type User struct {
    ID        uint   `gorm:"primaryKey"`
    FirstName string `gorm:"index:idx_name_email"` // part of composite index
    LastName  string `gorm:"index:idx_name_email"` // part of composite index
    Email     string `gorm:"uniqueIndex:idx_name_email"` // unique composite index
}

在这个例子中，FirstName、LastName 和 Email 共同构成一个唯一的复合索引，确保数据库中不会存在相同的 FirstName、LastName 和 Email 的组合记录。

复合索引的查询顺序

复合索引的字段顺序非常重要，它会影响查询的效率。数据库首先会根据复合索引中的第一个字段进行查找，然后再根据第二个字段优化查询。因此，创建复合索引时，应将查询最常用的字段放在前面。

例如，如果你最常用的查询是：

SELECT * FROM users WHERE FirstName = 'John' AND LastName = 'Doe';

将 FirstName 放在复合索引的第一位是合理的。

GORM 中的复合索引示例

如果你想创建一个普通的复合索引而不是唯一索引，可以这样做：

type User struct {
    FirstName string `gorm:"index:idx_name"` // part of composite index
    LastName  string `gorm:"index:idx_name"` // part of composite index
}

这个示例中，FirstName 和 LastName 共同构成了一个复合索引，提升了查询效率，但不要求组合唯一。

总结

•	唯一索引 的主要作用是确保字段的唯一性，同时提高查询效率。
	•	复合索引 用于对多个字段同时建立索引，加速涉及多个字段的查询。
	•	在设计索引时，考虑查询场景，选择合适的字段组合和顺序来优化查询性能。

在 GORM 中，复合索引和唯一索引都可以通过标签参数在模型结构体中定义。你可以使用 gorm:"index" 和 gorm:"uniqueIndex" 来创建普通复合索引和唯一复合索引。下面会详细解释如何在代码中使用这些索引，以及如何在查询中利用它们。

1. 创建唯一索引

唯一索引保证指定的字段或字段组合在数据库中不能有重复值。你可以在单个字段上或多个字段的组合上定义唯一索引。

单字段唯一索引

type User struct {
    ID       uint   `gorm:"primaryKey"`
    Username string `gorm:"uniqueIndex" json:"username"`  // 创建唯一索引
    Email    string `gorm:"uniqueIndex" json:"email"`     // 创建唯一索引
}

•	在此代码中，Username 和 Email 字段上分别创建了唯一索引，确保数据库中不会有相同的用户名或电子邮件。
	•	当你插入一条新记录时，如果该记录的 Username 或 Email 与已存在的记录冲突，数据库会抛出错误。

复合唯一索引

复合唯一索引保证多个字段的组合值在数据库中是唯一的，即这几个字段共同作为唯一标识。

type User struct {
    FirstName string `gorm:"uniqueIndex:idx_first_last_email"` // 复合唯一索引的一部分
    LastName  string `gorm:"uniqueIndex:idx_first_last_email"` // 复合唯一索引的一部分
    Email     string `gorm:"uniqueIndex:idx_first_last_email"` // 复合唯一索引的一部分
}

•	在这个例子中，FirstName、LastName 和 Email 三个字段共同构成了一个复合唯一索引，索引名称为 idx_first_last_email。
	•	这意味着在数据库中不会有两条记录的 FirstName、LastName 和 Email 值是相同的组合。

2. 创建普通复合索引

普通复合索引没有唯一性的约束，只是用来加速查询。当你经常需要根据多个字段进行查询时，使用复合索引可以提高查询效率。

复合索引示例

type User struct {
    FirstName string `gorm:"index:idx_first_last"`  // 复合索引的一部分
    LastName  string `gorm:"index:idx_first_last"`  // 复合索引的一部分
}

•	这里 FirstName 和 LastName 字段共同组成了复合索引 idx_first_last。
	•	这个复合索引加速了以 FirstName 和 LastName 组合进行的查询，但不会对字段的唯一性做约束。

3. 在查询中使用索引

虽然索引是后台数据库的机制，GORM 不需要特别的代码来“使用”索引。你只需要正常写查询，数据库会自动使用最优的索引来优化查询过程。

单字段查询（唯一索引）

当你对使用唯一索引的字段进行查询时，数据库会自动利用索引来加速查询。

// 根据唯一的用户名进行查询
var user User
db.Where("username = ?", "john_doe").First(&user)

多字段查询（复合索引）

如果你创建了复合索引（或复合唯一索引），当查询中使用到了这些索引的字段时，数据库会自动使用该索引。

// 根据 FirstName 和 LastName 进行查询，复合索引将优化查询速度
var users []User
db.Where("first_name = ? AND last_name = ?", "John", "Doe").Find(&users)

由于 first_name 和 last_name 上有复合索引，查询会更快。

4. 示例：复合唯一索引的插入操作

当插入一条记录时，唯一索引或复合唯一索引会自动确保数据的唯一性：

// 插入新用户
user := User{
    FirstName: "John",
    LastName:  "Doe",
    Email:     "john.doe@example.com",
}

if err := db.Create(&user).Error; err != nil {
    fmt.Println("Insert error:", err)  // 如果 FirstName + LastName + Email 组合不唯一，将返回错误
}

如果你尝试插入一条与数据库中现有记录具有相同 FirstName、LastName 和 Email 组合的记录，数据库会抛出唯一性冲突错误。

5. 完整示例

假设你要管理一个用户和他们的项目，用户与项目之间有多对多关系，并且每个用户在每个项目中的角色是唯一的（即，一个用户不能在同一个项目中有多个角色）。你可以使用复合唯一索引来确保用户在某个项目中的唯一性。

type UserProject struct {
    UserID    uint `gorm:"primaryKey"`
    ProjectID uint `gorm:"primaryKey"`
    Role      int  `gorm:"type:int;default:1"`

// 确保 UserID 和 ProjectID 的组合是唯一的
    gorm.Model
    User      User   `gorm:"foreignKey:UserID"`
    Project   Project `gorm:"foreignKey:ProjectID"`

// 复合唯一索引，确保同一个用户在同一个项目中只有一个角色
    gorm:"uniqueIndex:user_project_role"
}

在这个例子中：

•	UserID 和 ProjectID 共同构成一个复合唯一索引，确保每个用户在每个项目中只能有一条记录（即用户在同一个项目中只能有一个角色）。
	•	UserID 和 ProjectID 字段加上 Role 字段可以作为联合索引，确保组合的唯一性。

6. 在数据库中的效果

你在代码中使用 gorm:"uniqueIndex" 或 gorm:"index" 定义索引后，GORM 会在迁移时自动为你在数据库中创建相应的索引。通过查询数据库表结构，你可以看到这些索引的创建情况。

•	查看唯一索引：

SHOW INDEX FROM users WHERE Non_unique = 0;

•	查看复合索引：

SHOW INDEX FROM users;

总结

•	唯一索引 (uniqueIndex) 保证字段或字段组合的唯一性，适合用于用户名、邮箱等要求唯一的字段。
	•	复合索引 (index) 在多个字段上建立索引，优化多字段查询，适合常见的多字段过滤场景。
	•	复合唯一索引 确保字段组合值的唯一性，适用于业务逻辑需要多字段组合唯一的场景。

在代码中，你可以通过在模型字段上使用 gorm:"index" 和 gorm:"uniqueIndex" 标签来创建索引，并且数据库会自动优化查询，无需手动控制索引的使用。

MLcore-Engine/MLcore-Engine

简介

发行版

贡献者

近期动态

MLcore-Engine/MLcore-Engine .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

MLcore-Engine/MLcore-Engine