Введение в JSON с Java

Преимущества JSON

JSON имеет три основных преимущества: (1) он может быть легко прочитан людьми, (2) он может быть эффективно проанализирован с помощью кода, и (3) он выразителен. Первое преимущество очевидно при чтении файла JSON. Хотя некоторые файлы могут стать большими и сложными — содержащими много разных объектов и массивов, — размер этих файлов громоздок, а не язык, на котором они написаны. Например, приведенные выше фрагменты могут быть легко прочитаны без использования контекста или использования определенного набора инструментов.

Аналогично, код также может относительно легко анализировать JSON; весь язык JSON может быть сведен к набору простых конечных автоматов, как описано в стандарте обмена данными JSON ECMA-404 . В следующих разделах мы увидим, что эта простота преобразуется в библиотеки синтаксического анализа JSON на Java, которые могут быстро и точно использовать строки или файлы JSON и создавать пользовательские объекты Java.

Наконец, простота интерпретации не умаляет ее выразительности. Практически любая объектная структура может быть рекурсивно сведена к объекту или массиву JSON. Те поля, которые трудно сериализовать в объекты JSON, могут быть преобразованы в строку, и их строковое значение будет использовано вместо представления их объекта. Например, если мы хотим сохранить регулярное выражение в качестве значения, мы можем сделать это, просто превратив регулярное выражение в строку.

Понимая основы JSON, мы теперь можем углубиться в детали взаимодействия с фрагментами JSON и файлами через приложения Java.

Сериализация Java-объектов в JSON

Хотя процесс токенизации и анализа строк JSON утомителен и запутан, в Java существует множество библиотек, которые инкапсулируют эту логику в простые в использовании объекты и методы, которые делают взаимодействие с JSON почти тривиальным. Одна из самых популярных среди этих библиотек — FasterXML Jackson .

Джексон сосредотачивается вокруг простой концепции:  ObjectMapper. An  ObjectMapper — это объект, который инкапсулирует логику для взятия объекта Java и его сериализации в JSON, передачи JSON и десериализации его в указанный объект Java. В первом случае мы можем создавать объекты, представляющие нашу модель, и делегировать логику создания JSON  ObjectMapper. Следуя предыдущим примерам, мы можем создать два класса для представления нашей модели: человек и адрес:

public class Person {

    private String firstName;
    private String lastName;
    private String alias;
    private int age;
    private boolean isMale;
    private Address address;

    public Person(String firstName, String lastName, String alias, int age, boolean isMale, Address address) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.alias = alias;
        this.age = age;
        this.isMale = isMale;
        this.address = address;
    }

    public Person() {}

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getAlias() {
        return alias;
    }

    public void setAlias(String alias) {
        this.alias = alias;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public boolean isMale() {
        return isMale;
    }

    public void setMale(boolean isMale) {
        this.isMale = isMale;
    }

    public Address getAddress() {
        return address;
    }

    public void setAddress(Address address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "Person [firstName=" + firstName + ", lastName=" + lastName + ", alias=" + alias + ", age=" + age
                + ", isMale=" + isMale + ", address=" + address + "]";
    }
}

public class Address {

    private String street;
    private String city;
    private String state;
    private String zipCode;

    public Address(String street, String city, String state, String zipCode) {
        this.street = street;
        this.city = city;
        this.state = state;
        this.zipCode = zipCode;
    }

    public Address() {}

    public String getStreet() {
        return street;
    }

    public void setStreet(String street) {
        this.street = street;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }

    public String getZipCode() {
        return zipCode;
    }

    public void setZipCode(String zipCode) {
        this.zipCode = zipCode;
    }

    @Override
    public String toString() {
        return "Address [street=" + street + ", city=" + city + ", state=" + state + ", zipCode=" + zipCode + "]";
    }
}

Address johnDoeAddress = new Address("100 Elm Way", "Foo City", "NJ", "01234");
Person johnDoe = new Person("John", "Doe", null, 29, true, johnDoeAddress);

ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(johnDoe);

System.out.println(json);

{"firstName":"John","lastName":"Doe","alias":null,"age":29,"address":{"street":"100 Elm Way","city":"Foo City","state":"NJ","zipCode":"01234"},"male":true}

{
   "firstName":"John",
   "lastName":"Doe",
   "alias":null,
   "age":29,
   "address":{
      "street":"100 Elm Way",
      "city":"Foo City",
      "state":"NJ",
      "zipCode":"01234"
   },
   "male":true
}

public class Person {

    // ...

    @JsonProperty("isMale") 
    public boolean isMale() {
        return isMale;
    }

    // ...
}

{
   "firstName":"John",
   "lastName":"Doe",
   "alias":null,
   "age":29,
   "address":{
      "street":"100 Elm Way",
      "city":"Foo City",
      "state":"NJ",
      "zipCode":"01234"
   },
   "isMale":true
}

@JsonInclude(Include.NON_NULL)
public class Person {
    // ...
}

{
   "firstName":"John",
   "lastName":"Doe",
   "age":29,
   "address":{
      "street":"100 Elm Way",
      "city":"Foo City",
      "state":"NJ",
      "zipCode":"01234"
   },
   "isMale":true
}

Address johnDoeAddress = new Address("100 Elm Way", "Foo City", "NJ", "01234");
Person johnDoe = new Person("John", "Doe", null, 29, true, johnDoeAddress);

Address janeDoeAddress = new Address("200 Boxer Road", "Bar City", "NJ", "09876");
Person janeDoe = new Person("Jane", "Doe", null, 27, false, janeDoeAddress);

List<Person> people = List.of(johnDoe, janeDoe);

ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(people);

System.out.println(json);

[
   {
      "firstName":"John",
      "lastName":"Doe",
      "age":29,
      "address":{
         "street":"100 Elm Way",
         "city":"Foo City",
         "state":"NJ",
         "zipCode":"01234"
      },
      "isMale":true
   },
   {
      "firstName":"Jane",
      "lastName":"Doe",
      "age":27,
      "address":{
         "street":"200 Boxer Road",
         "city":"Bar City",
         "state":"NJ",
         "zipCode":"09876"
      },
      "isMale":false
   }
]

Address johnDoeAddress = new Address("100 Elm Way", "Foo City", "NJ", "01234");
Person johnDoe = new Person("John", "Doe", null, 29, true, johnDoeAddress);

ObjectMapper mapper = new ObjectMapper();
mapper.writeValue(new File("john.json"), johnDoe);

String json = "{\"firstName\":\"John\",\"lastName\":\"Doe\",\"alias\":\"Jay\","
    + "\"age\":29,\"address\":{\"street\":\"100 Elm Way\",\"city\":\"Foo City\","
    + "\"state\":\"NJ\",\"zipCode\":\"01234\"},\"isMale\":true}";

ObjectMapper mapper = new ObjectMapper();
Person johnDoe = mapper.readValue(json, Person.class);
System.out.println(johnDoe);

Person [firstName=John, lastName=Doe, alias=Jay, age=29, isMale=true, address=Address [street=100 Elm Way, city=Foo City, state=NJ, zipCode=01234]]

@JsonIgnoreProperties(ignoreUnknown = true)
public class Person {
    // ...
}

String json = "{\"firstName\":\"John\",\"lastName\":\"Doe\",\"alias\":\"Jay\","
    + "\"age\":29,\"address\":{\"street\":\"100 Elm Way\",\"city\":\"Foo City\","
    + "\"state\":\"NJ\",\"zipCode\":\"01234\"},\"isMale\":true, \"favoriteColor\":\"blue\"}";

ObjectMapper mapper = new ObjectMapper();
Person johnDoe = mapper.readValue(json, Person.class);
System.out.println(johnDoe);

Person [firstName=John, lastName=Doe, alias=Jay, age=29, isMale=true, address=Address [street=100 Elm Way, city=Foo City, state=NJ, zipCode=01234]]

String json = "[{\"firstName\":\"John\",\"lastName\":\"Doe\",\"age\":29,"
    + "\"address\":{\"street\":\"100 Elm Way\",\"city\":\"Foo City\","
    + "\"state\":\"NJ\",\"zipCode\":\"01234\"},\"isMale\":true},"
    + "{\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"age\":27,"
    + "\"address\":{\"street\":\"200 Boxer Road\",\"city\":\"Bar City\","
    + "\"state\":\"NJ\",\"zipCode\":\"09876\"},\"isMale\":false}]";

ObjectMapper mapper = new ObjectMapper();
@SuppressWarnings("unchecked")
List<Person> people = (List<Person>) mapper.readValue(json, List.class);

System.out.println(people);

[{firstName=John, lastName=Doe, age=29, address={street=100 Elm Way, city=Foo City, state=NJ, zipCode=01234}, isMale=true}, {firstName=Jane, lastName=Doe, age=27, address={street=200 Boxer Road, city=Bar City, state=NJ, zipCode=09876}, isMale=false}]

{"firstName":"John","lastName":"Doe","alias":"Jay","age":29,"address":{"street":"100 Elm Way","city":"Foo City","state":"NJ","zipCode":"01234"},"isMale":true}

ObjectMapper mapper = new ObjectMapper();
Person johnDoe = mapper.readValue(new File("john.json"), Person.class);
System.out.println(johnDoe);

Person [firstName=John, lastName=Doe, alias=null, age=29, isMale=true, address=Address [street=100 Elm Way, city=Foo City, state=NJ, zipCode=01234]]