Json.Net使用JSON Schema验证JSON格式

Json.NET supports the JSON Schema standard via the JsonSchema and JsonValidatingReader classes. It sits under the Newtonsoft.Json.Schema namespace.

Json.NET通过JsonSchemaJsonValidatingReader类,支持JSON Schema标准。这两个类位于Newtonsoft.Json.Schema命名空间。

JSON Schema is used to validate the structure and data types of a piece of JSON, similar to XML Schema for XML. Read more about JSON Schema at json-schema.org

JSON Schema用来验证Json的结构以及数据类型,类似于XML的XML Schema。关于更多JSON Schema的信息可以参见json-schema.org

Validating with JSON Schema  使用JSON Schema验证

The simplest way to check if JSON is valid is to load the JSON into a JObject or JArray and then use the IsValid(JToken, JsonSchema) method with the JSON Schema.

测试Json是否合符规定的最简便方法就是加载这个Json字符串到JObject或者Jarray,然后与JSON Schema一起调用IsValid(JToken, JsonSchema)

string schemaJson = @"{ ‘description‘: ‘A person‘, ‘type‘: ‘object‘,‘properties‘: { ‘name‘: {‘type‘:‘string‘}, ‘hobbies‘: {‘type‘: ‘array‘,  ‘items‘: {‘type‘:‘string‘}  } }}";

JsonSchema schema = JsonSchema.Parse(schemaJson);

JObject person = JObject.Parse(@"{  ‘name‘: ‘James‘, ‘hobbies‘: [‘.NET‘, ‘Blogging‘, ‘Reading‘, ‘Xbox‘, ‘LOLCATS‘]}");

bool valid = person.IsValid(schema);
// true

To get validation error messages use the IsValid(JToken, JsonSchema, IList<String>) or Validate(JToken, JsonSchema, ValidationEventHandler) overloads.

要得到验证错误的消息可以用IsValid(JToken, JsonSchema, IList<String>)Validate(JToken, JsonSchema, ValidationEventHandler)重载。

JsonSchema schema = JsonSchema.Parse(schemaJson);

JObject person = JObject.Parse(@"{ ‘name‘: null, ‘hobbies‘: [‘Invalid content‘, 0.123456789]}");

IList<string> messages;

bool valid = person.IsValid(schema, out messages);
// false
// Invalid type. Expected String but got Null. Line 2, position 21.
// Invalid type. Expected String but got Float. Line 3, position 51.

Internally IsValid uses JsonValidatingReader to perform the JSON Schema validation. To skip the overhead of loading JSON into a JObject/JArray, validating the JSON and then deserializing the JSON into a class, JsonValidatingReader can be used with JsonSerializer to validate JSON while the object is being deserialized.

跳过加载Json字符串到JObject/JArray的开销,验证Json然后将其反序列化为一个类,JsonValidatingReader可以与JsonSerializer在一个对象在反序列的时候验证Json。

string json = @"{  ‘name‘: ‘James‘, ‘hobbies‘: [‘.NET‘, ‘Blogging‘, ‘Reading‘, ‘Xbox‘, ‘LOLCATS‘]}";

JsonTextReader reader = new JsonTextReader(new StringReader(json));

JsonValidatingReader validatingReader = new JsonValidatingReader(reader);
validatingReader.Schema = JsonSchema.Parse(schemaJson);

IList<string> messages = new List<string>();
validatingReader.ValidationEventHandler += (o, a) => messages.Add(a.Message);

JsonSerializer serializer = new JsonSerializer();
Person p = serializer.Deserialize<Person>(validatingReader);

Creating JSON Schemas  生成JSON Schemas

The simplest way to get a JsonSchema object is to load it from a string or a file.

得到一个JsonSchema对象的最简易方法就是从字符串或者文件里加载。

// load from a string
JsonSchema schema1 = JsonSchema.Parse(@"{‘type‘:‘object‘}");

// load from a file
using (TextReader reader = File.OpenText(@"c:\schema\Person.json"))
{
    JsonSchema schema2 = JsonSchema.Read(new JsonTextReader(reader));

    // do stuff
}

It is also possible to create JsonSchema objects in code.

也可以从代码里创建JsonSchema对象。

JsonSchema schema = new JsonSchema();
schema.Type = JsonSchemaType.Object;
schema.Properties = new Dictionary<string, JsonSchema>
{
    { "name", new JsonSchema { Type = JsonSchemaType.String }         },
    {
         "hobbies", new JsonSchema
        {
            Type = JsonSchemaType.Array,
            Items = new List<JsonSchema> { new JsonSchema { Type = JsonSchemaType.String } }
        }
    },
};

JObject person = JObject.Parse(@"{‘name‘: ‘James‘,‘hobbies‘: [‘.NET‘, ‘Blogging‘, ‘Reading‘, ‘Xbox‘, ‘LOLCATS‘]}");

bool valid = person.IsValid(schema);
// true        

原文链接:http://james.newtonking.com/json/help/index.html

更多信息:http://json-schema.org/

时间: 2024-10-29 19:06:54

Json.Net使用JSON Schema验证JSON格式的相关文章

Json.Net使用JSON Schema验证JSON格式【实例】

给出一个Json,验证其格式是否符合规则. { "coord": { //对象 "lon": 145.77, "lat": -16.92 }, "sys": { //对象 "type": 1, "id": 8166, "message": 0.0402, "country": "AU", "sunrise":

.Net使用JsonSchema验证Json

最近项目中遇到了这样的需求,需要对上传的Json进行验证,以确保Json数据的准确性.前后使用了两种方式来验证: (1)第一种方式的实现思想:根据Json数据的格式,严格定义相应的类结构,并在System.Runtime.Serialization命名空间下的DataContractAttribute.DataMemberAttribute对class和property进行标注,如果property是必须提供的,则在Property上添加[DataMember(IsRequired = true

Ajax datatype:&#39;JSON&#39;的error问题Status1:200,JSON格式

转自:http://blog.sina.com.cn/s/blog_6e001be701017rux.html <script src="../js/jquery-1.8.0-vsdoc.js" type="text/javascript"></script> JSON格式有误,jquery 1.4以后的json格式变严格了,需注意: 必须要这种格式 {"键":"值","键":&qu

Android Json解析简单高效之org.json,取值如囊中取物

我们通常在Android上采用Gson来解析Json数据,很方便的就可以把数据转换成List或者map.当碰到日期时间的时候,你可能会遇到坑,需要格式化一下日期时间格式. 本文介绍org.json这种不需要导入任何包的解析方式,不管Json多少层,如探囊取物. 1.解析{"":""} 格式的 JSONObject 如何确认是这种格式,我们都不需要看,打开 http://json.cn (Json在线解析及格式化验证网站),把Json数据直接粘贴到左边,如果是正确的J

使用Json.Net解决MVC中各种json操作

最近收集了几篇文章,用于替换MVC中各种json操作,微软mvc当然用自家的序列化,速度慢不说,还容易出问题,自定义性也太差,比如得特意解决循环引用的问题,比如datetime的序列化格式,比如性能.NewtonSoft.json也就是Json.Net性能虽然不是最好的,但是是比较靠前的,其功能是最强大的,包含各种json操作模式.现在来看看mvc中的替换1, Controller.Json方法这个方法最容易出现循环引用,比如EF查出一个一对多集合想序列化,结果a引用了子表b,b中还引用了a,导

json与jsonp区别浅析(json才是目的,jsonp只是手段) (转)

一言以蔽之,json返回的是一串数据:而jsonp返回的是脚本代码(包含一个函数调用): JSON其实就是JavaScript中的一个对象,跟var obj={}在质上完全一样,只是在量上可以无限扩展.简单地讲,json其实就是JavaScript中的对象(Object)和数组(Array,其实也是对象)这倆好基友在那儿你嵌我我嵌你地套上n多层,以此模拟出许多复杂的数据结构. json易于人阅读和编写,也易于机器解析和生成,相对网络传输速率较高,功能型网站前后端往往要频繁大量交换数据,而json

JSON对象和字符串之间的相互转换JSON.stringify(obj)和JSON.parse(string)

在Firefox,chrome,opera,safari,ie9,ie8等高级浏览器直接可以用JSON对象的stringify()和parse()方法. JSON.stringify(obj)将JSON转为字符串.JSON.parse(string)将字符串转为JSON格式: var a={"name":"tom","sex":"男","age":"24"}; var aToStr =

JSon SuperObject 研究2:数据集与JSON对象互转

JSon SuperObject 研究2:数据集与JSON对象互转 JSON不能完全替代XML,但绝对是未来的大势所趋,其优点是简单.体积小.解析更快.解析占用资源更少.在delphi中,数据集是最常用数据存取方式.因此,必须建立JSON与TDataSet之间的互转关系,实现数据之间通讯与转换.值得注意的是,这只是普通的TDataset与JSON之间转换,由于CDS包含了Delta数据包,其数据格式远比普通的TDataset更复杂.下面的程序,或许你有不同的想法,如果你的想法更好更快,欢迎一起讨

JSON入门之二:org.json的基本使用方法

java中用于解释json的主流工具有org.json.json-lib与gson.本文介绍org.json的应用. 官方文档: http://www.json.org/java/ http://developer.android.com/reference/org/json/package-summary.html 1.主要类 Classes JSONArray A dense indexed sequence of values. JSONObject A modifiable set of