I Java spiller JSON, det vil si JavaScript Object Notation, en veldig viktig rolle i å manipulere respons på serversiden. I Java kan vi validere JSON-dokumenter mot et JSON-skjema. For å utføre valideringen bruker vi networknt JSON Schema validator bibliotek.

Grunnen til å bruke dette biblioteket er at det bruker Jackson som et JSON-bibliotek og støtter den nyeste JSON Schema-versjonen. Nettverksbiblioteket er en Java implementering av JSON Schema Core Draft v4, v6, v7 og v2019-09 (som vi bruker i vårt eksempel) spesifikasjonen for JSON-skjemavalidering. Den har Jackson som standard JSON-parser.

Først tar vi et eksempel på JSON-dokument og JSON-skjema, som vi bruker i programmet vårt for å utføre validering.

JSON-dokument

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

JSON-skjema

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

Vi legger til følgende avhengighet i vår pom.xml-fil.

 com.networknt json-schema-validator 1.0.42 

Vi kan også bruke org.everit.json bibliotek for å validere JSON-objektet. For å bruke den må vi legge til følgende avhengighet i pom.xml-filen vår:

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

I vårt tilfelle bruker vi nettverknt biblioteket i Java.

Vi bruker følgende trinn for å validere JSON-dokumentet:

1. Lag et nytt maven-prosjekt.
2. Legg til JSON-skjemavalidatoravhengigheten i vår pom.xml-fil.
3. Les dataene og skjemaet fra JSON-dokumentet ved hjelp av ObjectMapper.
4. Bruk validate()-metoden til JsonSchemaFactory for å validere JSON-dokumentet.
5. Lagre det returnerte resultatet i valideringssettet, skriv det ut på skjermen.

Alt er satt opp nå, slik at vi kan implementere selve koden for å validere JSON-dokumentet.

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

Beskrivelse

I koden ovenfor bruker vi Versjonsflagg . For å få tak i JsonSchemaFactory , er det nødvendig å sende det versjonsflagget i konstruktøren. I vårt tilfelle bruker vi 2019-09 versjon av JSON Schema.

Vi bruker også en tilpasset hjelpemetode, dvs. inputStreamFromClasspath(), for å laste begge filene fra klassebanen. Vi oppretter en forekomst av Jackson ObjectMapper-klassen for å lese JSON-dataene fra InputStream. Etter det analyserer vi de InputStream-dataene til et JsonNode-objekt. Ved å bruke forekomsten av JsonSchemaFactory får vi JsonSchema-objektet for å validere JsonNode. Vi lager et sett med valideringsfeil som inneholder ett eller flere ValidationMessage-objekter. Valideringssettet vil være tomt når det ikke er noen valideringsfeil.

Produksjon