溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章主要介紹“java如何校驗json的格式”的相關知識，小編通過實際案例向大家展示操作過程，操作方法簡單快捷，實用性強，希望這篇“java如何校驗json的格式”文章能幫助大家解決問題。
JSON Schema 是用于驗證 JSON 數據結構的強大工具，Schema可以理解為模式或者規則。
Json Schema定義了一套詞匯和規則，這套詞匯和規則用來定義Json元數據，且元數據也是通過Json數據形式表達的。Json元數據定義了Json數據需要滿足的規范，規范包括成員、結構、類型、約束等。
JSON Schema 就是json的格式描述、定義、模板，有了他就可以生成任何符合要求的json數據
在java中，對json數據格式的校驗，使用 json-schema-validator，具體實例如下：
<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 是必須要引入的，他們為 json-schema-validator 必須的
如果我們要校驗的數據格式如下：
{
"data": [
{
"sex": "男",
"name": "王小明",
"age": 18
},
{
"sex": "女",
"name": "王小紅",
"age": 17
}
],
"type": "human"
}外面是type和data，里面是一個數組，數組屬性包括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描述了目標json的數據格式，外層必須字段type、data，里面限制了name的最大長度 maxLength 為3，sex 為枚舉值，只可取 男、女兩個字符串，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 + " 字段缺失");
});
// 如果字段超長
} 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 + " 字段長度過長");
// 如果不在枚舉范圍內
} 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 + "字段值錯誤，" + value + "不在枚舉范圍內");
} 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 + " 類型錯誤，現有類型: " + found + ", 預期類型:" + expected);
}
});
}
} catch (IOException | ProcessingException e) {
log.error("校驗json格式異常", e);
}
return map;
}以上代碼首先獲取了 要校驗的json的標準文件 validator.json，然后調用 JsonSchemaFactory.byDefault().getValidator().validate(jsonNodeSchema, jsonNode, true) 方法對傳進來的json 進行了校驗，這里 true 的意思是深度檢查，如果沒有這個參數，校驗json的時候遇到第一個錯誤，就直接返回了
接下來構建測試方法
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字段值錯誤，未知不在枚舉范圍內, name=王小明1 字段長度過長, age=age 類型錯誤，現有類型: string, 預期類型:["integer","number"]}
如果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"
]
}如果是這樣的話，只會校驗 data 數組的第一條數據，其他的有錯誤也不會報錯！！
關于“java如何校驗json的格式”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識，可以關注億速云行業資訊頻道，小編每天都會為大家更新不同的知識點。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
