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

Програмиране

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

JSON (съкращение от JavaScript Object Notation) е лек формат за обмен на данни и най-често се използва за комуникация клиент-сървър. Лесен е за четене / писане и не зависи от езика. Стойността на JSON може да бъде друг JSON обект, масив, номер, низ, логическо (вярно / невярно) или нулево.

В този урок ще видим как можем да създаваме, манипулираме и анализираме JSON, като използваме една от наличните библиотеки за обработка на JSON, т.е. JSON-Java библиотеката е известна също като org.json.

2. Предварително условие

Преди да започнем, ще трябва да добавим следната зависимост в нашия pom.xml :

 org.json json 20180130

Най-новата версия може да бъде намерена в централното хранилище на Maven.

Имайте предвид, че този пакет вече е включен в Android SDK, така че не трябва да го включваме, докато използваме същия.

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

Библиотеката JSON-Java е известна също като org.json (да не се бърка с org.json.simple на Google) ни предоставя класове, които се използват за анализиране и манипулиране на JSON в Java.

Освен това тази библиотека може също да конвертира между JSON, XML, HTTP заглавки, бисквитки, списък с разделители със запетая или текст и т.н.

В този урок ще разгледаме:

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

4. JSONObject

А JSON обектите е неподреден събиране на ключ и стойност двойки, наподобяващи естествените на Java Карта реализации.

  • Ключовете са уникални низове, които не могат да бъдат null
  • Стойностите могат да бъдат всичко от Булева , номер , String , JSONArray или дори JSONObject.NULL обект
  • А JSON обектите могат да бъдат представени от String затворен в фигурни скоби с ключове и стойности разделени от дебелото черво, и двойки разделени със запетая
  • Той има няколко конструктора, с които да конструира JSONObject

Той също така поддържа следните основни методи:

  1. get (String key) - g извежда обекта, свързан с предоставения ключ, изхвърля 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 () . Докато ключът може да бъде само уникален, не-null String, стойността може да бъде всякаква.

4.2. Създаване на JSON от Map

Вместо директно поставяне на ключ и стойности в 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 String

За да анализираме JSON String на JSONObject , можем просто да предадем String на конструктора.

Този пример ще даде същите резултати като по-горе:

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

Приетият String аргумент трябва да бъде валиден JSON в противен случай този конструктор може да хвърли JSONException .

4.4. Сериализирайте Java Object към 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.