天天看点
返回

gorm使用总结

              时间也会有差错，也会出故障，它也能被撕成碎片，在一间屋子里留下一块永恒的碎屑。

                                                                                                         ——马尔克斯

目录

gorm操作的db实例

初始化表

普通查询

使用原生SQL

创建操作

修改操作

删除操作

校验是否存在

操作时忽略某属性

gorm结构体Tag

自定义列名称

使用过程中的一些坑

gorm操作的db实例 

var db *gorm.DB

初始化表 

     
  1.  //待创建的表对应的结构体       
    2.       
  2.  var tables = []             interface{}{       
    3.       
  3.  &model.Customer{},       
    4.       
  4.  &model.Order{},       
    5.       
  5.  &model.OrderItem{},       
    6.       
  6.  }       
    7.           
  7.  var gdb *gorm.DB       
    8.           
  8.  func Connection() *gorm.DB {       
    9.       
  9.  return gdb       
    10.       
  10.  }       
    11.       
  11.  var conn = config.Connection()       
    12.           
  12.  func InitTable() {       
    13.       
  13.  err := CheckTable()       
    14.       
  14.  if err !=              nil {       
    15.       
  15.  log.Fatal(             "check table err: ", err.Error())       
    16.       
  16.  }       
    17.       
  17.  log.Println(             "check table completed!")       
    18.       
  18.  }       
    19.           
  19.  func CheckTable() error {       
    20.       
  20.  var err error       
    21.       
  21.  for _, table :=              range tables {       
    22.       
  22.  flag := conn.HasTable(table)       
    23.       
  23.  if !flag {       
    24.       
  24.  err = conn.CreateTable(table).Error       
    25.       
  25.  if err !=              nil {       
    26.       
  26.  log.Fatal(             "create table err: ", err.Error())       
    27.       
  27.  break       
    28.       
  28.  }       
    29.       
  29.  log.Printf(             "create table %v success.", table)       
    30.       
  30.  continue       
    31.       
  31.  }       
    32.       
  32.  }       
    33.       
  33.  return err       
    34.       
  34.  }       
    35.

普通查询 

     
  1.  func GetGroupByIDInternal(id string) (group model.MsGroup, err error) (error){       
    2.       
  2.  db := config.Connection()       
    3.       
  3.  return db.Where(             "id = ?", id).Find(&group).Error       
    4.       
  4.  }       
    5.

说明：

1，model.MsGroup 是与数据库表对应的结构体，以上代码查询的就是ms_group表中的数据,

2，条件是以id查询,

3，一般在查询的最后使用.Error()来返回错误，查到的所有数据会存到Find方法的参数group这个对象中。

4，有几个参数就有几个?

使用原生SQL 

     
  1.  //查询       
    2.       
  2.  func ListCatalogAppByProjectIdInternal(projectID string) (gc []model.MsGroupCatalogApp, err error) {       
    3.       
  3.  err = config.Connection().Raw(             "SELECT * FROM ms_group_catalog_app WHERE deleted_at IS NULL " +       
    4.       
  4.  "AND parent_group_id IN (SELECT id FROM ms_group WHERE deleted_at IS NULL AND project_id = ?);", projectID).Find(&gc).Error       
    5.       
  5.  return gc, err       
    6.       
  6.  }       
    7.           
  7.  //其他增删改操作       
    8.       
  8.  db.Exec(             "UPDATE orders SET shipped_at=? WHERE id IN (?)", time.Now, []             int64{             ,             ,             })       
    9.

说明：

1，以上代码查询的是ms_group_catalog_app这个表中的数据，且按自定义需求使用自己写的SQL，

2，除过使用db.Raw("SQL语句").Find(&对象) 能执行查询SQL，也可使用

db.Raw("sql语句"，变量).Scan(&存放的结构体对象)

来执行查询。

创建操作 

     
  1.  func CreateGroupCatalogAppInternal(data model.MsGroupCatalogApp) error {       
    2.       
  2.  return config.Connection().Create(&data).Error       
    3.       
  3.  }       
    4.

说明：data是你要创建ms_group_catalog_app这个表的待插入记录

修改操作 

     
  1.  //修改所传的       
    2.       
  2.  func updateReceiver(receiver *model.Receiver)error{       
    3.       
  3.  return config.Connection().Model(receiver).Where(             "id = ?",receiver.Id).Update(receiver).Error       
    4.       
  4.  }       
    5.           
  5.  //只修改表中某1列值，如只修改allow_create的值       
    6.       
  6.  func UpdateClusterConfigInternal(conf model.ClusterConfig, tx *gorm.DB) error {       
    7.       
  7.  if tx !=              nil {       
    8.       
  8.  return tx.Model(&conf).Where(             "cluster_id = ?", conf.ClusterID).Update(             "allow_create", conf.AllowCreate).Error       
    9.       
  9.  }       
    10.       
  10.  return config.Connection().Model(&conf).Where(             "cluster_id = ?", conf.ClusterID).Update(             "allow_create", conf.AllowCreate).Error       
    11.       
  11.  }       
    12.       
  12.  //UPDATE cluster_config SET allow_create=conf.AllowCreate, updated_at='2019-7-26 15:34:10' WHERE cluster_id = conf.ID       
    13.           
  13.  //修改多个值       
    14.       
  14.  func UpdateNormsInternal(norm model.ContainerNorms, tx *gorm.DB) error {       
    15.       
  15.  if tx !=              nil {       
    16.       
  16.  return tx.Model(&norm).Where(             "id = ?", norm.ID).       
    17.       
  17.  Omit(             "is_default",              "created_at").       
    18.       
  18.  Updates(             map[             string]             interface{}{             "cpu": norm.Cpu,              "memory": norm.Memory}).Error       
    19.       
  19.  }       
    20.       
  20.  return config.Connection().Model(&norm).Where(             "id = ?", norm.ID).       
    21.       
  21.  Omit(             "is_default",              "created_at").       
    22.       
  22.  Updates(             map[             string]             interface{}{             "cpu": norm.Cpu,              "memory": norm.Memory}).Error       
    23.       
  23.  }       
    24.       
  24.  //UPDATE container_norms SET memory= norm.Memory,cpu= norm.Cpu, updated_at='2019-7-26 15:34:10' WHERE id = norm.ID       
    25.

说明：使用Save()方法也能达到目的，但Save()操作的是所有列，慎用。

删除操作 

     
  1.  func delReceiver(id string)error{       
    2.       
  2.  return config.Connection().Where(             "id = ?",id).Delete(&model.Receiver{}).Error       
    3.       
  3.  }       
    4.

校验是否存在 

     
  1.  func CheckReceiverExistByName(Name string)bool{       
    2.       
  2.  return config.Connection().Where(             "name = ?",Name).Find(&model.Receiver{}).RecordNotFound()       
    3.       
  3.  }       
    4.

在查询最后使用.RecordNotFound()可直接得知该条记录是否存在，返回true则表示没有这条记录，返回false则表明该条数据已存在。

操作时忽略某属性 

     
  1.  func UpdateGroupInternal(group model.MsGroup, tx *gorm.DB) error {       
    2.       
  2.  return config.Connection().Model(&group).Where(             "id = ?", group.ID).Omit(             "name",              "created_at",              "project_id").Save(&group).Error       
    3.       
  3.  }       
    4.

使用Omit方法，以上代码是修改操作，修改时将不会修改name，created_at， project_id这三项属性。

gorm结构体Tag 

     
  1.  type Model              struct {       
    2.       
  2.  ID                     string              `gorm:"primary_key"`       
    3.       
  3.  CreatedAt              int64       
    4.       
  4.  UpdatedAt *time.Time              `json:"UpdatedAt,omitempty"`       
    5.       
  5.  DeletedAt *time.Time              `sql:"index" json:"-"`       
    6.       
  6.  }       
    7.           
  7.  type MsGroup              struct {       
    8.       
  8.  Model       
    9.       
  9.  Name                     string                    `json:"name" gorm:"not null"`       
    10.       
  10.  ProjectID                string                    `json:"projectId" gorm:"not null"`       
    11.       
  11.  Description              string                    `json:"description"`       
    12.       
  12.  Workloads   []Workload                `json:"workloads" gorm:"-"`       
    13.       
  13.  CatalogApps []CatalogApp              `json:"catalogApps" gorm:"-"`       
    14.       
  14.  }       
    15.

使用``来写tag，gorm的tag以gorm开头，如果属性是主键，标注gorm:"primary_key" ；如果使用了gorm:"-"则表示有关于gorm的操作时忽略这个字段，比如建表时。

常用Tag如下表：

tag名称 含义
gorm:"primary_key" 主键
gorm:"not null" 该属性不能为空
gorm:"AUTO_INCREMENT" 该属性自增
gorm:"size:255" 对应的表中长度大小
gorm:"-" 忽略该属性
gorm:"not null;unique" 设置字段非空且唯一  
gorm:"type:text" 表的该列类型为text

自定义列名称

默认情况下（不加指定tag时），建表后的列名如下：

     
  1.  type User              struct {       
    2.       
  2.  ID              uint                          // 列名为 `id`       
    3.       
  3.  Name              string                      // 列名为 `name`       
    4.       
  4.  Birthday time.Time               // 列名为 `birthday`       
    5.       
  5.  CreatedAt time.Time              // 列名为 `created_at`       
    6.       
  6.  }       
    7.

如果需要自定义列名：

     
  1.  type Animal              struct {       
    2.       
  2.  AnimalId                 int64                  `gorm:"column:beast_id"`                      // 设置列名为`beast_id`       
    3.       
  3.  Birthday    time.Time              `gorm:"column:day_of_the_beast"`              // 设置列名为`day_of_the_beast`       
    4.       
  4.  Age                      int64                  `gorm:"column:age_of_the_beast"`              // 设置列名为`age_of_the_beast`       
    5.       
  5.  }       
    6.

即，使用`gorm:"column:name"`

使用过程中的一些坑

1，.Count()函数在特定情况下返回的记录数量不是正确的值

解决办法：调整语句，查询多次，分别查询

2，deleted_at是Model结课体的既定字段，删除记录时表的该条记录不会实际删除，而是deleted_at置为非空（删除操作时的时间），此时如果你的表结构设计的有些纰漏，那么功能就会有bug，如ID字段使用未来可能继续出现的值时。

解决办法：重新调整列功能及值，增加列

3，当对含有布尔值的结构体进行修改操作时，且修改到了这一列，那么此时使用.Update(&结构体变量)是不生效的，不生效体现为修改为true时能正常修改，修改为false时数据库中值不变。那么这种情况怎么解决？看上面列举的修改操作的几种情况就可以了。

              时间也会有差错，也会出故障，它也能被撕成碎片，在一间屋子里留下一块永恒的碎屑。

                                                                                                         ——马尔克斯

目录

gorm操作的db实例

初始化表

普通查询

使用原生SQL

创建操作

修改操作

删除操作

校验是否存在

操作时忽略某属性

gorm结构体Tag

自定义列名称

使用过程中的一些坑

gorm操作的db实例 

var db *gorm.DB

初始化表 

     
  1.  //待创建的表对应的结构体       
    2.       
  2.  var tables = []             interface{}{       
    3.       
  3.  &model.Customer{},       
    4.       
  4.  &model.Order{},       
    5.       
  5.  &model.OrderItem{},       
    6.       
  6.  }       
    7.           
  7.  var gdb *gorm.DB       
    8.           
  8.  func Connection() *gorm.DB {       
    9.       
  9.  return gdb       
    10.       
  10.  }       
    11.       
  11.  var conn = config.Connection()       
    12.           
  12.  func InitTable() {       
    13.       
  13.  err := CheckTable()       
    14.       
  14.  if err !=              nil {       
    15.       
  15.  log.Fatal(             "check table err: ", err.Error())       
    16.       
  16.  }       
    17.       
  17.  log.Println(             "check table completed!")       
    18.       
  18.  }       
    19.           
  19.  func CheckTable() error {       
    20.       
  20.  var err error       
    21.       
  21.  for _, table :=              range tables {       
    22.       
  22.  flag := conn.HasTable(table)       
    23.       
  23.  if !flag {       
    24.       
  24.  err = conn.CreateTable(table).Error       
    25.       
  25.  if err !=              nil {       
    26.       
  26.  log.Fatal(             "create table err: ", err.Error())       
    27.       
  27.  break       
    28.       
  28.  }       
    29.       
  29.  log.Printf(             "create table %v success.", table)       
    30.       
  30.  continue       
    31.       
  31.  }       
    32.       
  32.  }       
    33.       
  33.  return err       
    34.       
  34.  }       
    35.

普通查询 

     
  1.  func GetGroupByIDInternal(id string) (group model.MsGroup, err error) (error){       
    2.       
  2.  db := config.Connection()       
    3.       
  3.  return db.Where(             "id = ?", id).Find(&group).Error       
    4.       
  4.  }       
    5.

说明：

1，model.MsGroup 是与数据库表对应的结构体，以上代码查询的就是ms_group表中的数据,

2，条件是以id查询,

3，一般在查询的最后使用.Error()来返回错误，查到的所有数据会存到Find方法的参数group这个对象中。

4，有几个参数就有几个?

使用原生SQL 

     
  1.  //查询       
    2.       
  2.  func ListCatalogAppByProjectIdInternal(projectID string) (gc []model.MsGroupCatalogApp, err error) {       
    3.       
  3.  err = config.Connection().Raw(             "SELECT * FROM ms_group_catalog_app WHERE deleted_at IS NULL " +       
    4.       
  4.  "AND parent_group_id IN (SELECT id FROM ms_group WHERE deleted_at IS NULL AND project_id = ?);", projectID).Find(&gc).Error       
    5.       
  5.  return gc, err       
    6.       
  6.  }       
    7.           
  7.  //其他增删改操作       
    8.       
  8.  db.Exec(             "UPDATE orders SET shipped_at=? WHERE id IN (?)", time.Now, []             int64{             ,             ,             })       
    9.

说明：

1，以上代码查询的是ms_group_catalog_app这个表中的数据，且按自定义需求使用自己写的SQL，

2，除过使用db.Raw("SQL语句").Find(&对象) 能执行查询SQL，也可使用

db.Raw("sql语句"，变量).Scan(&存放的结构体对象)

来执行查询。

创建操作 

     
  1.  func CreateGroupCatalogAppInternal(data model.MsGroupCatalogApp) error {       
    2.       
  2.  return config.Connection().Create(&data).Error       
    3.       
  3.  }       
    4.

说明：data是你要创建ms_group_catalog_app这个表的待插入记录

修改操作 

     
  1.  //修改所传的       
    2.       
  2.  func updateReceiver(receiver *model.Receiver)error{       
    3.       
  3.  return config.Connection().Model(receiver).Where(             "id = ?",receiver.Id).Update(receiver).Error       
    4.       
  4.  }       
    5.           
  5.  //只修改表中某1列值，如只修改allow_create的值       
    6.       
  6.  func UpdateClusterConfigInternal(conf model.ClusterConfig, tx *gorm.DB) error {       
    7.       
  7.  if tx !=              nil {       
    8.       
  8.  return tx.Model(&conf).Where(             "cluster_id = ?", conf.ClusterID).Update(             "allow_create", conf.AllowCreate).Error       
    9.       
  9.  }       
    10.       
  10.  return config.Connection().Model(&conf).Where(             "cluster_id = ?", conf.ClusterID).Update(             "allow_create", conf.AllowCreate).Error       
    11.       
  11.  }       
    12.       
  12.  //UPDATE cluster_config SET allow_create=conf.AllowCreate, updated_at='2019-7-26 15:34:10' WHERE cluster_id = conf.ID       
    13.           
  13.  //修改多个值       
    14.       
  14.  func UpdateNormsInternal(norm model.ContainerNorms, tx *gorm.DB) error {       
    15.       
  15.  if tx !=              nil {       
    16.       
  16.  return tx.Model(&norm).Where(             "id = ?", norm.ID).       
    17.       
  17.  Omit(             "is_default",              "created_at").       
    18.       
  18.  Updates(             map[             string]             interface{}{             "cpu": norm.Cpu,              "memory": norm.Memory}).Error       
    19.       
  19.  }       
    20.       
  20.  return config.Connection().Model(&norm).Where(             "id = ?", norm.ID).       
    21.       
  21.  Omit(             "is_default",              "created_at").       
    22.       
  22.  Updates(             map[             string]             interface{}{             "cpu": norm.Cpu,              "memory": norm.Memory}).Error       
    23.       
  23.  }       
    24.       
  24.  //UPDATE container_norms SET memory= norm.Memory,cpu= norm.Cpu, updated_at='2019-7-26 15:34:10' WHERE id = norm.ID       
    25.

说明：使用Save()方法也能达到目的，但Save()操作的是所有列，慎用。

删除操作 

     
  1.  func delReceiver(id string)error{       
    2.       
  2.  return config.Connection().Where(             "id = ?",id).Delete(&model.Receiver{}).Error       
    3.       
  3.  }       
    4.

校验是否存在 

     
  1.  func CheckReceiverExistByName(Name string)bool{       
    2.       
  2.  return config.Connection().Where(             "name = ?",Name).Find(&model.Receiver{}).RecordNotFound()       
    3.       
  3.  }       
    4.

在查询最后使用.RecordNotFound()可直接得知该条记录是否存在，返回true则表示没有这条记录，返回false则表明该条数据已存在。

操作时忽略某属性 

     
  1.  func UpdateGroupInternal(group model.MsGroup, tx *gorm.DB) error {       
    2.       
  2.  return config.Connection().Model(&group).Where(             "id = ?", group.ID).Omit(             "name",              "created_at",              "project_id").Save(&group).Error       
    3.       
  3.  }       
    4.

使用Omit方法，以上代码是修改操作，修改时将不会修改name，created_at， project_id这三项属性。

gorm结构体Tag 

     
  1.  type Model              struct {       
    2.       
  2.  ID                     string              `gorm:"primary_key"`       
    3.       
  3.  CreatedAt              int64       
    4.       
  4.  UpdatedAt *time.Time              `json:"UpdatedAt,omitempty"`       
    5.       
  5.  DeletedAt *time.Time              `sql:"index" json:"-"`       
    6.       
  6.  }       
    7.           
  7.  type MsGroup              struct {       
    8.       
  8.  Model       
    9.       
  9.  Name                     string                    `json:"name" gorm:"not null"`       
    10.       
  10.  ProjectID                string                    `json:"projectId" gorm:"not null"`       
    11.       
  11.  Description              string                    `json:"description"`       
    12.       
  12.  Workloads   []Workload                `json:"workloads" gorm:"-"`       
    13.       
  13.  CatalogApps []CatalogApp              `json:"catalogApps" gorm:"-"`       
    14.       
  14.  }       
    15.

使用``来写tag，gorm的tag以gorm开头，如果属性是主键，标注gorm:"primary_key" ；如果使用了gorm:"-"则表示有关于gorm的操作时忽略这个字段，比如建表时。

常用Tag如下表：

tag名称 含义
gorm:"primary_key" 主键
gorm:"not null" 该属性不能为空
gorm:"AUTO_INCREMENT" 该属性自增
gorm:"size:255" 对应的表中长度大小
gorm:"-" 忽略该属性
gorm:"not null;unique" 设置字段非空且唯一  
gorm:"type:text" 表的该列类型为text

自定义列名称

默认情况下（不加指定tag时），建表后的列名如下：

     
  1.  type User              struct {       
    2.       
  2.  ID              uint                          // 列名为 `id`       
    3.       
  3.  Name              string                      // 列名为 `name`       
    4.       
  4.  Birthday time.Time               // 列名为 `birthday`       
    5.       
  5.  CreatedAt time.Time              // 列名为 `created_at`       
    6.       
  6.  }       
    7.

如果需要自定义列名：

     
  1.  type Animal              struct {       
    2.       
  2.  AnimalId                 int64                  `gorm:"column:beast_id"`                      // 设置列名为`beast_id`       
    3.       
  3.  Birthday    time.Time              `gorm:"column:day_of_the_beast"`              // 设置列名为`day_of_the_beast`       
    4.       
  4.  Age                      int64                  `gorm:"column:age_of_the_beast"`              // 设置列名为`age_of_the_beast`       
    5.       
  5.  }       
    6.

即，使用`gorm:"column:name"`

使用过程中的一些坑

1，.Count()函数在特定情况下返回的记录数量不是正确的值

解决办法：调整语句，查询多次，分别查询

2，deleted_at是Model结课体的既定字段，删除记录时表的该条记录不会实际删除，而是deleted_at置为非空（删除操作时的时间），此时如果你的表结构设计的有些纰漏，那么功能就会有bug，如ID字段使用未来可能继续出现的值时。

解决办法：重新调整列功能及值，增加列

3，当对含有布尔值的结构体进行修改操作时，且修改到了这一列，那么此时使用.Update(&结构体变量)是不生效的，不生效体现为修改为true时能正常修改，修改为false时数据库中值不变。那么这种情况怎么解决？看上面列举的修改操作的几种情况就可以了。

上一篇: 你大姨永远是你大姨！51岁失婚，根本没在怕。穿着紧身豹纹裙+名牌“恨天高”，跟姐妹们外出嗨皮。《摩登家庭》女星索菲娅（S
下一篇: 发现男朋友和前前女友s........