1. 概述

本快速教程演示瞭如何通過序列化時將字段的名稱更改為映射到另一個 JSON 屬性的方法。

如果您想深入瞭解以及學習更多使用 Jackson 2 的技巧，請訪問主 Jackson 教程。

2. 修改字段名稱進行序列化

使用一個簡單的實體:

public class MyDto {
    private String stringValue;

    public MyDto() {
        super();
    }

    public String getStringValue() {
        return stringValue;
    }

    public void setStringValue(String stringValue) {
        this.stringValue = stringValue;
    }
}

序列化它將產生以下 JSON:

{"stringValue":"some value"}

為了自定義輸出，使其而不是 stringValue，我們得到 – 例如 – strVal，我們需要只需註釋獲取器:

@JsonProperty("strVal")
public String getStringValue() {
    return stringValue;
}

現在，在序列化時，我們將獲得所需輸出:

{"strVal":"some value"}

一個簡單的單元測試應該驗證輸出是否正確:

@Test
public void givenNameOfFieldIsChanged_whenSerializing_thenCorrect()
  throws JsonParseException, IOException {
    ObjectMapper mapper = new ObjectMapper();
    MyDtoFieldNameChanged dtoObject = new MyDtoFieldNameChanged();
    dtoObject.setStringValue("a");

    String dtoAsString = mapper.writeValueAsString(dtoObject);

    assertThat(dtoAsString, not(containsString("stringValue")));
    assertThat(dtoAsString, containsString("strVal"));
}

3. 結論

將實體映射到特定的 JSON 格式是一項常見的任務——本文通過使用 @JsonProperty 註解來演示如何實現它。