10

我一直在使用Protobuf3来定义一个 PB 消息：

syntax = "proto3";
package vioozer_protobuf;

message Update
{
  string sensor_id = 1;
  ...
}

在我的系统中，传感器具有独特的 id 格式 (a-la SENSOR-1342r43)，可以使用正则表达式轻松验证。

有没有办法将正则表达式验证器添加到 protobuf 字段，以便只有符合正则表达式的字符串才会被接受到该字段中？

4

2 回答 2

11

Protobuf 不支持开箱即用的消息验证，但可以使用插件添加它（这是唯一的方法，但并不简单）。

您可以尝试查找现有插件，或创建自己的插件（如果您的语言没有现有插件）。

如果您决定编写自己的插件，那么第一步是为字段定义一个自定义选项：

package yourcompany;

import "google/protobuf/descriptor.proto";

extend google.protobuf.FieldOptions {
    optional string validator = 51234;
}

此选项允许您为具体字段指定正则表达式。然后应用新的自定义选项：

message Update {
    string sensor_id = 1 [(yourcompany.validator) = "SENSOR-???????"];
    // ...
}

其次，更具挑战性的一步是编写自己的插件，以便为生成的代码添加验证逻辑：

此外，插件能够将代码插入其他代码生成器生成的文件中。有关更多信息，请参阅plugin.proto中有关“插入点”的评论。例如，这可以用于编写一个插件，该插件生成为特定 RPC 系统量身定制的 RPC 服务代码。请参阅每种语言生成的代码的文档，以了解它们提供的插入点。

您的插件必须检查您的自定义选项的值并为字段生成额外的验证代码。

于 2016-10-08T21:56:04.560 回答
5

请检查这个项目 protoc-gen-validate https://github.com/envoyproxy/protoc-gen-validate

我在这里为 Golang 写了一个示例https://github.com/alexcpn/golang_grpc_test

有了这个，您可以在 proto 中将语义验证作为注释提供，并将其作为 protobuff 生成的一部分自动生成

message SearchRequest {
  string query = 1 [(validate.rules).string = {
                      pattern:   "([A-Za-z]+) ([A-Za-z]+)*$",
                      max_bytes: 50,
                   }];
  string email_id= 2 [(validate.rules).string.email = true];
  int32 page_number = 3;  // Which page number do we want?
  int32 result_per_page = 4;  // Number of results to return per page.
}

使用生成的存根进行服务器验证

func (s *Server)Search(ctx context.Context, in *pb.SearchRequest) (*pb.SearchResponse, error){
    log.Printf("Received Emailid: %v", in.EmailId)
    log.Printf("Received Query: %v", in.Query)

    // Note this is the only place we use validate
    err := in.Validate()
    if err != nil {
        log.Warn("SearchRequest validation failed: %v", err)
于 2019-08-09T06:41:33.463 回答