JSON开发笔记(二)—— JSON Schema实战(上)

1. JSON Schema简介

我们知道,JSON和XML相比,在很多方面具有更多的优势。未来,JSON在各方面取代XML,很有可能就是历史大势所趋。了解XML的都知道,XML Schema是以XML语言为基础,用于描述XML文档的结构以及校验XML文档内容,也就是我们常常见到的XSD(XML Schema Definition)文件。

和XML Schema类似,JSON Schema是基于JSON格式,用于定义JSON数据结构以及校验JSON数据内容。JSON Schema官网地址:http://json-schema.org/

2. 从一个简单例子开始

假如存在一份JSON数据,具体内容如下:

{"id":520,"name":"hello first blog","price":25.5}

其中,id表示图书的ID,name表示图书的书名,price表示图书的售价。如果你是图书馆的管理员,雇了很多兼职人员帮你手动录入图书馆内所有的图书信息。格式和上面的JSON保持一致,并且为了避免兼职人员失误录入脏数据,你做了如下额外要求:

id从1开始,且只能为整数

name的长度应该大于0,但是小于等于50

price必须大于0,可以为整数,也可以为小数

每本图书三个属性(id、name、price)必须都有值

试想,如果图书馆有几千本甚至上万本图书,每个兼职人员都把自己录入的信息汇总给你,你做最后的把关和审核,这个工作量是非常巨大的,而且很容易出现失误。所以,我们采用另一种自动化的方案,即通过JSON Schema来校验录入的JSON数据的合法性。

如果将上面所有的要求都写入JSON Schema文件,其内容如下:

{"$schema":"http://json-schema.org/draft-04/schema#","title":"BookInfo","description":"some information about book","type":"object","properties": {"id": {"description":"The unique identifier for a book","type":"integer","minimum":1},"name": {"description":"Name of the book","type":"string","maxLength":50,"minLength":1},"price": {"type":"number","minimum":0,"exclusiveMinimum":true}    },"required": ["id","name","price"]}

我们可以看到,JSON Schema实际上就是一个JSON文件,只不过其表示的信息内容是对另一个JSON文件结构和内容的约束。

3. JSON Schema关键字

要想完全理解上文中的JSON Schema文件内容,我们首先需要了解JSON Schema中关键字的含义和作用。JSON Schema中比较常见的关键字如下:

关键字描述

$schema表示该JSON Schema文件遵循的规范

title为该JSON Schema文件提供一个标题

description关于该JSON Schema文件的描述信息

type表示待校验元素的类型(例如,最外层的type表示待校验的是一个JSON对象,内层type分别表示待校验的元素类型为,整数,字符串,数字)

properties定义待校验的JSON对象中,各个key-value对中value的限制条件

required定义待校验的JSON对象中,必须存在的key

minimum用于约束取值范围,表示取值范围应该大于或等于minimum

exclusiveMinimum如果minimum和exclusiveMinimum同时存在,且exclusiveMinimum的值为true,则表示取值范围只能大于minimum

maximum用于约束取值范围,表示取值范围应该小于或等于maximum

exclusiveMaximum如果maximum和exclusiveMaximum同时存在,且exclusiveMaximum的值为true,则表示取值范围只能小于maximum

multipleOf用于约束取值,表示取值必须能够被multipleOf所指定的值整除

maxLength字符串类型数据的最大长度

minLength字符串类型数据的最小长度

pattern使用正则表达式约束字符串类型数据

其中,type的常见取值如下:

type取值对应的Java数据类型

arrayjava.util.List

booleanjava.lang.Boolean

integerint(java.lang.Integer)

numberfloat(java.lang.Float)或int

nullnull

objectjava.lang.Object

stringjava.lang.String

如果你熟悉了上面这些关键字的含义,那么读懂JSON Schema的内容也就不再那么困难了,甚至可以尝试动手写一些JSON Schema文件了。

4. JSON Schema在线工具

JSON Schema的在线辅助工具有很多,推荐以下几个:

根据JSON和对应的JSON Schema校验数据的正确性:http://json-schema-validator.herokuapp.com/

根据JSON数据,生成对应的JSON Schema数据:https://jsonschema.net/#/editor

根据JSON数据,生成对应的JSON Schema数据:http://schemaguru.snowplowanalytics.com/#

作者:秋梦尘

链接:https://www.jianshu.com/p/2b7a2b1d0c49

來源:

著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

你可能感兴趣的:(JSON开发笔记(二)—— JSON Schema实战(上))