Introduzione a JSON-Java (org.json)

1. Introduzione a JSON-Java

JSON (acronimo di JavaScript Object Notation) è un formato di scambio dati leggero ed è più comunemente utilizzato per la comunicazione client-server. È sia facile da leggere / scrivere che indipendente dalla lingua. Un valore JSON può essere un altro oggetto JSON , array, numero, stringa, booleano (vero / falso) o null.

In questo tutorial, vedremo come creare, manipolare e analizzare JSON utilizzando una delle librerie di elaborazione JSON disponibili, ovvero, la libreria JSON-Java è anche nota come org.json.

2. Pre-requisito

Prima di iniziare, dobbiamo aggiungere la seguente dipendenza nel nostro pom.xml :

 org.json json 20180130 

L'ultima versione può essere trovata nel repository Maven Central.

Tieni presente che questo pacchetto è già stato incluso in Android SDK, quindi non dovremmo includerlo durante l'utilizzo dello stesso.

3. JSON in Java [pacchetto org.json]

La libreria JSON-Java è anche conosciuta come org.json (da non confondere con org.json.simple di Google) ci fornisce classi che vengono utilizzate per analizzare e manipolare JSON in Java.

Inoltre, questa libreria può anche convertire tra JSON, XML, intestazioni HTTP, cookie, elenco delimitato da virgole o testo, ecc.

In questo tutorial, daremo uno sguardo a:

  1. JSONObject : simile all'oggetto simile a Map nativo di Javache memorizza coppie chiave-valore non ordinate
  2. JSONArray : una sequenza ordinata di valori simile all'implementazione Vector nativa di Java
  3. JSONTokener : uno strumento che suddivide una parte di testo in una serie di token che possono essere utilizzati da JSONObject o JSONArray per analizzare le stringhe JSON
  4. CDL : uno strumento che fornisce metodi per convertire il testo delimitato da virgole in un JSONArray e viceversa
  5. Cookie : converte dalla stringa JSONai cookie e viceversa
  6. HTTP : utilizzato per convertire dalla stringa JSONalle intestazioni HTTP e viceversa
  7. JSONException : questa è un'eccezione standard generata da questa libreria

4. JSONObject

Un JSONObject è una raccolta non ordinata di coppie chiave e valore, simile alle implementazioni Map native di Java .

  • Le chiavi sono stringhe univoche che non possono essere nulle
  • I valori possono essere qualsiasi cosa, da un oggetto Boolean , Number , String , JSONArray o anche un oggetto JSONObject.NULL
  • Un oggetto JSONObject può essere rappresentato da una stringa racchiusa tra parentesi graffe con chiavi e valori separati da due punti e coppie separate da virgola
  • Ha diversi costruttori con cui costruire un JSONObject

Supporta anche i seguenti metodi principali:

  1. get (String key) - ottiene l'oggetto associato alla chiave fornita, genera JSONException se la chiave non viene trovata
  2. opt (String key) - restituisce l'oggetto associato alla chiave fornita, altrimenti null
  3. put (String key, Object value): inserisce o sostituisce una coppia chiave-valore nell'attuale JSONObject.

Il metodo put () è un metodo sovraccarico che accetta una chiave di tipo String e più tipi per il valore.

Per l'elenco completo dei metodi supportati da JSONObject , visita la documentazione ufficiale.

Discutiamo ora alcune delle principali operazioni supportate da questa classe.

4.1. Creazione di JSON direttamente da JSONObject

JSONObject espone un'API simile a quella di Java Map interfaccia . Possiamo usare il metodo put () e fornire la chiave e il valore come argomento:

JSONObject jo = new JSONObject(); jo.put("name", "jon doe"); jo.put("age", "22"); jo.put("city", "chicago");

Ora il nostro JSONObject sarebbe simile a:

{"city":"chicago","name":"jon doe","age":"22"}

Esistono sette diverse firme sovraccaricate del metodo JSONObject.put () . Sebbene la chiave possa essere solo una stringa univoca, non nulla , il valore può essere qualsiasi cosa.

4.2. Creazione di JSON da mappa

Invece di inserire direttamente chiave e valori in un JSONObject , possiamo costruire una mappa personalizzata e quindi passarla come argomento al costruttore di JSONObject .

Questo esempio produrrà gli stessi risultati come sopra:

Map map = new HashMap(); map.put("name", "jon doe"); map.put("age", "22"); map.put("city", "chicago"); JSONObject jo = new JSONObject(map);

4.3. Creating JSONObject from JSON String

To parse a JSON String to a JSONObject, we can just pass the String to the constructor.

This example will produce same results as above:

JSONObject jo = new JSONObject( "{\"city\":\"chicago\",\"name\":\"jon doe\",\"age\":\"22\"}" );

The passed String argument must be a valid JSON otherwise this constructor may throw a JSONException.

4.4. Serialize Java Object to JSON

One of JSONObject's constructors takes a POJO as its argument. In the example below, the package uses the getters from the DemoBean class and creates an appropriate JSONObject for the same.

To get a JSONObject from a Java Object, we'll have to use a class that is a valid Java Bean:

DemoBean demo = new DemoBean(); demo.setId(1); demo.setName("lorem ipsum"); demo.setActive(true); JSONObject jo = new JSONObject(demo);

The JSONObject jo for this example is going to be:

{"name":"lorem ipsum","active":true,"id":1}

Although we have a way to serialize a Java object to JSON string, there is no way to convert it back using this library.

If we want that kind of flexibility, we can switch to other libraries such as Jackson.

5. JSONArray

A JSONArray is an ordered collection of values, resembling Java's native Vector implementation.

  • Values can be anything from a Number, String, Boolean, JSONArray, JSONObject or even a JSONObject.NULL object
  • It's represented by a String wrapped within Square Brackets and consists of a collection of values separated by commas
  • Like JSONObject, it has a constructor that accepts a source String and parses it to construct a JSONArray

The following are the primary methods of the JSONArray class:

  1. get(int index) – returns the value at the specified index(between 0 and total length – 1), otherwise throws a JSONException
  2. opt(int index) – returns the value associated with an index (between 0 and total length – 1). If there's no value at that index, then a null is returned
  3. put(Object value) – append an object value to this JSONArray. This method is overloaded and supports a wide range of data types

For a complete list of methods supported by JSONArray, visit the official documentation.

5.1. Creating JSONArray

Once we've initialized a JSONArray object, we can simply add and retrieve elements using the put() and get() methods:

JSONArray ja = new JSONArray(); ja.put(Boolean.TRUE); ja.put("lorem ipsum"); JSONObject jo = new JSONObject(); jo.put("name", "jon doe"); jo.put("age", "22"); jo.put("city", "chicago"); ja.put(jo);

Following would be contents of our JSONArray(code is formatted for clarity):

[ true, "lorem ipsum", { "city": "chicago", "name": "jon doe", "age": "22" } ]

5.2. Creating JSONArray Directly from JSON String

Like JSONObject the JSONArray also has a constructor that creates a Java object directly from a JSON String:

JSONArray ja = new JSONArray("[true, \"lorem ipsum\", 215]");

This constructor may throw a JSONException if the source String isn't a valid JSON String.

5.3. Creating JSONArray Directly from a Collection or an Array

The constructor of JSONArray also supports collection and array objects as arguments.

We simply pass them as an argument to the constructor and it will return a JSONArray object:

List list = new ArrayList(); list.add("California"); list.add("Texas"); list.add("Hawaii"); list.add("Alaska"); JSONArray ja = new JSONArray(list);

Now our JSONArray consists of:

["California","Texas","Hawaii","Alaska"]

6. JSONTokener

A JSONTokener takes a source String as input to its constructor and extracts characters and tokens from it. It's used internally by classes of this package (like JSONObject, JSONArray) to parse JSON Strings.

There may not be many situations where we'll directly use this class as the same functionality can be achieved using other simpler methods (like string.toCharArray()):

JSONTokener jt = new JSONTokener("lorem"); while(jt.more()) { Log.info(jt.next()); }

Now we can access a JSONTokener like an iterator, using the more() method to check if there are any remaining elements and next() to access the next element.

The tokens received from the previous example will be:

l o r e m

7. CDL

We're provided with a CDL (Comma Delimited List) class to convert comma delimited text into a JSONArray and vice versa.

7.1. Producing JSONArray Directly from Comma Delimited Text

In order to produce a JSONArray directly from the comma-delimited text, we can use the static method rowToJSONArray() which accepts a JSONTokener:

JSONArray ja = CDL.rowToJSONArray(new JSONTokener("England, USA, Canada"));

Our JSONArray now consists of:

["England","USA","Canada"]

7.2. Producing Comma Delimited Text from JSONArray

In order to reverse of the previous step and get back the comma-delimited text from JSONArray, we can use:

JSONArray ja = new JSONArray("[\"England\",\"USA\",\"Canada\"]"); String cdt = CDL.rowToString(ja);

The Stringcdt now contains:

England,USA,Canada

7.3. Producing JSONArray of JSONObjects Using Comma Delimited Text

To produce a JSONArray of JSONObjects, we'll use a text String containing both headers and data separated by commas.

The different lines are separated using a carriage return (\r) or line feed (\n).

The first line is interpreted as a list of headers and all the subsequent lines are treated as data:

String string = "name, city, age \n" + "john, chicago, 22 \n" + "gary, florida, 35 \n" + "sal, vegas, 18"; JSONArray result = CDL.toJSONArray(string);

The object JSONArray result now consists of (output formatted for the sake of clarity):

[ { "name": "john", "city": "chicago", "age": "22" }, { "name": "gary", "city": "florida", "age": "35" }, { "name": "sal", "city": "vegas", "age": "18" } ]

Notice that in this example, both data and header were supplied within the same String.There's an alternative way of doing this where we can achieve the same functionality by supplying a JSONArray that would be used to get the headers and a comma-delimited String working as the data.

Different lines are separated using a carriage return (\r) or line feed (\n):

JSONArray ja = new JSONArray(); ja.put("name"); ja.put("city"); ja.put("age"); String string = "john, chicago, 22 \n" + "gary, florida, 35 \n" + "sal, vegas, 18"; JSONArray result = CDL.toJSONArray(ja, string);

Here we'll get the contents of object result exactly as before.

8. Cookie

The Cookie class deals with web browser cookies and has methods to convert a browser cookie into a JSONObject and vice versa.

Here are the main methods of the Cookie class:

  1. toJsonObject(String sourceCookie) – converts a cookie string into a JSONObject

  2. toString(JSONObject jo) – this is reverse of the previous method, converts a JSONObject into a cookie String.

8.1. Converting a Cookie String into a JSONObject

To convert a cookie String to a JSONObject, well use the static method Cookie.toJSONObject():

String cookie = "username=John Doe; expires=Thu, 18 Dec 2013 12:00:00 UTC; path=/"; JSONObject cookieJO = Cookie.toJSONObject(cookie);

8.2. Converting a JSONObject into Cookie String

Now we'll convert a JSONObject into cookie String. This is reverse of the previous step:

String cookie = Cookie.toString(cookieJO);

9. HTTP

The HTTP class contains static methods that are used to convert HTTP headers to JSONObject and vice versa.

This class also has two main methods:

  1. toJsonObject(String sourceHttpHeader) – converts a HttpHeader String to JSONObject
  2. toString(JSONObject jo) – converts the supplied JSONObject to String

9.1. Converting JSONObject to HTTP Header

HTTP.toString() method is used to convert a JSONObject to HTTP header String:

JSONObject jo = new JSONObject(); jo.put("Method", "POST"); jo.put("Request-URI", "//www.example.com/"); jo.put("HTTP-Version", "HTTP/1.1"); String httpStr = HTTP.toString(jo);

Here, our String httpStr will consist of:

POST "//www.example.com/" HTTP/1.1

Note that while converting an HTTP request header, the JSONObject must contain “Method”,“Request-URI” and “HTTP-Version” keys, whereas, for response header, the object must contain “HTTP-Version”,“Status-Code” and “Reason-Phrase” parameters.

9.2. Converting HTTP Header String Back to JSONObject

Here we will convert the HTTP string that we got in the previous step back to the very JSONObject that we created in that step:

JSONObject obj = HTTP.toJSONObject("POST \"//www.example.com/\" HTTP/1.1");

10. JSONException

The JSONException is the standard exception thrown by this package whenever any error is encountered.

Viene utilizzato in tutte le classi di questo pacchetto. L'eccezione è solitamente seguita da un messaggio che indica cosa è andato storto esattamente.

11. Conclusione

In questo tutorial, abbiamo esaminato un JSON utilizzando Java - org.json - e ci siamo concentrati su alcune delle funzionalità principali disponibili qui.

Gli snippet di codice completi utilizzati in questo articolo sono disponibili su GitHub.