golang proto api 校验国际化 protovalidate

众所周知，protobuf 原型文件扩展很多功能，比如生成 http 接口层代码，顺势就有了生成接口参数校验代码的需求。

早期可以使用https://github.com/bufbuild/protoc-gen-validate 来实现，通过生成特定的 go 代码的方式来实现校验。

github 中也提到目前趋于稳定，不会有更多新特性的支持，推荐大家使用新的版本 protovalidate，https://github.com/bufbuild/protovalidate 。该版本是protoc-gen-validate 的“精神继承者”。它不需要任何代码生成并支持自定义约束。

现在我们尝试新版本，并且增加国际化支持。

go get github.com/bufbuild/protovalidate-go

import "github.com/bufbuild/protovalidate-go"

syntax = "proto3";
package demo;

import "google/api/annotations.proto";
import "validate/validate.proto";

option go_package = "demo/app";

service App {
  rpc AppDetail(AppRequest) returns (AppItem) {
    option (google.api.http) = {
      get: "/app/detail",
    };
  }
}

message AppRequest {
  // 应用id
  int64 app_id = 1 [(buf.validate.field).int64 = {gt:  999}];
}

上图中的 validate/validate.proto 可以从仓库中复制下来https://github.com/bufbuild/protovalidate/tree/main/proto/protovalidate/buf/validate。不过官方可能推荐你使用他家 buf managed mode 来生成，这里就不展开了。

package app

import (
	"github.com/bufbuild/protovalidate-go"
)

func (a AppHTTPServerController) AppDetail(context *gin.Context, request *app.AppRequest) (*app.AppItem, error) {
    validator, err := protovalidate.New()
    if err != nil {
        log.Fatalf("failed to create validator: %v", err)
    }
    // 为每个约束设置中文，这里是一个 demo，需要进一步完成。
    var ruleMessages = map[string]string{
        "int64.gt": "{{.FieldName}}: 值必须要大于 {{.FieldValue}}，当前值 {{.RuleValue}}",
    }

    type ErrorInfo struct {
        FieldName  string
        RuleValue  any
        FieldValue any
    }

    if err := validator.Validate(request); err != nil {
        fmt.Printf("Validation failed: %v\n", err)
        var valErr *protovalidate.ValidationError
        if ok := errors.As(err, &valErr); ok {
            for _, violation := range valErr.Violations {
                errmsg := template.Must(template.New("").Parse(ruleMessages[violation.Proto.GetConstraintId()])).
                    Execute(os.Stdout, ErrorInfo{
                        FieldName:  protovalidate.FieldPathString(violation.Proto.GetField()),
                        RuleValue:  violation.RuleValue.Interface(),
                        FieldValue: violation.FieldValue.Interface(),
                    })
                // 这里输出每个约束的信息
                fmt.Println(errmsg)
            }
        }
        return nil, err
    } else {
        fmt.Println("Validation passed!")
    }
}

输出：

网上鲜有 demo，这里仅作示例，未对任何框架做适配。