当前位置:首页 > 文章列表 > Golang > Go问答 > Go 输入校验怎么把清洗、验证和 JSON Schema 放在一次流程里

Go 输入校验怎么把清洗、验证和 JSON Schema 放在一次流程里

来源:17golang原创 2026-10-06 05:08:03 0浏览 收藏

如果一个 Go 接口既要去掉用户输入两侧的空格,又要统一邮箱大小写、检查必填字段,还要把同一份规则交给前端,最容易出现的问题是:清洗写在 handler,校验写在另一个包,Schema 又手工维护一份。更稳妥的做法是让请求结构成为规则的中心,再把处理拆成“规范化、校验、契约输出”三个边界。

官方地址:https://github.com/cinar/checker

本文使用 Golang News 近期介绍的 Checker 作为观察入口,示例和组织方式全部重新设计;技术事实以 Go 标准库与项目公开文档为准。

先把输入处理拆成三层

先明确三个动作的区别:规范化会改变输入值,例如去掉首尾空格;校验只判断值是否满足约束;契约输出则把结构上的规则转换成接口文档。它们可以共用一份字段声明,但不要混成一个无法解释的“大验证函数”。

Go 输入处理的清洗校验错误边界说明图
图1:Go 输入处理的清洗、校验与错误边界说明图。

下面的请求模型故意使用与常见注册表单不同的字段,重点是观察处理顺序:先规范化,再判断必填和格式,最后才把通过的数据交给业务层。

package main

import (
    "fmt"

    checker "github.com/cinar/checker/v2"
)

type MemberRequest struct {
    // 先清洗昵称,再确认它不是空值。
    Nickname string `json:"nickname" checkers:"trim required min-len:2"`
    // 邮箱先统一小写,后续校验和存储使用同一种表示。
    Email string `json:"email" checkers:"trim lower required email"`
    // 两次输入必须和密码字段保持一致。
    PasswordAgain string `json:"password_again" checkers:"required eq-field:Password"`
    Password      string `json:"password" checkers:"required min-len:10"`
}

func main() {
    req := &MemberRequest{
        Nickname:      "  Lin  ",
        Email:         "  LIN@EXAMPLE.COM ",
        Password:      "long-password",
        PasswordAgain: "long-password",
    }

    // CheckStruct 会按标签处理字段,并返回结构化的错误集合。
    errs, valid := checker.CheckStruct(req)
    if !valid {
        // JSON 适合直接作为接口错误响应,避免丢失字段定位信息。
        data, err := errs.JSON()
        if err != nil {
            panic(fmt.Errorf("marshal validation errors: %w", err))
        }
        fmt.Println(string(data))
        return
    }

    // 校验通过后,req 中已经是规范化后的业务输入。
    fmt.Println(req.Nickname, req.Email)
}

这里的关键不是标签数量,而是顺序语义:trim lower required email 先把值变成可比较的形态,再执行约束。校验失败时返回结构化错误;成功时业务层拿到的就是可以继续处理的值。

错误要保留原因,别只拼接字符串

输入校验错误通常要回到 HTTP 层,而文件、数据库或外部服务错误则要继续向上返回。两者都不应该通过字符串拼接来“伪装上下文”,因为调用方可能还要使用 errors.Is 或 errors.As 判断原始原因。

var errEmailExists = errors.New("email already exists")

func saveMember(req *MemberRequest) error {
    // 示例中用哨兵错误代表持久化层返回的重复邮箱。
    if req.Email == "used@example.com" {
        return fmt.Errorf("save member: %w", errEmailExists)
    }
    return nil
}

func handle(req *MemberRequest) error {
    // 输入错误已经在边界层处理,这里只接收通过校验的结构。
    if err := saveMember(req); err != nil {
        // 使用 %w 保留底层错误,调用者仍可做精确判断。
        return fmt.Errorf("member command failed: %w", err)
    }
    return nil
}

对于请求层,验证错误应包含字段和规则;对于业务层,包装错误应加入当前动作,例如“保存会员失败”,但仍保留原始错误链。这样日志可读,代码也能做稳定分支。

让校验规则同时成为接口契约

如果前端还要知道哪些字段必填、字符串最短长度是多少,单独手写一份 JSON Schema 很快就会和 Go 结构漂移。Checker 的思路是从结构标签生成 Draft 2020-12 Schema,让前端契约和服务端校验至少共享同一组字段声明。

Go 结构标签与 JSON Schema 接口契约关系说明图
图2:从 Go 结构标签到 JSON Schema 的契约关系说明图。
func schemaForMember() ([]byte, error) {
    // Schema 从同一结构类型生成,避免再维护一份平行字段清单。
    schema, err := checker.JSONSchema(MemberRequest{})
    if err != nil {
        // 生成失败时保留上下文,调用方可以决定是否阻止文档发布。
        return nil, fmt.Errorf("generate member schema: %w", err)
    }
    return schema.JSON()
}

Schema 是接口说明,不等于运行时验证本身。运行时仍要对请求执行校验;Schema 也不应被当作权限系统。尤其是跨字段规则、数据库唯一性和租户权限,往往不能只靠静态结构表达。

什么时候改用显式 Pipeline

结构标签适合字段之间相对独立、规则能随请求模型表达的场景。如果某个规则要查数据库、读取租户信息、调用上下文取消,应该把它放到显式 Pipeline,而不是把外部依赖硬塞进标签。

func checkTenant(ctx context.Context, req MemberRequest) error {
    // 外部查询需要上下文,因此不把数据库依赖写进静态标签。
    if err := ctx.Err(); err != nil {
        return fmt.Errorf("tenant check canceled: %w", err)
    }
    // 这里接入真实租户查询,并返回可定位的业务错误。
    return nil
}

可以把流程固定成:解析请求 → 标签校验与规范化 → 上下文相关检查 → 业务保存。这样每一步都有明确责任,失败时也能判断是用户输入、外部依赖还是业务状态问题。

几个容易踩坑的判断

  • 清洗不是安全边界。HTML 转义、权限检查和业务白名单仍要根据输出场景单独设计。
  • 原地规范化会改变请求对象。进入审计或签名流程前,先确定记录的是原始值还是规范化后的值。
  • Schema 生成成功不代表每个业务规则都被覆盖,数据库唯一性和动态权限必须留在业务层。

归纳起来:把稳定的字段规则放回请求结构,把清洗和验证保持在同一条可解释链路;把错误作为错误返回;再从同一结构生成接口契约。规则需要上下文时,及时切到显式 Pipeline,边界会比继续堆标签更清楚。

相关问题

清洗应该在 JSON 反序列化前还是后?通常在得到结构化字段后处理更容易表达规则;若担心超大输入,仍应先做请求体大小和解析层面的限制。

JSON Schema 能替代服务端校验吗?不能。Schema 主要描述契约,服务端仍要在不可信输入边界执行校验和业务授权。

版本声明
本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
PHP 属性钩子怎么避免 setter 再次触发自身PHP 属性钩子怎么避免 setter 再次触发自身
上一篇
PHP 属性钩子怎么避免 setter 再次触发自身
Go iter.Seq2 怎么为树形索引暴露键值遍历
下一篇
Go iter.Seq2 怎么为树形索引暴露键值遍历
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    343次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    405次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    404次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    364次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    186次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码