Gin(十一):集成 orm 框架 gorm

本文首发于个人微信公众号 代码猎奇站 欢迎关注

随着项目的不断扩大，总有一天，项目中的表和表中的字段多的数不胜数，如果此时仍旧使用 SQL 语言来执行增删改查，务必会带来很多繁琐的事情，比如说我们要添加一个字段有十多个的结构体，要把结构体中的每个属性都要写一遍。极大的降低了开发速度，也会引入一些错误，所以我们要引入一些框架来对数据库进行管理，方便我们完成项目。这里我们介绍一下 gorm

🥨gorm

gorm 是 Go 语言中比较知名的 orm 框架之一，在 Github 上的有 14.6 K stars。gorm 对于常见的功能基本都已实现。在 gin 中添加 gorm 是非常简单的。

首先打开我们的 initDB 文件夹。将原来 sql.Open 改为 gorm.Open 同时引入 gorm , 同时对 Db 的定义类型进行更改，*gorm.DB 。具体代码如下:

package initDB

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

var Db *gorm.DB

func init() {
	var err error
	Db, err = gorm.Open("mysql", "root:1234@tcp(127.0.0.1:3306)/ginhello")
	if err != nil {
		log.Panicln("err:", err.Error())
	}
}

此时我们的对框架的引入就已经完成了。

因为我们将 Db 的属性进行了修改，此时的 article.go 中出现了错误。

所以我们修改，利用 gorm 的 api 来进行。

🍗实现增删改查

增加

增加方法，之前使用 SQL 语言来实现添加的，如下:

result, e := initDB.Db.Exec("insert into ` article` (type, content) values (?, ?);", article.Type, article.Content)

现在我们要通过框架来实现这一个过程。

create := initDB.Db.Create(&article)

是不是很简单了？

查询单个

通过 article.Id 传入限制条件，该方法仅仅是用于主键为 int 类型时。

initDB.Db.First(&article, article.Id)
return article

查询所有

var articles []Article
initDB.Db.Find(&articles)
return articles

删除

initDB.Db.Delete(article)

通过以上的一些方法可以看出来，基本对之前的增删改查代码有了极大的缩短，大大的减少了错误的发生。

此时就可以运行我们的代码，通过 .http 也好，通过单元测试也好，但是一运行就会报错。报错如下：

Error 1146: Table 'ginhello.articles' doesn't exist

说在 ginhello 库中并没有 articles 表。这句话说的没有毛病啊，我们的确没有 articles 表，我们建立的是 article 表。

原来 gorm 在对应的结构体默认会加个 s，所以我们现在有两个办法，第一个就是改表明，但是表明往往是不可以随便修改的。第二个是修改代码，让它之道我们要找的表为 article 而不是 articles。

func (article Article) TableName() string {
	return "article"
}

实现该接口，该接口返回一个字符串，通过字符串来定义我们需要关联的表。

此时再次运行我们的代码，发现功能可以完整的使用，并且没有报错。

🚥自动建表

加入现在是一个新的项目，还没有建立数据库表，或者项目迁移到另一个环境，环境上还没有数据库表，怎么办？

gorm 给我们提供了建立数据库表的功能。

我们新建立一个 model 叫做 comment ，管理评论。

package model

type Comment struct {
	ID      int
	content string
}

这里的 ID 要全部进行大写。

建立好结构体后就可以对结构体进行建立对应的数据库表。

对于建表我们首要检查一下表是否存在，如果存在就不需要重新建立了，不能每次运行项目就把之前的数据覆盖掉。

func init() {
	table := initDB.Db.HasTable(Comment{})
	if !table {
		initDB.Db.CreateTable(Comment{})
	}
}

运行我们的项目就会发现数据库中已经新建立了表，如果我们想在建立的时候同时为 id 建立索引，我们可以对结构体 tag 上标明。如下

type Comment struct {
	ID      int `gorm:"index:idx_id"`
	Content string
}

将刚刚建立的表删除掉，重新运行代码。数据库表中会添加 idx_id 索引。

⚓gorm model 的使用

我们在建立数据库的时候，每个表都会建立主键 ID ，如果你读过 阿里巴巴 Java 开发规范 的话，还应该知道一些其他的必要信息，比如说创建时间，修改时间等。

此时 gorm model 就起到了作用，他已经给我们封装了一下属性。

我们需要将结构体改为下面的样子

type Comment struct {
	gorm.Model
	Content string
}

删除了之前的表结构，重新运行项目，此时就会生成新的表结构。

✍总结

通过本章节的简答学习，基本可以将 gorm 融入到我们的 gin 项目中，并且操作数据库，极大的减少了我们的代码量。如果有时间的话，后期可能会专门出一起 gorm 的使用介绍。

👨‍💻本章节代码

Github

youngxhui