当前位置：首页 > news >正文

GO_gorm

news 2025/11/20 5:25:41

gorm

环境准备

安装

go get -u gorm.io/gorm
//根据所用数据库执行相应的指令
go get -u gorm.io/driver/sqlite
go get -u gorm.io/driver/mysql

连接到数据库

方法一：
dsn := "user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
对于匿名字段，GORM 会将其字段包含在父结构体中，例如：
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})方法二：
db, err := gorm.Open(mysql.New(mysql.Config{DSN: "gorm:gorm@tcp(127.0.0.1:3306)/gorm?charset=utf8&parseTime=True&loc=Local",DefaultStringSize: 256, // string 类型字段的默认长度DisableDatetimePrecision: true, // 禁用 datetime 精度，MySQL 5.6 之前的数据库不支持DontSupportRenameIndex: true, // 重命名索引时采用删除并新建的方式，MySQL 5.7 之前的数据库和 MariaDB 不支持重命名索引DontSupportRenameColumn: true, // 用 `change` 重命名列，MySQL 8 之前的数据库和 MariaDB 不支持重命名列SkipInitializeWithVersion: false, // 根据当前 MySQL 版本自动配置
}), &gorm.Config{})

基础
- 模型定义
  - ```
  type User struct {ID           uint           // Standard field for the primary keyName         string         // A regular string fieldEmail        *string        // A pointer to a string, allowing for null valuesAge          uint8          // An unsigned 8-bit integerBirthday     *time.Time     // A pointer to time.Time, can be nullMemberNumber sql.NullString // Uses sql.NullString to handle nullable stringsActivatedAt  sql.NullTime   // Uses sql.NullTime for nullable time fieldsCreatedAt    time.Time      // Automatically managed by GORM for creation timeUpdatedAt    time.Time      // Automatically managed by GORM for update timeignored      string         // fields that aren't exported are ignored
  }
```
- 具体数字类型如 uint、string和 uint8 直接使用。
- 指向 *string 和 *time.Time 类型的指针表示可空字段。
- 来自 database/sql 包的 sql.NullString 和 sql.NullTime 用于具有更多控制的可空字段。
- CreatedAt 和 UpdatedAt 是特殊字段，当记录被创建或更新时，GORM 会自动向内填充当前时间。
- Non-exported fields (starting with a small letter) are not mapped
- 约定
  - 主键：GORM 使用一个名为ID 的字段作为每个模型的默认主键。
  - 表名：默认情况下，GORM 将结构体名称转换为 snake_case 并为表名加上复数形式。 For instance, a User struct becomes users in the database, and a GormUserName becomes gorm_user_names.
  - 列名：GORM 自动将结构体字段名称转换为 snake_case 作为数据库中的列名。
  - 时间戳字段：GORM使用字段 CreatedAt 和 UpdatedAt 来自动跟踪记录的创建和更新时间。
- 预定义结构体

GORM提供了一个预定义的结构体，名为gorm.Model，其中包含常用字段：

// gorm.Model 的定义
typeModel struct {ID        uint           `gorm:"primaryKey"`CreatedAt time.TimeUpdatedAt time.TimeDeletedAt gorm.DeletedAt `gorm:"index"`
}

高级选项
- 嵌入结构体

对于匿名字段，GORM 会将其字段包含在父结构体中，例如：

type Author struct {Name  stringEmail string
}type Blog struct {AuthorID      intUpvotes int32
}
// equals
type Blog struct {ID      int64Name    stringEmail   stringUpvotes int32
}

对于正常的结构体字段，你也可以通过标签 embedded 将其嵌入，例如：

type Author struct {Name  stringEmail string
}type Blog struct {ID      intAuthor  Author `gorm:"embedded"`Upvotes int32
}
// 等效于
type Blog struct {ID    int64Name  stringEmail stringUpvotes  int32
}

并且，您可以使用标签 embeddedPrefix 来为 db 中的字段名添加前缀，例如：

type Blog struct {ID      intAuthor  Author `gorm:"embedded;embeddedPrefix:author_"`Upvotes int32
}
// 等效于
type Blog struct {ID          int64AuthorName stringAuthorEmail stringUpvotes     int32
}

字段标签

标签名	说明
column	指定 db 列名
type	列数据类型，推荐使用兼容性好的通用类型，例如：所有数据库都支持 bool、int、uint、float、string、time、bytes 并且可以和其他标签一起使用，例如：`not null`、`size`, `autoIncrement`… 像 `varbinary(8)` 这样指定数据库数据类型也是支持的。在使用指定数据库数据类型时，它需要是完整的数据库数据类型，如：`MEDIUMINT UNSIGNED not NULL AUTO_INCREMENT`
serializer	指定将数据序列化或反序列化到数据库中的序列化器, 例如: `serializer:json/gob/unixtime`
size	定义列数据类型的大小或长度，例如 `size: 256`
primaryKey	将列定义为主键
unique	将列定义为唯一键
default	定义列的默认值
precision	指定列的精度
scale	指定列大小
not null	指定列为 NOT NULL
autoIncrement	指定列为自动增长
autoIncrementIncrement	自动步长，控制连续记录之间的间隔
embedded	嵌套字段
embeddedPrefix	嵌入字段的列名前缀
autoCreateTime	创建时追踪当前时间，对于 `int` 字段，它会追踪时间戳秒数，您可以使用 `nano`/`milli` 来追踪纳秒、毫秒时间戳，例如：`autoCreateTime:nano`
autoUpdateTime	创建/更新时追踪当前时间，对于 `int` 字段，它会追踪时间戳秒数，您可以使用 `nano`/`milli` 来追踪纳秒、毫秒时间戳，例如：`autoUpdateTime:milli`
index	根据参数创建索引，多个字段使用相同的名称则创建复合索引，查看索引获取详情
uniqueIndex	与 `index` 相同，但创建的是唯一索引
check	创建检查约束，例如 `check:age > 13`，查看约束获取详情
<-	设置字段写入的权限， `<-:create` 只创建、`<-:update` 只更新、`<-:false` 无写入权限、`<-` 创建和更新权限
->	设置字段读的权限，`->:false` 无读权限
-	忽略该字段，`-` 表示无读写，`-:migration` 表示无迁移权限，`-:all` 表示无读写迁移权限
comment	迁移时为字段添加注释