Введение в JSON-Java (org.json)

1. Введение в JSON-Java

JSON (аббревиатура от JavaScript Object Notation) - это облегченный формат обмена данными, который чаще всего используется для связи клиент-сервер. Его легко читать / писать, и он не зависит от языка. Значением JSON может быть другой объект JSON , массив, число, строка, логическое значение (истина / ложь) или значение 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 (не путать с org.json.simple от Google), предоставляет нам классы, которые используются для синтаксического анализа и управления JSON в Java.

Кроме того, эта библиотека также может конвертировать между JSON, XML, HTTP-заголовками, файлами cookie, списком с разделителями-запятыми или текстом и т. Д.

В этом уроке мы рассмотрим:

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

4. JSONObject

JSONObject представляет собой неупорядоченный набор ключей и значений пара, напоминающий родную Java - Карту реализации.

  • Ключи - это уникальные строки, которые не могут быть нулевыми
  • Значения могут быть любыми: от Boolean , Number , String , JSONArray или даже до объекта JSONObject.NULL.
  • JSONObject может быть представлена в виде строки , заключенной внутри фигурных скобок с ключами и значениями , разделенных двоеточием, а пары разделенных запятой
  • У него есть несколько конструкторов, с помощью которых можно создать JSONObject.

Он также поддерживает следующие основные методы:

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

Метод put () - это перегруженный метод, который принимает ключ типа String и несколько типов для значения.

Полный список методов, поддерживаемых JSONObject , можно найти в официальной документации.

Давайте теперь обсудим некоторые из основных операций, поддерживаемых этим классом.

4.1. Создание JSON непосредственно из JSONObject

JSONObject выставляет API , похожий на Явы Карта интерфейса . Мы можем использовать метод 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 () . Хотя ключ может быть только уникальным, не равным нулю String, значение может быть любым.

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. Создание JSONObject из строки JSON

Чтобы преобразовать строку JSON в объект JSONObject , мы можем просто передать строку конструктору.

Этот пример даст те же результаты, что и выше:

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

Переданный Строка аргумент должен быть допустимым JSON в противном случае этот конструктор может бросить JSONException .

4.4. Сериализовать объект Java в JSON

Один из конструкторов JSONObject принимает в качестве аргумента POJO. В приведенном ниже примере пакет использует геттеры из класса DemoBean и создает для него соответствующий JSONObject .

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.