知識庫 / JSON / Jackson RSS 訂閱

1. 概述

JSON 對象中的字段名稱可以採用多種格式。當我們想要將它們加載到我們的 POJO 中時，可能會遇到一個問題，即 Java 代碼中的屬性名稱與 JSON 中的命名約定不匹配。

在本簡短教程中，我們將學習如何使用 Jackson 將蛇形命名 JSON 轉換為駝峯命名字段。

2. 安裝 Jackson

讓我們首先將 Jackson 依賴項 添加到我們的 pom.xml 文件中：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13</version>
</dependency>

3. 使用默認值進行反序列化

讓我們考慮一個 User 類:

public class User {
    private String firstName;
    private String lastName;

    // standard getters and setters
}

讓我們嘗試加載這個 JSON，它使用了 Snake Case 命名標準（小寫名稱之間用 _ 分隔）：

{
    "first_name": "Jackie",
    "last_name": "Chan"
}

首先，我們需要使用 ObjectMapper 將此 JSON 進行反序列化：

ObjectMapper objectMapper = new ObjectMapper();
User user = objectMapper.readValue(JSON, User.class);

然而，當我們嘗試這樣做，我們將會收到一個錯誤：

com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field "first_name" (class com.baeldung.jackson.snakecase.User), not marked as ignorable (2 known properties: "lastName", "firstName"])

不幸的是，Jackson 無法完全匹配 JSON 中的名稱與 User 中字段名稱。

接下來，我們將學習三種解決此問題的方案。

4. 使用 @JsonProperty 註解

我們可以使用 @JsonProperty 註解來將類中的字段映射到 JSON 中確切的字段名稱。

public class UserWithPropertyNames {
    @JsonProperty("first_name")
    private String firstName;
    
    @JsonProperty("last_name")
    private String lastName;

    // standard getters and setters
}

現在我們可以將 JSON 解串為 UserWithPropertyNames：

ObjectMapper objectMapper = new ObjectMapper();
UserWithPropertyNames user = objectMapper.readValue(JSON, UserWithPropertyNames.class);
assertEquals("Jackie", user.getFirstName());
assertEquals("Chan", user.getLastName());

5. 使用 @JsonNaming</em/> 註解

@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)
public class UserWithSnakeStrategy {
    private String firstName;
    private String lastName;

    // standard getters and setters
}

ObjectMapper objectMapper = new ObjectMapper();
UserWithSnakeStrategy user = objectMapper.readValue(JSON, UserWithSnakeStrategy.class);
assertEquals("Jackie", user.getFirstName());
assertEquals("Chan", user.getLastName());

ObjectMapper objectMapper = new ObjectMapper()
  .setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE);
User user = objectMapper.readValue(JSON, User.class);
assertEquals("Jackie", user.getFirstName());
assertEquals("Chan", user.getLastName());