Java for Beginner

Jackson

Аннотации Jackson для десериализации и изменения структуры JSON

Иногда структура входящего JSON не совпадает напрямую с полями Java-объекта. Для корректной десериализации в таких случаях Jackson предлагает ряд аннотаций, среди которых особенно важны @JsonCreator, @JsonSetter и @JsonAlias.

@JsonCreator

Аннотация @JsonCreator позволяет указать, какой именно конструктор или фабричный метод должен использоваться для создания объекта из JSON.
Особенно полезна в случаях, когда объект должен быть создан через специфический конструктор, а не через пустой и геттеры/сеттеры.

Пример:

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

public class User {
    private final String name;
    private final int age;

    @JsonCreator
    public User(@JsonProperty("name") String name, 
                @JsonProperty("age") int age) {
        this.name = name;
        this.age = age;
    }

    // Только геттеры
    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }
}

При десериализации Jackson использует указанный конструктор, а не требует пустой конструктор и сеттеры:

String json = "{\"name\":\"Alice\",\"age\":30}";
User user = objectMapper.readValue(json, User.class);

@JsonSetter

Аннотация @JsonSetter указывается на методе и сообщает Jackson, что данный метод должен использоваться для установки значения при десериализации.
Это полезно, когда метод сеттера отличается по названию от поля или нужно выполнить какую-то дополнительную обработку значения.

Пример:

import com.fasterxml.jackson.annotation.JsonSetter;

public class Product {
    private String name;

    public Product() {}

    public String getName() {
        return name;
    }

    @JsonSetter("product_name")
    public void setName(String name) {
        this.name = name.toUpperCase();
    }
}

JSON:

{
  "product_name": "laptop"
}

При десериализации будет вызван метод setName, а имя продукта будет автоматически приведено к верхнему регистру: "LAPTOP".

@JsonAlias

Аннотация @JsonAlias позволяет указывать альтернативные имена полей, которые могут приходить в JSON. Это особенно полезно для работы с нестабильными или изменяющимися API.

Пример:

import com.fasterxml.jackson.annotation.JsonAlias;

public class Customer {
    @JsonAlias({"user_name", "login"})
    private String username;

    public Customer() {}

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }
}

Теперь следующий JSON будет корректно обработан:

{ "user_name": "admin" }

или

{ "login": "admin" }

И в обоих случаях значение попадет в поле username.

Пример нестандартного маппинга

Иногда API может менять структуру данных или использовать разные названия для одного и того же поля. Комбинируя @JsonCreator, @JsonProperty и @JsonAlias, можно добиться правильной обработки даже самых нестандартных случаев.

Например:

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonAlias;

public class Employee {
    private final String id;
    private final String fullName;

    @JsonCreator
    public Employee(@JsonProperty("id") String id,
                    @JsonProperty("full_name") @JsonAlias({"name", "fullname"}) String fullName) {
        this.id = id;
        this.fullName = fullName;
    }

    public String getId() {
        return id;
    }

    public String getFullName() {
        return fullName;
    }
}

Теперь Jackson корректно обработает JSON, где имя сотрудника приходит под разными ключами: full_name, name или fullname.

#Java #Training #Medium #Jackson #JsonCreator #JsonSetter #JsonAlias

135 views14:59

About

Blog

Apps

Platform