go-zero(三) 数据库操作

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 LoginHandlerpost /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) errorDelete(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.RestConfMysqlDb 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.DbSourceUserModel:   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 lineuserModel := l.svcCtx.UserModel  //从服务上下文获取UserModel //调用FindOneByUsername查询用户数据，判断用户是否已经注册//req.Username 从请求信息中获取 Usernameuser, _ := 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.UserModeluser, _ := 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}}

运行项目

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.rhkb.cn/news/475082.html

如若内容造成侵权/违法违规/事实不符，请联系长河编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

MFC图形函数学习09——画多边形函数

MFC图形函数学习09——画多边形函数

这里所说的多边形是指在同一平面中由多条边构成的封闭图形，强调封闭二字，否则无法进行颜色填充，多边形包括凸多边形和凹多边形。 一、绘制多边形函数 原型：BOOL Polygon(LPPOINT lpPoints,int nCount); 参数&#x…
阅读更多...
【算法】回文数索引、回文子串输出、整数反转

【算法】回文数索引、回文子串输出、整数反转

目录 回文数索引 思路： 回文子串输出 思路 回文数索引 思路： 目标字母索引可能是一个或者是两个，返回任意的一个索引即可，如果已经是回文串则直接返回-1。 下面列出几种目标删除字母可能出现的位置： 我们可以先定…
阅读更多...
MAC创建一个自动操作，启动系统【睡眠】功能，并将绑定快捷键

MAC创建一个自动操作，启动系统【睡眠】功能，并将绑定快捷键

目的 通过 Automator 创建一个服务来启动系统【睡眠】这个功能，并绑定快捷键。 步骤一：创建 Automator 服务 打开 Automator： ○ 在 Spotlight 中搜索 Automator，然后打开。选择服务类型： ○ 在 Automator 的启动界…
阅读更多...
ThinkPHP6门面（Facade)

ThinkPHP6门面（Facade)

门面 门面（Facade） 门面为容器中的（动态）类提供了一个静态调用接口，相比于传统的静态方法调用， 带来了更好的可测试性和扩展性，你可以为任何的非静态类库定义一个facade类。 系统已经为大部分…
阅读更多...
1436：数列分段II -整型二分

1436：数列分段II -整型二分

1436&#xff1a;数列分段II 题目来源&#xff1a;一本通 【输入样例】 5 3 4 2 4 5 1【输出样例】 6题意 将数列分成若干段&#xff0c;最多M段&#xff0c;求这些段中最大值中的最小值。&#xff08;M<N是M的约束&#xff09; 思路 最大最小问题考虑二分。由于M越大&…
阅读更多...
Linux-第1集-基础指令 pwd、cd……入门

Linux-第1集-基础指令 pwd、cd……入门

欢迎来到Linux操作系统的世界&#xff0c;本集我会用最简单的语言给大家讲解最基础的指令。 首先我们要明确Linux是通过指令完成相应的操作&#xff0c; 由于Linux的用户都是行内人&#xff0c;所有我们在学习此操作系统时看到的都是指令界面&#xff0c;而非像Windows操作系…
阅读更多...
Golang | Leetcode Golang题解之第564题寻找最近的回文数

Golang | Leetcode Golang题解之第564题寻找最近的回文数

题目&#xff1a; 题解&#xff1a; func nearestPalindromic(n string) string {m : len(n)candidates : []int{int(math.Pow10(m-1)) - 1, int(math.Pow10(m)) 1}selfPrefix, _ : strconv.Atoi(n[:(m1)/2])for _, x : range []int{selfPrefix - 1, selfPrefix, selfPrefix …
阅读更多...
【最新鸿蒙应用开发】——合理使用自定义弹框

【最新鸿蒙应用开发】——合理使用自定义弹框

自定义弹窗选型 合理选择不同的系统能力实现弹窗&#xff0c;有利于提升应用开发效率&#xff0c;实现更好的功能需求&#xff0c;因此了解自定义弹窗的选型和差异非常重要。在应用开发中&#xff0c;为了选择出合适的弹窗选型&#xff0c;从使用场景上&#xff0c;需要重点关…
阅读更多...
044 商品详情(异步编排)

044 商品详情(异步编排)

文章目录 销售属性分组规格参数异步编排application.ymlMyThreadConfig.javaThreadPoolConfigProperties.javaSkuInfoServiceImpl.java 销售属性 sku表&#xff1a;tb_sku_info sku对应销售属性表&#xff1a;tb_sku_sale_attr_value 结果 在详情页系统中&#xff0c;切换属…
阅读更多...
【热门主题】000054 ECMAScript：现代 Web 开发的核心语言

【热门主题】000054 ECMAScript：现代 Web 开发的核心语言

前言&#xff1a;哈喽&#xff0c;大家好&#xff0c;今天给大家分享一篇文章&#xff01;并提供具体代码帮助大家深入理解&#xff0c;彻底掌握&#xff01;创作不易&#xff0c;如果能帮助到大家或者给大家一些灵感和启发&#xff0c;欢迎收藏关注哦 &#x1f495; 目录 【热…
阅读更多...
进程优先级——Linux

进程优先级——Linux

目录 前言 查看系统进程 进程优先级的修改 Linux调度与切换 Cpu的进程切换 Linux实现调度的算法 前言 进程访问系统资源要排队等待&#xff0c;而cpu资源分配和执行的先后顺序&#xff0c;就是指进程的优先级。进程的优先级&#xff0c;保证了必要进程的执行。进程访问某…
阅读更多...
11.18 Maven-SpringBootWeb入门

11.18 Maven-SpringBootWeb入门

Maven 什么是maven? Maven是apache旗下的一个开源项目&#xff0c;是一款用于管理和构建java项目的工具。 Apache 软件基金会&#xff0c;成立于1999年7月&#xff0c;是目前世界上最大的最受欢迎的开源软件基金会&#xff0c;也是一个专门为支持开源项目而生的非盈利性组织…
阅读更多...
selenium元素定位校验以及遇到的元素操作问题记录

selenium元素定位校验以及遇到的元素操作问题记录

页面元素定位方法及校验 使用比较多的是通过id、class和xpath来对元素进行定位。在定位前可以现在浏览器验证是否可以找到指定的元素。这样就不用每添加一个元素定位都运行代码来检查定位方式表达式是否正确。 使用XPATH定位 在浏览器F12&#xff0c;找到元素&#xff0c;在元…
阅读更多...
【UGUI】Unity 背包系统实现02：道具信息提示与显示

【UGUI】Unity 背包系统实现02：道具信息提示与显示

在游戏开发中&#xff0c;背包系统是一个常见的功能模块&#xff0c;用于管理玩家拾取的物品。本文将详细介绍如何在 Unity 中实现一个简单的背包系统&#xff0c;包括道具信息的提示和显示功能。我们将通过代码和场景搭建来逐步实现这一功能。 1. 功能需求清单 在实现背包系…
阅读更多...
服务器上部署并启动 Go 语言框架 **GoZero** 的项目

服务器上部署并启动 Go 语言框架 **GoZero** 的项目

要在服务器上部署并启动 Go 语言框架 **GoZero** 的项目&#xff0c;下面是一步步的操作指南&#xff1a; ### 1. 安装 Go 语言环境 首先&#xff0c;确保你的服务器上已安装 Go 语言。如果还没有安装&#xff0c;可以通过以下步骤进行安装&#xff1a; #### 1.1 安装 Go 语…
阅读更多...
Node.js | Yarn下载安装与环境配置

Node.js | Yarn下载安装与环境配置

一、安装Node.js Yarn 是 Node.js 下的包管理工具&#xff0c;因此想要使用 Yarn 就必须先下载 Node.js。 推荐参考&#xff1a;Node.js | npm下载安装及环境配置教程 二、Yarn安装 打开cmd&#xff0c;输入以下命令&#xff1a; npm install -g yarn检查是否安装成功&…
阅读更多...
【Linux实践2】实验四：存储管理

【Linux实践2】实验四：存储管理

文章目录 一、存储管理的目的1.1 内存空间的分配与回收1.2 地址转换1.3 内存保护1.4 内存共享1.5 内存扩充 二、可变分区存储管理2.1 分区结构体定义2.2 初始化分区链表 三、内存分配算法实现3.1 首次适应算法&#xff08;First Fit&#xff09;3.1.1 算法实现 3.2 循环首次适应…
阅读更多...
linux 中mysql查看慢日志

linux 中mysql查看慢日志

1、到mysql容器&#xff0c;先登录到数据库&#xff0c;查看是否开启 mysql -h 127.0.0.1 -uroot -p SHOW VARIABLES LIKE slow_query_log; 2、如果没有开启&#xff0c;需要先开启 set global slow_query_log ON; 3、查看慢日志文件 SHOW VARIABLES LIKE slow_query_log…
阅读更多...
微服务day09

微服务day09

DSL查询 快速入门 GET /items/_search {"query": {"match_all": {}} } 叶子查询 GET /items/_search {"query": {"match_all": {}} }GET /items/_search {"query": {"multi_match": {"query": "脱…
阅读更多...
vue中el-select 模糊查询下拉两种方式

vue中el-select 模糊查询下拉两种方式

第一种&#xff1a;先获取所有下拉数据再模糊查询&#xff0c;效果如下 1&#xff0c;页面代码&#xff1a;speciesList是种类列表List, speciesId 是speciesList里面对应的id&#xff0c;filterable是过滤查询标签 <el-form-item label"种类" prop"species…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023