当前位置： 首页 > news >正文

[Go 微服务] Kratos 验证码业务

news 来源：原创 2024/7/5 22:04:11

文章目录

      • 1.环境准备
      • 2.验证码服务
        • 2.1 kratos 初始化验证码服务项目
        • 2.2 使用 Protobuf 定义验证码生成接口
        • 2.3 业务逻辑代码实现

1.环境准备

protoc和protoc-gen-go插件安装和kratos工具安装

  1. protoc下载

    • 下载二进制文件：https://github.com/protocolbuffers/protobuf/releases 下拉到最下方下载系统对应的版本，将解压出来bin目录下的protoc.exe拷贝到GOPATH的bin目录下。
    • 查看protoc版本：protoc --version。
    • 在这里插入图片描述

  2. protoc-gen-go插件安装

    • protoc是针对所有语言开发的，protoc-gen-go是专门针对go语言开发，因为是使用go语言开发的，所以直接使用go install就可以进行安装，安装后在GOPATH的bin沐目录下就会有对应的二进制文件。
    • go install google.golang.org/protobuf/cmd/protoc-gen-go@latest，版本验证protoc-gen-go --version
    • go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest，版本验证protoc-gen-go-grpc --version
    • 在这里插入图片描述
    • 在这里插入图片描述

  3. kratos工具安装

    • kratos也是go语言编写的，帮助我们快速生成代码的，直接go install安装即可，安装完成也会在GOPATH的bin目录中生成二进制文件。
    • 安装命令：go install github.com/go-kratos/kratos/cmd/kratos/v2@latest
    • 版本验证：kratos -v
    • 在这里插入图片描述
    • 在这里插入图片描述

2.验证码服务

2.1 kratos 初始化验证码服务项目
kratos new kratos-demo03

在这里插入图片描述

PS E:\java\go_code> kratos new kratos-demo03
🚀 Creating service kratos-demo03, layout repo is https://github.com/go-kratos/kratos-layout.git, please wait a moment.Already up to date.CREATED E:\java\go_code\kratos-demo03\.gitignore (590 bytes)
CREATED E:\java\go_code\kratos-demo03\Dockerfile (483 bytes)
CREATED E:\java\go_code\kratos-demo03\LICENSE (1087 bytes)
CREATED E:\java\go_code\kratos-demo03\Makefile (2608 bytes)
CREATED E:\java\go_code\kratos-demo03\README.md (1113 bytes)
CREATED E:\java\go_code\kratos-demo03\api\helloworld\v1\error_reason.pb.go (5126 bytes)
CREATED E:\java\go_code\kratos-demo03\api\helloworld\v1\error_reason.proto (306 bytes)
CREATED E:\java\go_code\kratos-demo03\api\helloworld\v1\greeter.pb.go (8299 bytes)
CREATED E:\java\go_code\kratos-demo03\api\helloworld\v1\greeter.proto (711 bytes)
CREATED E:\java\go_code\kratos-demo03\api\helloworld\v1\greeter_grpc.pb.go (3667 bytes)
CREATED E:\java\go_code\kratos-demo03\api\helloworld\v1\greeter_http.pb.go (2213 bytes)
CREATED E:\java\go_code\kratos-demo03\cmd\kratos-demo03\main.go (1834 bytes)
CREATED E:\java\go_code\kratos-demo03\cmd\kratos-demo03\wire.go (645 bytes)
CREATED E:\java\go_code\kratos-demo03\cmd\kratos-demo03\wire_gen.go (1121 bytes)
CREATED E:\java\go_code\kratos-demo03\configs\config.yaml (306 bytes)
CREATED E:\java\go_code\kratos-demo03\go.mod (1301 bytes)
CREATED E:\java\go_code\kratos-demo03\go.sum (9022 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\biz\README.md (7 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\biz\biz.go (134 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\biz\greeter.go (1285 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\conf\conf.pb.go (21434 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\conf\conf.proto (805 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\data\README.md (8 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\data\data.go (500 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\data\greeter.go (880 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\server\grpc.go (867 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\server\http.go (872 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\server\server.go (158 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\service\README.md (11 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\service\greeter.go (723 bytes)
CREATED E:\java\go_code\kratos-demo03\internal\service\service.go (142 bytes)
CREATED E:\java\go_code\kratos-demo03\openapi.yaml (1169 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\README.md (15 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\errors\errors.proto (428 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\api\annotations.proto (1082 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\api\client.proto (3495 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\api\field_behavior.proto (3090 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\api\http.proto (15515 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\api\httpbody.proto (2748 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\any.proto (6067 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\api.proto (7942 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\compiler\plugin.proto (8937 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\descriptor.proto (39418 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\duration.proto (5011 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\empty.proto (2481 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\field_mask.proto (8430 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\source_context.proto (2389 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\struct.proto (3874 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\timestamp.proto (6606 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\type.proto (6313 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\google\protobuf\wrappers.proto (4165 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\openapi\v3\annotations.proto (2254 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\openapi\v3\openapi.proto (22754 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\validate\README.md (84 bytes)
CREATED E:\java\go_code\kratos-demo03\third_party\validate\validate.proto (32133 bytes)🍺 Project creation succeeded kratos-demo03
$ cd kratos-demo03
$ go generate ./...
$ go build -o ./bin/ ./...
$ ./bin/kratos-demo03 -conf ./configs🤝 Thanks for using Kratos📚 Tutorial: https://go-kratos.dev/docs/getting-started/start🤝 Thanks for using Kratos📚 Tutorial: https://go-kratos.dev/docs/getting-started/start

在这里插入图片描述

# 进入项目目录，拉取依赖\
cd kratos-demo03
go mod tidy# 安装wire工具：kratos使用了依赖注入来生成相关的代码，所以运行项目前也需要安装
go get github.com/google/wire/cmd/wire# 生成了wire_gen.go
go generate ./...

在这里插入图片描述

# 项目运行
kratos run

在这里插入图片描述

在这里插入图片描述

以上的layout的目录布局，仅仅是kratos推荐的项目目录布局方式

2.2 使用 Protobuf 定义验证码生成接口
  1. 定义 protobuf 文件说明接口
  2. 利用 protoc 基于 protobuf 生成必要代码
  3. 将生成的代码整合到项目中
  4. 完善业务逻辑
kratos proto add api/verifyCode/verifyCode.proto

在这里插入图片描述

syntax = "proto3";package api.verifyCode;
// 生成的go代码所在的包
option go_package = "kratos-demo03/api/verifyCode;verifyCode";
// 定义 VerifyCode 服务
service VerifyCode {rpc GetVerifyCode (GetVerifyCodeRequest) returns (GetVerifyCodeReply);
}
// 类型常量
enum TYPE {DEFAULT = 0;DIGIT = 1;LETTER = 2;MIXED = 3;
};
// 定义 GetVerifyCodeRequest 消息
message GetVerifyCodeRequest {//    验证码长度uint32 length = 1;// 验证码类型TYPE type = 2;}
// 定义 GetVerifyCodeReply 消息
message GetVerifyCodeReply {//    生成的验证码string code = 1;
}

基于verifyCode.proto生成 client（Stub）相关代码

  • kratos proto client api/verifyCode/verifyCode.proto
  • api/verifyCode/verifyCode.pb.go：类型定义代码
  • api/verifyCode/verifyCode_grpc.pb.go：gRPC服务定义代码

在这里插入图片描述

基于verifyCode.proto文件生成 grpc服务代码

  • kratos proto server api/verifyCode/verifyCode.proto -t internal/service
  • -t 选项指定生成文件所在位置，代码会生成在internal/service目录中的internal/service/verifycode.go
  • internal/service/verifycode.go该文件定义了最基本的 VerifyCode 服务和对应的 GetVerifyCode 方法

在这里插入图片描述

在这里插入图片描述

package serviceimport ("context"pb "kratos-demo03/api/verifyCode"
)type VerifyCodeService struct {pb.UnimplementedVerifyCodeServer
}func NewVerifyCodeService() *VerifyCodeService {return &VerifyCodeService{}
}func (s *VerifyCodeService) GetVerifyCode(ctx context.Context, req *pb.GetVerifyCodeRequest) (*pb.GetVerifyCodeReply, error) {return &pb.GetVerifyCodeReply{}, nil
}

将生成的服务代码注册到 gRPC 服务中

  • 更新 internal/service/service.go 文件
  • 在这里插入图片描述
  • 告知 wire 依赖注入系统，如果需要 VerifyCodeService 的话，使用NewVerifyCodeService 函数来构建

将 VerifyCodeService 注册到 gRPC 服务中

  • 更新 internal/server/grpc.go 文件
  • 在这里插入图片描述
package serverimport (v1 "kratos-demo03/api/helloworld/v1""kratos-demo03/api/verifyCode""kratos-demo03/internal/conf""kratos-demo03/internal/service""github.com/go-kratos/kratos/v2/log""github.com/go-kratos/kratos/v2/middleware/recovery""github.com/go-kratos/kratos/v2/transport/grpc"
)// NewGRPCServer new a gRPC server.
func NewGRPCServer(c *conf.Server, greeter *service.GreeterService, verifyCodeService *service.VerifyCodeService, logger log.Logger) *grpc.Server {var opts = []grpc.ServerOption{grpc.Middleware(recovery.Recovery(),),}if c.Grpc.Network != "" {opts = append(opts, grpc.Network(c.Grpc.Network))}if c.Grpc.Addr != "" {opts = append(opts, grpc.Address(c.Grpc.Addr))}if c.Grpc.Timeout != nil {opts = append(opts, grpc.Timeout(c.Grpc.Timeout.AsDuration()))}srv := grpc.NewServer(opts...)v1.RegisterGreeterServer(srv, greeter)verifyCode.RegisterVerifyCodeServer(srv, verifyCodeService)return srv
}

生成依赖注入代码：go generate ./...

在这里插入图片描述

kratos run

在这里插入图片描述

建立ApiPost的项目

在这里插入图片描述

2.3 业务逻辑代码实现
  1. GetVerifyCode方法中添加code返回
  2. 添加RandCode方法，返回测试字符串"result"
  3. kratos启动测试
package serviceimport ("context"pb "kratos-demo03/api/verifyCode"
)type VerifyCodeService struct {pb.UnimplementedVerifyCodeServer
}func NewVerifyCodeService() *VerifyCodeService {return &VerifyCodeService{}
}func (s *VerifyCodeService) GetVerifyCode(ctx context.Context, req *pb.GetVerifyCodeRequest) (*pb.GetVerifyCodeReply, error) {return &pb.GetVerifyCodeReply{Code: RandCode(int(req.Length), req.Type),}, nil
}func RandCode(l int, t pb.TYPE) string {return "result"
}

在这里插入图片描述

// RandCode 开放的被调用的方法，用于区分类型
func RandCode(l int, t pb.TYPE) string {switch t {case pb.TYPE_DEFAULT:fallthroughcase pb.TYPE_DIGIT:return randCode("0123456789", l)case pb.TYPE_LETTER:return randCode("abcdefghijklmnopqrstuvwxyz", l)case pb.TYPE_MIXED:return randCode("0123456789abcdefghijklmnopqrstuvwxyz", l)}return ""
}// randCode 随机的核心方法
func randCode(chars string, l int) string {charsLen := len(chars)result := make([]byte, l)for i := 0; i < l; i++ {// 核心函数 生成[0,n]的整型随机数randIndex := rand.Intn(charsLen)result[i] = chars[randIndex]}return string(result)
}

在这里插入图片描述

相关文章：

  • PHP电商系统开发指南数据库管理
  • 多线程软件不响应处理
  • JAVA 面试常见问题详解
  • 模板类内部能否含有虚函数？
  • Android动画：提升用户体验的关键技术
  • Python特征工程 — 1.4 特征归一化方法详解
  • 有什么简单方便的提取图片文字的方法？6个软件教你快速提取图片文字
  • day02-广播机制
  • 【手撕面试题】React（高频知识点一）
  • GitHub每日最火火火项目（7.2）
  • 探索迁移学习：通过实例深入理解机器学习的强大方法
  • 【MindSpore学习打卡】应用实践-计算机视觉-FCN图像语义分割-基于MindSpore实现FCN-8s进行图像语义分割的教程
  • Linux各种命令——tac命令，more 命令， less命令，head命令，tail命令，file 命令， stat 命令
  • 1.7-自然语言的分布式表示-skip-gram模型代码实现
  • Psychtoolbox 脑电实验范式之mp4视频绘制
  • [js高手之路]搞清楚面向对象,必须要理解对象在创建过程中的内存表示
  • echarts花样作死的坑
  • es的写入过程
  • Hexo+码云+git快速搭建免费的静态Blog
  • JavaScript标准库系列——Math对象和Date对象（二）
  • java取消线程实例
  • js操作时间（持续更新）
  • Mybatis初体验
  • Vue.js 移动端适配之 vw 解决方案
  • vue2.0开发聊天程序(四) 完整体验一次Vue开发（下）
  • 从PHP迁移至Golang - 基础篇
  • 分享一个自己写的基于canvas的原生js图片爆炸插件
  • 前端每日实战：61# 视频演示如何用纯 CSS 创作一只咖啡壶
  • 深入浏览器事件循环的本质
  • 实现菜单下拉伸展折叠效果demo
  • 学习笔记：对象，原型和继承（1）
  • 学习使用ExpressJS 4.0中的新Router
  • 用 Swift 编写面向协议的视图
  • 用Canvas画一棵二叉树
  • 与 ConTeXt MkIV 官方文档的接驳
  • 看到一个关于网页设计的文章分享过来！大家看看！
  • TPG领衔财团投资轻奢珠宝品牌APM Monaco
  • 如何通过报表单元格右键控制报表跳转到不同链接地址 ...
  • ​LeetCode解法汇总518. 零钱兑换 II
  • #LLM入门|Prompt#3.3_存储_Memory
  • （1）(1.9) MSP (version 4.2)
  • （函数）颠倒字符串顺序（C语言）
  • （十二）springboot实战——SSE服务推送事件案例实现
  • (文章复现)基于主从博弈的售电商多元零售套餐设计与多级市场购电策略
  • （学习日记）2024.01.19
  • （学习日记）2024.02.29：UCOSIII第二节
  • (一)基于IDEA的JAVA基础10
  • (转)关于多人操作数据的处理策略
  • *++p：p先自＋，然后*p，最终为3 ++*p：先*p，即arr[0]=1，然后再++，最终为2 *p++：值为arr[0],即1，该语句执行完毕后，p指向arr[1]
  • .L0CK3D来袭：如何保护您的数据免受致命攻击
  • .NET Core 版本不支持的问题
  • .NET Framework杂记
  • .NET 发展历程
  • .Net 基于MiniExcel的导入功能接口示例
  • .NET上SQLite的连接