使用xeipuuv/gojsonschema验证JSON时遇必填字段误报问题求助

一、"object1为必填字段"错误的常见原因及修复 #

1. Schema中required数组路径错误 #

检查你的JSON Schema是否将required字段放在了顶层（与properties同级），而非嵌套在子结构里。错误写法会导致校验规则失效，正确示例：

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "object1": {
      "type": "object",
      "properties": {
        "title": {"type": "string"},
        "id": {"type": "string"},
        "birthDate": {"type": "string", "format": "date"}
      },
      "required": ["title", "id", "birthDate"]
    },
    "object2": {
      "type": "object"
    }
  },
  "required": ["object1"] // 必须在顶层，和properties同级
}

2. 待验证JSON结构不匹配 #

确认object1是JSON的顶层直接属性，而非嵌套在其他字段中。比如下面的结构会触发错误：

{
  "wrapper": {
    "object1": { ... }
  }
}

需调整为根层级结构：

{
  "object1": {
    "title": "Mr.",
    "id": "123",
    "birthDate": "1990-01-01"
  },
  "object2": { ... }
}

3. Schema加载或解析错误 #

检查Schema文件路径是否正确、文件本身是否有JSON语法错误（比如逗号缺失、引号不匹配）。代码中要捕获加载异常：

schemaLoader := gojsonschema.NewReferenceLoader("file:///path/to/your/schema.json")
schema, err := gojsonschema.NewSchema(schemaLoader)
if err != nil {
    log.Fatalf("Schema加载失败: %v", err)
}

二、对象内部字段（title、id、出生日期）的验证配置 #

在Schema的对应properties下定义字段规则，并通过required数组指定必填项：

1. 基础规则示例 #

"object1": {
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 10
    },
    "id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9-]{1,20}$" // 匹配自定义ID格式
    },
    "birthDate": {
      "type": "string",
      "format": "date" // 强制ISO 8601日期格式（YYYY-MM-DD）
    }
  },
  "required": ["title", "id", "birthDate"],
  "additionalProperties": false // 可选，禁止未定义字段
}

2. 代码中处理验证结果 #

遍历错误信息精准定位问题：

documentLoader := gojsonschema.NewStringLoader(`{"object1": {"title": "Mr.", "id": "123", "birthDate": "1990-01-01"}, "object2": {}}`)
result, err := schema.Validate(documentLoader)
if err != nil {
    log.Fatalf("验证失败: %v", err)
}

if result.Valid() {
    fmt.Println("JSON数据符合Schema规则")
} else {
    fmt.Println("验证错误:")
    for _, desc := range result.Errors() {
        fmt.Printf("- %s\n", desc)
    }
}

三、额外排查点 #

• 确认Schema指定的$schema版本与xeipuuv/gojsonschema支持的版本一致（该库支持draft-04至draft-07）
• 检查待验证JSON的字段拼写，JSON是大小写敏感的，比如Object1和object1会被视为不同字段

内容的提问来源于stack exchange，提问作者Bruno Barbosa