logo

TechCodeview

JSON Validator Java

A Java-ban a JSON, azaz a JavaScript Object Notation nagyon fontos szerepet játszik a szerveroldali válaszok manipulálásában. Java-ban a JSON-dokumentumokat egy JSON-séma alapján ellenőrizhetjük. Az érvényesítés elvégzéséhez a networknt JSON séma érvényesítő könyvtár.

A könyvtár használatának oka az, hogy a Jacksont használja JSON-könyvtárként, és támogatja a legújabb JSON-séma verziót. A networknt könyvtár a Jáva a JSON Schema Core Draft v4, v6, v7 és v2019-09 (amelyet a példánkban használunk) specifikáció megvalósítása a JSON-séma érvényesítéséhez. A Jackson alapértelmezett JSON-elemző.

Először is veszünk egy példát a JSON-dokumentumra és a JSON-sémára, amelyeket programunkban használunk az érvényesítés végrehajtására.

JSON-dokumentum 

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

JSON-séma 

 { '$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'] } } }

A következő függőséget adjuk hozzá a pom.xml fájlunkhoz.

 com.networknt json-schema-validator 1.0.42

Használhatjuk azt is org.everit.json könyvtár a JSON objektum érvényesítéséhez. Használatához a következő függőséget kell hozzáadnunk a pom.xml fájlunkhoz:

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

Esetünkben a networknt Java könyvtár.

A következő lépéseket alkalmazzuk a JSON-dokumentum érvényesítéséhez:

  1. Hozzon létre egy új maven projektet.
  2. Adja hozzá a JSON-sémaérvényesítő függőségét a pom.xml fájlunkhoz.
  3. Olvassa be az adatokat és a sémát a JSON-dokumentumból az ObjectMapper segítségével.
  4. A JSON-dokumentum érvényesítéséhez használja a JsonSchemaFactory validte() metódusát.
  5. A visszaadott eredményt tárolja az érvényesítési készletben, nyomtassa ki a képernyőre.

Most már minden be van állítva, így megvalósíthatjuk a JSON-dokumentum érvényesítésének tényleges kódját.

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())); } } } }

Leírás

A fenti kódban a VersionFlag . Megszerzéséhez a JsonSchemaFactory , át kell adni a verziójelzőt a konstruktorban. A mi esetünkben használjuk a 2019-09 JSON-séma verziója.

Használunk egy egyéni helper metódust is, azaz az inputStreamFromClasspath(), hogy mindkét fájlt betöltsük az osztályútvonalról. Létrehozzuk a Jackson ObjectMapper osztály példányát a JSON-adatok beolvasásához az InputStreamből. Ezt követően az InputStream adatokat egy JsonNode objektumba elemezzük. A JsonSchemaFactory példány használatával megkapjuk a JsonSchema objektumot a JsonNode érvényesítéséhez. Létrehozzuk az érvényesítési hibák készletét, amely egy vagy több ValidationMessage objektumot tartalmaz. Az érvényesítési készlet üres lesz, ha nincs érvényesítési hiba.

Kimenet

JSON Validator Java