PRA04.rst

Pracowania Programowania

JSON & XML

Współautor części materiału : Tomasz Ziętkiewicz

Uwaga! Kod do tych zajęć znajduje się na gałęzi JsonAndXmlStart w repozytorium https://github.com/WitMar/PRA2025 . Kod końcowy w gałęzi JsonAndXmlEnd.

Jeżeli nie widzisz odpowiednich gałęzi na GitHubie wykonaj Ctr+T, a jak to nie pomoże to wybierz z menu Git->Fetch.

JSON

JSON (JavaScript Object Notation) http://www.json.org/ to lekki, tekstowy format wymiany danych.

Jest oparty na podzbiorze języka JavaScript.

Powszechnie wykorzystywany do przechowywania i przekazywania ustrukturyzowanych danych w postaci tekstowej.

Właściwości JSON-a:

  • czytelny dla człowieka

  • szeroko rozpowszechniony - biblioteki dla każdego języka (lista na http://www.json.org)

Przykład JSON
{
    "artist": "Pink Floyd",
    "title": "Dark Side of the moon",
    "year": 1973,
    "tracks": [
        {
            "track#": 1,
            "title": "Speak to Me/Breathe",
            "length": "3:57",
            "music": ["Mason"]
        },
        {
            "track#": 2,
            "title": "On the run",
            "length": "3:50",
            "music": ["Waters", "Gilmour"]
        }
    ]
}

Przykład z życia: API rowerów miejskich

Składnia JSON

Dwie struktury danych:

  • object (obiekt, słownik, mapa) zbiór par klucz-wartość

{
"title": "Dark Side of the Moon",
"year": 1973,
"tracks#": 9
}
My Image
  • array (tablica, lista)

    uporządkowany zbiór wartości

{
    "name":"John",
    "age":30,
    "cars":[ "Ford", "BMW", "Fiat" ]
}
My Image

Siedem typów wartości:

My Image
Komentarze

Do pliku JSON nie możemy dodawać komentarzy

XML

XML (Extensible Markup Language) - język znaczników (markup language), który podobnie jak JSON umożliwia serializację i wymianę strukturalnych danych w postaci tekstowej.

Składnia XML

W dokumencie XML możemy wydzielić zawartość (content) i znaczniki (markup).

Znaczniki znajdują się między parami znaków "<" i ">" lub "&" i ";".

Treść dokumentu to wszystkie znaki, które nie są znacznikami.

Tagi
  • tagi początku elementu:

<album>
  • tagi końca elementu:

</album>
  • tagi puste (bez zawartości):

<album />
Element

Element rozpoczna się tagiem początku, kończy tagiem końca elementu, albo jest pustym tagiem.

Pomiędzy tagami znajduje się zawartość elementu, którym może być albo zwykły tekst, albo zagnieżdżone elementy.

Tagi początkowy i pusty mogą zawierać atrybuty, czyli pary klucz-wartość.

Klucz podajemy jako text bez cudzysłowów, wartości zawsze w cudzysłowie.

<track number="3" title="Time" length="3:57">
    Ticking away the moments that make up a dull day
    You fritter and waste the hours in an offhand way
    Kicking around on a piece of ground in your home town
    Waiting for someone or something to show you the way
</track>
Komentarze

Komentarze znajdują się między znacznikami "<!--" i "-->".

Przykład XML
<?xml version="1.0" encoding="UTF-8"?>
<album title="Dark Side of the Moon" year="1973">
    <track number="1" title="Speak to Me/Breathe">
        Breathe, breathe in the air
        Don't be afraid to care
        Leave but don't leave me
        Look around and choose your own ground
        For long you live and high you fly
        Smiles you'll give and tears you'll cry
        And all you touch and all you see
        Is all your life will ever be
    </track>
    <track number="2" title="On the run" />
    <track number="3" title="Time" length="3:57">
        Ticking away the moments that make up a dull day
        You fritter and waste the hours in an offhand way
        Kicking around on a piece of ground in your home town
        Waiting for someone or something to show you the way
    </track>
</album>

Życiowy przykład: API rowerów miejskich, XML

Serializacja / Deserializacja

Serializacja - proces polegający na przekształceniu struktur danych albo stanu obiektu do sekwencyjnej formy, która umożliwa zapisanie lub przesłanie tych danych i potencjalnie odtworzenie struktur danych lub obiektów w późniejszym czasie/przez inny proces/komputer (deserializację).

Na przykład, serializacja może polegać na zapisie do pliku w formacie JSON obiektów wygenerowanych przez nasz program, w celu późniejszego wczytania tych obiektów z powrotem do programu w celu kontynuowania obliczeń.

JSON i XML są przykładami formatów dobrze nadających się do serializacji danych w sposób czytelny dla człowieka.

Dane można również serializować dane w postaci binarnej, niezrozumiałej dla człowieka.

Jackson

Jackson - zestaw narzędzi do przetwarzania danych dla Javy ("suite of data-processing tools for Java").

Głównym komponentem jest generator/parser JSON, pozwalający m.in. na deserializację/serializację do/z JSON z/do Javy.

Posiada liczne moduły dodające obsługę innych formatów danych, m.in. XML, YAML czy CSV.

Strona domowa projektu nie działa, ale projekt jest aktywnie rozwijany na GitHub.

Zarchiwizowana wersja strony domowej.

Przygotowanie

Zobacz jak tworzeni są pracownicy w kodzie oraz jak są serializowani oraz co jest wynikiem programu. Każdy z pracowników ma przypisany adres.

Zobacz jak za pomocą om.fasterxml.jackson.databind.ObjectMapper zapisywany (serializowany) jest obiekt.

Przykłady:

Zadanie 0: Uruchom serializację

Uruchom kod, sprawdź jaka wersja biblioteki Jackson jest zainmportowana do pom.xml.

Wskazówka: Odpowiedni wpis znajdzie w dokumentacji w repozytorium maven.

Zadanie 1: Uruchom deserializację

Odkomentuj linijkę

//deserializeDemo(jsonMapper, "json");

Uruchom kod, zobacz jaki błąd widzisz. Dodaj do katalou resources plik employee.json i wklej do niego zawartość pliku result.json, czy błąd zniknął? Co zobaczysz jeżeli plik będzie zapisany w niepoprawnym miejscu?

Zadanie 2: Deserializacja z JSON

Uruchom kod korzystając z debugera żeby sprawdzić jak zachowują się obiekty i jak zmienia się wynagrodzenie.

Zadanie 3: Annotacje

W języku Java dla zapisu nazwy pól klasy przyjmuje się konwencję notacji lowerCamelCase.

W JSON nie ma przyjętego standardu notacji (dyskusja na StackOverflow).

Domyślnie pola w JSONie wygenerowanym przez Jackson/Gson mają takie same nazwy jak pola w klasie, którą serializujemy.

Dodaj do modelowanych klas annotacje zmieniającą nazwę pola w JSON z salary na "wynagrodzenie" oraz adnotacje do ignorowania pola "pesel" przy serializacji.

Wskazówka: Skorzystaj z dokumentacji.

Zobacz w jakiej kolejności serializowane są pola oraz odpowiedz na pytanie dlaczego wystąpił błąd deserializacji? Napraw błąd. Czy Pesel wczytuje się przy deserializacji?

Zadanie 4: Deserializacja typów generycznych

Spróbuj serializować listę pracowników (w postaci ArrayList) zobacz jak wygląda plik json zawierający listę kilku pracowników. Wczytaj tę listę do kolekcji ArrayList<Employee>.

Następnie spróbuj zdeserializować otrzymany plik wynikowy.

Wskazówka: Skorzystaj z 3 minute tutorial.

Jackson XML

Jackson posiada moduł rozszerzający go o obsługę formatu XML. Aby użyć XML zamiast JSON wystarczy zmienić "ObjectMapper" na XmlMapper":

ObjectMapper xmlMapper = new XmlMapper();

Więcej szczegółów:

http://www.baeldung.com/jackson-xml-serialization-and-deserialization

Zadanie 5: XML

Korzystając z istniejącej klasy JacksonSerialization zmodyfikuj ją, albo stwórz nową klasę tak, żeby umożliwić serializację / deserializację do/z formatu XML. Dodaj do katalogu main/resources pliki xml odpowiadające istniejącym już plikom json.

Wskazówka: Nie musisz tworzyć zawartości plików xml samodzielnie, możesz wygenerować je za pomocą odpowiednich metod.

Wskazówka: Pamiętaj żeby dodać bibliotekę do pom.xml. Odpowiedni wpis znajdziesz w repozytorium GitHub modułu XML. Skorzystaj z wersji 2.17.1.

Zadanie 6: Joda Time

Dodaj do klasy Employee pole

DateTime birthDate

zawierające datę urodzenia pracownika.

Wskazówka: Możesz potrzebować modułu jackson-datatype-joda.

Spróbuj dokonać serializacji a następnie deserializacji obiektu tak zmodyfikowanej klasy.

Żeby wszystko zadziałało potrzebujesz zarejestrować w mapperze moduł Joda.

Zobacz jak teraz serializuje się plik.

StackOverflow powie Ci, że brakuje Ci adnotacji względem tego jak formatowana powinna być data. Dodaj nad polem daty adnotacje

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss.SSSZ")

Zadanie 7: rekurencyjne odwołania

Zauważ, że w JSONie wypisywane są całe obiekty wraz z zależnościami. Co stałoby się gdyby pracownik X miał podwładnego Y którego podwładnym byłby znów X? Otrzymalibyśmy nieskończoną rekurencję i błąd serializacji. Żeby tego uniknąć możemy zastosować adnotację:

Odkomentuj linie w ModeObjectCreator.java

emp2.getManagers().add(emp);

i dodaj:

@JsonIdentityInfo(generator=ObjectIdGenerators.IntSequenceGenerator.class,
        property="refId", scope=Employee.class)
public class Employee { ... }

Która spowoduje, że obiekty wypisywane będą tylko raz, a przy wielokrotnych odwołaniach zostanie zastosowane Id jako referencja.

Więcej na ten temat:

http://www.baeldung.com/jackson-bidirectional-relationships-and-infinite-recursion

Generowanie klas z JSON

Istnieje wiele generatorów online zamieniających JSON na klasy modelu w Java.