Introduzione a JsonPath

1. Panoramica

Uno dei vantaggi di XML è la disponibilità dell'elaborazione, incluso XPath, che è definito come uno standard W3C. Per JSON è emerso uno strumento simile chiamato JSONPath.

Questo articolo fornirà un'introduzione a Jayway JsonPath , un'implementazione Java della specifica JSONPath. Descrive la configurazione, la sintassi, le API comuni e una dimostrazione dei casi d'uso.

2. Configurazione

Per utilizzare JsonPath, dobbiamo semplicemente includere una dipendenza nel Maven pom:

 com.jayway.jsonpath json-path 2.4.0 

3. Sintassi

La seguente struttura JSON verrà utilizzata in questa sezione per dimostrare la sintassi e le API di JsonPath:

{ "tool": { "jsonpath": { "creator": { "name": "Jayway Inc.", "location": [ "Malmo", "San Francisco", "Helsingborg" ] } } }, "book": [ { "title": "Beginning JSON", "price": 49.99 }, { "title": "JSON at Work", "price": 29.99 } ] }

3.1. Notazione

JsonPath utilizza una notazione speciale per rappresentare i nodi e le loro connessioni ai nodi adiacenti in un percorso JsonPath. Esistono due stili di notazione, ovvero punto e parentesi.

Entrambi i percorsi seguenti fanno riferimento allo stesso nodo dal documento JSON sopra, che è il terzo elemento all'interno del campo di posizione del nodo creatore , ovvero un figlio dell'oggetto jsonpath che appartiene allo strumento sotto il nodo radice.

Con notazione punto:

$.tool.jsonpath.creator.location[2]

Con notazione tra parentesi:

$['tool']['jsonpath']['creator']['location'][2]

Il segno di dollaro ($) rappresenta l'oggetto membro radice.

3.2. Operatori

Abbiamo diversi operatori utili in JsonPath:

Nodo radice ($) : questo simbolo indica il membro radice di una struttura JSON, indipendentemente dal fatto che si tratti di un oggetto o di un array. I suoi esempi di utilizzo sono stati inclusi nella sottosezione precedente.

Nodo corrente (@) : rappresenta il nodo che viene elaborato, utilizzato principalmente come parte delle espressioni di input per i predicati. Supponiamo di avere a che fare con un array di libri nel documento JSON sopra, l'espressione libro [? (@. Price == 49,99)] si riferisce al primo libro in quell'array.

Carattere jolly (*) : esprime tutti gli elementi all'interno dell'ambito specificato. Ad esempio, book [*] indica tutti i nodi all'interno di un array di libri .

3.3. Funzioni e filtri

JsonPath ha anche funzioni che possono essere utilizzate alla fine di un percorso per sintetizzare le espressioni di output di quel percorso: min () , max () , avg () , stddev () , length () .

Infine, abbiamo i filtri; si tratta di espressioni booleane per limitare gli elenchi di nodi restituiti solo a quelli necessari ai metodi di chiamata.

Alcuni esempi sono l'uguaglianza ( == ), la corrispondenza di espressioni regolari ( = ~ ), l'inclusione ( in ), il controllo del vuoto ( vuoto ). I filtri vengono utilizzati principalmente per i predicati.

Per un elenco completo e spiegazioni dettagliate di diversi operatori, funzioni e filtri, fare riferimento al progetto JsonPath GitHub.

4. Operazioni

Prima di entrare nelle operazioni, una breve nota a margine: questa sezione fa uso della struttura di esempio JSON che abbiamo definito in precedenza.

4.1. Accesso ai documenti

JsonPath ha un modo conveniente per accedere ai documenti JSON, che è tramite API di lettura statica :

 T JsonPath.read(String jsonString, String jsonPath, Predicate... filters);

Le API di lettura possono funzionare con API fluenti statiche per fornire maggiore flessibilità:

 T JsonPath.parse(String jsonString).read(String jsonPath, Predicate... filters);

Altre varianti di lettura sovraccaricate possono essere utilizzate per diversi tipi di origini JSON, inclusi Object , InputStream , URL e File .

Per rendere le cose semplici, il test per questa parte non include predicati nell'elenco dei parametri ( vararg vuoti ); predicati saranno discussi nelle sottosezioni successive.

Iniziamo definendo due percorsi di esempio su cui lavorare:

String jsonpathCreatorNamePath = "$['tool']['jsonpath']['creator']['name']"; String jsonpathCreatorLocationPath = "$['tool']['jsonpath']['creator']['location'][*]";

Successivamente, creeremo un oggetto DocumentContext analizzando la data origine JSON jsonDataSourceString . L'oggetto appena creato verrà quindi utilizzato per leggere il contenuto utilizzando i percorsi definiti sopra:

DocumentContext jsonContext = JsonPath.parse(jsonDataSourceString); String jsonpathCreatorName = jsonContext.read(jsonpathCreatorNamePath); List jsonpathCreatorLocation = jsonContext.read(jsonpathCreatorLocationPath);

La prima API di lettura restituisce una stringa contenente il nome del creatore di JsonPath, mentre la seconda restituisce un elenco dei suoi indirizzi. E useremo l' API JUnit Assert per confermare che i metodi funzionino come previsto:

assertEquals("Jayway Inc.", jsonpathCreatorName); assertThat(jsonpathCreatorLocation.toString(), containsString("Malmo")); assertThat(jsonpathCreatorLocation.toString(), containsString("San Francisco")); assertThat(jsonpathCreatorLocation.toString(), containsString("Helsingborg"));

4.2. Predicati

Ora che abbiamo finito con le basi, definiamo un nuovo esempio JSON su cui lavorare e illustriamo la creazione e l'utilizzo dei predicati:

{ "book": [ { "title": "Beginning JSON", "author": "Ben Smith", "price": 49.99 }, { "title": "JSON at Work", "author": "Tom Marrs", "price": 29.99 }, { "title": "Learn JSON in a DAY", "author": "Acodemy", "price": 8.99 }, { "title": "JSON: Questions and Answers", "author": "George Duckett", "price": 6.00 } ], "price range": { "cheap": 10.00, "medium": 20.00 } }

Predicates determine true or false input values for filters to narrow down returned lists to only matched objects or arrays. A Predicate may easily be integrated into a Filter by using as an argument for its static factory method. The requested content can then be read out of a JSON string using that Filter:

Filter expensiveFilter = Filter.filter(Criteria.where("price").gt(20.00)); List expensive = JsonPath.parse(jsonDataSourceString) .read("$['book'][?]", expensiveFilter); predicateUsageAssertionHelper(expensive);

We may also define our customized Predicate and use it as an argument for the read API:

Predicate expensivePredicate = new Predicate() { public boolean apply(PredicateContext context) { String value = context.item(Map.class).get("price").toString(); return Float.valueOf(value) > 20.00; } }; List expensive = JsonPath.parse(jsonDataSourceString) .read("$['book'][?]", expensivePredicate); predicateUsageAssertionHelper(expensive);

Finally, a predicate may be directly applied to read API without the creation of any objects, which is called inline predicate:

List expensive = JsonPath.parse(jsonDataSourceString) .read("$['book'][?(@['price'] > $['price range']['medium'])]"); predicateUsageAssertionHelper(expensive);

All the three of the Predicate examples above are verified with the help of the following assertion helper method:

private void predicateUsageAssertionHelper(List predicate) { assertThat(predicate.toString(), containsString("Beginning JSON")); assertThat(predicate.toString(), containsString("JSON at Work")); assertThat(predicate.toString(), not(containsString("Learn JSON in a DAY"))); assertThat(predicate.toString(), not(containsString("JSON: Questions and Answers"))); }

5. Configuration

5.1. Options

Jayway JsonPath provides several options to tweak the default configuration:

  • Option.AS_PATH_LIST: Returns paths of the evaluation hits instead of their values.
  • Option.DEFAULT_PATH_LEAF_TO_NULL: Returns null for missing leaves.
  • Option.ALWAYS_RETURN_LIST: Returns a list even when the path is definite.
  • Option.SUPPRESS_EXCEPTIONS: Makes sure no exceptions are propagated from path evaluation.
  • Option.REQUIRE_PROPERTIES: Requires properties defined in the path when an indefinite path is evaluated.

Here is how Option is applied from scratch:

Configuration configuration = Configuration.builder().options(Option.).build();

and how to add it to an existing configuration:

Configuration newConfiguration = configuration.addOptions(Option.);

5.2. SPIs

JsonPath's default configuration with the help of Option should be enough for the majority of tasks. However, users with more complex use cases can modify the behavior of JsonPath according to their specific requirements – using three different SPIs:

  • JsonProvider SPI: Lets us change the ways JsonPath parses and handles JSON documents
  • MappingProvider SPI: Allows for customization of bindings between node values and returned object types
  • CacheProvider SPI: Adjusts the manners that paths are cached, which can help to increase performance

6. An Example Use Cases

Now that we have a good understanding of the functionality that JsonPath can be used for – let's look at an example.

This section illustrates dealing with JSON data returned from a web service – assume we have a movie information service, which returns the following structure:

[ { "id": 1, "title": "Casino Royale", "director": "Martin Campbell", "starring": [ "Daniel Craig", "Eva Green" ], "desc": "Twenty-first James Bond movie", "release date": 1163466000000, "box office": 594275385 }, { "id": 2, "title": "Quantum of Solace", "director": "Marc Forster", "starring": [ "Daniel Craig", "Olga Kurylenko" ], "desc": "Twenty-second James Bond movie", "release date": 1225242000000, "box office": 591692078 }, { "id": 3, "title": "Skyfall", "director": "Sam Mendes", "starring": [ "Daniel Craig", "Naomie Harris" ], "desc": "Twenty-third James Bond movie", "release date": 1350954000000, "box office": 1110526981 }, { "id": 4, "title": "Spectre", "director": "Sam Mendes", "starring": [ "Daniel Craig", "Lea Seydoux" ], "desc": "Twenty-fourth James Bond movie", "release date": 1445821200000, "box office": 879376275 } ]

Where the value of release date field is duration since the Epoch in milliseconds and box office is revenue of a movie in the cinema in US dollars.

We are going to handle five different working scenarios related to GET requests, supposing that the above JSON hierarchy has been extracted and stored in a String variable named jsonString.

6.1. Getting Object Data Given IDs

In this use case, a client requests detailed information on a specific movie by providing the server with the exact id of that one. This example demonstrates how the server looks for requested data before returning to the client.

Say we need to find a record with id equaling to 2. Below is how the process is implemented and tested.

The first step is to pick up the correct data object:

Object dataObject = JsonPath.parse(jsonString).read("$[?(@.id == 2)]"); String dataString = dataObject.toString();

The JUnit Assert API confirms the existence of several fields:

assertThat(dataString, containsString("2")); assertThat(dataString, containsString("Quantum of Solace")); assertThat(dataString, containsString("Twenty-second James Bond movie"));

6.2. Getting the Movie Title Given Starring

Let's say we want to look for a movie starring an actress called Eva Green. The server needs to return title of the movie that Eva Green is included in the starring array.

The succeeding test will illustrate how to do that and validate the returned result:

@Test public void givenStarring_whenRequestingMovieTitle_thenSucceed() { List dataList = JsonPath.parse(jsonString) .read("$[?('Eva Green' in @['starring'])]"); String title = (String) dataList.get(0).get("title"); assertEquals("Casino Royale", title); }

6.3. Calculation of the Total Revenue

This scenario makes use of a JsonPath function called length() to figure out the number of movie records, to calculate the total revenue of all the movies. The implementation and testing are demonstrated as follows:

@Test public void givenCompleteStructure_whenCalculatingTotalRevenue_thenSucceed() { DocumentContext context = JsonPath.parse(jsonString); int length = context.read("$.length()"); long revenue = 0; for (int i = 0; i < length; i++) { revenue += context.read("$[" + i + "]['box office']", Long.class); } assertEquals(594275385L + 591692078L + 1110526981L + 879376275L, revenue); }

6.4. Highest Revenue Movie

This use case exemplifies the usage of a non-default JsonPath configuration option, namely Option.AS_PATH_LIST, to find out the movie with the highest revenue. The particular steps are described underneath.

At first, we need to extract a list of all the movies' box office revenue, then convert it to an array for sorting:

DocumentContext context = JsonPath.parse(jsonString); List revenueList = context.read("$[*]['box office']"); Integer[] revenueArray = revenueList.toArray(new Integer[0]); Arrays.sort(revenueArray);

The highestRevenue variable may easily be picked up from the revenueArray sorted array, then used for working out the path to the movie record with the highest revenue:

int highestRevenue = revenueArray[revenueArray.length - 1]; Configuration pathConfiguration = Configuration.builder().options(Option.AS_PATH_LIST).build(); List pathList = JsonPath.using(pathConfiguration).parse(jsonString) .read("$[?(@['box office'] == " + highestRevenue + ")]");

Based on that calculated path, title of the corresponding movie can be determined and returned:

Map dataRecord = context.read(pathList.get(0)); String title = dataRecord.get("title");

The whole process is verified by the Assert API:

assertEquals("Skyfall", title);

6.5. Latest Movie of a Director

This example will illustrate the way to figure out the lasted movie directed by a director named Sam Mendes.

To begin with, a list of all the movies directed by Sam Mendes is created:

DocumentContext context = JsonPath.parse(jsonString); List dataList = context.read("$[?(@.director == 'Sam Mendes')]");

That list is used for extraction of release dates. Those dates will be stored in an array and then sorted:

List dateList = new ArrayList(); for (Map item : dataList) { Object date = item.get("release date"); dateList.add(date); } Long[] dateArray = dateList.toArray(new Long[0]); Arrays.sort(dateArray);

The lastestTime variable, which is the last element of the sorted array, is used in combination with the director field's value to determine the title of the requested movie:

long latestTime = dateArray[dateArray.length - 1]; List finalDataList = context.read("$[?(@['director'] == 'Sam Mendes' && @['release date'] == " + latestTime + ")]"); String title = (String) finalDataList.get(0).get("title");

The following assertion proved that everything works as expected:

assertEquals("Spectre", title);

7. Conclusion

This tutorial has covered fundamental features of Jayway JsonPath – a powerful tool to traverse and parse JSON documents.

Sebbene JsonPath presenti alcuni inconvenienti, come la mancanza di operatori per raggiungere i nodi padre o di pari livello, può essere molto utile in molti scenari.

L'implementazione di tutti questi esempi e frammenti di codice può essere trovata in un progetto GitHub .