Golang基于泛型的通用数据验证插件库go-validator的使用

快速直观的Go验证库

这个库使用了govalidator项目中的Is...验证函数。

安装

go get github.com/tiendc/go-validator

使用

基本用法

import (
    vld "github.com/tiendc/go-validator"
)

type Person struct {
    FirstName string
    LastName  string
    Birthdate time.Time

    Unemployed bool
    Salary     uint
    Rank       string
    WorkEmail  string
    Projects   []string
    TaskMap    map[string]Task
}
var p Person

errs := vld.Validate(
    // 分别验证first和last name
    vld.StrLen(&p.FirstName, 3, 30).OnError(
        vld.SetField("first_name", nil),
        vld.SetCustomKey("ERR_VLD_PERSON_FIRST_NAME_INVALID"),
    ),
    vld.StrLen(&p.FirstName, 3, 30).OnError(
        vld.SetField("last_name", nil),
        vld.SetCustomKey("ERR_VLD_PERSON_LAST_NAME_INVALID"),
    ),

    // 或者使用Group来在其中一个失败时只产生一个错误
    vld.Group(
        vld.StrLen(&p.FirstName, 3, 30),
        vld.StrLen(&p.LastName, 3, 30),
    ).OnError(
        vld.SetField("name", nil),
        vld.SetCustomKey("ERR_VLD_PERSON_NAME_INVALID"),
    ),

    // 生日是可选的，但如果存在，必须在1950年和现在之间
    vld.When(!p.Birthdate.IsZero()).Then(
        vld.TimeRange(p.Birthdate, <1950-01-01>, time.Now()).OnError(...),
    )

    vld.When(!p.Unemployed).Then(
        vld.Required(&p.Salary),
        // 工作邮箱必须有效
        vld.StrIsEmail(&p.WorkEmail),

        // Rank必须是常量之一
        vld.StrIn(&p.Rank, "Employee", "Manager", "Director"),
        vld.Case(
            vld.When(p.Rank == "Manager").Then(vld.NumGT(&p.Salary, 10000)),
            vld.When(p.Rank == "Director").Then(vld.NumGT(&p.Salary, 30000)),
        ).Default(
            vld.NumLT(&p.Salary, 10000),
        ),

        // Projects是可选的，但如果存在，必须是唯一且排序的
        vld.When(len(p.Projects) > 0).Then(
            vld.SliceUnique(p.Projects).OnError(...),
            vld.SliceSorted(p.Projects).OnError(...),
        )
    ).Else(
        // 当人员失业时
        vld.NumEQ(&p.Salary, 0),
        vld.StrEQ(&p.WorkEmail, ""),
    ),

    // 验证切片元素
    vld.Slice(p.Projects).ForEach(func(elem int, index int, validator ItemValidator) {
        validator.Validate(
            vld.StrLen(&elem, 10, 30).OnError(
                vld.SetField(fmt.Sprintf("projects[%d]", index), nil),
                vld.SetCustomKey("ERR_VLD_PROJECT_NAME_INVALID"),
            ),
        )
    }),

    // 验证map条目
    vld.Map(p.TaskMap).ForEach(func(k string, v Task, validator ItemValidator) {
        validator.Validate(
            vld.StrLen(&v.Name, 10, 30).OnError(
                vld.SetField(fmt.Sprintf("taskMap[%s].name", k), nil),
                vld.SetCustomKey("ERR_VLD_TASK_NAME_INVALID"),
            ),
        )
    }),

    // 其他函数
    // 如果至少有一个验证通过则通过
    vld.OneOf(
        // 验证列表
    ),

    // 如果恰好有一个验证通过则通过
    vld.ExactOneOf(
        // 验证列表
    ),

    // 如果没有验证通过则通过
    vld.NotOf(
        // 验证列表
    ),
)

for _, e := range errs {
    detail, warnErr := e.BuildDetail()
    fmt.Printf("%+v\n", detail)
}

错误消息本地化

方法1：内联本地化（不推荐）

errs := Validate(
    NumLTE(&p.Age, 40).OnError(
        // 覆盖默认的英文模板
        SetTemplate("Tuổi nhân viên phải nhỏ hơn hoặc bằng {{.Max}}"),
    ),
)

for _, e := range errs {
    detail, warnErr := e.BuildDetail()
    fmt.Printf("%+v\n", detail)
}

方法2：使用其他本地化库（推荐）

// 假设你有2个定义错误消息的文件
// 在`error_messages.en`中:
// ERR_VLD_EMPLOYEE_AGE_TOO_BIG = "Employee {{.EmployeeName}} has age bigger than {{.Max}}"
// 在`error_messages.vi`中:
// ERR_VLD_EMPLOYEE_AGE_TOO_BIG = "Nhân viên {{.EmployeeName}} có tuổi lớn hơn {{.Max}}"

errs := Validate(
    NumLTE(&p.Age, 40).OnError(
        // 自定义参数（默认模板没有这个）
        SetParam("EmployeeName", p.Name),
        // 自定义键来定义要使用的自定义模板
        SetCustomKey("ERR_VLD_EMPLOYEE_AGE_TOO_BIG"),
    ),
)

for _, e := range errs {
    errKey := e.CustomKey()
    errParams := e.Params() // 或 e.ParamsWithFormatter()
    errorMsg := translationFunction(errKey, errParams) // 你需要提供这个函数
    fmt.Printf("%+v\n", errorMsg)
}

自定义错误参数格式化器

errs := Validate(
    NumLT(&budget, 1000000).OnError(
        SetField("Budget", nil),
    ),
)

// e.BuildDetail()可能产生消息`Budget must be less than 1000000`,
// 但你可能想要这样的消息: `Budget must be less than 1,000,000`.
// 让我们使用自定义格式化器

errs := Validate(
    NumLT(&budget, 1000000).OnError(
        SetField("Budget", nil),
        SetNumParamFormatter(NewDecimalFormatFunc('.', ',', "%f")),
    ),
)

贡献

• 欢迎提交新功能和错误修复的拉取请求。

许可证

• MIT License