logo

TechCodeview

Convalidatore JSON Java

In Java, JSON, ovvero JavaScript Object Notation, svolge un ruolo molto importante nella manipolazione della risposta lato server. In Java, possiamo convalidare i documenti JSON rispetto a uno schema JSON. Per eseguire la convalida, utilizziamo il file Convalidatore dello schema JSON networknt biblioteca.

Il motivo per utilizzare questa libreria è che utilizza Jackson come libreria JSON e supporta l'ultima versione dello schema JSON. La libreria networknt è a Giava implementazione delle specifiche JSON Schema Core Draft v4, v6, v7 e v2019-09 (che utilizziamo nel nostro esempio) per la convalida dello schema JSON. Ha Jackson come parser JSON predefinito.

Innanzitutto, prendiamo un esempio di documento JSON e schema JSON, che utilizziamo nel nostro programma per eseguire la convalida.

Documento JSON 

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

Schema 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'] } } }

Aggiungiamo la seguente dipendenza nel nostro file pom.xml.

 com.networknt json-schema-validator 1.0.42

Possiamo anche usare il org.everit.json libreria per la convalida dell'oggetto JSON. Per usarlo, dobbiamo aggiungere la seguente dipendenza nel nostro file pom.xml:

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

Nel nostro caso, utilizziamo il file networknt biblioteca di Giava.

Utilizziamo i seguenti passaggi per convalidare il documento JSON:

  1. Crea un nuovo progetto esperto.
  2. Aggiungi la dipendenza del validatore dello schema JSON nel nostro file pom.xml.
  3. Leggere i dati e lo schema dal documento JSON utilizzando ObjectMapper.
  4. Utilizzare il metodo validate() di JsonSchemaFactory per convalidare il documento JSON.
  5. Memorizza il risultato restituito nel set di validazione e stampalo sullo schermo.

Ora è tutto configurato, quindi possiamo implementare il codice effettivo di convalida del documento 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())); } } } }

Descrizione

Nel codice precedente usiamo il file VersionFlag . Per ottenere il JsonSchemaFactory , è necessario passare il flag di versione nel costruttore. Nel nostro caso, usiamo il 2019-09 versione dello schema JSON.

Utilizziamo anche un metodo di supporto personalizzato, ovvero inputStreamFromClasspath(), per caricare entrambi i file dal classpath. Creiamo un'istanza della classe Jackson ObjectMapper per leggere i dati JSON da InputStream. Successivamente, analizziamo i dati InputStream in un oggetto JsonNode. Utilizzando l'istanza di JsonSchemaFactory, otteniamo l'oggetto JsonSchema per convalidare il JsonNode. Creiamo una serie di errori di convalida che contiene uno o più oggetti ValidationMessage. Il set di convalida sarà vuoto quando non sono presenti errori di convalida.

Produzione

Convalidatore JSON Java