您好,登錄后才能下訂單哦!
這篇“java怎么校驗(yàn)json的格式是否符合要求”文章的知識(shí)點(diǎn)大部分人都不太理解,所以小編給大家總結(jié)了以下內(nèi)容,內(nèi)容詳細(xì),步驟清晰,具有一定的借鑒價(jià)值,希望大家閱讀完這篇文章能有所收獲,下面我們一起來看看這篇“java怎么校驗(yàn)json的格式是否符合要求”文章吧。
JSON Schema 是用于驗(yàn)證 JSON 數(shù)據(jù)結(jié)構(gòu)的強(qiáng)大工具,Schema可以理解為模式或者規(guī)則。
Json Schema定義了一套詞匯和規(guī)則,這套詞匯和規(guī)則用來定義Json元數(shù)據(jù),且元數(shù)據(jù)也是通過Json數(shù)據(jù)形式表達(dá)的。Json元數(shù)據(jù)定義了Json數(shù)據(jù)需要滿足的規(guī)范,規(guī)范包括成員、結(jié)構(gòu)、類型、約束等。
JSON Schema 就是json的格式描述、定義、模板,有了他就可以生成任何符合要求的json數(shù)據(jù)
在java中,對(duì)json數(shù)據(jù)格式的校驗(yàn),使用 json-schema-validator
,具體實(shí)例如下:
<dependency> <groupId>com.github.fge</groupId> <artifactId>json-schema-validator</artifactId> <version>2.2.6</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>2.3.0</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>2.3.0</version> </dependency>
jackson-core
和 jackson-core
是必須要引入的,他們?yōu)?json-schema-validator
必須的
如果我們要校驗(yàn)的數(shù)據(jù)格式如下:
{ "data": [ { "sex": "男", "name": "王小明", "age": 18 }, { "sex": "女", "name": "王小紅", "age": 17 } ], "type": "human" }
外面是type和data,里面是一個(gè)數(shù)組,數(shù)組屬性包括sex、name、age
編寫schema文件
{ "type": "object", "properties": { "type": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 3 }, "sex": { "enum": [ "男", "女" ] }, "age": { "type": "number" } }, "required": [ "name", "sex", "age" ] } } }, "required": [ "type", "data" ] }
以上json描述了目標(biāo)json的數(shù)據(jù)格式,外層必須字段type、data,里面限制了name的最大長(zhǎng)度 maxLength
為3,sex 為枚舉值,只可取 男、女兩個(gè)字符串,age 為number類型。
public Map validatorJsonUnchecked(String body) { Map<String, String> map = new HashMap<>(); String filePath = "validator" + File.separator + "validator.json"; ObjectMapper objectMapper = new ObjectMapper(); try { JsonNode jsonNodeSchema = objectMapper.readTree(ResourceUtil.readUtf8Str(filePath)); JsonNode jsonNode = objectMapper.readTree(body); ProcessingReport processingReport = JsonSchemaFactory.byDefault().getValidator().validate(jsonNodeSchema, jsonNode, true); if (!processingReport.isSuccess()) { processingReport.forEach(processingMessage -> { JsonNode missing = processingMessage.asJson().get("missing"); String keyword = processingMessage.asJson().get("keyword").asText(); // 如果缺失字段 if (!Objects.isNull(missing)) { missing.forEach(miss -> { String text = miss.asText(); map.put(text, text + " 字段缺失"); }); // 如果字段超長(zhǎng) } else if ("maxLength".equals(keyword)) { String field = processingMessage.asJson().get("instance").get("pointer").asText(); String value = processingMessage.asJson().get("value").asText(); field = field.substring(field.lastIndexOf("/") + 1); map.put(field, value + " 字段長(zhǎng)度過長(zhǎng)"); // 如果不在枚舉范圍內(nèi) } else if ("enum".equals(keyword)) { String field = processingMessage.asJson().get("instance").get("pointer").asText(); String value = processingMessage.asJson().get("value").asText(); field = field.substring(field.lastIndexOf("/") + 1); map.put(field, field + "字段值錯(cuò)誤," + value + "不在枚舉范圍內(nèi)"); } else if ("type".equals(keyword)) { String field = processingMessage.asJson().get("instance").get("pointer").asText(); String found = processingMessage.asJson().get("found").asText(); String expected = processingMessage.asJson().get("expected").toString(); field = field.substring(field.lastIndexOf("/") + 1); map.put(field, field + " 類型錯(cuò)誤,現(xiàn)有類型: " + found + ", 預(yù)期類型:" + expected); } }); } } catch (IOException | ProcessingException e) { log.error("校驗(yàn)json格式異常", e); } return map; }
以上代碼首先獲取了 要校驗(yàn)的json的標(biāo)準(zhǔn)文件 validator.json
,然后調(diào)用 JsonSchemaFactory.byDefault().getValidator().validate(jsonNodeSchema, jsonNode, true)
方法對(duì)傳進(jìn)來的json 進(jìn)行了校驗(yàn),這里 true
的意思是深度檢查,如果沒有這個(gè)參數(shù),校驗(yàn)json的時(shí)候遇到第一個(gè)錯(cuò)誤,就直接返回了
接下來構(gòu)建測(cè)試方法
public static void main(String[] args) { ValidatorService validatorService = new ValidatorServiceImpl(); Map<String, Object> body = new HashMap<>(); HashMap<String, Object> one = new HashMap<String, Object>() {{ put("name", "王小明"); put("sex", "男"); put("age", 18); }}; HashMap<String, Object> two = new HashMap<String, Object>() {{ put("name", "王小明1"); put("sex", "未知"); put("age", "18"); }}; body.put("type", "human"); body.put("data", Arrays.asList(one,two)); Map map = validatorService.validatorJsonUnchecked(JSONUtil.toJsonStr(body)); System.out.println(map); }
{sex=sex字段值錯(cuò)誤,未知不在枚舉范圍內(nèi), name=王小明1 字段長(zhǎng)度過長(zhǎng), age=age 類型錯(cuò)誤,現(xiàn)有類型: string, 預(yù)期類型:["integer","number"]}
如果schema 編寫的時(shí)候,對(duì)列表使用了中括號(hào) []
,那么當(dāng)校驗(yàn)的時(shí)候只會(huì)校驗(yàn)數(shù)組中的第一個(gè),這是一個(gè)坑,如下
{ "type": "object", "properties": { "type": { "type": "string" }, "data": { "type": "array", "items": [ { "type": "object", "properties": { "name": { "type": "string", "maxLength": 3 }, "sex": { "enum": [ "男", "女" ] }, "age": { "type": "number" } }, "required": [ "name", "sex", "age" ] } ] } }, "required": [ "type", "data" ] }
如果是這樣的話,只會(huì)校驗(yàn) data 數(shù)組的第一條數(shù)據(jù),其他的有錯(cuò)誤也不會(huì)報(bào)錯(cuò)?。?/strong>
以上就是關(guān)于“java怎么校驗(yàn)json的格式是否符合要求”這篇文章的內(nèi)容,相信大家都有了一定的了解,希望小編分享的內(nèi)容對(duì)大家有幫助,若想了解更多相關(guān)的知識(shí)內(nèi)容,請(qǐng)關(guān)注億速云行業(yè)資訊頻道。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。