使用.NET 生成 JSON Schema 验证器

在现代软件开发中，JSON（JavaScript Object Notation）已成为数据交换的通用格式。为了确保接收到的 JSON 数据符合预期格式，我们可以使用 JSON Schema 进行验证。在.NET 环境中，我们可以利用一些库来生成和使用 JSON Schema 验证器。

本文将介绍如何使用.NET 代码生成 JSON Schema 验证器，并提供一个简单的示例来演示验证过程。

一、安装必要的 NuGet 包

在.NET 项目中，我们可以使用 NJsonSchema 这个 NuGet 包来生成和处理 JSON Schema。你可以通过 NuGet 包管理器或命令行工具来安装它：

Install-Package NJsonSchema


或者使用 .NET CLI：

dotnet add package NJsonSchema


二、生成 JSON Schema

首先，我们需要定义一个.NET 类，该类将作为我们生成 JSON Schema 的基础。例如，我们定义一个简单的 Person 类：

public classPerson
{
publicstring FirstName { get; set; }
publicstring LastName { get; set; }
publicint Age { get; set; }
}


接下来，我们可以使用 NJsonSchema 库来为这个类生成 JSON Schema：

using NJsonSchema;
using NJsonSchema.Generation;
using System;
classProgram
{
staticvoidMain(string[] args)
{
var generator = new JsonSchemaGeneratorSettings();
var schema = JsonSchema.FromType<Person>(generator);
// 将生成的 JSON Schema 转换为字符串以便查看或保存
var schemaJson = schema.ToJson(SchemaType.JsonSchemaDraft7);
Console.WriteLine(schemaJson);
}
}


这段代码会输出一个描述 Person 类的 JSON Schema。

三、使用 JSON Schema 进行验证

一旦我们有了 JSON Schema，我们就可以使用它来验证 JSON 数据是否符合预期格式。以下是一个简单的验证示例：

using NJsonSchema;
using NJsonSchema.Validation;
using System;
using System.Text;
using Newtonsoft.Json.Linq;
classProgram
{
staticvoidMain(string[] args)
{
// 加载之前生成的 JSON Schema（或从其他地方获取）
var schemaJson = "{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"properties\":{\"FirstName\":{\"type\":\"string\"},\"LastName\":{\"type\":\"string\"},\"Age\":{\"type\":\"integer\"}},\"required\":[\"FirstName\",\"LastName\",\"Age\"]}";
var schema = JsonSchema.FromJson(schemaJson);
// 要验证的 JSON 数据
var json = "{\"FirstName\":\"John\",\"LastName\":\"Doe\",\"Age\":30}";
var jsonData = JToken.Parse(json);
// 进行验证
var validator = new JsonSchemaValidator();
var validationErrors = validator.Validate(schema, jsonData);
// 输出验证结果
if (validationErrors.Count == 0)
{
Console.WriteLine("JSON 数据验证通过！");
}
else
{
Console.WriteLine("JSON 数据验证失败！");
foreach (var error in validationErrors)
{
Console.WriteLine($"错误: {error.Path} - {error.Message}");
}
}
}
}




在这个示例中，我们首先加载了之前生成的 JSON Schema（在实际应用中，你可能需要从文件、数据库或其他存储中加载它）。然后，我们定义了一个要验证的 JSON 字符串，并使用 NJsonSchema 的验证器对其进行验证。最后，我们输出了验证结果。

通过这两个简单的示例，你可以看到在.NET 中使用 NJsonSchema 库生成和使用 JSON Schema 验证器是多么容易。这对于确保你的应用程序接收到的 JSON 数据符合预期格式非常有用。