Iris框架怎么自定义Struct结构体验证规则

小磊小哥_3826

小磊小哥_3826

2026-10-02

120人浏览

原创

iris 中需同时满足字段导出、含 json tag 和 validate tag 才能触发校验;必须显式设置 app.validator = validator.new(),并手动处理 validationerrors 以返回结构化错误。

iris框架怎么自定义struct结构体验证规则

怎么给 struct 字段加自定义校验标签

Iris 本身不内置复杂校验逻辑,但支持通过 validator 第三方库(如 go-playground/validator/v10)注入校验器,并在 struct 字段上用 validate tag 声明规则。关键不是 Iris 提供了什么,而是你注册了哪个验证器、字段是否导出、tag 是否写对。

必须满足三个条件才能触发校验:

  • struct 字段首字母大写(导出),否则 ReadJSON 会静默跳过
  • 字段必须带 json:"xxx" tag,否则反序列化失败,校验无从谈起
  • 必须额外加 validate:"xxx",比如 validate:"required,email"

示例:

type User struct {
    Email    string `json:"email" validate:"required,email"`
    Password string `json:"password" validate:"required,gte=8,lte=32"`
    Age      uint8  `json:"age" validate:"gte=0,lte=150"`
}

注意:validate tag 和 json tag 是独立的,缺一不可。

为什么调用了 ReadJSON 却没触发校验

最常见原因是没给 app.Validator 赋值。Iris 不默认启用任何验证器,必须显式设置:

import "github.com/go-playground/validator/v10"

func main() {
    app := iris.New()
    app.Validator = validator.New() // ← 这行不能少
    app.Post("/user", func(ctx iris.Context) {
        var u User
        if err := ctx.ReadJSON(&u); err != nil {
            ctx.StatusCode(iris.StatusBadRequest)
            ctx.JSON(iris.Map{"error": err.Error()})
            return
        }
        // 校验通过才继续
    })
}

其他容易踩的坑:

  • 用 map[string]interface{} 接收数据 → validate 不生效,因为没 struct 字段可扫描
  • 字段类型不匹配(比如 JSON 传字符串,struct 定义为 int)→ 在校验前就已报 json: cannot unmarshal string into Go struct field
  • 忘记在 ReadJSON 后检查返回的 err → 校验失败时 err 是 *validator.InvalidValidationError 或 validator.ValidationErrors 类型,需类型断言提取具体字段错误

如何返回结构化校验错误(含字段名和提示)

Iris 不自动格式化校验错误,你需要手动处理 validator.ValidationErrors。直接 err.Error() 只是扁平字符串,不利于前端解析。

Iris框架 12.2.5
Iris框架 12.2.5

Iris框架 12.2.5 版本源码包下载,适合需要 MVC Singleton 控制器、依赖注入字段控制和 debug 错误日志改进的开发者。

下载

推荐做法:写一个辅助函数,把 ValidationErrors 转成 map:

func parseValidatorErrors(err error) map[string]string {
    errs := make(map[string]string)
    if _, ok := err.(*validator.InvalidValidationError); ok {
        return errs
    }
    if validationErrors, ok := err.(validator.ValidationErrors); ok {
        for _, e := range validationErrors {
            field := e.Field()
            tag := e.Tag()
            switch tag {
            case "required":
                errs[field] = "必填项"
            case "email":
                errs[field] = "邮箱格式不正确"
            case "gte", "lte":
                errs[field] = "数值超出范围"
            default:
                errs[field] = "格式错误"
            }
        }
    }
    return errs
}

然后在 handler 中调用:

if err := ctx.ReadJSON(&u); err != nil {
    ctx.StatusCode(iris.StatusBadRequest)
    ctx.JSON(iris.Map{"code": 400, "errors": parseValidatorErrors(err)})
    return
}

自定义验证函数怎么注册(比如手机号、身份证)

标准 validate tag 不支持业务级规则,需注册自定义函数。例如校验 11 位手机号:

v := validator.New()
v.RegisterValidation("phone", func(fl validator.FieldLevel) bool {
    s := fl.Field().String()
    return regexp.MustCompile(`^1[3-9]\d{9}$`).MatchString(s)
})
app.Validator = v

之后就能在 struct 中使用:

Phone string `json:"phone" validate:"required,phone"`

注意点:

  • 注册必须在 app.Validator = v 之前完成
  • 函数名("phone")要和 tag 中一致,大小写敏感
  • 自定义函数里不要 panic,FieldLevel 提供的是只读访问,别试图修改原始 struct
  • 正则匹配前先判空,避免 fl.Field().String() 对 nil 指针 panic

真正容易被忽略的是:自定义验证函数的错误信息默认还是英文且不带字段上下文,如果要返回中文提示,得自己封装一层错误包装逻辑,而不是依赖 validator 默认输出。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

0

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

0

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

0

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

0

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

0

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

220

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

120

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

100

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

60

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Iris框架MVC快速入门指南
Iris框架MVC快速入门指南

共0课时 | 0人学习

Iris框架官方文档
Iris框架官方文档

共0课时 | 0人学习