logo

TechCodeview

JSON Validator Java

V Javě hraje JSON, tj. JavaScript Object Notation, velmi důležitou roli při manipulaci s odezvou na straně serveru. V Javě můžeme ověřovat dokumenty JSON proti schématu JSON. K provedení ověření používáme networknt JSON Schema validator knihovna.

Důvodem použití této knihovny je, že používá Jackson jako knihovnu JSON a podporuje nejnovější verzi schématu JSON. Knihovna networknt je a Jáva implementace specifikace JSON Schema Core Draft v4, v6, v7 a v2019-09 (kterou používáme v našem příkladu) pro ověření schématu JSON. Má Jackson jako výchozí analyzátor JSON.

Nejprve si vezmeme příklad dokumentu JSON a schématu JSON, které používáme v našem programu k provedení ověření.

Dokument JSON 

 { 'name': 'Emma Watson', 'artist': 'Paul Walker', 'description': null, 'tags': ['oil', 'famous'] }

schéma JSON 

 { '$schema': 'https://json-schema.org/draft/2019-09/schema#', '$id+': 'http://my-paintings-api.com/schemas/painting-schema.json', 'type': 'object', 'title': 'Painting', 'description': 'Painting information', 'additionalProperties': true, 'required': ['name', 'artist', 'description', 'tags'], 'properties': { 'name': { 'type': 'string', 'description': 'Painting name' }, 'artist': { 'type': 'string', 'maxLength': 50, 'description': 'Name of the artist' }, 'description': { 'type': ['string', 'null'], 'description': 'Painting description' }, 'tags': { 'type': 'array', 'items': { '$ref': '#/$defs/tag' } } }, '$defs': { 'tag': { 'type': 'string', 'enum': ['oil', 'watercolor', 'digital', 'famous'] } } }

Do našeho souboru pom.xml přidáme následující závislost.

 com.networknt json-schema-validator 1.0.42

Můžeme také použít org.everit.json knihovna pro ověření objektu JSON. Abychom jej mohli použít, musíme do našeho souboru pom.xml přidat následující závislost:

 org.everit.json org.everit.json.schema 1.11.1

V našem případě používáme networknt knihovna Java.

K ověření dokumentu JSON používáme následující kroky:

  1. Vytvořte nový maven projekt.
  2. Přidejte závislost validátoru schématu JSON do našeho souboru pom.xml.
  3. Přečtěte si data a schéma z dokumentu JSON pomocí ObjectMapper.
  4. Použijte metodu validate() JsonSchemaFactory k ověření dokumentu JSON.
  5. Uložte vrácený výsledek do ověřovací sady a vytiskněte jej na obrazovku.

Vše je nyní nastaveno, takže můžeme implementovat skutečný kód ověřování dokumentu JSON.

JsonValidatorExample.java 

 //import required classes and packages package javaTpoint.ObjectToJsonConversion; import java.io.InputStream; import java.util.Set; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import com.networknt.schema.JsonSchema; import com.networknt.schema.JsonSchemaFactory; import com.networknt.schema.SpecVersion; import com.networknt.schema.ValidationMessage; // create class to validate JSON document public class JsonValidatorExample { // create inputStreamFromClasspath() method to load the JSON data from the class path private static InputStream inputStreamFromClasspath( String path ) { // returning stream return Thread.currentThread().getContextClassLoader().getResourceAsStream( path ); } // main() method start public static void main( String[] args ) throws Exception { // create instance of the ObjectMapper class ObjectMapper objectMapper = new ObjectMapper(); // create an instance of the JsonSchemaFactory using version flag JsonSchemaFactory schemaFactory = JsonSchemaFactory.getInstance( SpecVersion.VersionFlag.V201909 ); // store the JSON data in InputStream try( InputStream jsonStream = inputStreamFromClasspath( 'C:\Users\ajeet\eclipse-workspace\data.json' ); InputStream schemaStream = inputStreamFromClasspath( 'C:\Users\ajeet\eclipse-workspace\schema.json' ) ){ // read data from the stream and store it into JsonNode JsonNode json = objectMapper.readTree(jsonStream); // get schema from the schemaStream and store it into JsonSchema JsonSchema schema = schemaFactory.getSchema(schemaStream); // create set of validation message and store result in it Set validationResult = schema.validate( json ); // show the validation errors if (validationResult.isEmpty()) { // show custom message if there is no validation error System.out.println( 'There is no validation errors' ); } else { // show all the validation error validationResult.forEach(vm -> System.out.println(vm.getMessage())); } } } }

Popis

Ve výše uvedeném kódu používáme VersionFlag . Chcete-li získat JsonSchemaFactory , je nutné předat tento příznak verze v konstruktoru. V našem případě používáme 2019-09 verze schématu JSON.

K načtení obou souborů z cesty třídy používáme také vlastní pomocnou metodu, tj. inputStreamFromClasspath(). Vytvoříme instanci třídy Jackson ObjectMapper pro čtení dat JSON z InputStream. Poté tato data InputStream analyzujeme do objektu JsonNode. Pomocí instance JsonSchemaFactory získáme objekt JsonSchema k ověření JsonNode. Vytváříme sadu chyb ověření, která obsahuje jeden nebo více objektů ValidationMessage. Ověřovací sada bude prázdná, pokud nedojde k chybě ověření.

Výstup

JSON Validator Java