.NET下 支持大小写不敏感的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(规定属性名只能大小写敏感),所以这个扩展功能需要显式配置:

csharp 复制代码
/// <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; }

例子:

csharp 复制代码
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

相关推荐
鲤籽鲲2 小时前
C# System.Net.IPAddress 使用详解
网络·c#·.net
a123_z6 小时前
.NET 创建MCP使用大模型对话
.net
三天不学习10 小时前
基于 .NET 8 + Lucene.Net + 结巴分词实现全文检索与匹配度打分实战指南
全文检索·.net·lucene
小码编匠12 小时前
C# 实现西门子S7系列 PLC 数据管理工具
后端·c#·.net
时光追逐者2 天前
在 Blazor 中使用 Chart.js 快速创建数据可视化图表
开发语言·javascript·信息可视化·c#·.net·blazor
三天不学习2 天前
Lucene.Net FSDirectory 和 RAMDirectory 的区别和用法 【搜索引擎系列教程】
搜索引擎·.net·lucene
爱吃奶酪的松鼠丶2 天前
.net GRPC服务搭建,跨进程调用。C#应用和Python应用之间的通信。
python·c#·.net
S3下载站2 天前
Microsoft .NET Framework 4.8 离线安装包 下载
microsoft·.net
AI.NET 极客圈2 天前
AI与.NET技术实操系列(四):使用 Semantic Kernel 和 DeepSeek 构建AI应用
人工智能·.net