Go语言ORM-gorm学习笔记

Go语言ORM-gorm学习笔记(一)

安装

go get github.com/jinzhu/gorm

连接数据库

导入数据库驱动

import _ "github.com/go-sql-driver/mysql"
import _ "github.com/jinzhu/gorm/dialects/mysql"

MySQL连接

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/mysql"
)

func main () {
  db, err := gorm.Open("mysql", "user:password@(127.0.0.1:3306)/dbname?charset=utf8&parseTime=True&loc=Local")
  if err != nil {
    panic(err)
  }
}

模型定义

模型(Models)通常只是正常的golang structs、基本的go类型或它们的指针。同时也支持sql.Scanner及driver.Valuer接口(interfaces)。

模型(Model)示例:

type User struct { // 表名默认使用结构体名称的复数 users
  gorm.Model // 嵌入gorm.Model gorm.Model 是一个包含了ID,CreatedAt,UpdatedAt,DeletedAt四个字段的go结构体
  Name string `gorm:"column:username;comment:'用户名'"` // 使用tag标记 column 定义字段的名称 使用tag标记 comment 定义字段注释
  Age sql.NullInt64 `gorm:"comment:'年龄'"`
  Birthday *time.Time `gorm:"comment:'生日'"`
  Email string `gorm:"comment:'邮箱';unique_index;type:varchar(100)"` // 使用tag标记 type 定义字段类型和索引 使用tag标记 unique_index 设置唯一索引
  Role string `gorm:"size:255;comment:'角色'"` // 使用tag标记 size 设置字段大小为255
  MemberNumber *string `gorm:"unique;not null;comment:'会员卡号'"` // 使用tag标记 unique 设置唯一 使用tag标记 not null 设置字段属性不为空
  Num int `gorm:"AUTO_INCREMENT;comment:'数量'"` // 使用tag标记 AUTO_INCREMENT 设置字段自增
  Addres string `gorm:"index:addr;comment:'地址'"` // 使用tag标记 index 设置索引名为addr的普通索引
  Ignore int `gorm:"-"` // 使用tag标记 - 忽略该字段
}

结构体标记(tags)

标记(tags)在声明模型时是可选项。

支持的结构体标记(Struct tags)

结构体标记(Tag)

描述

Column

指定列名

Type

指定列数据类型

Size

指定列大小,默认值255

PRIMARY_KEY

将列指定为主键

UNIQUE

将列指定为唯一

DEFAULT

指定列默认值

PRECISION

指定列精度

NOT NULL

将列指定为非NULL

AUTO_INCREMENT

指定列是否为自增类型

INDEX

创建具有或不带名称的索引,如果多个索引同名则创建复合索引

UNIQUE_INDEX

和INDEX类似,只不过创建的是唯一索引

EMBEDDED

将结构设置为嵌入

EMBEDDED_PREFIX

设置嵌入结构的前缀

忽略此字段

补充: COMMENT 字段注释

Go语言ORM-gorm学习笔记(二)

惯例约定

gorm.model

gorm.model是一个包含了ID,CreatedAtUpdatedAtDeletedAt四个字段的Golang结构体。你可以将它嵌入到你自己的模型中,当然你也可以完全使用自己的模型。

// gorm.Model 定义
type Model struct {
ID unit `gorm:"primary_key"` // 字段名为 ID 的字段默认作为表的主键
CreatedAt time.Time
UpdatedAt time.Time
DeletedAt *time.Time
}

ID作为主键

GORM默认会使用名为ID的字段作为表的主键。

type User struct {
ID string // 名为ID的字段会默认作为表的主键
Name string
}

// 使用AnimalID作为主键
type Animal struct {
AnimalID int64 `gorm:"primary_key"`
Name string
Age int64
}

表名

表名默认就是结构体名称的复数,例如:

type User struct {} // 默认表名是users

// 将User的表名设置为profiles
func (User) TableName () string {
if u.Role == "admin" {
        return "admin_users"
} else {
        return "users"
}
}

// 禁用默认表名的复数形式,如果设置true,则User的默认表名是user
db.SingularTable(true)

指定表名称

// 使用User结构体创建名为deleted_users的表
db.Table("deleted_users").CreateTable(&User{})

var deleted_users []User
db.Table("deleted_users").Find(&deleted_users)
// SELECT * FROM deleted_users;

db.Table("deleted_users").WHERE("name=?", "jinzhu").Delete()
// DELETE FROM deleted_users WHERE name='jinzhu';

更改默认表名(table name)

你可以通过定义DefaultTableNameHandler来设置默认表名的命名规则

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

迁移(数据表操作)

自动迁移

自动迁移你的模型,使之保持最新状态。

警告:自动迁移只会创建表、缺失的列、缺失的索引,不会更改现有列的类型或删除未使用的列,以此来保护您的数据。

db.AutoMigrate(&User{})
db.AutoMigrate(&User{}, &Product{}, &Order{}) // 可同时创建多张表

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

模型方法

Has Table

// 检查模型User的表是否存在
db.HasTable(&User{})

// 检查表users是否存在
db.HasTable("users")

Create Table

// 为模型User创建表
db.CreateTable(&User{})

// 创建表时会追加ENGINE=InnoDB到SQL语句中
db.Set("gorm:table_options", "ENGINE=InnoDB").CreateTable(&User{})

Drop Table

// 删除模型User的表
db.DropTable(&User{})

// 删除表users
db.DropTable("users")

// 删除模型User的表和表products
db.DropTableIfExists(&User{}, "products") // 删除多张表,如果表存在则删除

ModifyColumn

修改列类型为给定的值

// 修改模型User的description列的类型为text
db.Model(&User{}).ModifyColumn("description", "text")

DropColumn

// 删除模型User的description列
db.Model(&User{}).DropColumn("description")

Add Indexes

添加索引

// 为name列添加名为idx_user_name的普通索引
db.Model(&User{}).AddIndex("idx_user_name", "name")

// 为name和age两列添加名为idx_user_name_age的复合索引
db.Model(&User{}).AddIndex("idx_user_name_age", "name", "age")

// 添加唯一索引
db.Model(&User{}).AddUniqueIndex("idx_user_name", "name")

// 为多列添加唯一索引
db.Model(&User{}).AddUniqueIndex("idx_user_name_age", "name", "age")

Remove Index

// 删除索引
db.Model(&User{}).RemoveIndex("idx_user_name")

本文分享自微信公众号 – Go语言开发栈(golanghubcn),作者:frankphper

Go语言ORM-gorm学习笔记
滚动到顶部