Gorm配置表前缀和禁用表名复数

gorm-gorm-config.png

今天在开发项目的时候,在配置统一表前缀的时候,突然发现和之前的配置方式不一样,是因为一个项目使用的是v1.9.6版本,另外一个项目使用的最新1.20.9 也即是作者说的v2.0版本

v1.0 和 v2.0 变化对于使用者来说变化最大的表现在

1、包的安装和import

2、表全局前缀定义和禁用表复数


下面具体来操作验证下不同之处

包的安装和import

v1.0 版本

# http://v1.gorm.io/docs/
go get -u github.com/jinzhu/gorm

# 驱动import如下方式
_ "github.com/jinzhu/gorm/dialects/mysql"

V2.0 版本

# https://gorm.io/docs/
go get -u gorm.io/gorm

# 驱动独立,直接import
go get -u gorm.io/gorm/driver/mysql

数据库连接方式

在介绍表前缀和表复数禁用之前,先说说数据库连接的方式的不同,这个影响到后面有些参数的设置

v1.0版本

dsn := "xxxx:xxxxxx@tcp(127.0.0.1:3306)/yyyyy?charset=utf8mb4&parseTime=True&loc=Local"
    
// gorm - v1.x
db, err := gorm.Open("mysql", dsn)  // *gorm.DB

v2.0版本

dsn := "xxxx:xxxxxx@tcp(127.0.0.1:3306)/yyyyy?charset=utf8mb4&parseTime=True&loc=Local"
    
// gorm - v2
// gorm.Config 参考 https://gorm.io/docs/gorm_config.html
db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
    NamingStrategy: schema.NamingStrategy{
        TablePrefix: "gormv2_",
        SingularTable: true,
    },
    Logger: logger.Default.LogMode(logger.Silent),
})

主要v2.0 Open的参数变化,dsn 是通过独立驱动建立连接,一些全局配置放到了第二个参数 gorm.Config中去,
比如logMode参数定义的变化,具体gorm.Config 参考 https://gorm.io/docs/gorm_config.html

注意,此时两个gorm.Open 返回的db变量 类型都是*gorm.DB 但是 db.DB() 函数返回值却不同:

v1.0 db.DB() 返回一个结果 *sql.DB

v2.0 db.DB() 返回两个结果 *sql.DBerror

所以SetMaxIdleConnsSetMaxOpenConnsSetConnMaxLifetime变量的设置就发生了变化

v1.0 可以直接 db.DB().SetMaxIdleConns(10)

v2.0 必须先赋值到新的变量,然后使用新的变量设置


sqlDB, err := db.DB()
if err != nil {
    log.Panicln("db.DB() err: ", err)
}
sqlDB.SetMaxIdleConns(10)

当然还有其他一些细节,等到大家自己深入研究

表前缀和表复数禁用

v1.0 版本

是通过独立的变量来定义

// gorm - v1.x 
// 设置全局表名禁用复数
db.SingularTable(true)
// gorm - v1.x 
// 指定表前缀,修改默认表名 
gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string  {    
    return "gormv1_" + defaultTableName 
}

v2.0 版本

是通过 gorm.Config 来配置

dsn := "xxxx:xxxxxx@tcp(127.0.0.1:3306)/yyyyy?charset=utf8mb4&parseTime=True&loc=Local"
    
    // gorm - v2
    // gorm.Config 参考 https://gorm.io/docs/gorm_config.html
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
        NamingStrategy: schema.NamingStrategy{
            TablePrefix: "gormv2_",
            SingularTable: true,
        },
        Logger: logger.Default.LogMode(logger.Silent),
    })

直接具体指定表名称

当然对于Model对应的数据库表名称还有一种共同的定义方式,如下

func (ModelName) TableName() string {
    return "self-define-tablename"
}

这里定义的表名称不依赖上面介绍的表前缀和禁用表复数

实战演示

演示是分两个主文件,执行一个的时候,记得把另外一个改名备份即可

v1.0 方式执行结果

gorm-v1-todo-demo.png

查看数据库表如下

mysql> show tables ;
+------------------+
| Tables_in_bamboo |
+------------------+
| gormv1_todo      |
+------------------+
1 row in set (0.00 sec)

mysql> desc gormv1_todo ;
+--------------+------------------+------+-----+---------+----------------+
| Field        | Type             | Null | Key | Default | Extra          |
+--------------+------------------+------+-----+---------+----------------+
| id           | int(10) unsigned | NO   | PRI | NULL    | auto_increment |
| created_at   | datetime         | YES  |     | NULL    |                |
| updated_at   | datetime         | YES  |     | NULL    |                |
| deleted_at   | datetime         | YES  | MUL | NULL    |                |
| title        | varchar(255)     | YES  |     | NULL    |                |
| is_completed | tinyint(1)       | YES  |     | NULL    |                |
+--------------+------------------+------+-----+---------+----------------+
6 rows in set (0.01 sec)

v2.0 方式执行结果

gorm-v2-todo-demo.png

查看数据库表如下;注意表mytag 是采用TableName() 函数来实现的,不依赖全局定义

mysql> show tables ;
+------------------+
| Tables_in_bamboo |
+------------------+
| gormv1_todo      |
| gormv2_todo      |
| mytag            |
+------------------+
3 rows in set (0.00 sec)

mysql> desc gormv2_todo ;
+--------------+---------------------+------+-----+---------+----------------+
| Field        | Type                | Null | Key | Default | Extra          |
+--------------+---------------------+------+-----+---------+----------------+
| id           | bigint(20) unsigned | NO   | PRI | NULL    | auto_increment |
| created_at   | datetime(3)         | YES  |     | NULL    |                |
| updated_at   | datetime(3)         | YES  |     | NULL    |                |
| deleted_at   | datetime(3)         | YES  | MUL | NULL    |                |
| title        | longtext            | YES  |     | NULL    |                |
| is_completed | tinyint(1)          | YES  |     | NULL    |                |
+--------------+---------------------+------+-----+---------+----------------+
6 rows in set (0.01 sec)

mysql> desc mytag ;
+------------+---------------------+------+-----+---------+----------------+
| Field      | Type                | Null | Key | Default | Extra          |
+------------+---------------------+------+-----+---------+----------------+
| id         | bigint(20) unsigned | NO   | PRI | NULL    | auto_increment |
| created_at | datetime(3)         | YES  |     | NULL    |                |
| updated_at | datetime(3)         | YES  |     | NULL    |                |
| deleted_at | datetime(3)         | YES  | MUL | NULL    |                |
| name       | longtext            | YES  |     | NULL    |                |
+------------+---------------------+------+-----+---------+----------------+
5 rows in set (0.01 sec)

附加:

实战的全部代码详见 https://gitee.com/colin5063/go-learn/tree/master/20201227-gorm

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,295评论 6 512
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,928评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,682评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,209评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,237评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,965评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,586评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,487评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,016评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,136评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,271评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,948评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,619评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,139评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,252评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,598评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,267评论 2 358

推荐阅读更多精彩内容