目錄

• 1. @JsonProperty
• 2. @JsonFormat
• 3. @JsonIgnore
• 4. @JsonIgnoreProperties
• 5. @JsonInclude
• 6. @JsonTypeInfo 和 @JsonSubTypes
• 7. @JsonView
• 8. @JsonNaming
• 9. @JsonSerialize 和 @JsonDeserialize
• 10. @JsonAnyGetter 和 @JsonAnySetter
• 11. @JsonIdentityInfo
• 總結(jié)

1. @JsonProperty

@JsonProperty 注解用于自定義 JSON 屬性名稱，以及在序列化和反序列化過(guò)程中控制屬性的包含。通過(guò)使用這個(gè)注解，您可以確保 JSON 數(shù)據(jù)與 Java 對(duì)象之間正確映射。

public class User {
    @JsonProperty("first_name")
    private String firstName;
    // ...
}

2. @JsonFormat

@JsonFormat 注解用于指定日期、時(shí)間和數(shù)字的格式。這使得您可以自定義如何在 JSON 中表示這些值。

public class User {
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
    private LocalDate birthDate;
    // ...
}

3. @JsonIgnore

@JsonIgnore 注解用于在序列化和反序列化過(guò)程中忽略某個(gè)屬性。這在處理敏感數(shù)據(jù)或不需要序列化的字段時(shí)非常有用。

public class User {
    @JsonIgnore
    private String password;
    // ...
}

4. @JsonIgnoreProperties

@JsonIgnoreProperties 注解用于在類級(jí)別忽略一個(gè)或多個(gè)屬性。這對(duì)于在處理來(lái)自外部系統(tǒng)的 JSON 數(shù)據(jù)時(shí)忽略未知屬性很有用。

@JsonIgnoreProperties({"age", "address"})
public class User {
    // ...
}

5. @JsonInclude

@JsonInclude 注解用于指定僅在某些條件下才包含屬性。例如，您可以要求僅在屬性具有非空值時(shí)才包含它。

@JsonInclude(JsonInclude.Include.NON_NULL)
public class User {
    private String middleName;
    // ...
}

6. @JsonTypeInfo 和 @JsonSubTypes

@JsonTypeInfo 和 @JsonSubTypes 注解用于處理多態(tài)類型。這些注解使得在序列化和反序列化時(shí)能夠正確處理繼承關(guān)系和類型信息。

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({
    @JsonSubTypes.Type(value = Manager.class, name = "manager"),
    @JsonSubTypes.Type(value = Employee.class, name = "employee")
})
public abstract class Person {
    // ...
}

7. @JsonView

@JsonView 注解用于根據(jù)視圖定義序列化時(shí)包含的屬性。這允許您根據(jù)不同的上下文返回不同的 JSON 結(jié)構(gòu)。

public class User {
    @JsonView(Views.Public.class)
    private String firstName;
    @JsonView(Views.Internal.class)
    private String ssn;
    // ...
}

8. @JsonNaming

@JsonNaming 注解用于自定義屬性名稱的命名策略。例如，您可以將所有屬性名稱自動(dòng)轉(zhuǎn)換為蛇形命名法。

@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)
public class User {
    private String firstName;
    private String lastName;
    // ...
}

9. @JsonSerialize 和 @JsonDeserialize

@JsonSerialize 和 @JsonDeserialize 注解用于指定自定義的序列化和反序列化器。這在處理復(fù)雜的數(shù)據(jù)類型或需要定制序列化邏輯的情況下非常有用。

public class User {
    @JsonSerialize(using = CustomDateSerializer.class)
    @JsonDeserialize(using = CustomDateDeserializer.class)
    private LocalDate birthDate;
    // ...
}

10. @JsonAnyGetter 和 @JsonAnySetter

@JsonAnyGetter 和 @JsonAnySetter 注解用于處理動(dòng)態(tài)屬性。這些注解允許您在序列化和反序列化過(guò)程中處理未知或動(dòng)態(tài)生成的屬性。

public class User {
    private Map<String, Object> properties;

    @JsonAnyGetter
    public Map<String, Object> getProperties() {
        return properties;
    }

    @JsonAnySetter
    public void setProperty(String key, Object value) {
        properties.put(key, value);
    }
    // ...
}

11. @JsonIdentityInfo

@JsonIdentityInfo 注解用于處理循環(huán)引用和重復(fù)引用的問(wèn)題。它可以確保在序列化和反序列化過(guò)程中正確處理對(duì)象間的關(guān)系。

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
public class User {
    private int id;
    private List<User> friends;
    // ...
}

總結(jié)

Jackson 提供了豐富的注解來(lái)處理各種 JSON 序列化和反序列化需求。通過(guò)了解這些注解及其用途，您將能夠更高效地處理 JSON 數(shù)據(jù)。請(qǐng)記住，根據(jù)您的需求和具體場(chǎng)景選擇合適的注解非常重要。希望本文能幫助您更好地理解和使用 Jackson 注解。