Go Web编程--应用ORM

上篇文章中我们在使用的开发环境中增加了 MySQL容器，然后介绍了使用 database/sql标准库结合数据库驱动包进行数据库操作的方法。不过它们是相对偏底层的软件包。实际开发经常会使用一些在它的基础上封装的 ORM库。ORM的查询使用起来更简单些，语法更富表达力。这篇文章我们主要探究下面这些内容。

• gorm的基本用法

• 如何管理 ORM的使用

• 如何合理规划项目目录结构

安装gorm包

gorm是一个出色的，对开发人员友好的 Golang ORM 库，其支持的特性包括：

• 全特性 ORM (几乎包含所有特性)

• 模型关联 (一对一， 一对多，一对多（反向）， 多对多， 多态关联)

• 钩子 (Before/After Create/Save/Update/Delete/Find)

• 预加载

• 事务

• 复合主键

• SQL 构造器

• 自动迁移

• 日志

使用如下命令进行安装：

1. go get -u github.com/jinzhu/gorm

将gorm加入项目中

规划数据模型目录结构

我们在项目根目录下新建如下目录:

1. http_demo

2. |

3. └───model

4. │ └───dao

5. │ │ init.go

6. │ └───────table

7. │ │ user.go

在 Go 中包以目录的形式来组织，所以 model包中存放所有数据模型， dao代表数据访问对象，存放数据库 CRUD方法的封装，其中的 init.go存放 dao包的初始化函数主要是用来在加载包后连接上数据库。table包里放与数据表对应的模型定义（使用 ORM 之前要先定义模型与数据库中的表对应），在示例里我们会定义一个 User模型放在 user.go文件中。

规划完目录后就可以在各部分写相应的代码了，首先来看使用 gorm连接数据库。

连接数据库

我们在 dao包的 init.go中加入包的初始化逻辑进行数据库连接，初始化函数会在 dao包第一次被导入时执行，由于 gorm文档连接数据库的例子太简单，参考价值不大，我们根据项目需要做些简单封装， init.go中的代码如下所示：

1. package dao

2. import (

3. _ "github.com/go-sql-driver/mysql"

4. "github.com/jinzhu/gorm"

5. "time"

6. )

7. var _DB *gorm.DB

8. func DB() *gorm.DB {

9. return _DB

10. }

11. func init() {

12. _DB = initDB()

13. }

14. func initDB() *gorm.DB {

15. db, err := gorm.Open("mysql", "go_web:go_web@tcp(localhost:33063)/go_web?charset=utf8&parseTime=True&loc=Local")

16. if err != nil {

17. panic(err)

18. }

19. db.DB().SetMaxOpenConns(100)

20. db.DB().SetMaxIdleConns(10)

21. db.DB().SetConnMaxLifetime(time.Second * 300)

22. if err = db.DB().Ping(); err != nil {

23. panic(err)

24. }

25. return db

26. }

代码很简单，大家实操的时候根据自己的 MySQL配置更改代码里面的配置就行了。唯一说明一点的是，如果使用了我们提供的 Docker环境，在连接数据库时 host要改为 database:3306，因为我在容器环境里将 MySQL容器的服务名定义成了 database，在运行了 Go的 app容器需要用服务名访问容器网络中的其他容器。关于容器环境的详细配置请大家查看Go Web编程--应用数据库 中的描述。

定义模型

使用模型访问数据库的表之前我们需要先定义对应的模型。我们示例中现在只有一个 users表，接下来我们在 table包中添加 users表的模型定义并放置在 user.go文件中。

1. package table

2. import "time"

3. type User struct {

4. Id int64 `gorm:"column:id;primary_key"`

5. UserName string `gorm:"column:username"`

6. Secret string `gorm:"column:secret;type:varchar(1000)"`

7. CreatedAt time.Time `gorm:"column:created_at"`

8. UpdatedAt time.Time `gorm:"column:updated_at"`

9. }

10. func (m *User) TableName() string {

11. return "users"

12. }

模型 CRUD

关于模型的 CRUD，建议将单个模型的 CRUD放在 dao包的单个文件中，这样方便以后代码的管理。这里多说一点，建议不要直接用 controller或者叫 handler包直接访问 dao包，而是在中间加一层 logic包，把逻辑放在这一层。这样对代码的管理、复用性都有帮助。

因为数据库的 CRUD 有很多种操作，本文的目的是帮助大家快速开始使用 gorm所以我就只放简单的 CRUD 做演示了。大家按照这里步骤引入 gorm后用到其他的数据库操作了直接去官方文档里查一查就好。

在 dao包中新建 user.go用来存放 User模型的操作方法。

1. package dao

2. import "example.com/http_demo/model/dao/table"

3. func CreateUser(user *table.User) (err error) {

4. err = DB().Create(user).Error

5. return

6. }

7. func GetUserById(userId int64) (user *table.User, err error) {

8. user = new(table.User)

9. err = DB().Where("id = ?", userId).First(user).Error

10. return

11. }

12. func GetAllUser() (users []*table.User, err error) {

13. err = DB().Find(&users).Error

14. return

15. }

16. func UpdateUserNameById(userName string, userId int64) (err error) {

17. user := new(table.User)

18. err = DB().Where("id = ?", userId).First(user).Error

19. if err != nil {

20. return

21. }

22. user.UserName = userName

23. err = DB().Save(user).Error

24. return

25. }

26. func DeleteUserById(userId int64) (err error) {

27. user := new(table.User)

28. err = DB().Where("id = ?", userId).First(user).Error

29. if err != nil {

30. return

31. }

32. err = DB().Delete(user).Error

33. return

34. }

验证ORM 方法

经过上面几步的设置后我们就可以在项目里使用 gorm访问数据库了，由于我们项目的 main goroutine中运行了 http服务，所以我们使用测试用例对上面 dao包中定义的几个方法进行一下测试。

篇幅原因我就只贴一个 GetAllUsers方法的测试用例了:

1. func TestGetAllUser(t *testing.T) {

2. tests := []struct {

3. name string

4. wantErr bool

5. }{

6. {

7. name: "test",

8. wantErr: false,

9. },

10. }

11. for _, tt := range tests {

12. t.Run(tt.name, func(t *testing.T) {

13. gotUsers, err := GetAllUser()

14. if (err != nil) != tt.wantErr {

15. t.Errorf("GetAllUser() error = %v, wantErr %v", err, tt.wantErr)

16. return

17. }

18. for _, user := range gotUsers {

19. log.Info("user: %v", user)

20. }

21. })

22. }

23. }

运行测试后，可以看到结果：

1. INFO user: &{1 2020-02-15 14:14:46 +0800 CST 2020-02-15 06:44:17 +0800 CST}

2. --- PASS: TestGetAllUsers (0.00s)

3. --- PASS: TestGetAllUsers/test (0.00s)

4. PASS

5. Process finished with exit code 0

在公众号里回复 gohttp05可以得到完整的测试用例代码，建议这些 CRUD都要写好测试用例进行自测，使用 GoLand可以很容易的生成测试函数和运行测试。

重新规划项目目录

引入 ORM后，我们项目中的代码就比较多了，都放在根目录下的 main包中有点杂乱，所以我们根据各部分的功能和职责对项目目录进行了简单的划分，划分后的目录结构如下：

1. http_demo

2. |

3. └───handler//route handler

4. |

5. └───logic//business logic

6. |

7. └───middleware

8. │

9. └───model

10. │ └───dao

11. │ │ init.go

12. │ └───table

13. │ │ user.go

14. └───router// router

15. |

16. | main.go

感觉今天的内容还是挺多的，尤其对于刚入门 Go的同学们一定要把今天的代码下载下来实操一遍才能掌握。gorm提供的功能还是很多的，每个功能在官方文档里都有讲解，我们这里就不做过多介绍了。这篇文章的目的主要是让大家能快速入门，同时把 ORM相关的代码管理和初始化流程做的规范些，这些组织方式完全可以应用到生产级别的项目中的。

公众号回复 gohttp05获取文章中完整的源代码，喜欢我的文章请帮忙点在看和转发。

前文回顾