Verify项目中的JSON引用处理问题解析

在Verify测试库中处理包含JSON引用($ref)的验证时，开发者可能会遇到引用被替换为null的问题。本文将深入分析这一现象的原因，并提供解决方案。

问题现象

当使用VerifyJson方法验证包含JSON引用($ref)的JSON数据时，会出现以下情况：

1. 所有$ref引用节点被替换为null值
2. $id等元数据属性被自动移除

例如，输入JSON：

{
  "a": { "$id": "x", "b": 1 },
  "b": 2,
  "c": { "$ref": "#x/b" },
  "d": { "$ref": "#/b" }
}

预期结果应为解引用后的JSON或保持原样，但实际输出却是：

{
  "a": { "b": 1 },
  "b": 2,
  "c": null,
  "d": null
}

技术背景

此问题源于Verify库内部使用的JSON.NET(Argon)库对JSON引用($ref)和ID($id)的特殊处理机制。JSON.NET默认会尝试解析这些引用，当解析失败时会将引用节点替换为null值。

解决方案

Verify库在23.6.0版本中已修复此问题，改为直接保留原始JSON结构，包括$ref和$id等特殊属性。升级后输出如下：

{
  "a": { "$id": "x", "b": 1 },
  "b": 2,
  "c": { "$ref": "#x/b" },
  "d": { "$ref": "#/b" }
}

对于无法立即升级的用户，可通过配置JSON.NET的元数据处理方式临时解决：

VerifierSettings.AddExtraSettings(s => 
    s.MetadataPropertyHandling = MetadataPropertyHandling.Ignore);

此配置使JSON.NET忽略$前缀的属性，将其视为普通属性处理。

最佳实践

1. 对于JSON Schema验证等需要保留引用的场景，建议升级到Verify 23.6.0或更高版本
2. 若需要解引用功能，应在验证前自行处理JSON引用
3. 了解JSON.NET对各种JSON扩展属性的处理机制，必要时进行适当配置

Verify库的这一改进使其更适合用于验证包含JSON引用和扩展属性的复杂JSON结构，特别是在API契约测试和JSON Schema验证等场景中。