當前位置：首頁 > 运维知识 > windows >内容正文

windows

Json Schema简介和Json Schema的.net实现库 LateApexEarlySpeed.Json.Schema

發布時間：2023/12/29 windows 26 coder

生活随笔收集整理的這篇文章主要介紹了 Json Schema简介和Json Schema的.net实现库 LateApexEarlySpeed.Json.Schema 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

什么是Json Schema ？

Json Schema是一種聲明式語言，它可以用來標識Json的結構，數據類型和數據的具體限制，它提供了描述期望Json結構的標準化方法。
利用Json Schema, 你可以定義Json結構的各種規則，以便確定Json數據在各個子系統中交互傳輸時保持兼容和一致的格式。

一般來說，系統可以自己實現邏輯來判斷當前json是否滿足接口要求，比如是否某個字段存在，是否屬性值是有效的。但當驗證需求變得復雜后，比如有大量嵌套json結構，屬性之間的復雜關聯限制等等，則容易編寫出考慮不全的驗證代碼。另外，當系統需要動態的json數據要求，比如先由用戶自己決定他需要的json結構，然后系統根據用戶表達的定制化json結構需求，幫助用戶驗證后續的json數據。這種系統代碼編譯時無法確定的json結構，就需要另一種解決方案。

Json Schema就是針對這種問題的比較自然的解決方案。它可以讓你或你的用戶描述希望的json結構和值的內容限制，有效屬性，是否是required, 還有有效值的定義，等等。。利用Json Schema, 人們可以更好的理解Json結構，而且程序也可以根據你的Json Schema驗證Json數據。

比如下面的一個簡單例子，用.net下的Json Schema實現庫LateApexEarlySpeed.Json.Schema進行Json數據的驗證：

Json Schema （文件：schema.json）：

{
  "type": "object",
  "properties": {
    "propBoolean": {
      "type": "boolean"
    },
    "propArray": {
      "type": "array",
      "uniqueItems": true
    }
  }
}

Json 數據（文件：instance.json）：

{
  "propBoolean": true,
  "propArray": [ 1, 2, 3, 4, 4 ]
}

C# 代碼：

            string jsonSchema = File.ReadAllText("schema.json");
            string instance = File.ReadAllText("instance.json");

            var jsonValidator = new JsonValidator(jsonSchema);
            ValidationResult validationResult = jsonValidator.Validate(instance);

            if (validationResult.IsValid)
            {
                Console.WriteLine("good");
            }
            else
            {
                Console.WriteLine($"Failed keyword: {validationResult.Keyword}");
                Console.WriteLine($"ResultCode: {validationResult.ResultCode}");
                Console.WriteLine($"Error message: {validationResult.ErrorMessage}");
                Console.WriteLine($"Failed instance location: {validationResult.InstanceLocation}");
                Console.WriteLine($"Failed relative keyword location: {validationResult.RelativeKeywordLocation}");
            }

輸出：

Failed keyword: uniqueItems
ResultCode: DuplicatedArrayItems
Error message: There are duplicated array items
Failed instance location: /propArray
Failed relative keyword location: /properties/propArray/uniqueItems

LateApexEarlySpeed.Json.Schema中文介紹

項目原始文檔：https://github.com/lateapexearlyspeed/Lateapexearlyspeed.JsonSchema.Doc

中文文檔：
LateApexEarlySpeed.Json.Schema是2023年12月發布的一個新的.net下的Json Schema實現庫，基于截止到2023年12月為止最新版的Json schema - draft 2020.12。
Json Schema驗證功能經過了official json schema test-suite for draft 2020.12的測試。（部分排除的用例見下面的已知限制章節）
LateApexEarlySpeed.Json.Schema的主要特點是：

基于微軟.net下默認的System.Text.Json而非經典的Newtonsoft.Json
使用簡單
和已有的知名且杰出的.net下的一些JsonSchema實現庫相比，具有很好的性能 (在common case下，利用BenchmarkDotnet進行的性能測試)。用戶請根據自己的使用場景進行性能驗證

該實現庫之后可能會transfer成開源項目。

基礎用法

安裝Nuget package

Install-Package LateApexEarlySpeed.Json.Schema

string jsonSchema = File.ReadAllText("schema.json");
string instance = File.ReadAllText("instance.json");

var jsonValidator = new JsonValidator(jsonSchema);
ValidationResult validationResult = jsonValidator.Validate(instance);

if (validationResult.IsValid)
{
    Console.WriteLine("good");
}
else
{
    Console.WriteLine($"Failed keyword: {validationResult.Keyword}");
    Console.WriteLine($"ResultCode: {validationResult.ResultCode}");
    Console.WriteLine($"Error message: {validationResult.ErrorMessage}");
    Console.WriteLine($"Failed instance location: {validationResult.InstanceLocation}");
    Console.WriteLine($"Failed relative keyword location: {validationResult.RelativeKeywordLocation}");
    Console.WriteLine($"Failed schema resource base uri: {validationResult.SchemaResourceBaseUri}");
}

輸出信息

當json數據驗證失敗后，可以查看錯誤數據的具體信息:

IsValid: As summary indicator for passed validation or failed validation.
ResultCode: The specific error type when validation failed.
ErrorMessage: the specific wording for human readable message
Keyword: current keyword when validation failed
InstanceLocation: The location of the JSON value within the instance being validated. The value is a JSON Pointer.
RelativeKeywordLocation: The relative location of the validating keyword that follows the validation path. The value is a JSON Pointer, and it includes any by-reference applicators such as "$ref" or "$dynamicRef". Eg:
```
/properties/width/$ref/minimum
```
SubSchemaRefFullUri: The absolute, dereferenced location of the validating keyword when validation failed. The value is a full URI using the canonical URI of the relevant schema resource with a JSON Pointer fragment, and it doesn't include by-reference applicators such as "$ref" or "$dynamicRef" as non-terminal path components. Eg:
```
https://example.com/schemas/common#/$defs/count/minimum
```
SchemaResourceBaseUri: The absolute base URI of referenced json schema resource when validation failed. Eg:
```
https://example.com/schemas/common
```

性能建議

盡可能的重用已實例化的JsonValidator實例（JsonValidator可以簡單理解為代表一個json schema驗證文檔）來驗證json數據，以便獲得更高性能

外部json schema依賴的支持

除了自動支持當前schema文檔內的引用關系，還支持外部json schema依賴：

本地schema依賴文本

var jsonValidator = new JsonValidator(jsonSchema);
string externalJsonSchema = File.ReadAllText("schema2.json");
jsonValidator.AddExternalDocument(externalJsonSchema);
ValidationResult validationResult = jsonValidator.Validate(instance);

遠程schema url (實現庫將訪問網絡來獲得遠程的schema)

var jsonValidator = new JsonValidator(jsonSchema);
await jsonValidator.AddHttpDocumentAsync(new Uri("http://this-is-json-schema-document"));
ValidationResult validationResult = jsonValidator.Validate(instance);

自定義keyword的支持

除了json schema specification中的標準keywords之外，還支持用戶創建自定義keyword來實現額外的驗證需求：

{
  "type": "object",
  "properties": {
    "prop1": {
      "customKeyword": "Expected value"
    }
  }
}

ValidationKeywordRegistry.AddKeyword<CustomKeyword>();

[Keyword("customKeyword")] // It is your custom keyword name
[JsonConverter(typeof(CustomKeywordJsonConverter))] // Use 'CustomKeywordJsonConverter' to deserialize to 'CustomKeyword' instance out from json schema text
internal class CustomKeyword : KeywordBase
{
    private readonly string _customValue; // Simple example value

    public CustomKeyword(string customValue)
    {
        _customValue = customValue;
    }

    // Do your custom validation work here
    protected override ValidationResult ValidateCore(JsonInstanceElement instance, JsonSchemaOptions options)
    {
        if (instance.ValueKind != JsonValueKind.String)
        {
            return ValidationResult.ValidResult;
        }

        return instance.GetString() == _customValue
            ? ValidationResult.ValidResult
            : ValidationResult.CreateFailedResult(ResultCode.UnexpectedValue, "It is not my expected value.", options.ValidationPathStack, Name, instance.Location);
    }
}

internal class CustomKeywordJsonConverter : JsonConverter<CustomKeyword>
{
    // Library will input json value of your custom keyword: "customKeyword" to this method.
    public override CustomKeyword? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        // Briefly: 
        return new CustomKeyword(reader.GetString()!);
    }

    public override void Write(Utf8JsonWriter writer, CustomKeyword value, JsonSerializerOptions options)
    {
        throw new NotImplementedException();
    }
}

Format支持

目前實現庫支持如下format:

uri
uri-reference
date
time
date-time
email
uuid
hostname
ipv4
ipv6
json-pointer
regex

Format 驗證需要顯式enable, 當驗證數據時，請傳入配置好的 JsonSchemaOptions:

jsonValidator.Validate(instance, new JsonSchemaOptions{ValidateFormat = true});

如果需要自定義format驗證，可以實現一個FormatValidator子類并注冊：

[Format("custom_format")] // this is your custom format name in json schema
public class TestCustomFormatValidator : FormatValidator
{
    public override bool Validate(string content)
    {
        // custom format validation logic here...
    }
}

// register it globally
FormatRegistry.AddFormatType<TestCustomFormatValidator>();

Other extension usage doc is to be continued .

限制

目前類庫關注于驗證，暫不支持annotation
因為暫不支持annotation, 所以不支持如下keywords: unevaluatedProperties, unevaluatedItems
目前不支持 content-encoded string

問題報告

歡迎把使用過程中遇到的問題和希望增加的功能發到github repo issue中

More doc is to be written

總結

以上是生活随笔為你收集整理的Json Schema简介和Json Schema的.net实现库 LateApexEarlySpeed.Json.Schema的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：毕业论文查重可以抄书吗
下一篇： NetSuite 开发日记 —— 库存详