go-zero(三) 数据库操作

🕗 发布于 2024-11-18 20:02 golang 数据库 android

go-zero 数据库操作

在本篇文章中，我们将实现一个用户注册和登录的服务。我们将为此构建一个简单而高效的 API，包括请求参数和响应参数的定义。

一、Mysql连接

1. 创建数据库和表

在 MySQL 中创建名为 test_zero的数据库，并创建`user 表

CREATE TABLE `users` (
`id` BIGINT NOT NULL AUTO_INCREMENT,
`username` VARCHAR(50) NOT NULL COLLATE 'utf8_general_ci',
`password` VARCHAR(255) NOT NULL COLLATE 'utf8_general_ci',
`created_at` TIMESTAMP NULL DEFAULT (CURRENT_TIMESTAMP),
PRIMARY KEY (`id`) USING BTREE,
UNIQUE INDEX `username` (`username`) USING BTREE
)
COLLATE='utf8_general_ci'
ENGINE=InnoDB
;

可以看到username 字段被我设置了唯一性即UNIQUE ，这里先解释一下，使用goctl 生成model代码的时候，它会自动帮我们生成增删改查等方法。

如果字段设置了唯一性，它会自动生成通过这个字段查找数据的方法，后续我希望通过username去查询和修改用户数据，所以这里设置了一下。

2. 创建API文件

接下来我们根据这个表，创建user.api文件，

syntax = "v1"

type (
// 定义注册接口的 json 请求体
RegisterRequest {
//请求体定义了 Username 和Password 字段， 并且都设置了不能为空
Username string `json:"username" validate:"required"`   
Password string `json:"password" validate:"required"`
}
// 定义注册接口的 json 响应体
RegisterResponse {
//响应体 定义类一个Message  用来返回结果
Message string `json:"message"`
}
)

type (
// 定义登录接口的 json 请求体
LoginRequest {
Username string `json:"username" validate:"required"`
Password string `json:"password" validate:"required"`
}
// 定义登录接口的 json 响应体
LoginResponse {
//正常的业务逻辑，用户登录后会产生一个token，用来记录登录信息
Token string `json:"token"`
}
)


@server (
group:  user //  生成代码时都会被放到 user 目录下
prefix: /v1 //定义路由前缀为 "/v1"
)


// 定义 HTTP 服务
// 微服务名称为 user-api，生成的代码目录和配置文件将和 user 值相关
service user-api {

// 定义用户注册接口
    //定义 http.HandleFunc 转换的 go 文件名称及方法
@handler RegisterHandler
// 请求方法为 post
    // 路由为 /register 
    // 请求体为 RegisterRequest
    // 响应体为 RegisterResponse，响应体必须有 returns 关键字修饰
post /register (RegisterRequest) returns (RegisterResponse)

//用户登录
@handler LoginHandler
post /login (LoginRequest) returns (LoginResponse)
}

这个 API 的结构可以通过注释清晰地理解。在下面这段代码中，我们可以看到请求参数和响应参数之间通过 returns 进行修饰：

post /register (RegisterRequest) returns (RegisterResponse)

需要注意的是，请求参数和响应参数并不总是必需的。

例如，在更新数据时，我们可以省略响应体，只保留请求参数：

post /update (UpdateUserInfoReq)

同样，当我们通过 token 获取数据时，也可以省略请求体，而只定义响应参数：

get /getinfo returns (UserInfoResp)

这样的灵活性使得 API 定义更加简洁明了。

3. 生成服务代码和model代码

我们创建一个新的项目，目录设置为user ，使用goctl通过user.api生成项目代码:

goctl api go --api user.api --dir ./

下面我们就演示怎么使用goclt 以及sql生成model ，在刚刚生成的项目中，在internal目录下创建一个modle的文件夹，然后再这个文件夹下面创建user.sql，把之前的sql语句粘贴进来，然后使用命令：

 goctl model mysql ddl --src user.sql --dir ./

当你看到 Done. 输出则代表生成成功了，帮我们生成了下面3个文件。

$ tree
.
├── usermodel.go
├── usermodel_gen.go
└── vars.go

usermodel.go: 定义数据库表的模型及其业务逻辑。
usermodel_gen.go: 自动生成的代码，包含数据库操作的实现。
vars.go: 全局变量和配置的定义，供各个模块使用。

4.查看model代码

现在我们来具体看下goctl帮我们生成的model代码，我们先看下usersmodel.go文件，

它帮我们定义了NewUsersModel 用来返回user表模型

// NewUsersModel returns a model for the database table.
//NewUsersModel 返回数据库表的模型
func NewUsersModel(conn sqlx.SqlConn) UsersModel {
return &customUsersModel{
defaultUsersModel: newUsersModel(conn),
}
}

接着看下usersmodel_gen.go文件：

帮我们根据数据库自动生成了数据模型

 
Users struct {
Id        int64     `db:"id"`
Username  string    `db:"username"`
Password  string    `db:"password"`
CreatedAt time.Time `db:"created_at"`
}

给usersModel定义了基本的增删改查的接口

usersModel interface {
    Insert(ctx context.Context, data *Users) (sql.Result, error)
    FindOne(ctx context.Context, id int64) (*Users, error)
    FindOneByUsername(ctx context.Context, username string) (*Users, error)
    Update(ctx context.Context, data *Users) error
    Delete(ctx context.Context, id int64) error
}

5.链接数据库

go-zero 提供了一个强大的 sqlx 工具，用于操作数据库。所有 SQL 相关操作的包在 github.com/zeromicro/go-zero/core/stores/sqlx

在使用 go-zero 框架与数据库交互时，通常会遵循一系列的步骤和逻辑，下面是调用数据库的典型顺序和逻辑：

增加数据库连接配置

打开 etc\user-api.yaml文件，增加 MySQL 连接字符串：

#定义了一个名为MysqlDB的结构体，并有一个名为DbSource的字符串。
MysqlDB:
# 字符串请根据实际配置环境更改
  DbSource: "root:root@tcp(127.0.0.1:3306)/test_zero"

设置结构体，用来解析配置文件

现在我们需要把这个MysqlDB这个字段映射到 go-zero的结构体中，打开internal/config/config.go 文件，把代码修改为以下：

type Config struct {
rest.RestConf

MysqlDb struct{
DbSource string `json:"DbSource"`
}
}

我们之前提到过，Config 结构体中的字段与 YAML 文件中的字段可以不区分大小写，但必须保持一致，否则会导致解析错误。如果希望使用不同的名称，可以通过 json: 标签指定 YAML 文件中对应的字段名。

把数据库连接注册到服务上下文

go-zero提供了一个快捷的方式可以创建 Mysql 链接，接着我们就可以使用这个连接进行各种数据库操作:

func NewMysql(datasource string, opts ...SqlOption) SqlConn

我们先使用sqlx.NewMysql(c.MysqlDb.DbSource) 创建数据库连接，然后传给NewUsersModel,初始化UserModel,打开internal/svc/servicecontext.go文件，把代码修改为：

//ServiceContext 结构体用户封装服务的上下文信息，相当环境初始化

type ServiceContext struct {
Config config.Config  
//UserModel: 类型为 model.UsersModel，表示与用户相关的数据库模型
//用于处理与用户相关的数据操作（如用户的创建、读取、更新和删除等）
UserModel model.UsersModel     
}
//NewServiceContext 是ServiceContext 的构造函数
//它接收配置参数并初始化 ServiceContext，确保服务可以访问所需的配置和数据模型
func NewServiceContext(c config.Config) *ServiceContext {
return &ServiceContext{
Config: c,  //把配置信息注册到服务上下文

//通过调用 model.NewUsersModel 函数对UserModel 进行初始化
//sqlx.NewMysql 是数据库连接,链接字符串为config中的MysqlDb.DbSource
UserModel:   model.NewUsersModel(sqlx.NewMysql(c.MysqlDb.DbSource)),
}
}

sqlx.NewMysql 是 sqlx 包中的一个函数，通常用于创建一个新的 MySQL 数据库连接,我们可以看下它在go-zero中的代码，就是传入datasource 字符串，然后返回SqlConn 数据库连接

func NewMysql(datasource string, opts ...SqlOption) SqlConn {
opts = append([]SqlOption{withMysqlAcceptable()}, opts...)
return NewSqlConn(mysqlDriverName, datasource, opts...)
}

二、CURD演示

1. 实现注册服务（查、赠）

现在我们开始实现注册逻辑
打开internal/logic/user/registerlogic.go文件，修改代码如下：

func (l *RegisterLogic) Register(req *types.RegisterRequest) (resp *types.RegisterResponse, err error) {
// todo: add your logic here and delete this line

userModel := l.svcCtx.UserModel  //从服务上下文获取UserModel 

//调用FindOneByUsername查询用户数据，判断用户是否已经注册
//req.Username 从请求信息中获取 Username
user, _ := userModel.FindOneByUsername(l.ctx, req.Username)
//如果username不为空说明已经注册
if user != nil {
//已经存在用户
return nil, err
}
//插入新的数据
_, err = userModel.Insert(l.ctx, &model.Users{
Username:  req.Username,
Password:  req.Password,
CreatedAt: time.Now(),
})
if err != nil {
//注册失败
return nil, err
}
//返回响应信息
return &types.RegisterResponse{
Message: "注册成功",
}, nil
}

我们先运行程序，测试一下

在这里插入图片描述

2.实现登录服务（查）

现在我们开始实现=登录逻辑
打开internal/logic/user/loginlogic.go文件，修改代码如下：

func (l *LoginLogic) Login(req *types.LoginRequest) (resp *types.LoginResponse, err error) {
// todo: add your logic here and delete this line

//因为我们目前还没涉及到jwt鉴权，所以先把token当面message使用
userModel := l.svcCtx.UserModel
user, _ := userModel.FindOneByUsername(l.ctx, req.Username)
//查询username判断是否有数据
if user != nil { 
//如果有数据，密码是否和数据库匹配
if req.Password == user.Password {
return &types.LoginResponse{
Token: "登录成功",
}, nil
} else {
return &types.LoginResponse{
Token: "密码错误",
}, nil
}
} else {
return &types.LoginResponse{
Token: "用户未注册",
}, nil
}

}

运行项目

原文地址：https://blog.csdn.net/yang731227/article/details/143837221

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：笔记整理—linux驱动开发部分（13）块设备
下一篇：selinux和防火墙

PCL 三维重建 RBF移动立方体三维重建算法
RBF（径向基函数）Marching Cubes算法是一种基于RBF插值的方法，用于从点云数据中提取三维表面。这种算法结合了传统的Marching Cubes算法和径向基函数的优势，能够处理复杂的点云
阅读更多2024-11-19
Argo workflow 拉取git 并使用pvc共享文件
第一个任务（拉取 Git 仓库）：这个任务将使用 git 命令克隆指定的 Git 仓库。第二个任务（读取 Git 文件）：这个任务会读取第一个任务拉取的 Git 仓库中的文件。我们将使用 Argo W
阅读更多2024-11-19
java计算机毕业设计选题参考3000篇
【294】springboot+jpa+layui学生住宿管理系统mysql学生寝室分配系统含文档。基于微信小程序的社区车位租赁系统的设计与实现+springboot后台weixin200。【483】
阅读更多2024-11-19
《Python网络安全项目实战》项目6 编写密码工具程序_练习题(2)答案
《Python网络安全项目实战》项目6 编写密码工具程序_练习题(2)答案
阅读更多2024-11-19
三种方式js的引入
1.js的组成部分：BOM(browser object model)浏览器对象模型、DOM(document object model)文档对象模型、ECMAScript。2.js的引入方式:行内式
阅读更多2024-11-19
使用MQTTX连接新版ONENet
使用mqtt连接新版的onenet 教程包含产品创建设备创建，关键参数获取，token软件获取，token生成，mqttx软件的下载与使用数据流的上传等手把手操作帮助你上云
阅读更多2024-11-19
深度学习之其他常见的生成式模型
自回归模型通过对图像数据的概率分布pdataxpdatax进行显式建模，并利用极大似然估计优化模型。pdatax∏i1npxi∣x1x2xi−1pdataxi1∏npxi∣x1x2..
阅读更多2024-11-19
MySQL表的新增与查询
这里的值要和列的个数和类型相匹配使用'或者"来表示字符串。
阅读更多2024-11-19
Vue-组件三大组成&组件通信
style的默认样式是作用到哪里的？scoped的作用是什么？style中推不推荐加scoped？data写成函数的目的是什么？组件通信，就是指组件与组件之间的数据传递组件的数据是独立的，无法直接访问
阅读更多2024-11-19
Python爬虫学习路线精简大纲！！！
Python爬虫学习路线精简大纲！！！
阅读更多2024-11-19