go-zero 单体应用实践（一）

最新推荐文章于 2024-09-19 21:31:04 发布
最新推荐文章于 2024-09-19 21:31:04 发布
阅读量1.6k 收藏 7
点赞数
分类专栏： go-zero 文章标签： golang
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Devin_S/article/details/125883902
版权

环境搭建

官方文档

  • Golang 环境安装 👉 golang
  • Go Module设置 go env -w GO111MODULE="on"
  • goctl安装 👉 goctl
  • protoc & protoc-gen-go安装 goctl env check -i -f --verbose

etcd，redis，mysql 等开发工具可以通过Docker 快速搭建；可参考👉 gonivinck

创建单体应用

1、创建目录

mkdir user-login
cd user-login
go mod init user-login

2、编辑api文件 userlogin.api

api语法介绍

type (
	RegisterRequest {
		Name     string `json:"name"`
		Email    string `json:"email"`
		Password string `json:"password"`
	}

	RegisterResponse {
		ID    int    `json:"id"`
		Name  string `json:"name"`
		Email string `json:"email"`
	}

	LoginRequest {
		Email    string `json:"email"`
		Password string `json:"password"`
	}

	LoginResponse {
		Token  string `json:"token"`
		Expire int64  `json:"expire"`
	}
)

service userlogin-api {
	@handler RegisterHandler
	post /api/register(RegisterRequest) returns (RegisterResponse);
	
	@handler LoginHandler
	post /api/login(LoginRequest) returns (LoginResponse);
}

3、执行生成代码命令

goctl api go -api userlogin.api -dir .
go mod tidy

生成文件目录

userlogin
├─etc // // 配置文件
├─internal
│  ├─config  // 配置声明type
│  ├─handler  // 路由及handler转发
│  ├─logic  // 业务逻辑
│  ├─svc // logic所依赖的资源池
│  └─types  // request、response的struct，根据api自动生成

4、编辑配置文件 userlogin/etc/userlogin-api.yaml

Name: userlogin-api
Host: 0.0.0.0
Port: 8888
Mysql:
  DataSource: root:123456@tcp(mysql:3306)/user?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai

CacheRedis:
  - Host: redis:6379
    Type: node

Salt: DWe7OZf6KPlnv7yy
Auth:
  AccessSecret: uOvKLmVfztaXGpNYd4Z0I1SiT7MweJhl
  AccessExpire: 86400

添加config声明 userlogin/internal/config/config.go
其中Salt 用来密码加密存储，Auth 用于 jwt鉴权

type Config struct {
	rest.RestConf
	Mysql struct {
		DataSource string
	}

	CacheRedis cache.CacheConf
	Salt       string
	Auth       struct {
		AccessSecret string
		AccessExpire int64
	}
}

4、生成Model文件

添加用户表 userlogin/model/user.sql

CREATE TABLE `user` (
  `id` bigint unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(255)  NOT NULL DEFAULT '' COMMENT '用户姓名',
  `email` varchar(255)  NOT NULL DEFAULT '' COMMENT '用户邮箱',
  `password` varchar(255)  NOT NULL DEFAULT '' COMMENT '用户密码',
  `create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
  `update_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`),
  UNIQUE KEY `idx_email_unique` (`email`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4;

通过命令生成model文件 model 指令

goctl model mysql ddl -src=“userlogin/model/user.sql” -dir=“userlogin/model/” -c

-c 参数代表 在model层使用缓存 需要配置对应的 CacheRedis
生成文件如下：

user.sql
usermodel.go
usermodel_gen.go
vars.go

可以看到 goctl 已经生成了 UserModel interface 并实现了基本的增删改查询代码；

UserModel

5、完善服务依赖

编辑 userlogin/internal/svc/servicecontext.go 添加 logic所依赖的 UserModel

type ServiceContext struct {
	Config config.Config

	UserModel model.UserModel
}

func NewServiceContext(c config.Config) *ServiceContext {
	conn := sqlx.NewMysql(c.Mysql.DataSource)

	return &ServiceContext{
		Config:    c,
		UserModel: model.NewUserModel(conn, c.CacheRedis),
	}
}

6、业务逻辑代码

1、注册逻辑代码

type RegisterLogic struct {
	logx.Logger
	ctx    context.Context
	svcCtx *svc.ServiceContext
}

func NewRegisterLogic(ctx context.Context, svcCtx *svc.ServiceContext) *RegisterLogic {
	return &RegisterLogic{
		Logger: logx.WithContext(ctx),
		ctx:    ctx,
		svcCtx: svcCtx,
	}
}

func (l *RegisterLogic) Register(req *types.RegisterRequest) (resp *types.RegisterResponse, err error) {

	_, err = l.svcCtx.UserModel.FindOneByEmail(l.ctx, req.Email)
	if err == nil {
		return nil, status.Error(100, "该用户已存在")
	}
	if err != model.ErrNotFound {
		return nil, status.Error(100, err.Error())
	}
	newUser := model.User{
		Name:     req.Name,
		Email:    req.Email,
		Password: cryptx.PasswordEncrypt(l.svcCtx.Config.Salt, req.Password),
	}

	res, err := l.svcCtx.UserModel.Insert(l.ctx, &newUser)
	if err != nil {
		return nil, status.Error(500, err.Error())
	}

	newUser.Id, err = res.LastInsertId()
	if err != nil {
		return nil, status.Error(500, err.Error())
	}

	return &types.RegisterResponse{
		ID:    int(newUser.Id),
		Name:  newUser.Name,
		Email: newUser.Email,
	}, nil
}

2、添加 JWT 工具 userlogin/common/jwtx/jwt.go

package jwtx

import "github.com/golang-jwt/jwt"

func GetToken(secretKey string, iat, seconds, uid int64) (string, error) {
	claims := make(jwt.MapClaims)
	claims["exp"] = iat + seconds
	claims["iat"] = iat
	claims["uid"] = uid
	token := jwt.New(jwt.SigningMethodHS256)
	token.Claims = claims
	return token.SignedString([]byte(secretKey))
}

3、用户登录逻辑 userlogin/internal/logic/loginlogic.go

type LoginLogic struct {
	logx.Logger
	ctx    context.Context
	svcCtx *svc.ServiceContext
}

func NewLoginLogic(ctx context.Context, svcCtx *svc.ServiceContext) *LoginLogic {
	return &LoginLogic{
		Logger: logx.WithContext(ctx),
		ctx:    ctx,
		svcCtx: svcCtx,
	}
}

func (l *LoginLogic) Login(req *types.LoginRequest) (resp *types.LoginResponse, err error) {
	res, err := l.svcCtx.UserModel.FindOneByEmail(l.ctx, req.Email)
	if err != nil {
		if err == model.ErrNotFound {
			return nil, status.Error(100, "用户不存在")
		}
		return nil, status.Error(500, err.Error())
	}
	// 判断密码是否正确
	password := cryptx.PasswordEncrypt(l.svcCtx.Config.Salt, req.Password)
	if password != res.Password {
		return nil, status.Error(100, "密码错误")
	}
	now := time.Now().Unix()
	accessExpire := l.svcCtx.Config.Auth.AccessExpire

	accessToken, err := jwtx.GetToken(l.svcCtx.Config.Auth.AccessSecret, now, accessExpire, res.Id)
	if err != nil {
		return nil, err
	}
	return &types.LoginResponse{
		Token:  accessToken,
		Expire: now + accessExpire,
	}, nil
}

7、启动测试

go run userlogin.go -f etc/userlogin-api.yaml
# Starting server at 0.0.0.0:8888...

注册测试

curl -i -X POST http://127.0.0.1:8888/api/register -H 'Content-Type: application/json' -d '{"name":"test","email":"test@gmail.com","password":"****"}'

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Traceparent: 00-91ee4162c2a42c7df3111ab73cdb242f-1b886700e9099cc8-00
Date: Tue, 19 Jul 2022 16:19:33 GMT
Content-Length: 47

{"id":1,"name":"test","email":"test@gmail.com"}

登录测试

curl -i -X POST http://127.0.0.1:8888/api/login -H 'Content-Type: application/json' -d '{"email":"test@gmail.com","password":"****"}'

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Traceparent: 00-4cc2b11a99a2216590c50a2a7215e832-d7af5dc45fa6a65b-00
Date: Tue, 19 Jul 2022 16:22:28 GMT
Content-Length: 171

{"token":"eyJhbGciOiJIUzI1NiI………………………………","expire":1658334148}

jwt鉴权应用

上面已经完成了登录注册功能；并且登录返回了Token；接下来就用一下Token

1、开启jwt鉴权

编写 api 文件 在 service 上方声明使用jwt鉴权
修改 userlogin/userlogin.api 重新执行 goctl api 命令

type UserInfoResponse {
		ID    int64    `json:"id"`
		Name  string `json:"name"`
		Email string `json:"email"`
	}

@server(
	jwt: Auth // Auth 与 userlogin/internal/config/config.go 中配置的 jwt 参数对应
)
service userlogin-api {
	@handler UserInfo
	get /api/userinfo returns (UserInfoResponse)
}

可以看到路由文件中 userlogin/internal/handler/routes.go 新增的路由中通 WithJwt 声明了使用jwt鉴权

server.AddRoutes(
		[]rest.Route{
			{
				Method:  http.MethodGet,
				Path:    "/api/userinfo",
				Handler: UserInfoHandler(serverCtx),
			},
		},
		rest.WithJwt(serverCtx.Config.Auth.AccessSecret),
	)

2、编写logic 代码

userlogin/internal/logic/userinfologic.go

func NewUserInfoLogic(ctx context.Context, svcCtx *svc.ServiceContext) *UserInfoLogic {
	return &UserInfoLogic{
		Logger: logx.WithContext(ctx),
		ctx:    ctx,
		svcCtx: svcCtx,
	}
}

func (l *UserInfoLogic) UserInfo() (resp *types.UserInfoResponse, err error) {
	uid, _ := l.ctx.Value("uid").(json.Number).Int64()
	one, err := l.svcCtx.UserModel.FindOne(l.ctx, uid)
	if err != nil {
		return nil, err
	}
	return &types.UserInfoResponse{
		ID:    one.Id,
		Name:  one.Name,
		Email: one.Email,
	}, nil
}

3、运行测试

# curl -i http://127.0.0.1:8000/api/userinfo

HTTP/1.1 401 Unauthorized
Traceparent: 00-a418d68212d9e2c29664a7e9aeefbd14-7282c005bbcd5f24-00
Date: Thu, 21 Jul 2022 17:01:21 GMT
Content-Length: 0

#curl -i -X GET  'http://127.0.0.1:8000/api/userinfo'  -H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2NTg1MDkzNDAsImlhdCI6MTY1ODQyMjk0MCwidWlkIjoxfQ.j6K0CjJ9jM5a3a7-DRUGq6b3uvMFcelvR7vQkZAQXWw'

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Traceparent: 00-e547b466d3e7da54d932838bfdee17c4-4ec7aaedb056ef03-00
Date: Thu, 21 Jul 2022 17:07:42 GMT
Content-Length: 47

{"id":1,"name":"test","email":"test@gmail.com"}
Devin_S
关注
专栏目录
【go-zero】simple-admin 开篇：进击 go-zero 二开框架 simple-admin 加速 go-zero 开发 之 rpc项目快速创建（更新中~）
CTRA®王大大技术中心
04-12 617
【go-zero】simple-admin 开篇：进击 go-zero 二开框架 simple-admin 加速 go-zero 开发 之 rpc项目快速创建（更新中~）
企业项目迁移go-zero全攻略（一）
我心飞翔
01-21 992
作者：Mikael 最近发现 golang 社区里出了一个新兴的微服务框架。看了一下官方提供的工具真的很好用，只需要定义好 .api 文件模版代码都可以一键生成，只需要关心业务；同时 core 中的工具极大减少了开发成本。 废话不多说，来看看这个微服务框架：go-zero 起源 聊聊与go-zero结缘 最先接触go-zero是2020年10月国庆假期，说来也巧，看到有人在go-micro群中问go-zero情况，当时go-zero作者在群中就大概回答了一下，引起了我的好奇，当时公司用的go-micro1.
go-zero 单体应用最假实践 - chat
qq_26798857的博客
05-07 2049
### 相关信息 应用前后端分离实现 后端：golang 前端：vue 框架：go-zero、Mint UI 功能清单： - 用户注册、登录 - 用户搜索、添加好友、删除好友 - 发送/接收文本消息（支持离线消息的接收） ### 几张功能时序图 1、添加好友 ![go-zero 单体应用最假实践之chat（聊天）](https://cdn.learnku.com/uploads/images/202205/05/29943/EJ1NViae5e.png!large) > 1、用户A请求api接口
2024 go-zero社交项目实战
最新发布
qq_33665793的博客
09-19 1327
一位商业大亨，他非常看好国内的社交产品赛道，想要造一款属于的社交产品，于是他找到了负责软件研发的小明。 小明跟张三一拍即合，小明决定跟张三大干一番。
go-zero单体应用入门实战（一）
u013477601的博客
06-03 3009
go-zero是一个go语言的框架，类似于java中的spring boot和spring cloud。作者是国内go语言大神级人物，万俊峰Kevin。go-zero功能非常强大，初学者建议从单体应用开始，再逐步深入。
go-zero 单体应用框架学习—4 监听端口
wanmei002的博客
05-13 505
框架运行起来 先说下思路: 注册必要的中间件 给每个路由处理函数用中间件处理 给路由生成字典树 开始监听端口 启动入口 入口函数 server.Start() ，实际上运行的是 Server.opts.start。 在 go-zero/rest/engine.go 文件中的 bindRoute 方法, 这个里面注册了中间件， 并对路由处理函数用中间件处理。中间件原理请看这篇文章 ```go func (c Chain) Then(h http.Handler) http.Handler {
go-zero 单体应用实践（二）
Devin_S的博客
07-25 1511
在go-zero中，中间件可以分为路由中间件和全局中间件，路由中间件是指某一些特定路由需要实现中间件逻辑，其和jwt类似，没有放在jwtxxx下的路由不会使用中间件功能，而全局中间件的服务范围则是整个服务。...
go-zero单体应用入门实战（四）
u013477601的博客
06-03 288
先删除types/types.go文件，新建mytypes/types.go。goctl（可能版本过低）生成，不支持结构体泛型。
使用Go语言和go-zero框架开发高性能服务器应用
该项目不仅展示了Go语言在构建Web服务和微服务架构方面的应用，同时也为开发者提供了一个学习和实践Go语言和微服务架构的平台。开发者可以通过这个项目学习如何使用Go语言和go-zero框架进行实际的Web服务开发，以及...
Go 语言体系下的微服务框架选型：Dubbo-go
阿里云技术
04-10 362
Go 语言作为云原生领域最受欢迎的开发语言，正被越来越多的企业作为微服务开发的首选语言，其中比较流行的包括 Go-micro、Go-zero、Dubbo-go 等。
云原生Go微服务框架与CLI工具一站式解决方案
Go语言（又称Golang）是一种编译型、静态类型语言，由Google设计，它以其简洁、高效、安全、并发性能优良而广受欢迎，特别适合构建微服务架构中的后端服务。Go语言提供了强大的标准库和第三方库，可以快速构建高性能...
go-zero单体应用入门实战（七）
u013477601的博客
06-03 359
下一步将上面的"program": "${fileDirname}"改为"program": "${workspaceFolder}/service/marsbook/api"
go-zero单体应用入门实战（三）
u013477601的博客
06-03 485
编写一个简单的api。
go-zero单体应用入门实战（二）
u013477601的博客
06-03 510
项目名称：火星电子书店 参考项目结构：参照微服务架构来搭建，方便以后扩展。单体应用可以看作微服务架构当中的一个特例。软件架构在以后业务发展，逐步重构，好的架构是重构出来的。
go-zero 单体应用框架学习—3 路由生成字典树
wanmei002的博客
05-13 594
找到实现 http.Handler 接口的结构体 顺着入口函数 server.Start()，找到了 router.NewRouter() 创建的对象实现了 http.Handler 接口 创建的对象为 router.patRouter 结构体的实例 这个结构体有两个方法 Handle 路由生成字典树 ServeHTTP 方法实现了 http.Handler 接口，这个方法里有路由匹配，匹配失败的逻辑 type patRouter struct { trees map[string]*sea
GO语言：微服务简介--构建单体应用
qianfeng_dashuju的博客
11-06 320
互联网技术发展迅速的今天，微服务倍受关注：文章、博客、社交媒体讨论和会议演讲都在谈论。与此同时，也有持怀疑态度的软件社区人员认为微服务没什么新鲜可言。反对者声称它的思想只是面向服务架构的重塑。然而，无论是炒作还是怀疑，不可否认，微服务架构模式具有非常明显的优势 —- 特别是在实施敏捷开发和复杂的企业应用迭代开发方面。 从本篇文章开始，我们来开学了解学习微服务的相关知识。 单体应用 我们先不问微服务是什么？微服务该如何实现？让我们从我们原本最熟悉的创建一个应用和一个普通的项目开始说起。 打车系统 我
go-zero开发流程
qq_35429326的博客
01-06 522
添加user rpc配置,service/user/api/internal/config/config.go。添加user rpc配置,service/user/api/internal/config/config.go。完善服务依赖,service/user/api/internal/svc/servicecontext.go。添加yaml配置，service/user/api/etc/config.yaml。添加yaml配置，service/user/api/etc/config.yaml。
Go-Zero 开源项目教程
gitblog_00368的博客
08-07 675
Go-Zero 开源项目教程 go-zeroA cloud-native Go microservices framework with cli tool for productivity.项目地址:https://gitcode.com/gh_mirrors/go/go-zero 1. 项目介绍 Go-Zero（go-zero）是收录于CNCF全景图的一个Web和RPC框架，它集成了多种工程实...
go-zero开发入门-API网关开发示例
一见
12-08 1225
开发一个 API 网关，代理 https://blog.csdn.net/Aquester/article/details/134856271 中的 RPC 服务。 编译网关源码生成可执行程序文件 生成被代理 RPC 服务的 pb 文件 add.pb 是一个二进制文件。
go-zero-1.5.5：高并发稳定的Go语言Web/RPC框架
资源摘要信息: "go-zero（版本号为1.5.5）是一个为处理大...综上所述，go-zero是一个功能强大的Web和RPC框架，它结合了Go语言的高效性能与实战中打磨出来的稳定架构，是构建高性能Web应用和分布式系统不可或缺的工具。
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Devin_S

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值