I Java spelar JSON, det vill säga JavaScript Object Notation, en mycket viktig roll för att manipulera svar på serversidan. I Java kan vi validera JSON-dokument mot ett JSON-schema. För att utföra valideringen använder vi networknt JSON Schema validator bibliotek.

Anledningen till att det här biblioteket används är att det använder Jackson som ett JSON-bibliotek och stöder den senaste JSON Schema-versionen. Nätverksbiblioteket är en Java implementering av JSON Schema Core Draft v4, v6, v7 och v2019-09 (som vi använder i vårt exempel) specifikation för JSON-schemavalidering. Den har Jackson som standard JSON-parser.

Först tar vi ett exempel på JSON-dokument och JSON-schema, som vi använder i vårt program för att utföra validering.

JSON-dokument

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

JSON-schema

 { '$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 lägger till följande beroende i vår pom.xml-fil.

 com.networknt json-schema-validator 1.0.42 

Vi kan också använda org.everit.json bibliotek för att validera JSON-objektet. För att använda den måste vi lägga till följande beroende i vår pom.xml-fil:

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

I vårt fall använder vi nätverk Javas bibliotek.

Vi använder följande steg för att validera JSON-dokumentet:

1. Skapa ett nytt maven-projekt.
2. Lägg till JSON-schemavalideringsberoendet i vår pom.xml-fil.
3. Läs data och schemat från JSON-dokumentet med ObjectMapper.
4. Använd metoden validate() för JsonSchemaFactory för att validera JSON-dokumentet.
5. Lagra det returnerade resultatet i valideringssetet, skriv ut det på skärmen.

Allt är inställt nu, så vi kan implementera själva koden för att validera 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())); } } } } 

Beskrivning

I ovanstående kod använder vi VersionFlagga . För att få JsonSchemaFactory , krävs det att den versionsflaggan skickas i konstruktorn. I vårt fall använder vi 2019-09 version av JSON Schema.

Vi använder också en anpassad hjälpmetod, det vill säga inputStreamFromClasspath(), för att ladda båda filerna från klasssökvägen. Vi skapar en instans av Jackson ObjectMapper-klassen för att läsa JSON-data från InputStream. Efter det analyserar vi den InputStream-datan till ett JsonNode-objekt. Genom att använda instansen av JsonSchemaFactory får vi JsonSchema-objektet för att validera JsonNode. Vi skapar en uppsättning valideringsfel som innehåller ett eller flera ValidationMessage-objekt. Valideringsuppsättningen kommer att vara tom när det inte finns något valideringsfel.

Produktion