Вступ до JSON-Java (org.json)

1. Вступ до JSON-Java

JSON (абревіатура від JavaScript Object Notation) - це легкий формат обміну даними, який найчастіше використовується для зв'язку клієнт-сервер. Це і читати / писати, і не залежить від мови. Значенням JSON може бути інший об’єкт JSON , масив, число, рядок, логічне значення (true / false) або null.

У цьому підручнику ми побачимо, як ми можемо створювати, обробляти та аналізувати JSON, використовуючи одну з доступних бібліотек обробки JSON, тобто бібліотека JSON-Java також відома як org.json.

2. Передумова

Перш ніж розпочати, нам потрібно додати таку залежність у наш pom.xml :

 org.json json 20180130 

Останню версію можна знайти у сховищі Maven Central.

Зверніть увагу, що цей пакет уже включений в Android SDK, тому ми не повинні включати його, використовуючи той самий.

3. JSON на Java [пакет org.json]

Бібліотека JSON-Java також відома як org.json (не плутати з Google org.json.simple) надає нам класи, які використовуються для синтаксичного аналізу та маніпулювання JSON в Java.

Крім того, ця бібліотека може також перетворювати між заголовками JSON, XML, HTTP, файлами cookie, списком, розділеним комами, текстом тощо.

У цьому підручнику ми розглянемо:

  1. JSONObject - схожий на рідну карту Java,як об'єкт, який зберігає невпорядковані пари ключ-значення
  2. JSONArray - упорядкована послідовність значень, подібна до власної реалізації Java Java
  3. JSONTokener - інструмент, який розбиває фрагмент тексту на ряд лексем, які можуть бути використані JSONObject або JSONArray для синтаксичного аналізу рядків JSON
  4. CDL - інструмент, який надає методи перетворення тексту, розділеного комами, у JSONArray і навпаки
  5. Cookie - перетворює з JSON String на cookie і навпаки
  6. HTTP - використовується для перетворення з JSON String в заголовки HTTP і навпаки
  7. JSONException - це стандартний виняток, створений цією бібліотекою

4. JSONObject

JSONObject є невпорядкований набір ключів і значень пара, що нагадує рідну Java - Карту реалізації.

  • Ключі - це унікальні рядки, які не можуть бути нульовими
  • Значення можуть бути що завгодно , від булевої , Number , String , , JSONArray або навіть JSONObject.NULL об'єкта
  • JSONObject може бути представлена у вигляді рядка , укладеної всередині фігурних дужок з ключами і значеннями , розділених двокрапкою, а пари розділених комою
  • Він має кілька конструкторів, за допомогою яких можна побудувати JSONObject

Він також підтримує такі основні методи:

  1. get (String key) - отримує об'єкт, пов'язаний із наданим ключем, кидає JSONException, якщо ключ не знайдено
  2. opt (String key) - отримує об'єкт, асоційований із наданим ключем, інакше нуль
  3. put (String key, Object value) - вставляє або замінює пару ключ-значення в поточному JSONObject.

Метод put () - це перевантажений метод, який приймає ключ значення String та кілька типів для значення.

Повний перелік методів, що підтримуються JSONObject , відвідайте офіційну документацію.

Давайте тепер обговоримо деякі основні операції, що підтримуються цим класом.

4.1. Створення JSON безпосередньо з JSONObject

JSONObject надає API, подібний до інтерфейсу Map Java . Ми можемо використовувати метод put () і надати ключ і значення як аргумент:

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

Тепер наш JSONObject буде виглядати так:

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

Існує сім різних перевантажених підписів методу JSONObject.put () . Хоча ключ може бути лише унікальним, не нульовим рядком, значення може бути будь-яким.

4.2. Створення JSON з карти

Замість того, щоб безпосередньо поміщати ключ і значення в JSONObject , ми можемо створити власну карту, а потім передати її як аргумент конструктору JSONObject .

Цей приклад дасть ті самі результати, що і вище:

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.

Це використовується у всіх класах цього пакету. За винятком зазвичай йде повідомлення, в якому зазначається, що саме пішло не так.

11. Висновок

У цьому посібнику ми розглянули JSON за допомогою Java - org.json - і зосередили увагу на деяких основних функціональних можливостях, доступних тут.

Повні фрагменти коду, використані в цій статті, можна знайти на GitHub.