Golang中使用jsonassert验证JSON序列化正确性

jsonassert是一个用于测试JSON序列化正确性的Go测试库，它可以帮助你验证生成的JSON是否符合预期结构，包括字段名称、值和类型。

安装

go get github.com/kinbiko/jsonassert

基本用法

1. 简单验证

package main

import (
	"testing"
	"github.com/kinbiko/jsonassert"
)

type Person struct {
	Name string `json:"name"`
	Age  int    `json:"age"`
}

func TestPersonJSON(t *testing.T) {
	ja := jsonassert.New(t)
	p := Person{Name: "Alice", Age: 30}
	expected := `{"name": "Alice", "age": 30}`

	// 将结构体序列化为JSON字符串
	actual, err := json.Marshal(p)
	if err != nil {
		t.Fatalf("Failed to marshal: %v", err)
	}

	ja.Assertf(string(actual), expected)
}

2. 验证可选字段

func TestOptionalFields(t *testing.T) {
	ja := jsonassert.New(t)
	
	// 使用"<present>"表示字段必须存在但不关心具体值
	ja.Assertf(
		`{"name": "Bob", "age": 25, "email": "bob@example.com"}`,
		`{"name": "<present>", "age": 25, "email": "<present>"}`,
	)
}

3. 正则表达式匹配

func TestRegexMatching(t *testing.T) {
	ja := jsonassert.New(t)
	
	// 使用正则表达式验证字段值格式
	ja.Assertf(
		`{"id": "user-12345", "created_at": "2023-01-01T12:00:00Z"}`,
		`{
			"id": "<<PRESENCE>>",
			"created_at": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$"
		}`,
	)
}

4. 数组验证

func TestArrayValidation(t *testing.T) {
	ja := jsonassert.New(t)
	
	// 验证数组内容和顺序
	ja.Assertf(
		`{"items": [1, 2, 3]}`,
		`{"items": [1, 2, 3]}`,
	)
	
	// 只验证数组长度
	ja.Assertf(
		`{"items": [1, 2, 3]}`,
		`{"items": "<<PRESENCE>>"}`,
	)
}

5. 嵌套结构验证

type Address struct {
	Street string `json:"street"`
	City   string `json:"city"`
}

type User struct {
	Name    string  `json:"name"`
	Address Address `json:"address"`
}

func TestNestedStruct(t *testing.T) {
	ja := jsonassert.New(t)
	user := User{
		Name: "Charlie",
		Address: Address{
			Street: "123 Main St",
			City:   "New York",
		},
	}

	expected := `{
		"name": "Charlie",
		"address": {
			"street": "123 Main St",
			"city": "New York"
		}
	}`

	actual, _ := json.Marshal(user)
	ja.Assertf(string(actual), expected)
}

高级特性

1. 忽略某些字段

func TestIgnoreFields(t *testing.T) {
	ja := jsonassert.New(t)
	
	// 使用"<<IGNORE>>"忽略特定字段
	ja.Assertf(
		`{"id": "123", "name": "Dave", "timestamp": "2023-01-01"}`,
		`{
			"id": "<<IGNORE>>",
			"name": "Dave",
			"timestamp": "<<IGNORE>>"
		}`,
	)
}

2. 自定义比较器

func TestCustomComparator(t *testing.T) {
	ja := jsonassert.New(t)
	
	// 为特定字段定义自定义比较逻辑
	ja.AssertfWithOptions(
		`{"score": 95.12345}`,
		`{"score": 95.12}`,
		jsonassert.Options{
			FloatPrecision: 2, // 只比较小数点后两位
		},
	)
}

最佳实践

1. 保持测试简洁：只验证必要的字段，使用<<PRESENCE>>或<<IGNORE>>简化测试
2. 优先验证结构：类型和字段名称比具体值更重要
3. 处理动态数据：对时间戳、ID等动态生成的数据使用正则或忽略
4. 组合使用：可以结合标准库的json.Unmarshal和jsonassert进行更全面的测试

jsonassert是一个强大的工具，可以显著简化JSON序列化的测试工作，同时保持测试的准确性和可维护性。