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

來源:简书

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容