Protovalidate: 在运行时验证Protocol Buffers的权威指南

最新推荐文章于 2024-09-22 07:07:37 发布

管翌锬

最新推荐文章于 2024-09-22 07:07:37 发布

阅读量677

点赞数 12

本文链接：https://blog.csdn.net/gitblog_00217/article/details/142429373

版权

Protovalidate: 在运行时验证Protocol Buffers的权威指南

protovalidate Protocol Buffer Validation - Go, Java, Python, and C++ Beta Releases! 项目地址: https://gitcode.com/gh_mirrors/pr/protovalidate

项目介绍

Protovalidate 是一系列库，设计用于基于用户自定义的验证规则在运行时对Protocol Buffers消息进行验证。它利用了Google的Common Expression Language (CEL)，为制定和评估定制验证规则提供了一个灵活且高效的基础。该项目旨在帮助开发者确保跨网络的数据一致性和完整性，无需生成额外代码。Protovalidate作为protoc-gen-validate的精神继任者，提供了更先进的功能，并推荐给新旧项目迁移使用。

项目快速启动

安装依赖

首先，你需要决定如何构建你的Protocol Buffers文件。对于现代开发，推荐使用Buf，但也可以直接通过protoc来编译。

使用Buf

安装Buf：遵循 Buf 的官方安装指南。
配置Buf工作区：在项目根目录下创建一个buf.yaml文件，并添加依赖：
```
version: v1
deps:
  - buf.build/bufbuild/protovalidate
```
更新依赖：执行 buf mod update。

使用Protoc直接编译

确保已安装protoc以及bufbuild,protovalidate,proto的导入路径已设置。

示例命令（假设你已经有了导入路径）:

protoc -I /path/to/your/protobufs --go_out=plugins=grpc:. *.proto

编写带有验证规则的消息

编辑.proto文件，引入buf/validate/validate.proto并添加约束，比如：

syntax = "proto3";
import "buf/validate/validate.proto";

message ExampleMessage {
    string name = 1 [
        (buf.validate.field).string.min_len = 1
    ];
}

运行时验证

在Go语言中使用protovalidate-go进行验证：

package main

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

func main() {
    var msg ExampleMessage // 假设ExampleMessage是上述定义的结构体
    v, err := protovalidate.New()
    if err != nil {
        fmt.Println("初始化验证器失败:", err)
        return
    }
    if err := v.Validate(&msg); err != nil {
        fmt.Println("验证失败:", err)
    } else {
        fmt.Println("验证成功")
    }
}