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环境搭建哦!
目录结构阐明
https://img-blog.csdnimg.cn/img_convert/d7060398696c6f68ebfb8ff0030d0028.png
[*]在app下面我们将会新建一个服务comment,表示晒单评论服务,deploy/sql存放的是我们的建表语句,相干语句将会在接下来的讲解中给大家。
实战
设置docker组件
[*]在docker-commpose-env.yml中添加如下设置mysql
https://img-blog.csdnimg.cn/img_convert/c289a7037e4c7817dbadcb30962bbfbc.png
mysql:
image: mysql/mysql-server:8.0.28
container_name: mysql
environment:
# 时区上海 - Time zone Shanghai (Change if needed)
TZ: Asia/Shanghai
# root 密码 - root password
MYSQL_ROOT_PASSWORD: xxxxxx #这里填上mysql的密码
ports:
- 33069:3306
volumes:
# 数据挂载 - Data mounting
- ./data/mysql/data:/var/lib/mysql
# 日志
command:
# 将mysql8.0默认密码策略 修改为 原先 策略 (mysql8.0对其默认策略做了更改 会导致密码无法匹配)
# Modify the Mysql 8.0 default password strategy to the original strategy (MySQL8.0 to change its default strategy will cause the password to be unable to match)
--default-authentication-plugin=mysql_native_password
--character-set-server=utf8mb4
--collation-server=utf8mb4_general_ci
--explicit_defaults_for_timestamp=true
--lower_case_table_names=1
privileged: true
restart: always
networks:
- testProject_net
[*]在本次实战中我们会利用到缓存(利用sqlc库),因此也举行了redis的设置。假如不想走缓存,可以利用sqlx库,后续根据需求再添加缓存。
[*]在docker-commpose-env.yml中添加如下设置redis
https://img-blog.csdnimg.cn/img_convert/604b084e9b6f2888d8946c96159e3ea2.png
#redis容器 - Redis container
redis:
image: redis:6.2.5
container_name: redis
ports:
- 36379:6379
environment:
# 时区上海 - Time zone Shanghai (Change if needed)
TZ: Asia/Shanghai
volumes:
# 数据文件 - data files
- ./data/redis/data:/data:rw
command: "redis-server --requirepass G62m50oigInC30sf--appendonly yes"
privileged: true
restart: always
networks:
- testProject_net
[*]在举行复制粘贴的时候需要注意缩进哦!
重新启动项目所依靠的环境
$ docker-compose -f docker-compose-env.yml up -d
https://img-blog.csdnimg.cn/img_convert/2da877646360100c34bdcb15b1c82cf5.png
Navicate毗连数据库
https://img-blog.csdnimg.cn/img_convert/1966f7eb133e880b59f03057ce321ce8.png
Go-Zero操作数据库
go-zero提供了两个操作数据库的库,分别是sqlc和sqlx。区别是前者带缓存,后者不带缓存。
https://img-blog.csdnimg.cn/img_convert/1dd66d2f43a8d443838721e5df66af53.png
我们先在(六)Go-Zero实战之docker开发环境摆设 中创建的usercent服务举行gozero操作数据库相干内容的学习
https://img-blog.csdnimg.cn/img_convert/742224b5ef453c35296f1d0e466c1f80.png
[*]tips:相干服务和表结构在(六)Go-Zero实战之docker开发环境摆设 中已经实现,假如当地没有的小伙伴可以先举行(六)的学习和操作哦!
[*]在(六)Go-Zero实战之docker开发环境摆设中我们已经定义了两个RPC接口,接下来我们通过实现这两个register接口展示如何利用gozero操作数据库。
利用脚本生成数据库对应的model
[*]tips:这一小节的内容在(三)Go-Zero和goctl:解锁微服务开发的神器,快速上手指南 中有过详细的讲解,假如有不清楚的小伙伴可以点击这里举行回顾哦!本节仅举行操作以及结果展示。
[*]脚本如下(放在目录的deploy/script/mysql/genModel.sh下):
#!/usr/bin/env bash
# 使用方法:
# ./genModel.sh lottery lottery
# ./genModel.sh lottery prize
# ./genModel.sh looklook_usercenter user_contact
# 再将./genModel下的文件剪切到对应服务的model目录里面,记得改package
#生成的表名
tables=$2
#表生成的genmodel目录
modeldir=./genModel
# 数据库配置
host=127.0.0.1
port=33069
dbname=$1
username=root
passwd=PXDN93VRKUm8TeE7
template=../../goctl/1.6.1
echo "开始创建库:$dbname 的表:$2"
goctl model mysql datasource -url="${username}:${passwd}@tcp(${host}:${port})/${dbname}" -table="${tables}" -dir="${modeldir}" -cache=true --home="${template}" --style=goZero
[*]利用GitBash打开deploy/script/mysql目录,实行脚本
https://img-blog.csdnimg.cn/img_convert/5e551be533ced3c6a46f3f8a625e3bd3.png
[*]将相干代码放到model下
https://img-blog.csdnimg.cn/img_convert/ba12d480cfb0137a482523fd82267f28.png
[*]把包名改成model
https://img-blog.csdnimg.cn/img_convert/5508cbcc3c77c67ff2e0eb59f41ca566.png
[*]设置文件中参加如下设置,用于jwt鉴权以及mysql、redis毗连设置的获取
https://img-blog.csdnimg.cn/img_convert/f5c17131811df5b436ed76ddc32e55f4.png
package config
import (
"github.com/zeromicro/go-zero/core/stores/cache"
"github.com/zeromicro/go-zero/zrpc"
)
type Config struct {
zrpc.RpcServerConf
CheckinRpcConf zrpc.RpcClientConf
JwtAuth struct {
AccessSecret string
AccessExpire int64
}
DB struct {
DataSource string
}
Cache cache.CacheConf
}
[*]svc下的serviceContext参加如下设置,用于获取mysql毗连
https://img-blog.csdnimg.cn/img_convert/1593fc7bf5db480dbe3c0b8d560f7196.png
package svc
import (
"github.com/zeromicro/go-zero/core/stores/redis"
"github.com/zeromicro/go-zero/core/stores/sqlx"
"testProject/app/usercenter/cmd/rpc/internal/config"
"testProject/app/usercenter/model"
)
type ServiceContext struct {
Config config.Config
UserModel model.UserModel
RedisClient *redis.Redis
}
func NewServiceContext(c config.Config) *ServiceContext {
sqlConn := sqlx.NewMysql(c.DB.DataSource)
return &ServiceContext{
UserModel: model.NewUserModel(sqlConn, c.Cache),
Config: c,
}
}
[*]rpc/etc/usercenter.yaml加上jwtAuth设置
#jwtAuth
JwtAuth:
AccessSecret: ae0536f9-6450-4606-8e13-5a19ed505da0
AccessExpire: 31536000
[*]注册model
https://img-blog.csdnimg.cn/img_convert/6c8ea6029a89d5a575017d7f9d2b2e0f.png
UserModel: model.NewUserModel(sqlConn, c.Cache),
[*]如许我们就可以在userModel下写我们自己的sql操作了
https://img-blog.csdnimg.cn/img_convert/2e40555fb0a60f5c4b32051c45b9fada.png
事件操作
[*]sqlc为我们提供了事件操作,相干源码如下:
https://img-blog.csdnimg.cn/img_convert/7de759d5bed732713c16987689ff86dc.png
[*]我们可以基于官方提供的TransactCtx方法,封装自己的事件处置惩罚方法
[*]起首在userModel里面注册Trans方法,如下图所示
https://img-blog.csdnimg.cn/img_convert/9516a877a9e89074e70de60dd9b79492.png
Trans(ctx context.Context, fn func(ctx context.Context, session sqlx.Session) error) error
[*]接着写这个方法的实现,其实就是对原本的函数举行了一个封装。
https://img-blog.csdnimg.cn/img_convert/5375877c7aacaa24ca8ca1a4e356691c.png
func (m *defaultUserModel) Trans(ctx context.Context, fn func(ctx context.Context, session sqlx.Session) error) error
{ return m.TransactCtx(ctx, func(ctx context.Context, session sqlx.Session) error { return fn(ctx, session) })}
[*]通过这个例子,我们可以知道gozero如何注册自己的数据库操作方法,以及了解到如何举行事件操作。
注册业务逻辑的实现
[*]起首我们先在tool下新增encryption.go文件,增长一个md5加密字符串的函数
https://img-blog.csdnimg.cn/img_convert/9c9bdbda7eb18583172d1146e0654a1c.png
func Md5ByString(str string) string {
m := md5.New()
_, err := io.WriteString(m, str)
if err != nil {
panic(err)
}
arr := m.Sum(nil)
return fmt.Sprintf("%x", arr)
}
[*]在logic/registerLogic.go里面编写我们的注册逻辑,注册业务代码如下
func (l *RegisterLogic) Register(in *pb.RegisterReq) (*pb.RegisterResp, error) {
if err := l.svcCtx.UserModel.Trans(l.ctx, func(ctx context.Context, session sqlx.Session) error {
user := new(model.User)
if len(in.Password) > 0 {
user.Password = tool.Md5ByString(in.Password)
}
insertResult, err := l.svcCtx.UserModel.Insert(ctx, user)
if err != nil {
return errors.Wrapf(err, "Register db user Insert err:%v,user:%+v", err, user)
}
lastId, err := insertResult.LastInsertId()
if err != nil {
return errors.Wrapf(err, "Register db user insertResult.LastInsertId err:%v,user:%+v", err, user)
}
fmt.Println("lastId:", lastId)
return nil
}); err != nil {
logx.Error("Register:", err)
return nil, err
}
return &usercenter.RegisterResp{}, nil
}
[*]tips:这个是最简单的插入一条数据的逻辑,实际生产中我们往往需要添加各种校验以及登录回调,jwt返回等,根据实际需求举行修改。假如读者朋侪有需求,后续文章我们也会美满这个注册逻辑。
[*]可以瞥见我们实际调用了Insert方法举行了插入操作。gozero框架的默认模板帮我们封装好了常规的增删改查操作,我们可以直接调用即可,假如有额外需求我们可以在userModel.go定义自己的sql查询方法,或者自定义我们自己的goctl,关于自定义模板可以看我前面的文章(四)Go-Zero自定义goctl实战:定制化模板,加速你的微服务开发效率哦!
[*]接下来我们简单看一下模板中对于增删查改方法的实现
[*]插入操作
https://img-blog.csdnimg.cn/img_convert/4341d80bcea0f5484b6afdf0bdca2cb4.png
[*]删除操作
https://img-blog.csdnimg.cn/img_convert/538544ebeb14e140c4e0da2111dcb31e.png
[*]更新操作
https://img-blog.csdnimg.cn/img_convert/acf0a179b853bb9a295cd42ce431ddc1.png
[*]查询操作
https://img-blog.csdnimg.cn/img_convert/3b7ecc3fb08cf0b84b1f4b5cb24abc06.png
[*]更多的数据库操作建议可以检察官方文档mysql 代码生成 | go-zero Documentation,本教程更注重于实践操作以及代码实现。
测试与验证
[*]编写完业务后我们启动服务,关于服务启动在(三)Go-Zero和goctl:解锁微服务开发的神器,快速上手指南 中有详细讲解,这里不举行重复讲解。
https://img-blog.csdnimg.cn/img_convert/27f2a3fb8d16a193675221958cb04e21.png
https://img-blog.csdnimg.cn/img_convert/fe6d0fdd6d5df2041664f459aa72dd8c.png
https://img-blog.csdnimg.cn/img_convert/28f46b6cbf8c1bf138fa13e40d4250ba.png
[*]可以瞥见成功举行了用户注册,阐明插入操作有用。
结语
至此,我们已经完成了数据库相干设置,以及通过用户服务和注册接口了解到了常规的增删改查操作。
关于更详细的实现,假如有小伙伴有需求,我们可以单独拿一节课来举行详细的拆分讲解。
本篇文章先容了Go-Zero中的数据库操作,并提供了常用的命令示例。通过学习和实践,我们可以更加纯熟地利用Go-Zero举行高效的数据库操作。在后续的文章中,我们将进一步探索数据库操作的高级用法和本领,为小伙伴们提供更多的参考。
欢迎关注 ❤
我的文章都首发在同名公众号:王中阳
需要简历优化或者就业辅导,可以直接加我微信:wangzhongyang1993,备注:知乎
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。
页:
[1]