前言
数据的传入当然是需要校验之后才会进入到我们业务逻辑中,但是在grpc 中怎么校验呢,proto 文件又该怎么写呢?
库:github.com/envoyproxy/protoc-gen-validate
一、proto文件的编写
具体的proto 文件示例可以看上面给出的库
import "validate/validate.proto";
message HelloRequest {
string name = 1 [(validate.rules).string.email = true];
}
二、buf文件编写
光有了 proto 文件 还是没用的,咱们还得把它编译成 .go 文件 所以借助 buf 工具来生成(buf 工具上一篇文章中有介绍) ,
1.buf.gen.yaml 编写
相比于上一篇文章主要添加了一个 validate plugins
version: v1
plugins:
- name: go
out: .
opt: paths=source_relative
- name: go-grpc
out: .
opt: paths=source_relative
- name: grpc-gateway
out: .
opt: paths=source_relative
- name: validate
out: .
opt:
- paths=source_relative
- lang=go
2.buf.yaml
更新一下依赖
version: v1
deps:
- buf.build/googleapis/googleapis
- buf.build/envoyproxy/protoc-gen-validate
这一系列操作下来就可以开始生成我们的.go 文件了
// 更新下buf依赖
buf mod update
// 生成文件
buf generate
之后我们就可以看到比原来多了一个 .validate.go 文件
三、参数验证中间件
有了这些文件之后我们并不能 go run main.go 去跑,因为我们只是生成了对应的文件,但是我门还没有加入到代码中。
- 中间件编写
type Validator interface { Validate() error } func ValidateParams(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error) { // 校验 if p, ok := req.(Validator); ok { if err := p.Validate(); err != nil { return nil, status.Error(codes.InvalidArgument, err.Error()) } } // 通过验证 return handler(ctx, req) }
- 向服务中注册中间件
grpc.NewServer(grpc.UnaryInterceptor(ValidateParams))
接下来让我们看看成果吧