Wprowadzenie do JSON-Java (org.json)

1. Wprowadzenie do JSON-Java

JSON (skrót od JavaScript Object Notation) to lekki format wymiany danych i jest najczęściej używany do komunikacji klient-serwer. Jest zarówno łatwy do czytania / pisania, jak i niezależny od języka. Wartość JSON może być innym obiektem JSON , tablicą, liczbą, ciągiem znaków, wartością logiczną (prawda / fałsz) lub wartością null.

W tym samouczku zobaczymy, jak możemy tworzyć, manipulować i analizować JSON przy użyciu jednej z dostępnych bibliotek przetwarzania JSON, tj. Biblioteka JSON-Java jest również znana jako org.json.

2. Wymaganie wstępne

Zanim zaczniemy, musimy dodać następującą zależność w naszym pom.xml :

 org.json json 20180130 

Najnowszą wersję można znaleźć w repozytorium Maven Central.

Zwróć uwagę, że ten pakiet został już uwzględniony w Android SDK, więc nie powinniśmy go dołączać podczas korzystania z tego samego.

3. JSON w Javie [pakiet org.json]

Biblioteka JSON-Java jest również znana jako org.json (nie mylić z Google org.json.simple) zapewnia nam klasy, które są używane do analizowania i manipulowania JSON w Javie.

Co więcej, ta biblioteka może również konwertować między JSON, XML, nagłówkami HTTP, plikami cookie, listą rozdzielaną przecinkami lub tekstem itp.

W tym samouczku przyjrzymy się:

  1. JSONObject - podobny do natywnegoobiektuJava typu Map, który przechowuje nieuporządkowane pary klucz-wartość
  2. JSONArray - uporządkowana sekwencja wartości podobna do natywnej implementacji Vector w Javie
  3. JSONTokener - narzędzie, które rozbija fragment tekstu na serię tokenów, które mogą być użyte przez JSONObject lub JSONArray do parsowania ciągów JSON
  4. CDL - narzędzie zapewniające metody konwersji tekstu rozdzielanego przecinkami na JSONArray i odwrotnie
  5. Cookie - konwertuje z JSON String na cookies i odwrotnie
  6. HTTP - służy do konwersji z JSON String do nagłówków HTTP i odwrotnie
  7. JSONException - jest to standardowy wyjątek rzucany przez tę bibliotekę

4. JSONObject

JSONObject jest nieuporządkowana kolekcja par kluczy i wartości, przypominający rodzimych Java Mapa implementacje.

  • Klucze to unikalne ciągi, które nie mogą być puste
  • Wartości mogą być dowolnymi wartościami, od Boolean , Number , String , JSONArray lub nawet obiektu JSONObject.NULL
  • Obiekt JSONObject może być reprezentowany przez ciąg zamknięty w nawiasach klamrowych z kluczami i wartościami oddzielonymi dwukropkiem oraz parami oddzielonymi przecinkiem
  • Ma kilka konstruktorów, za pomocą których można skonstruować JSONObject

Obsługuje również następujące główne metody:

  1. get (String key) - pobiera obiekt skojarzony z podanym kluczem, wyrzuca JSONException, jeśli klucz nie zostanie znaleziony
  2. opt (String key) - pobiera obiekt skojarzony z podanym kluczem, w przeciwnym razie null
  3. put (klucz ciągu, wartość obiektu) - wstawia lub zastępuje parę klucz-wartość w bieżącym obiekcie JSONObject.

Metoda put () jest przeciążoną metodą, która akceptuje klucz typu String i wiele typów dla wartości.

Pełną listę metod obsługiwanych przez JSONObject można znaleźć w oficjalnej dokumentacji.

Omówmy teraz niektóre z głównych operacji obsługiwanych przez tę klasę.

4.1. Tworzenie JSON bezpośrednio z JSONObject

JSONObject udostępnia API podobne do interfejsu Map w Javie . Możemy użyć metody put () i podać klucz i wartość jako argument:

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

Teraz nasz JSONObject wyglądałby tak:

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

Istnieje siedem różnych przeciążonych sygnatur metody JSONObject.put () . Chociaż klucz może być tylko unikatowym ciągiem niezerowym , wartością może być dowolna.

4.2. Tworzenie JSON z Map

Zamiast bezpośrednio umieszczać klucz i wartości w obiekcie JSONObject , możemy skonstruować niestandardową mapę, a następnie przekazać ją jako argument do konstruktora JSONObject .

Ten przykład da takie same wyniki jak powyżej:

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

4.3. Tworzenie JSONObject z JSON String

Aby przeanalizować ciąg JSON do obiektu JSONObject , możemy po prostu przekazać String do konstruktora.

Ten przykład da takie same wyniki jak powyżej:

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

Przekazany argument String musi być prawidłowym kodem JSON, w przeciwnym razie ten konstruktor może zgłosić wyjątek JSONException .

4.4. Serializuj obiekt Java do formatu JSON

Jeden z konstruktorów JSONObject przyjmuje POJO jako argument. W poniższym przykładzie pakiet używa metod pobierających z klasy DemoBean i tworzy dla nich odpowiedni obiekt 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.

Jest to używane we wszystkich klasach z tego pakietu. Wyjątkiem zwykle towarzyszy komunikat, który dokładnie określa, co poszło nie tak.

11. Wniosek

W tym samouczku przyjrzeliśmy się JSONowi przy użyciu języka Java - org.json - i skupiliśmy się na niektórych podstawowych funkcjach dostępnych tutaj.

Pełne fragmenty kodu użyte w tym artykule można znaleźć na GitHub.