grpc-gateway 添加参数校验


前言

数据的传入当然是需要校验之后才会进入到我们业务逻辑中,但是在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 去跑,因为我们只是生成了对应的文件,但是我门还没有加入到代码中。

  1. 中间件编写
    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)
    }
    
  2. 向服务中注册中间件
    grpc.NewServer(grpc.UnaryInterceptor(ValidateParams))
    

接下来让我们看看成果吧
在这里插入图片描述

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Java + gRPC + grpc-gateway 的实践主要分为以下几个步骤: 1. 定义 proto 文件 在 proto 文件中定义需要调用的服务以及方法,同时指定请求和响应的数据类型。例如: ``` syntax = "proto3"; package example; service ExampleService { rpc ExampleMethod (ExampleRequest) returns (ExampleResponse) {} } message ExampleRequest { string example_field = 1; } message ExampleResponse { string example_field = 1; } ``` 2. 使用 protoc 编译 proto 文件 使用 protoc 编译 proto 文件,生成 Java 代码。例如: ``` protoc --java_out=./src/main/java ./example.proto ``` 3. 实现 gRPC 服务 在 Java 代码中实现定义的 gRPC 服务,例如: ``` public class ExampleServiceImpl extends ExampleServiceGrpc.ExampleServiceImplBase { @Override public void exampleMethod(ExampleRequest request, StreamObserver<ExampleResponse> responseObserver) { // 实现具体逻辑 ExampleResponse response = ExampleResponse.newBuilder().setExampleField("example").build(); responseObserver.onNext(response); responseObserver.onCompleted(); } } ``` 4. 启动 gRPC 服务器 使用 gRPC 提供的 ServerBuilder 构建 gRPC 服务器,并启动服务器。例如: ``` Server server = ServerBuilder.forPort(8080).addService(new ExampleServiceImpl()).build(); server.start(); ``` 5. 集成 grpc-gateway 使用 grpc-gateway 可以将 gRPC 服务转换为 HTTP/JSON API。在 proto 文件中添加以下内容: ``` import "google/api/annotations.proto"; service ExampleService { rpc ExampleMethod (ExampleRequest) returns (ExampleResponse) { option (google.api.http) = { post: "/example" body: "*" }; } } ``` 在 Java 代码中添加以下内容: ``` Server httpServer = ServerBuilder.forPort(8081).addService(new ExampleServiceImpl()).build(); httpServer.start(); String grpcServerUrl = "localhost:8080"; String httpServerUrl = "localhost:8081"; ProxyServerConfig proxyConfig = new ProxyServerConfig(grpcServerUrl, httpServerUrl, "/example"); HttpProxyServer httpProxyServer = new HttpProxyServer(proxyConfig); httpProxyServer.start(); ``` 6. 测试 使用 HTTP/JSON API 调用 gRPC 服务,例如: ``` POST http://localhost:8081/example Content-Type: application/json { "example_field": "example" } ``` 以上就是 Java + gRPC + grpc-gateway 的实践步骤。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值