Golang如何实现简单的JSON Schema校验_Golang JSON Schema验证示例-Golang-PHP中文网

Golang如何实现简单的JSON Schema校验_Golang JSON Schema验证示例

P粉602998670

发布： 2025-12-15 18:08:50

原创

705人浏览过

Go语言通过第三方库xeipuuv/gojsonschema实现JSON Schema校验，支持Draft 4规范，可定义结构规则并验证JSON数据，如字段类型、必填项、数值范围和格式（如email），使用NewStringLoader或NewReferenceLoader加载Schema和数据，Validate执行校验，result.Valid()判断结果，Errors()获取详细错误信息，适用于API请求验证等场景。

golang如何实现简单的json schema校验_golang json schema验证示例

在 Go 语言中，虽然标准库 encoding/json 提供了 JSON 的编码与解码功能，但并未内置对 JSON Schema 的校验支持。如果需要验证 JSON 数据是否符合预定义的结构和规则，可以通过第三方库来实现。一个常用且轻量的选择是 xeipuuv/go jsonschema，它完整实现了 JSON Schema Draft 4 规范。

安装 gojsonschema 库

使用以下命令安装 JSON Schema 校验库：

go get github.com/xeipuuv/gojsonschema

基本使用示例：校验 JSON 是否符合 Schema

下面是一个简单的例子，展示如何用 Go 定义 JSON Schema 并校验输入的 JSON 数据。

假设我们有一个用户信息的 JSON 结构，要求：

立即学习“go语言免费学习笔记（深入）”；

name 字段为字符串，且必填
age 字段为整数，且大于 0
email 字段为合法邮箱格式

对应的 JSON Schema 如下：

const userSchema = `{
"type": "object",
"required": ["name", "age", "email"],
"properties": {
"name": { "type": "string" },
"age": { "type": "integer", "minimum": 1 },
"email": { "type": "string", "format": "email" }
}
}`

待校验的 JSON 数据：

Visla

AI视频生成器，快速轻松地将您的想法转化为视觉上令人惊叹的视频。

100

查看详情

const inputJSON = `{
"name": "Alice",
"age": 25,
"email": "alice@example.com"
}`

完整的校验代码：

package main

import (
"fmt"
"github.com/xeipuuv/gojsonschema"
)

const userSchema = `{
"type": "object",
"required": ["name", "age", "email"],
"properties": {
"name": { "type": "string" },
"age": { "type": "integer", "minimum": 1 },
"email": { "type": "string", "format": "email" }
}
}`

const inputJSON = `{
"name": "Alice",
"age": 25,
"email": "alice@example.com"
}`

func main() {
schemaLoader := gojsonschema.NewStringLoader(userSchema)
documentLoader := gojsonschema.NewStringLoader(inputJSON)

result, err := gojsonschema.Validate(schemaLoader, documentLoader)
if err != nil {
panic(err.Error())
}

if result.Valid() {
fmt.Printf("数据校验通过")
} else {
fmt.Printf("校验失败:")
for _, desc := range result.Errors() {
fmt.Printf("- %s\n", desc)
}
}
}

处理校验错误

当 result.Valid() 返回 false 时，可以通过 result.Errors() 获取详细的错误列表。每个错误包含字段路径、类型和具体原因，例如：

“age must be greater than or equal to 1”
“email: does not match format 'email'”
“missing property: name”

这些信息可用于调试或返回给 API 调用方作为提示。

从文件加载 Schema 或 JSON

除了字符串，你也可以从本地文件或 HTTP URL 加载 Schema 和数据：

schemaLoader := gojsonschema.NewReferenceLoader("file:///path/to/schema.json")
documentLoader := gojsonschema.NewReferenceLoader("https://api.example.com/data.json")

注意使用 file:// 或 http(s):// 前缀触发引用加载器。

基本上就这些。使用 gojsonschema 可以快速实现结构化 JSON 校验，适合配置解析、API 请求验证等场景。不复杂但容易忽略的是格式关键字（如 email、uri）必须显式启用，某些高级特性如条件校验也需注意版本兼容性。

以上就是Golang如何实现简单的JSON Schema校验_Golang JSON Schema验证示例的详细内容，更多请关注php中文网其它相关文章！