🍀중첩된 JSON을 Java Object 로 매핑하는 방법2 (With Jackson)

이전 포스트
중첩된 JSON을 Java Object 로 매핑하는 방법1 (With Jackson)

---

🤨 들어가며

저번 포스트에서 어노테이션을 사용하여 중첩된 JSON을 자바 오브젝트로 매핑하는 방법을 다루었습니다. 그런데 문제는 제가 매핑해야할 JSON의 중첩 깊이를 보면 1~2레벨 정도가 아니었다는 거죠.

"info": {
        "gameCreation": 1662939391488,
        "mapId": 11,
        "participants": [
            {
                "assists": 3,
                "baronKills": 0,
                "basicPings": 1,
                "bountyLevel": 0,
                "challenges": {
                    "12AssistStreakCount": 0,
                    "abilityUses": 220,                  
                },
                "champExperience": 14906,
                "champLevel": 16,
                "perks": {
                    "statPerks": {
                        "defense": 5003,
                        "flex": 5008,
                        "offense": 5005
                    },
                    "styles": [
                        {
                            "description": "primaryStyle",
                            "selections": [
                                {
                                    "perk": 8010,

(다시 한번 등장 )

저번 포스트를 읽으신 분들은 아시겠지만 어노테이션을 사용하여 매핑 시, 각 중첩 JSON마다 Map<String,Object>타입을 사용하여 매핑하였습니다. 중첩이 한두개 정도면 그냥 편하게 쓰겠지만, 중첩 depth가 여러 레벨이 되면 Map 인스턴스를 계속 생성해야하는 단점이 있었습니다. 이는 효율적인 메모리 사용법이 아니라고 생각합니다. (제 생각입니다. 그렇게 큰 문제가 아니라면 댓글로 알려주시면 감사하겠습니다.)

따라서 다른 방법을 시도해보려고 합니다. 제가 중첩된 JSON을 JAVA 오브젝트로 매핑하는 방법이 3가지 정도가 있다고 말씀드렸었는데, 이번에는 그 중 두번째 방법에 대해서 설명해보겠습니다. 3번째 방법인 JsonDeserializer를 이용한 매핑은, 지금 다룰 JsonNode 매핑과 상당히 유사하여 다루지 않겠습니다.

(스포하자면 결론부에서 생각은 바뀌게 됩니다..)

<매핑하는 방법 3가지>

1. 어노테이션을 사용한 매핑
2. JsonNode를 사용한 매핑 -> 이번 포스트!
3. 사용자가 정의한 JsonDeserializer를 이용한 매핑

---

JSON 소스코드

{
    "nation": "Korea",
    "name": "Minsu",
    "address": {
        "city": "Seoul",
        "gu": "Songpa",
        "apart": {
            "apartName": "JsonApart",
            "dong": "101",
            "ho": "1501"
        }
    }  
}

매핑될 JAVA Object

public class Person {

    private String nation; //국적
    private String name; // 사람 이름
    private String city; // 사는 도시
    private String apartName; // 아파트 이름
    
}

저번과 똑같이, 한국 국적의 서울시 송파구 JsonApart 101동 1501호 사는 민수를 가져오겠습니다. 객체 또한 Person 객체를 그대로 사용하겠습니다.

---

JsonNode를 사용한 매핑

ObjectMapper의 readTree를 사용할 것입니다. 코드 먼저 보시죠

@Test
public void whenUsingJsonNode_thenOk() throws IOException {

	String SOURCE_JSON = "{"nation": "Korea","name": "Minsu","address": {"city": "Seoul","gu": "Songpa","apart": {"apartName": "JsonApart","dong": "101","ho": "1501"}}}";
    
    JsonNode personNode = new ObjectMapper().readTree(SOURCE_JSON);

    Person person = new Person();
    person.setNation(personNode.get("nation").textValue());
    person.setName(personNode.get("name").textValue());
    person.setCity(personNode.get("address")
      .get("city").textValue());
    person.setApartName(personNode.get("address")
      .get("apart").get("apartName").textValue());
	
    assertEquals(person.getNation(), "Korea");
    assertEquals(person.getName(), "Minsu");
    assertEquals(person.getCity(), "Seoul");
    assertEquals(person.getApartName(), "JsonApart");
}

저번 코드보다 직관적으로 와닿는 부분이 있습니다. 중간에 setter를 사용하는 부분은 만약 Builder 패턴으로 대체가 가능할 것 같습니다.

이 코드의 핵심은 아무래도 이 부분인 것 같습니다.

JsonNode personNode = new ObjectMapper().readTree(SOURCE_JSON);

위에서 사용한 readTree 메소드의 원형은 다음과 같습니다.

public <T extends TreeNode> T readTree(JsonParser p)

JSON을 읽어들여, TreeNode인터페이스를 리턴합니다. TreeNode란 JSON을 트리 형태로 나타낸 일종의 자료구조입니다.
제가 사용한 코드에서는 TreeNode의 구현체인 JsonNode타입을 리턴합니다.

다음 코드를 보시죠

	Person person = new Person();
    person.setNation(personNode.get("nation").textValue());
    person.setName(personNode.get("name").textValue());
    person.setCity(personNode.get("address")
      .get("city").textValue());

먼저 새로운 Person 객체를 만듭니다. JsonNode타입의 personNode에서 Person 필드에 맞는 노드들을 get() 메소드로 꺼내 textValue() 메소드로 String 형변환을 해주고 있습니다.

---

어노테이션 매핑 vs. JsonNode 매핑

이렇게 두 가지의 매핑 방법을 살펴보았습니다.
다시 한번 코드를 보고, 각각의 장단점을 생각해서 정리해보겠습니다.

• 어노테이션 매핑 코드

public class Person {
    private String nation;
    private String name;
    private String city;
    private String apartName;
	
    @SuppressWarnings("unchecked")
    @JsonProperty("address")
    private void unpackNested(Map<String,Object> address) {
        this.city = (String)address.get("city");
        Map<String,String> apart = (Map<String,String>)address.get("apart");
        this.apartName = apart.get("apartName");
    }
}

• 어노테이션 매핑 실행 코드

@Test
public void whenUsingAnnotations_thenOk() throws IOException {
    Product product = new ObjectMapper()
      .readerFor(Product.class)
      .readValue(SOURCE_JSON);	// 민수의 JSON이 넘어올 예정
}

• JsonNode 매핑 코드

@Test
public void whenUsingJsonNode_thenOk() throws IOException {

	String SOURCE_JSON = "{"nation": "Korea","name": "Minsu","address": {"city": "Seoul","gu": "Songpa","apart": {"apartName": "JsonApart","dong": "101","ho": "1501"}}}";
    
    JsonNode personNode = new ObjectMapper().readTree(SOURCE_JSON);

    Person person = new Person();
    person.setNation(personNode.get("nation").textValue());
    person.setName(personNode.get("name").textValue());
    person.setCity(personNode.get("address")
      .get("city").textValue());
    person.setApartName(personNode.get("address")
      .get("apart").get("apartName").textValue());

}

✨ 어노테이션 매핑 장점

1. 0레벨 depth의 중첩은 처리할 필요가 없다 (ObjectMapper가 알아서 해줌).
2. 한번 JAVA Object에 정의해놓으면 그 다음부터는 ObjectMapper.readValue로 처리가 가능하다.
3. 중복되는 코드는 어노테이션 매핑이 덜하다.

💥어노테이션 매핑 단점

1. 코드 레벨에서 한눈에 들어오지 않는다.
2. Map 인스턴스를 중첩 깊이마다 생성해줘야 한다.
3. 안전하지 않은 제네릭 형변환 케이스가 발생할 수 있다. (계속 경고도 뜨고)

✨JsonNode 매핑 장점

1. 코드 레벨에서 직관적으로 이해할 수 있다.
2. JsonNode 인스턴스 하나로 매핑이 가능하다.

💥JsonNode 매핑 단점

1. JAVA Object 필드 개수가 많아질 수록 getter, setter 반복이 심해진다.
2. 0레벨 depth의 중첩 또한 일일이 매핑해줘야 한다.
3. 빌더 패턴을 사용하지 않을 시, setter가 강제될 수 있다.

---

🤨 그래서 뭘쓰라고

하나의 포스트에서도 의견이 왔다 갔다 하는데 웃긴데.. 정리하고 보니 어노테이션 매핑이 낫겠다 싶습니다. 지금 Riot Api에서 응답으로 받아와서 매핑할 Dto 필드 개수가 장난이 아닌데요,

(물론 다쓰진 않고 필요한 것만 몇개 추릴 예정입니다....)
이거를 언제 다 MatchNode.set().get()... 이런 식으로 해야할지 모르겠습니다. 또한, JsonNode의 성능 또한 무조건 Map.get()보다 좋다고 할 순 없으니... (JsonNode가 어떤 구조인지는 한번 찾아봐야할 것 같습니다.) 특히 어노테이션 매핑을 사용하면 0레벨 깊이의 중첩 property는 처리하지 않아도 되니, 무조건 어노테이션 매핑을 써야할 것 같습니다.

---

마치며..

그래도 둘 사이의 비교를 하고 나니 좀 더 선택에 확신이 서는 느낌이네요.. 다행입니다!

틀린 내용, 덧붙일 내용 있으시면 댓글로 달아주세요!!
읽어주셔서 감사합니다!!

---

📚 Reference

https://www.baeldung.com/jackson-nested-values
https://www.baeldung.com/jackson-annotations