Go语言微服务框架 - 11.接口的参数校验功能-buf中引入PGV

--- micro_web_service            项目目录
 |-- gen                            从idl文件夹中生成的文件，不可手动修改
    |-- idl                             对应idl文件夹
       |-- demo                             对应idl/demo服务，包括基础结构、HTTP接口、gRPC接口
      |-- order                            对应idl/order服务，同上
     |-- swagger.json                    openapiv2的接口文档
 |-- idl                            原始的idl定义
    |-- demo                            业务package定义，protobuffer的原始定义
    |-- order                           业务order定义，同时干
 |-- internal                       项目的内部代码，不对外暴露
    |-- config                          配置相关的文件夹，viper的相关加载逻辑
    |-- dao                             Data Access Object层，是model层的实现
    |-- gormer                          从pkg/gormer中生成的相关代码，不允许更改
    |-- model                           model层，定义对象的接口方法，具体实现在dao层
    |-- mysql                           MySQL连接
    |-- server                          服务器的实现，对idl中定义服务的具体实现
    |-- service                         service层，作为领域实现的核心部分
     |-- zlog                            封装zap日志的代码实现
  |-- pkg                            开放给第三方的工具库
     |-- gormer                          gormer二进制工具，用于生成Gorm相关Dao层代码
 |-- buf.gen.yaml                   修改：buf生成代码的定义，新增参数校验逻辑
 |-- buf.yaml                       buf工具安装所需的工具，从v1beta升到v1
 |-- gen.sh                         生成代码的脚本：buf+gormer
 |-- go.mod                         Go Module文件
 |-- gormer.yaml                    将gormer中的参数移动到这里
 |-- main.go                        项目启动的main函数
 |-- swagger.sh                     生成openapiv2的相关脚本

deps:
  - buf.build/envoyproxy/protoc-gen-validate

plugins:
  - name: validate
    out: gen
    opt:
      - paths=source_relative
      - lang=go

import "validate/validate.proto";

message ListOrdersRequest {
  int32 page_number = 1 [(validate.rules).int32 = {gt: 0}];
  int32 page_size = 2   [(validate.rules).int32 = {gt: 0}];
}

buf mod update
buf generate

func (m *ListOrdersRequest) Validate() error {
 return m.validate(false)
}

func (m *ListOrdersRequest) ValidateAll() error {
 return m.validate(true)
}

func UnaryInterceptor(i UnaryServerInterceptor) ServerOption {
}

func ChainUnaryInterceptor(interceptors ...UnaryServerInterceptor) ServerOption {
}

// ValidateAll 对应 protoc-gen-validate 生成的 *.pb.validate.go 中的代码
type Validator interface {
 ValidateAll() error
}

func ServerValidationUnaryInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error) {
 if r, ok := req.(Validator); ok {
  if err := r.ValidateAll(); err != nil {
   return nil, status.Error(codes.InvalidArgument, err.Error())
  }
 }

 return handler(ctx, req)
}

s := grpc.NewServer(
  grpc.ChainUnaryInterceptor(
    grpc_opentracing.UnaryServerInterceptor(
      grpc_opentracing.WithTracer(opentracing.GlobalTracer()),
    ),
    ServerValidationUnaryInterceptor,
  ),
)

{
    "code": 3,
    "message": "invalid ListOrdersRequest.PageNumber: value must be greater than 0; invalid ListOrdersRequest.PageSize: value must be greater than 0",
    "details": []
}

lint:
  use:
    - DEFAULT
  except:
    - PACKAGE_VERSION_SUFFIX
    - PACKAGE_DIRECTORY_MATCH
  rpc_allow_google_protobuf_empty_requests: true
  rpc_allow_google_protobuf_empty_responses: true