0

0

如何在Golang中实现JSON校验_Golang encoding/json与struct标签方法

P粉602998670

P粉602998670

发布时间:2026-01-25 17:14:02

|

712人浏览过

|

来源于php中文网

原创

Go JSON解析失败时需先检查字段是否导出、json标签拼写是否正确(如json:"name")、类型是否匹配并合理使用omitempty;再用json.RawMessage延迟解析不确定结构;关键字段可自定义UnmarshalJSON校验;推荐用validator库声明式校验。

如何在golang中实现json校验_golang encoding/json与struct标签方法

JSON 解析失败时如何定位 struct 标签问题

Go 的 encoding/json 在解析失败时通常只报 json.UnmarshalTypeErrorjson.SyntaxError,但不会直接告诉你哪个字段的 struct 标签写错了。常见诱因是字段未导出(首字母小写)、json 标签拼写错误(如写成 josn)、或类型不匹配却没设 omitempty 导致空值无法赋给非指针非零值字段。

  • 确保所有需参与 JSON 编解码的字段首字母大写(即导出)
  • json 标签必须全小写,且用双引号包裹:正确是 `json:"name"`,错误是 `json:"Name"`(大小写不影响解析,但影响字段名映射)或 `json:name`(漏双引号)
  • 对可选字段,优先用指针类型或配合 omitempty:例如 Name *string `json:"name,omitempty"`,避免 JSON 中缺失该字段时解码失败

json.RawMessage 延迟校验嵌套结构

当 JSON 中某字段结构不确定(比如可能是对象、数组或字符串),直接绑定到具体 struct 会 panic。用 json.RawMessage 可先跳过解析,后续按需校验。

type Payload struct {
    ID    int              `json:"id"`
    Data  json.RawMessage  `json:"data"`
}

var p Payload
if err := json.Unmarshal(b, &p); err != nil {
    return err
}
// 后续再判断 data 是什么类型,再 Unmarshal 到对应 struct
  • json.RawMessage 本质是 []byte,不触发解析,性能开销低
  • 适合做“柔性解析”:先解出外层,再根据 data 的实际内容决定用哪个 struct 解内层
  • 注意:若后续多次调用 json.Unmarshal 解同一段 RawMessage,需确保字节未被修改(它不拷贝底层数据)

自定义 UnmarshalJSON 实现细粒度校验

标准库不提供字段级必填/格式校验能力。要实现如“email 字段必须含 @”或“price 必须 ≥ 0”,得重写 UnmarshalJSON 方法。

Miniflow
Miniflow

AI工作流自动化平台

下载
type Order struct {
    ID     int     `json:"id"`
    Email  string  `json:"email"`
    Price  float64 `json:"price"`
}

func (o *Order) UnmarshalJSON(data []byte) error {
    type Alias Order // 防止递归调用
    aux := &struct {
        *Alias
        Email string `json:"email"`
        Price float64 `json:"price"`
    }{
        Alias: (*Alias)(o),
    }
    if err := json.Unmarshal(data, &aux); err != nil {
        return err
    }
    if !strings.Contains(aux.Email, "@") {
        return fmt.Errorf("email must contain '@'")
    }
    if aux.Price < 0 {
        return fmt.Errorf("price must be non-negative")
    }
    o.Email = aux.Email
    o.Price = aux.Price
    return nil
}
  • 用内部 Alias 类型避免无限递归(否则调用 json.Unmarshal 会再次进本方法)
  • 字段校验逻辑写在解码后、赋值前,错误能精准定位到业务规则
  • 注意:此方法绕过了默认标签行为,需手动处理所有字段,建议只对关键字段定制

用第三方库做声明式校验(如 go-playground/validator)

手写 UnmarshalJSON 易出错且重复。更推荐用 validator 库,在 struct 标签中声明规则,解码后再统一校验。

立即学习go语言免费学习笔记(深入)”;

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

type User struct {
    Name  string `json:"name" validate:"required,min=2,max=20"`
    Email string `json:"email" validate:"required,email"`
    Age   uint8  `json:"age" validate:"gte=0,lte=150"`
}

var u User
if err := json.Unmarshal(b, &u); err != nil {
    return err
}
validate := validator.New()
if err := validate.Struct(u); err != nil {
    return err // 返回具体哪个字段、哪条规则失败
}
  • 校验与解码分离:先无脑解码,再集中校验,逻辑清晰
  • 错误信息可读性强,例如 Key: 'User.Email' Error:Field validation for 'Email' failed on the 'email' tag
  • 注意:validator 不介入 JSON 解码过程,所以仍需保证 struct 字段可导出、标签拼写正确,否则字段根本进不到校验环节
字段可导出、标签拼写、类型匹配这三关没过,再强的校验库也救不了——它们都发生在解码之后。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

180

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

228

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

341

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

209

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

393

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

200

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

192

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

315

2025.06.17

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

52

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号