logo

TechCodeview

Walidator JSON w Javie

W Javie JSON, czyli JavaScript Object Notation, odgrywa bardzo ważną rolę w manipulowaniu odpowiedzią po stronie serwera. W Javie możemy weryfikować dokumenty JSON względem schematu JSON. Aby przeprowadzić walidację, używamy networknt Walidator schematu JSON biblioteka.

Powodem użycia tej biblioteki jest to, że używa ona Jacksona jako biblioteki JSON i obsługuje najnowszą wersję schematu JSON. Biblioteka networknt to a Jawa implementacja specyfikacji JSON Schema Core Draft v4, v6, v7 i v2019-09 (której używamy w naszym przykładzie) do sprawdzania poprawności schematu JSON. Ma Jacksona jako domyślny parser JSON.

Najpierw bierzemy przykład dokumentu JSON i schematu JSON, którego używamy w naszym programie do przeprowadzania walidacji.

Dokument JSON 

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

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

Dodajemy następującą zależność w naszym pliku pom.xml.

 com.networknt json-schema-validator 1.0.42

Możemy także skorzystać z org.everit.json biblioteka do sprawdzania poprawności obiektu JSON. Aby z niego skorzystać musimy dodać w naszym pliku pom.xml następującą zależność:

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

W naszym przypadku korzystamy z sieć biblioteka Java.

Aby zweryfikować dokument JSON, wykonujemy następujące kroki:

  1. Utwórz nowy projekt maven.
  2. Dodaj zależność modułu sprawdzania poprawności schematu JSON w naszym pliku pom.xml.
  3. Przeczytaj dane i schemat z dokumentu JSON za pomocą ObjectMapper.
  4. Użyj metody valid() JsonSchemaFactory, aby sprawdzić poprawność dokumentu JSON.
  5. Zapisz zwrócony wynik w zestawie walidacyjnym i wydrukuj go na ekranie.

Wszystko jest już skonfigurowane, więc możemy zaimplementować faktyczny kod sprawdzający poprawność 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())); } } } }

Opis

W powyższym kodzie używamy Flaga wersji . Aby uzyskać Fabryka JsonSchema , wymagane jest przekazanie flagi tej wersji do konstruktora. W naszym przypadku używamy 2019-09 wersja schematu JSON.

Używamy również niestandardowej metody pomocniczej, tj. inputStreamFromClasspath(), aby załadować oba pliki ze ścieżki klas. Tworzymy instancję klasy Jackson ObjectMapper w celu odczytania danych JSON ze strumienia wejściowego. Następnie analizujemy dane InputStream w obiekcie JsonNode. Korzystając z instancji JsonSchemaFactory, uzyskujemy obiekt JsonSchema w celu sprawdzenia poprawności JsonNode. Tworzymy zestaw błędów walidacyjnych, który zawiera jeden lub więcej obiektów ValidationMessage. Zestaw walidacyjny będzie pusty, jeśli nie wystąpi błąd sprawdzania poprawności.

Wyjście

Walidator JSON w Javie