Golang快速实现JSON Schema表达式匹配

JSON Schema是一种用于描述JSON数据结构的强大工具，可以用来验证JSON文档的结构。在Golang中，我们可以使用github.com/xeipuuv/gojsonschema库来快速实现JSON Schema的表达式匹配。

安装依赖

首先安装必要的依赖：

go get github.com/xeipuuv/gojsonschema

基本使用示例

下面是一个基本的JSON Schema验证示例：

package main

import (
	"fmt"
	"log"

	"github.com/xeipuuv/gojsonschema"
)

func main() {
	// 定义JSON Schema
	schemaString := `{
		"type": "object",
		"properties": {
			"name": {
				"type": "string",
				"minLength": 3,
				"maxLength": 20
			},
			"age": {
				"type": "integer",
				"minimum": 18,
				"maximum": 120
			},
			"email": {
				"type": "string",
				"format": "email"
			}
		},
		"required": ["name", "age"]
	}`

	// 要验证的JSON数据
	documentString := `{
		"name": "John Doe",
		"age": 30,
		"email": "john@example.com"
	}`

	// 加载schema
	schemaLoader := gojsonschema.NewStringLoader(schemaString)
	documentLoader := gojsonschema.NewStringLoader(documentString)

	// 验证
	result, err := gojsonschema.Validate(schemaLoader, documentLoader)
	if err != nil {
		log.Fatalf("Error validating schema: %v", err)
	}

	if result.Valid() {
		fmt.Println("The document is valid!")
	} else {
		fmt.Println("The document is not valid. See errors:")
		for _, desc := range result.Errors() {
			fmt.Printf("- %s\n", desc)
		}
	}
}

高级功能

1. 自定义验证器

package main

import (
	"fmt"
	"log"
	"strings"

	"github.com/xeipuuv/gojsonschema"
)

// 自定义格式验证器
func init() {
	gojsonschema.FormatCheckers.Add("uppercase", UppercaseFormatChecker{})
}

type UppercaseFormatChecker struct{}

func (c UppercaseFormatChecker) IsFormat(input interface{}) bool {
	s, ok := input.(string)
	if !ok {
		return false
	}
	return s == strings.ToUpper(s)
}

func main() {
	schemaString := `{
		"type": "object",
		"properties": {
			"username": {
				"type": "string",
				"format": "uppercase"
			}
		}
	}`

	documentString := `{"username": "ADMIN"}`

	schemaLoader := gojsonschema.NewStringLoader(schemaString)
	documentLoader := gojsonschema.NewStringLoader(documentString)

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

	if result.Valid() {
		fmt.Println("Valid!")
	} else {
		fmt.Println("Invalid:")
		for _, err := range result.Errors() {
			fmt.Println(err.String())
		}
	}
}

2. 从文件加载Schema

package main

import (
	"fmt"
	"log"

	"github.com/xeipuuv/gojsonschema"
)

func main() {
	// 从文件加载schema
	schemaLoader := gojsonschema.NewReferenceLoader("file:///path/to/schema.json")
	documentLoader := gojsonschema.NewReferenceLoader("file:///path/to/document.json")

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

	if result.Valid() {
		fmt.Println("Valid!")
	} else {
		fmt.Println("Invalid:")
		for _, err := range result.Errors() {
			fmt.Println(err.String())
		}
	}
}

3. 动态生成Schema

package main

import (
	"encoding/json"
	"fmt"
	"log"

	"github.com/xeipuuv/gojsonschema"
)

func main() {
	// 动态生成schema
	schema := map[string]interface{}{
		"type": "object",
		"properties": map[string]interface{}{
			"id": map[string]interface{}{
				"type":    "string",
				"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[8|9|aA|bB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$",
			},
			"tags": map[string]interface{}{
				"type":  "array",
				"items": map[string]interface{}{"type": "string"},
				"minItems": 1,
				"uniqueItems": true,
			},
		},
		"required": []string{"id"},
	}

	schemaBytes, err := json.Marshal(schema)
	if err != nil {
		log.Fatal(err)
	}

	documentString := `{
		"id": "550e8400-e29b-41d4-a716-446655440000",
		"tags": ["golang", "json"]
	}`

	schemaLoader := gojsonschema.NewBytesLoader(schemaBytes)
	documentLoader := gojsonschema.NewStringLoader(documentString)

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

	if result.Valid() {
		fmt.Println("Valid!")
	} else {
		fmt.Println("Invalid:")
		for _, err := range result.Errors() {
			fmt.Println(err.String())
		}
	}
}

性能优化建议

1. 缓存Schema加载器：如果多次使用同一个schema，可以缓存gojsonschema.Schema对象
2. 避免重复解析：对于频繁验证的场景，可以预编译schema
3. 使用ReferenceLoader：对于大型schema，使用文件引用而不是字符串

总结

gojsonschema库提供了强大的JSON Schema验证功能，支持：

• 基本数据类型验证
• 复杂结构验证（数组、对象等）
• 自定义验证规则
• 多种加载方式（字符串、文件、网络等）

通过合理使用这个库，可以轻松实现JSON数据的结构化验证，确保数据符合预期的格式和约束。