beego的model篇 - 模型定义和表生成model

发布时间：2024年01月18日

1. 模型定义

复杂的模型定义不是必须的，此功能用作数据库数据转换和自动建表。

默认的表名规则，使用驼峰转蛇形：

AuthUser -> auth_user
Auth_User -> auth__user
DB_AuthUser -> d_b__auth_user

除了开头的大写字母以外，遇到大写会增加?_，原名称中的下划线保留。

1.1. 自定义表名

type User struct {
    Id int
    Name string
}

func (u *User) TableName() string {
    return "auth_user"
}

如果前缀设置为?prefix_?那么表名为：prefix_auth_user

1.2. 自定义索引

为单个或多个字段增加索引

type User struct {
    Id    int
    Name  string
    Email string
}

// 多字段索引
func (u *User) TableIndex() [][]string {
    return [][]string{
        []string{"Id", "Name"},
    }
}

// 多字段唯一键
func (u *User) TableUnique() [][]string {
    return [][]string{
        []string{"Name", "Email"},
    }
}

1.3. 自定义引擎

仅支持 MySQL

默认使用的引擎，为当前数据库的默认引擎，这个是由你的 mysql 配置参数决定的。

你可以在模型里设置 TableEngine 函数，指定使用的引擎

type User struct {
    Id    int
    Name  string
    Email string
}

// 设置引擎为 INNODB
func (u *User) TableEngine() string {
    return "INNODB"
}

1.4. 设置参数

orm:"null;rel(fk)"

多个设置间使用?;?分隔，设置的值如果是多个，使用?,?分隔。

设置?-?即可忽略 struct 中的字段

type User struct {
...
    AnyField string `orm:"-"`
...
}

auto

当 Field 类型为 int, int32, int64, uint, uint32, uint64 时，可以设置字段为自增健

  • 当模型定义里没有主键时，符合上述类型且名称为?Id?的 Field 将被视为自增健。

鉴于 go 目前的设计，即使使用了 uint64，但你也不能存储到他的最大值。依然会作为 int64 处理。

pk

设置为主键，适用于自定义其他类型为主键

null

数据库表默认为?NOT NULL，设置 null 代表?ALLOW NULL

Name string `orm:"null"`

index

为单个字段增加索引

unique

为单个字段增加 unique 键

Name string `orm:"unique"`

column

为字段设置 db 字段的名称

Name string `orm:"column(user_name)"`

size

string 类型字段默认为 varchar(255)

设置 size 以后，db type 将使用 varchar(size)

Title string `orm:"size(60)"`

digits / decimals

设置 float32, float64 类型的浮点精度

Money float64 `orm:"digits(12);decimals(4)"`

总长度 12 小数点后 4 位 eg:?99999999.9999

auto_now / auto_now_add

Created time.Time `orm:"auto_now_add;type(datetime)"`
Updated time.Time `orm:"auto_now;type(datetime)"`
  • auto_now 每次 model 保存时都会对时间自动更新
  • auto_now_add 第一次保存时才设置时间

对于批量的 update 此设置是不生效的

type

设置为 date 时，time.Time 字段的对应 db 类型使用 date

Created time.Time `orm:"auto_now_add;type(date)"`

设置为 datetime 时，time.Time 字段的对应 db 类型使用 datetime

Created time.Time `orm:"auto_now_add;type(datetime)"`

default

为字段设置默认值，类型必须符合（目前仅用于级联删除时的默认值）

type User struct {
    ...
    Status int `orm:"default(1)"`
    ...
}

Comment

为字段添加注释

type User struct {
    ...
    Status int `orm:"default(1)" description:"这是状态字段"`
    ...
}

1.5. 表关系设置

rel / reverse

RelOneToOne:

type User struct {
    ...
    Profile *Profile `orm:"null;rel(one);on_delete(set_null)"`
    ...
}

对应的反向关系?RelReverseOne:

type Profile struct {
    ...
    User *User `orm:"reverse(one)"`
    ...
}

RelForeignKey:

type Post struct {
    ...
    User *User `orm:"rel(fk)"` // RelForeignKey relation
    ...
}

对应的反向关系?RelReverseMany:

type User struct {
    ...
    Posts []*Post `orm:"reverse(many)"` // fk 的反向关系
    ...
}

RelManyToMany:

type Post struct {
    ...
    Tags []*Tag `orm:"rel(m2m)"` // ManyToMany relation
    ...
}

对应的反向关系?RelReverseMany:

type Tag struct {
    ...
    Posts []*Post `orm:"reverse(many)"`
    ...
}
rel_table / rel_through

此设置针对?orm:"rel(m2m)"?的关系字段

rel_table       设置自动生成的 m2m 关系表的名称
rel_through     如果要在 m2m 关系中使用自定义的 m2m 关系表
                通过这个设置其名称，格式为 pkg.path.ModelName
                eg: app.models.PostTagRel
                PostTagRel 表需要有到 Post 和 Tag 的关系

当设置 rel_table 时会忽略 rel_through

设置方法：

orm:"rel(m2m);rel_table(the_table_name)"

orm:"rel(m2m);rel_through(pkg.path.ModelName)"

on_delete

设置对应的 rel 关系删除时，如何处理关系字段。

cascade? ? ? ? 级联删除(默认值)

set_null? ? ? ?设置为 NULL，需要设置 null = true

set_default? ? 设置为默认值，需要设置 default 值

do_nothing? ? ?什么也不做，忽略

type User struct {
    ...
    Profile *Profile `orm:"null;rel(one);on_delete(set_null)"`
    ...
}
type Profile struct {
    ...
    User *User `orm:"reverse(one)"`
    ...
}

// 删除 Profile 时将设置 User.Profile 的数据库字段为 NULL
关于 on_delete 的相关例子
type User struct {
    Id int
    Name string
}

type Post struct {
    Id int
    Title string
    User *User `orm:"rel(fk)"`
}

假设 Post -> User 是 ManyToOne 的关系，也就是外键。

o.Filter("Id", 1).Delete()

这个时候即会删除 Id 为 1 的 User 也会删除其发布的 Post

不想删除的话，需要设置 set_null

type Post struct {
    Id int
    Title string
    User *User `orm:"rel(fk);null;on_delete(set_null)"`
}

那这个时候，删除 User 只会把对应的 Post.user_id 设置为 NULL

当然有时候为了高性能的需要，多存点数据无所谓啊，造成批量删除才是问题。

type Post struct {
    Id int
    Title string
    User *User `orm:"rel(fk);null;on_delete(do_nothing)"`
}

那么只要删除的时候，不操作 Post 就可以了。

1.6. 模型字段与数据库类型的对应

在此列出 ORM 推荐的对应数据库类型，自动建表功能也会以此为标准。

默认所有的字段都是?NOT NULL

MySQL

gomysql
int, int32 - 设置 auto 或者名称为?Id?时integer AUTO_INCREMENT
int64 - 设置 auto 或者名称为?Id?时bigint AUTO_INCREMENT
uint, uint32 - 设置 auto 或者名称为?Id?时integer unsigned AUTO_INCREMENT
uint64 - 设置 auto 或者名称为?Id?时bigint unsigned AUTO_INCREMENT
boolbool
string - 默认为 size 255varchar(size)
string - 设置 type(char) 时char(size)
string - 设置 type(text) 时longtext
time.Time - 设置 type 为 date 时date
time.Timedatetime
bytetinyint unsigned
runeinteger
intinteger
int8tinyint
int16smallint
int32integer
int64bigint
uintinteger unsigned
uint8tinyint unsigned
uint16smallint unsigned
uint32integer unsigned
uint64bigint unsigned
float32double precision
float64double precision
float64 - 设置 digits, decimals 时numeric(digits, decimals)

Sqlite3

gosqlite3
int, int32, int64, uint, uint32, uint64 - 设置 auto 或者名称为?Id?时integer AUTOINCREMENT
boolbool
string - 默认为 size 255varchar(size)
string - 设置 type(char) 时character(size)
string - 设置 type(text) 时text
time.Time - 设置 type 为 date 时date
time.Timedatetime
bytetinyint unsigned
runeinteger
intinteger
int8tinyint
int16smallint
int32integer
int64bigint
uintinteger unsigned
uint8tinyint unsigned
uint16smallint unsigned
uint32integer unsigned
uint64bigint unsigned
float32real
float64real
float64 - 设置 digits, decimals 时decimal

PostgreSQL

gopostgres
int, int32, int64, uint, uint32, uint64 - 设置 auto 或者名称为?Id?时serial
boolbool
string - 若没有指定 size 默认为 textvarchar(size)
string - 设置 type(char) 时char(size)
string - 设置 type(text) 时text
string - 设置 type(json) 时json
string - 设置 type(jsonb) 时jsonb
time.Time - 设置 type 为 date 时date
time.Timetimestamp with time zone
bytesmallint CHECK("column" >= 0 AND "column" <= 255)
runeinteger
intinteger
int8smallint CHECK("column" >= -127 AND "column" <= 128)
int16smallint
int32integer
int64bigint
uintbigint CHECK("column" >= 0)
uint8smallint CHECK("column" >= 0 AND "column" <= 255)
uint16integer CHECK("column" >= 0)
uint32bigint CHECK("column" >= 0)
uint64bigint CHECK("column" >= 0)
float32double precision
float64double precision
float64 - 设置 digits, decimals 时numeric(digits, decimals)

1.7. 关系型字段

其字段类型取决于对应的主键。

  • RelForeignKey
  • RelOneToOne
  • RelManyToMany
  • RelReverseOne
  • RelReverseMany

2?表生成model

对于项目开始设计，不少做过开发的都会先做功能需求文档，而数据库设计可能就是功能需求文档的一部分。这个时候就需要数据库反向生成，从最开始的项目分析，功能需求文档，数据库设计到功能模块开发。

?（1）通过?bee generate scaffold 构建代码

scaffold是一个综合性代码生成命令

PS C:\Users\leell\go\src\quickstart> bee generate scaffold user -fields="id:int,name:string" -conn="leellun:fansimao@tcp(127.0.0.1:3308)/test"
______
| ___ \
| |_/ /  ___   ___
| ___ \ / _ \ / _ \
| |_/ /|  __/|  __/
\____/  \___| \___| v2.1.0
2024/01/18 19:47:12 INFO     ? 0001 Do you want to create a 'user' model? [Yes|No] 
yes
2024/01/18 19:47:14 INFO     ? 0002 Using 'User' as model name
2024/01/18 19:47:14 INFO     ? 0003 Using 'models' as package name
        create   C:\Users\leell\go\src\quickstart/models/user.go
2024/01/18 19:47:14 INFO     ? 0004 Do you want to create a 'user' controller? [Yes|No]
yes
2024/01/18 19:47:18 INFO     ? 0005 Using 'User' as controller name
2024/01/18 19:47:18 INFO     ? 0006 Using 'controllers' as package name
2024/01/18 19:47:18 INFO     ? 0007 Using matching model 'User'
        create   C:\Users\leell\go\src\quickstart/controllers/user.go
2024/01/18 19:47:18 INFO     ? 0008 Do you want to create views for this 'user' resource? [Yes|No]
yes
2024/01/18 19:47:21 INFO     ? 0009 Generating view...
        create   C:\Users\leell\go\src\quickstart/views/user/index.tpl
        create   C:\Users\leell\go\src\quickstart/views/user/show.tpl
        create   C:\Users\leell\go\src\quickstart/views/user/create.tpl
        create   C:\Users\leell\go\src\quickstart/views/user/edit.tpl
2024/01/18 19:47:21 INFO     ? 0010 Do you want to create a 'user' migration and schema for this resource? [Yes|No]
yes
        create   C:\Users\leell\go\src\quickstart/database/migrations/20240118_194724_user.go
2024/01/18 19:47:24 INFO     ? 0011 Do you want to migrate the database? [Yes|No]

通过上面提示就知道bee会一步一步的询问你需要生成什么？包括model、controller、views、migration。并且最后还会循问是否在数据库创建表结构，当然需要安装相关依赖包，需要的话根据提示自行安装。

（2）bee generate model生成模型

bee generate model user -fields="id:int,name:string"

（3）bee generate appcode生成controller、model、router

通过表生成model。

PS C:\Users\leell\go\src\quickstart> bee generate appcode -tables=user -driver=mysql -conn="leellun:fansimao666@tcp(127.0.0.1:3308)/test"
2024/01/18 20:02:34 INFO     ? 0006 Creating model files...
        create   C:\Users\leell\go\src\quickstart/models/user.go
2024/01/18 20:02:34 INFO     ? 0007 Creating controller files...
        create   C:\Users\leell\go\src\quickstart/controllers/user.go
2024/01/18 20:02:34 INFO     ? 0008 Creating router files...
        create   C:\Users\leell\go\src\quickstart\routers\router.go
2024/01/18 20:02:34 SUCCESS  ? 0009 Appcode successfully generated!

参考文章：

https://www.fansimao.com/833195.html

https://www.fansimao.com/833236.html

文章来源:https://blog.csdn.net/liu289747235/article/details/135679087
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
最新文章