Jackson 어노테이션 사용법#

  • Jackson Annotation Examples 예제를 적용전, 적용후로 나누어서 정리 해봤습니다.
  • 2.Jackson Serialization Annotations 정리 (3,4… 추후 계속 추가될 예정)
  • 테스트코드도 참고하시면 좋습니다.
  • 해당 코드는 Github를 참고해주세요

2 Jackson Serialization Annotations#

2.1. @JsonAnyGetter#

  • 이 엔티티의 인스턴스를 직렬화 할 때 Map의 모든 키 - 값 을 표준 일반 속성으로 가져옵니다
1
2
3
4
5
6
7
8
9
10
11
@Getter
@Builder
public static class ExtendableBean {
    public String name;
    private Map<String, String> properties;

    @JsonAnyGetter
    public Map<String, String> getProperties() {
        return properties;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
//적용전
{
  "name": "yun",
  "properties": {
    "key1": "value1",
    "key2": "value2"
  }
}
//적용후
{
  "name": "yun",
  "key1": "value1",
  "key2": "value2"
}

2.2. @JsonGetter#

  • getter 이름 기반으로 키값이 정해지는것을 어노테이션을 제어
1
2
3
4
5
6
7
8
9
10
@Builder
public static class MyBean {
    public int id;
    private String name;

    @JsonGetter("name")
    public String getTheName() {
        return name;
    }
}
1
2
3
4
5
6
7
8
9
10
//적용전
{
  "id": 1,
  "theName": "yun"
}
//적용후
{
  "id": 1,
  "name": "yun"
}

2.3. @JsonPropertyOrder#

  • Json 직렬화 순서를 제어
1
2
3
4
5
6
@JsonPropertyOrder({"name", "id"})
@Builder
public static class PropertyOrder {
    private long id;
    private String name;
}
1
2
3
4
5
6
7
8
9
10
//적용전
{
  "id": 1,
  "name": "name"
}
//적용후
{
  "name": "name",
  "id": 1
}

2.4. @JsonRawValue#

  • @JsonRawValue 는 Jackson이 속성을 그대로 직렬화하여 JSON으로 변경
1
2
3
4
5
6
7
@Builder
    public static class RawBean {
        public String name;

        @JsonRawValue
        public String json;
    }
1
2
3
4
5
6
7
8
9
10
11
12
//적용전
{
  "name": "yun",
  "json": "{\n  \"attr\":false\n}"
}
//적용후
{
  "name": "yun",
  "json": {
    "attr": false
  }
}

2.5. @JsonValue#

  • getName 에 @JsonValue 해당 멤버필드가 이름을 통해 직렬화 시킴
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public enum TypeEnumWithValue {
    TYPE1(1, "Type A"),
    TYPE2(2, "Type 2");

    private Integer id;
    private String name;

    TypeEnumWithValue(Integer id, String name) {
        this.id = id;
        this.name = name;
    }

    @JsonValue
    public String getName() {
        return name;
    }
}
1
2
3
4
//적용전
"TYPE1"
//적용후
"Type A"

2.6. @JsonRootName#

  • Root 이름 지정
1
2
3
4
5
6
7
8
@Builder
@JsonRootName(value = "user")
public static class UserWithRoot {
    public int id;
    public String name;
}

//objectMapper.enable(SerializationFeature.WRAP_ROOT_VALUE); 반드시 적용해야함
1
2
3
4
5
6
7
8
9
10
11
12
//적용전
{
  "id": 1,
  "name": "yun"
}
//적용후
{
  "user": {
    "id": 1,
    "name": "yun"
  }
}