logo

TechCodeview

JSON Validator Java

Javassa JSONilla eli JavaScript Object Notationilla on erittäin tärkeä rooli palvelinpuolen vastausten manipuloinnissa. Javassa voimme vahvistaa JSON-asiakirjoja JSON-skeemaa vastaan. Validoinnin suorittamiseksi käytämme networknt JSON Schema validaattori kirjasto.

Syy tämän kirjaston käyttöön on, että se käyttää Jacksonia JSON-kirjastona ja tukee uusinta JSON Schema -versiota. Verkkokirjasto on a Java JSON Schema Core Draft v4, v6, v7 ja v2019-09 (jota käytämme esimerkissämme) määrityksen toteuttaminen JSON-skeeman validointia varten. Siinä on Jackson oletusarvoisena JSON-jäsentimenä.

Ensin otamme esimerkin JSON-asiakirjasta ja JSON-skeemasta, joita käytämme ohjelmassamme validoinnin suorittamiseen.

JSON-asiakirja 

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

JSON-skeema 

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

Lisäämme seuraavan riippuvuuden pom.xml-tiedostoomme.

 com.networknt json-schema-validator 1.0.42

Voimme myös käyttää org.everit.json kirjasto JSON-objektin vahvistamiseksi. Jotta voimme käyttää sitä, meidän on lisättävä seuraava riippuvuus pom.xml-tiedostoomme:

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

Meidän tapauksessamme käytämme networknt Java-kirjasto.

Käytämme seuraavia vaiheita JSON-asiakirjan vahvistamiseen:

  1. Luo uusi maven-projekti.
  2. Lisää JSON-skeeman vahvistajan riippuvuus pom.xml-tiedostoomme.
  3. Lue tiedot ja skeema JSON-dokumentista ObjectMapperin avulla.
  4. Käytä JsonSchemaFactoryn valide()-menetelmää JSON-asiakirjan vahvistamiseen.
  5. Tallenna palautettu tulos vahvistussarjaan, tulosta se näytölle.

Kaikki on nyt määritetty, joten voimme ottaa käyttöön JSON-asiakirjan varsinaisen vahvistuskoodin.

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

Kuvaus

Yllä olevassa koodissa käytämme VersionFlag . Saadaksesi JsonSchemaFactory , sen versiolipun on välitettävä rakentajassa. Meidän tapauksessamme käytämme 2019-09 JSON Schema -versio.

Käytämme myös mukautettua apumenetelmää, eli inputStreamFromClasspath(), ladataksesi molemmat tiedostot luokkapolusta. Luomme Jackson ObjectMapper -luokan esiintymän JSON-tietojen lukemiseksi InputStreamista. Sen jälkeen jäsennämme nämä InputStream-tiedot JsonNode-objektiksi. Käyttämällä JsonSchemaFactory-instanssia saamme JsonSchema-objektin JsonNoden vahvistamiseksi. Luomme joukon vahvistusvirheitä, jotka sisältävät yhden tai useamman ValidationMessage-objektin. Vahvistusjoukko on tyhjä, jos vahvistusvirhettä ei ole.

Lähtö

JSON Validator Java