gRPC 进阶——Validator 验证器

已于 2024-07-16 17:19:14 修改
阅读量1.1k 收藏 21
点赞数 24
分类专栏： gRPC 文章标签： go rpc
于 2024-07-14 18:22:49 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/MPY_3/article/details/140420543
版权

gRPC 验证器（Validator）是一种用于在 gRPC 通信过程中进行数据验证的工具，通过在 .proto 文件中定义验证规则（例如长度限制、格式检查等），确保客户端和服务器之间传递的数据符合预期的格式和约束条件。它使用 Protocol Buffers 作为序列化机制，并通过生成的代码在传输过程中自动执行这些验证规则，从而提高系统的可靠性和安全性。

这一小节我们利用开源gRPC验证器项目protoc-gen-validate来实现gRPC在客户端与服务端之间的通信。

1. 安装protoc-gen-validate

# fetches this repo into $GOPATH
go get -d github.com/envoyproxy/protoc-gen-validate

2. protoc-gen-validate可支持的校验类型

类型校验规则
字符串min_len（最小长度）、max_len（最大长度）、length（固定长度）、pattern（正则表达式模式）、prefix（前缀）、suffix（后缀）、contains（包含）、in（在集合中）、not_in（不在集合中）、email（电子邮件）、hostname（主机名）、ip（IP地址）、ipv4（IPv4地址）、ipv6（IPv6地址）、uri（URI）、uri_ref（URI引用）、address（地址）、uuid（UUID）、well_known_regex（已知正则表达式）、well_known_regex_pattern（已知正则表达式模式）
Int32const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
Int64const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
UInt32const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
UInt64const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
SInt32const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
SInt64const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
Fixed32const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
Fixed64const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
SFixed32const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
SFixed64const（常量）、lt（小于）、lte（小于等于）、gt（大于）、gte（大于等于）、in（在集合中）、not_in（不在集合中）、ignore_empty（忽略空值）
布尔const（常量）
字节min_len（最小长度）、max_len（最大长度）、length（固定长度）、pattern（正则表达式模式）、prefix（前缀）、suffix（后缀）、contains（包含）、in（在集合中）、not_in（不在集合中）

3. protoc-gen-validate的语法

以部分string语法为例，详见请见官方文档

// x must be set to "foo"
string x = 1 [(validate.rules).string.const = "foo"];

// x must be exactly 5 characters long
string x = 1 [(validate.rules).string.len = 5];

// x must be at least 3 characters long
string x = 1 [(validate.rules).string.min_len = 3];

// x must be between 5 and 10 characters, inclusive
string x = 1 [(validate.rules).string = {min_len: 5, max_len: 10}];

// x must be at most 15 bytes long
string x = 1 [(validate.rules).string.max_bytes = 15];

// x must be between 128 and 1024 bytes long
string x = 1 [(validate.rules).string = {min_bytes: 128, max_bytes: 1024}];

// x must be a non-empty, case-insensitive hexadecimal string
string x = 1 [(validate.rules).string.pattern = "(?i)^[0-9a-f]+$"];

// x must begin with "foo"
string x = 1 [(validate.rules).string.prefix = "foo"];

// x must end with "bar"
string x = 1 [(validate.rules).string.suffix = "bar"];

// x must contain "baz" anywhere inside it
string x = 1 [(validate.rules).string.contains = "baz"];

// x cannot contain "baz" anywhere inside it
string x = 1 [(validate.rules).string.not_contains = "baz"];

// x must be a valid email address (via RFC 5322)
string x = 1 [(validate.rules).string.email = true];

// x must be a valid address (IP or Hostname).
string x = 1 [(validate.rules).string.address = true];

// x must be a valid hostname (via RFC 1034)
string x = 1 [(validate.rules).string.hostname = true];

4. 使用示例

0. 目录树如下
.
├── client
│   └── client.go
├── proto
│   ├── student_grpc.pb.go
│   ├── student.pb.go
│   ├── student.pb.validate.go
│   ├── student.proto
│   └── validate.proto
└── server
    └── server.go
1. 建立proto/student.proto

代码如下：

syntax = "proto3";

import "validate.proto";

option go_package = ".;proto";

service StudentService {
  rpc GetStudent(Student) returns (Student);
}

message Student {
  // uid 是学生的唯一标识符，它必须大于999
  uint64 uid = 1 [(validate.rules).uint64.gt = 999];

  // email 是学生的电子邮件地址，它必须是一个有效的电子邮件地址
  string email = 2 [(validate.rules).string.email = true];

  // phone 是学生的电话号码，它必须符合中国大陆的手机号码格式
  string phone = 3 [(validate.rules).string = {pattern: "^1[3456789]\\d{9}$"}];
}

此时import语句会爆红，显示Cannot resolve import 'validate.proto'，所以我们需要建立validate.proto文件

2. 建立proto/validate.proto

使用protoc-gen-validate需要我们自己cv代码或者用import语句引入它的validate.proto文件。这里我们以用cv大法自己建立validate.proto文件为例。

建立proto/validate.proto后，代码可以从两种方式进行cv。

  1. 在GO Modules内找到 github.com/envoyproxy/protoc-gen-validate@v1.0.4这个库中的validate/validate.proto文件，利用cv大法复制到proto/validate.proto文件中。
  2. 从GitHub找到此项目该文件的代码：validate/validate.proto，利用cv大法复制到proto/validate.proto文件中。

在解决掉proto/validate.proto问题后。我们利用生成命令生成对应的go文件。

protoc student.proto --go_out=. --go-grpc_out=. --validate_out="lang=go:."
3.编写server/server.go代码
package main

import (
	"context"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
	"net"

	"google.golang.org/grpc"

	"go-try/grpc_validate/proto"
)

type StudentServer struct {
	proto.UnimplementedStudentServiceServer
}

// Validate接口定义了一个需要被实现的方法Validate。
// 任何类型只要实现了Validate方法（返回一个error）就满足了这个接口。
// 在这个demo中，它被用于在运行时检查请求是否可以进行验证。
type Validate interface {
	Validate() error
}

func (s *StudentServer) GetStudent(ctx context.Context, request *proto.Student) (*proto.Student, error) {
	return &proto.Student{
		Uid:   1,
		Email: "1234567890@qq.com",
		Phone: "12345678912",
	}, nil
}

// 拦截器的函数
var interceptor = func(ctx context.Context, req any,
	info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp any, err error) {
	// 尝试将请求转换为Validate接口类型
	if r, ok := req.(Validate); ok {
		// 如果转换成功，调用Validate方法进行验证
		if err := r.Validate(); err != nil {
			// 如果验证失败，返回一个错误状态
			return nil, status.Error(codes.InvalidArgument, err.Error())
		}
	}
	return handler(ctx, req)
}

func main() {
	var opts []grpc.ServerOption
	opts = append(opts, grpc.UnaryInterceptor(interceptor))

	server := grpc.NewServer(opts...)
	proto.RegisterStudentServiceServer(server, &StudentServer{})
	listen, err := net.Listen("tcp", "0.0.0.0:8080")
	if err != nil {
		panic("faild to listen : " + err.Error())
	}
	err = server.Serve(listen)
	if err != nil {
		panic("faild to start grpc : " + err.Error())
	}
}
4.编写client/client.go代码
package main

import (
	"context"
	"fmt"

	"google.golang.org/grpc"

	"go-try/grpc_validate/proto"
)

func main() {
	conn, err := grpc.NewClient("0.0.0.0:8080", grpc.WithInsecure())
	if err != nil {
		panic(err)
	}
	defer conn.Close()

	cli := proto.NewStudentServiceClient(conn)
	msg, err := cli.GetStudent(context.Background(), &proto.Student{Uid: 1234}) 
    // 报错信息：panic: rpc error: code = InvalidArgument desc = invalid Student.Uid: value must be less than 999
	
    msg, err := cli.GetStudent(context.Background(), &proto.Student{Email: "1234"})
    // 报错信息：panic: rpc error: code = InvalidArgument desc = invalid Student.Email: value must be a valid email address | caused by: mail: missing '@' or angle-addr
	
    msg, err := cli.GetStudent(context.Background(), &proto.Student{Phone: "1234"})
    // 报错信息：panic: rpc error: code = InvalidArgument desc = invalid Student.Email: value must be a valid email address | caused by: mail: no address
    
	msg, err := cli.GetStudent(context.Background(), &proto.Student{
		Uid:   1,
		Email: "1234567890@qq.com",
		Phone: "19536486248",
	})
    // 运行成功！运行结果：uid:1 email:"1234567890@qq.com" phone:"12345678912"
    
	if err != nil {
		panic(err)
	}
	fmt.Println(msg)
}
5.分别运行server.go和client.go

运行结果在client代码内已标明，至此，一个gRPC验证器简单的demo项目已经完成，相信你已经学会了如何使用gRPC验证器。

MPY_3
关注
  • 24
    点赞
  • 踩
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
grpc验证器的使用（protoc-gen-validate）
Jason World
12-13 2269
1、grpc验证器扩展包 protoc-gen-validate Github地址：https://github.com/envoyproxy/protoc-gen-validate 注意：This project is currently in alpha. The API should be considered unstable and likely to change 2、安装与配置 2.1 linux安装 # fetches this repo into $GOPATH go get -d g
gRPC集成protoc-gen-validate
zl5186888的博客
09-09 1390
protoc-gen-validate简介安装和配置 Linux执行make build之前需要先切换到protoc-gen-validate路径下;因为make build执行的就是这个路径下的Makefile;一定要确保在对应的路径下,这样make build才不会出错。
使用protovalidate提升你的Protobuf数据验证体验！
gitblog_00085的博客
05-22 524
使用protovalidate提升你的Protobuf数据验证体验！ 项目地址:https://gitcode.com/bufbuild/protovalidate 在软件开发中，确保数据的准确性和一致性是至关重要的。为此，我们向您推荐一个强大的开源项目——protovalidate，它提供了一种创新的方式，基于Google的Common Expression Language (CEL)，帮助你...
grpc的验证器
新法的博客
03-11 1903
在使用grpc库时候 ,很多时候我们需要对反序列化的参数进行校验,代码中有很多参数校验的代码，如果手动实现，会非常繁琐，对于grpc来说，在定义proto的时候使用直接定义参数的限制规则是一种更合理、更优雅的方式，插件就是来帮助我们实现这一功能的,使用 proto-gen-validate 生成后的代码进行参数校验，我们可以通过在 proto 中编写参数校验规则，然后生成代码，通过中间件自动的进行校验。}];// 参数必须大于 0// 参数必须在 0 到 120 之间。
gRPC验证器
weixin_54984185的博客
01-26 513
方法进行验证，具体请看下面代码。原生的类型，所以需要设置。
protoc-gen-validate:protoc插件生成多语种消息验证器
05-11
验证原始协议（PGV） 该项目目前处于alpha状态。 API应该被认为是不稳定的并且可能会改变 PGV是一个协议插件，用于生成多语种消息验证器。 尽管协议缓冲区有效地保证了结构化数据的类型，但它们不能对值强制执行语义规则。 该插件为协议生成的代码添加了支持，以验证此类约束。 开发人员导入PGV扩展名，并使用约束规则注释其原型文件中的消息和字段： syntax = "proto3" ; package examplepb ; import "validate/validate.proto" ; message Person { uint64 id = 1 [(validate.rules) .uint64.gt = 999 ]; string email = 2 [(validate.rules) .string.email = true ]; string n
开源项目-lyft-protoc-gen-validate.zip
10-22
开源项目-lyft-protoc-gen-validate.zip,生成polyglot消息验证器的protoc插件
grpc-dotnet-validator:grpc.aspnet的简单请求消息验证器
05-24
grpc-dotnet-validator 请求用于消息验证器中间件 特征 支持一元流呼叫的异步验证 支持IoC LifeStyle范围和依赖项注入 验证者资料 扫描装配体中的验证器和配置文件 如何使用。 该软件包与集成在一起。 如果您想...
grpc-demo:java版grpc 示例，使用拦截器实现了token认证
05-16
通过这个“grpc-demo”项目，开发者可以学习到如何在实际项目中结合gRPC、JWT和拦截器实现安全的身份验证，为自己的微服务架构增添一层保障。同时，这也是提升gRPC应用安全性和灵活性的一个实例。
ASP.NET Core 3.0 gRPC拦截器的使用
12-23
拦截器就像MVC的过滤器或者是ASP.NET Core middleware 一样，具有面向切面的思想，可以在调用服务的时候进行一些统一处理， 很适合在这里处理验证、日志等流程。本片文章就以记录日志为例来进行讲解。 二. ...
grpc-auth-example:使用gRPC进行客户端身份验证的示例
04-29
所有身份验证均在实现的服务器端拦截器中执行。 TLS客户端证书认证 第一种身份验证使用TLS证书主题来验证正确的客户端正在连接。 当然，这仅依赖于颁发证书颁发机构，该颁发机构仅颁发具有适用于正确服务的正确主题...
protoc.exe grpc编辑器环境配置
最新发布
07-02
protoc.exe grpc编辑器环境配置
Windows下protoc-gen-validate的安装使用
lwbgxd的博客
04-30 1756
Windows下protoc-gen-validate的安装使用validate简介下载validate的使用 validate简介 其实是帮我们在grpc中实现验证器的一个插件，会帮我们生成具有验证器功能的go代码。 下载 git方式：通过下面的cmd命令，克隆项目下来，然后cd命令进入到你拉取的protoc-gen-validate项目的文件路径下，然后运行第三步命令。之后你就会在你的GOPATH的bin目录（这是我的C:\Users\SLY FOX\go\bin）下发现一个exe文件，没错他就是
linux下安装protoc-gen-validate验证器
dorlolo的博客
02-26 2182
目录下的，这个pkg目录下默认是没有权限编译的，会报错。因为设置为on的话，包是下载到。这里提供百度网盘的下载渠道。如果是on需要设置为off。
探索 Protoc-Gen-Validate: 强力验证你的 Protocol Buffers 消息
gitblog_00044的博客
03-22 570
探索 Protoc-Gen-Validate: 强力验证你的 Protocol Buffers 消息 项目地址:https://gitcode.com/bufbuild/protoc-gen-validate 在软件开发中，数据的一致性和准确性至关重要。Protocol Buffers（简称 Protobuf）是谷歌推出的一种高效的数据序列化协议，它允许我们定义数据结构并跨多种编程语言进行通信。而...
go krotos，proto文件引用自定义proto（例如validate.proto）
热门推荐
weixin_39810091的博客
04-18 1万+
1、proto文件中引用自定义proto（例如validate.proto） helloworld.proto中引用validate.proto（Goland中，此时"validate/validate.proto"会显示红色），对http请求的入参做校验 syntax = "proto3"; package api.helloworld.v1; import "google/api/annotations.proto"; import "validate/validate.proto"; optio
grpc-gateway 添加参数校验
qq_46032430的博客
08-31 1199
grpc 参数校验
java grpc 流式_grpc双向流式调用——构建一个简单的流数据分析器
06-01
好的，我理解了你的问题。让我们来探讨一下如何使用Java gRPC实现双向流式调用来构建一个简单的流数据分析器。 首先，我们需要定义一个 gRPC 服务。假设我们要构建一个数据分析器，这个服务可以接收一系列数据，并返回一系列数据分析结果。我们可以这样定义这个服务： ``` service DataAnalyzer { // 客户端发送数据流到服务端，并返回分析结果流 rpc Analyze(stream Data) returns (stream Result) {} } // 定义数据和分析结果的消息类型 message Data { string content = 1; } message Result { string analysis = 1; } ``` 接下来，我们需要实现这个服务。我们可以创建一个 Java 类来实现这个服务： ``` public class DataAnalyzerImpl extends DataAnalyzerGrpc.DataAnalyzerImplBase { @Override public StreamObserver<Data> analyze(StreamObserver<Result> responseObserver) { // 创建一个用于处理数据的 StreamObserver StreamObserver<Data> requestObserver = new StreamObserver<Data>() { @Override public void onNext(Data data) { // 处理数据并生成分析结果 Result result = Result.newBuilder() .setAnalysis("Analysis of " + data.getContent()) .build(); // 将分析结果发送给客户端 responseObserver.onNext(result); } @Override public void onError(Throwable t) { // 处理错误 } @Override public void onCompleted() { // 处理完成 responseObserver.onCompleted(); } }; return requestObserver; } } ``` 在这个实现中，我们实现了 `analyze` 方法，它接收一个 `StreamObserver`，并返回一个 `StreamObserver`。我们使用返回的 `StreamObserver` 处理客户端发送的数据。对于每个接收到的数据，我们生成一个分析结果，并将其发送给客户端。 现在我们已经实现了服务端，接下来让我们来实现客户端。我们可以创建一个 Java 类来实现客户端： ``` public class DataAnalyzerClient { public void analyzeData(List<String> data) { // 创建一个用于接收分析结果的 StreamObserver StreamObserver<Result> responseObserver = new StreamObserver<Result>() { @Override public void onNext(Result result) { // 处理分析结果 System.out.println(result.getAnalysis()); } @Override public void onError(Throwable t) { // 处理错误 } @Override public void onCompleted() { // 处理完成 } }; // 创建一个用于发送数据的 StreamObserver StreamObserver<Data> requestObserver = stub.analyze(responseObserver); // 发送数据并等待分析结果 for (String content : data) { Data data = Data.newBuilder() .setContent(content) .build(); requestObserver.onNext(data); } // 完成数据发送 requestObserver.onCompleted(); } } ``` 在这个实现中，我们首先创建两个 `StreamObserver`，一个用于接收分析结果，一个用于发送数据。然后，我们使用 `stub.analyze` 方法获取到一个 `StreamObserver`，并将其传递给用于发送数据的 `StreamObserver`。接着，我们循环发送数据，并等待分析结果。 现在，我们已经实现了一个简单的流数据分析器。我们可以在服务端启动 gRPC 服务器，并在客户端发送一些数据来测试这个分析器。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值