.NET下支持大小写不敏感的JSON Schema验证方法

net,json,schema · 浏览次数 : 0

小编点评

本文介绍了在微服务架构下，如何解决由于历史原因导致的JSON数据属性名大小写不一致的问题。由于目前的JSON Schema标准是大小写敏感的，因此需要一种临时解决方案来满足大小写无关的需求。一种临时解决方案是利用JSON Schema中的`patternProperties`关键字，通过写正则表达式来表示当前属性名是大小写无关的。例如，对于数据`[ { "Count": 1 }, { "count": 3 }]`，可以编写如下JSON Schema： ```json { "type": "array", "items": { "patternProperties": { "^[Cc]ount$": { "minimum": 1 } } } } ``` 虽然这种解决方案可以解决问题，但会使JSON Schema变得复杂。更优雅的解决方案是在.NET中使用System.Text.Json库，它的反序列化器支持属性名大小写无关的选项`PropertyNameCaseInsensitive`。然而，目前并没有公开的JSON Schema实现库支持大小写无关的扩展选项。在.NET下，可以使用Lateapexearlyspeed.Json.Schema库来实现属性名大小写无关的JSON Schema级验证。这个库遵循标准JSON Schema，并提供了显式配置`PropertyNameCaseInsensitive`选项。例如： ```csharp // 创建一个JsonValidator实例，设置PropertyNameCaseInsensitive为true JsonValidator jsonValidator = new JsonValidator(jsonSchema, new JsonValidatorOptions { PropertyNameCaseInsensitive = true }); // 验证JSON实例 ValidationResult validationResult = jsonValidator.Validate(jsonInstance); ``` 通过这种方式，可以更方便地实现属性名大小写无关的JSON Schema验证。如有问题，请将发现的问题报告到相关仓库，希望能帮助到大家。

正文

问题

有很多应用程序在验证JSON数据的时候用到了JSON Schema。
在微服务架构下，有时候各个微服务由于各种历史原因，它们所生成的数据对JSON Object属性名的大小写规则可能并不统一，它们需要消费的JSON数据的属性名可能需要大小写无关。
遗憾的是，目前的JSON Schema没有这方面的标准，标准中都是大小写敏感的。在类似上述情况下，这给使用JSON Schema进行数据验证造成了困难。

解决方案

一种 临时解决方案 是利用JSON Schema中的patternProperties关键字，写正则表达式来表示当前属性名是大小写无关的。
比如你的数据是这样的：

[
  { "Count": 1 },
  { "count": 3 }
]

那么你可以这样写JSON Schema：

{
  "type": "array",
  "items": {
    "patternProperties": {
      "^[Cc]ount$": { "minimum": 1 }
    }
  }
}

显然这样的JSON Schema会比原来的更复杂。

更优雅的解决方案

想象一下.NET下的JSON library System.Text.Json，它的反序列化器支持属性名大小写无关的选项PropertyNameCaseInsensitive，这个是用来反序列化的。

那么，有没有JSON Schema实现库支持大小写无关的扩展选项呢？在.NET下，目前实现库 Lateapexearlyspeed.Json.Schema支持属性名大小写无关的 JSON Schema级验证。由于该实现库遵循标准JSON Schema（规定属性名只能大小写敏感），所以这个扩展功能需要显式配置：

/// <summary>
/// Gets or sets a value that determines whether a property's name uses a case-insensitive comparison during validation. The default value is false.
/// </summary>
/// <returns>
/// true to compare property names using case-insensitive comparison; otherwise, false.
/// </returns>
public bool PropertyNameCaseInsensitive { get; set; }

例子：

string jsonSchema = """
    {
      "properties": {
        "A": {
                "properties": { 
                  "B": {"type": "string"} 
                }
        }
      }
    }
    """;

string jsonInstance = """
    {
      "a": {
        "b": 123
      }
    }
    """;

// By default, JSON Schema validation is property names case sensitive, so instance data's property names are not matched:
ValidationResult validationResult = new JsonValidator(jsonSchema).Validate(jsonInstance);
Assert.True(validationResult.IsValid);

// Opt in to feature of property names case Insensitive:
validationResult = new JsonValidator(jsonSchema, new JsonValidatorOptions { PropertyNameCaseInsensitive = true }).Validate(jsonInstance);

Assert.False(validationResult.IsValid);

Assert.Equal("Expect type(s): 'String' but actual is 'Number'", validationResult.ErrorMessage);
Assert.Equal("/a/b", validationResult.InstanceLocation!.ToString());
Assert.Equal("/properties/A/properties/B/type", validationResult.RelativeKeywordLocation!.ToString());

总结

本文介绍了.NET下实现属性名大小写无关的JSON Schema验证方法，其中最优雅的方式应该是用 .NET实现库 Lateapexearlyspeed.Json.Schema中的扩展选项 PropertyNameCaseInsensitive。

欢迎大家将使用过程中发现的问题报到repo issue，希望.NET实现库 Lateapexearlyspeed.Json.Schema 能帮到大家。

Github repo: https://github.com/lateapexearlyspeed/Lateapexearlyspeed.JsonSchema