Go-Zero 数据库实战:配置、建模与业务逻辑一体化

前言
在之前的几篇文章中,我们深入学习了 Go-Zero 框架的实战应用,包括模板定制化、API 定义、抽奖算法设计等内容。本文将继续探索 Go-Zero 框架的实践技巧,并介绍一些与数据库操作相关的主题。
在现代应用程序开发中,对数据库的操作是非常常见且重要的一部分。Go-Zero 框架提供了强大的数据库支持,使得我们可以轻松地进行数据库访问和操作。本文将重点介绍如何使用 Go-Zero 框架进行数据库的增删改查(CRUD)操作,并提供详细的示例代码和解释。
在本文中,我们将使用 MySQL 数据库作为示例,并结合 Go-Zero 框架的相关组件,如数据模型(Model)、事务处理、连接池等,来展示数据库操作的最佳实践。无论你是初学者还是有一定经验的开发者,本文都将为你提供有用的信息和技巧,帮助你更好地理解和应用 Go-Zero 框架中的数据库操作。
在阅读本文之前,请确保你已经按照前几篇文章中的说明进行了必要的准备工作,包括安装所需的工具和设置项目环境。同时,本文假设你已经具备一定的数据库基础知识,如表的创建、数据的插入和查询等。
通过学习本文,你将掌握以下内容:
如何配置和初始化数据库连接;
如何使用 Go-Zero 框架的 Model 组件进行数据表的创建和映射;
如何进行常见的 CRUD 操作,包括数据的插入、查询、更新和删除;
如何处理数据库事务;
实现用户注册业务逻辑。
我们鼓励你跟随示例代码,动手实践,并根据自己的需求进行定制和扩展。无论是为了学习 Go-Zero 的数据库操作,还是为了解决具体的业务问题,本文都将为你提供实用的指导和技巧。
祝你阅读愉快,并从中获得所需的知识和灵感!
实战前准备
本次实战我们是建立在(六)Go-Zero实战之docker开发环境部署 基础之上,如果没有学习过,可以点击跳转学习,然后再看本文哦!
本次实战采用的是 docker 部署,请提前准备好相关环境,关于 docker 环境的搭建在(六)Go-Zero实战之docker开发环境部署 中也有讲解,不了解小伙伴建议先行实战 docker 环境搭建哦!
目录结构说明

在 app 下面我们将会新建一个服务 comment,表示晒单评论服务,deploy/sql 存放的是我们的建表语句,相关语句将会在接下来的讲解中给大家。
实战
配置 docker 组件
在 docker-commpose-env.yml 中添加如下配置 mysql

在本次实战中我们会使用到缓存(使用 sqlc 库),因此也进行了 redis 的配置。如果不想走缓存,可以使用 sqlx 库,后续根据需求再添加缓存。
在 docker-commpose-env.yml 中添加如下配置 redis

在进行复制粘贴的时候需要注意缩进哦!
重新启动项目所依赖的环境

Navicate 连接数据库

Go-Zero 操作数据库
go-zero 提供了两个操作数据库的库,分别是 sqlc 和 sqlx。区别是前者带缓存,后者不带缓存。

我们先在(六)Go-Zero实战之docker开发环境部署 中创建的 usercent 服务进行 gozero 操作数据库相关内容的学习

tips:相关服务和表结构在(六)Go-Zero实战之docker开发环境部署 中已经实现,如果本地没有的小伙伴可以先进行(六)的学习和操作哦!
在(六)Go-Zero实战之docker开发环境部署 中我们已经定义了两个 RPC 接口,接下来我们通过实现这两个 register 接口展示如何使用 gozero 操作数据库。
使用脚本生成数据库对应的 model
tips:这一小节的内容在(三)Go-Zero和goctl:解锁微服务开发的神器,快速上手指南 中有过详细的讲解,如果有不清楚的小伙伴可以点击这里进行回顾哦!本节仅进行操作以及效果展示。
脚本如下(放在目录的 deploy/script/mysql/genModel.sh 下):
使用 GitBash 打开 deploy/script/mysql 目录,执行脚本

将相关代码放到 model 下

把包名改成 model

配置文件中加入如下配置,用于 jwt 鉴权以及 mysql、redis 连接配置的获取

svc 下的 serviceContext 加入如下配置,用于获取 mysql 连接

rpc/etc/usercenter.yaml 加上 jwtAuth 配置
注册 model

这样我们就可以在 userModel 下写我们自己的 sql 操作了

事务操作
sqlc 为我们提供了事务操作,相关源码如下:

我们可以基于官方提供的 TransactCtx 方法,封装自己的事务处理方法
首先在 userModel 里面注册 Trans 方法,如下图所示

接着写这个方法的实现,其实就是对原本的函数进行了一个封装。

通过这个例子,我们可以知道 gozero 如何注册自己的数据库操作方法,以及了解到如何进行事务操作。
注册业务逻辑的实现
首先我们先在 tool 下新增 encryption.go 文件,增加一个 md5 加密字符串的函数

在 logic/registerLogic.go 里面编写我们的注册逻辑,注册业务代码如下
tips:这个是最简单的插入一条数据的逻辑,实际生产中我们往往需要添加各种校验以及登录回调,jwt 返回等,根据实际需求进行修改。如果读者朋友有需求,后续文章我们也会完善这个注册逻辑。
可以看见我们实际调用了 Insert 方法进行了插入操作。gozero 框架的默认模板帮我们封装好了常规的增删改查操作,我们可以直接调用即可,如果有额外需求我们可以在 userModel.go 定义自己的 sql 查询方法,或者自定义我们自己的 goctl,关于自定义模板可以看我前面的文章(四)Go-Zero自定义goctl实战:定制化模板,加速你的微服务开发效率哦!
接下来我们简单看一下模板中对于增删查改方法的实现
插入操作

删除操作

更新操作

查询操作

更多的数据库操作建议可以查看官方文档mysql 代码生成 | go-zero Documentation,本教程更注重于实践操作以及代码实现。
测试与验证
编写完业务后我们启动服务,关于服务启动在(三)Go-Zero和goctl:解锁微服务开发的神器,快速上手指南 中有详细讲解,这里不进行重复讲解。



可以看见成功进行了用户注册,说明插入操作有效。
结语
至此,我们已经完成了数据库相关配置,以及通过用户服务和注册接口了解到了常规的增删改查操作。
关于更详细的实现,如果有小伙伴有需求,我们可以单独拿一节课来进行详细的拆分讲解。
本篇文章介绍了 Go-Zero 中的数据库操作,并提供了常用的命令示例。通过学习和实践,我们可以更加熟练地使用 Go-Zero 进行高效的数据库操作。在后续的文章中,我们将进一步探索数据库操作的高级用法和技巧,为小伙伴们提供更多的参考。
欢迎关注 ❤
我的文章都首发在同名公众号:王中阳
需要简历优化或者就业辅导,可以直接加我微信:wangzhongyang1993,备注:infoq
评论