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

🤨 들어가며

롤 전적 검색 사이트를 만들기 위해 Riot Api 를 받아와서 Java 객체에 매핑시키던 작업을 하던 중, Response body 로 넘어온 JSON 응답 데이터의 상태가 심상치 않은 것을 발견했습니다.

"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,                                  

(벌써 어지럽다)

게임의 정보를 가져오는 Match-V5 api 의 (극히)일부인데, JSON 오브젝트 안에 중첩된 객체와 JSON 배열이 너무 많습니다. 아마도 하나의 게임에 포함된 정보가 너무 많아서 그런 듯합니다. 데이터를 읽어보면 온갖 자질구레한 정보까지 주어집니다.

이 응답을 어떻게 하면 Java 객체에 매핑을 시킬까를 공부하다가 기록겸 포스트를 작성하게 되었습니다. 간단한 예시로 알아봅시다.

---

JSON 소스코드

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

한국의 사는 민수의 주소 정보를 보내주는 Json 데이터입니다. 민수는 서울시 송파구의 Json 아파트 101동 1501호에 살고있네요.

보시다시피 이 JSON은 2레벨 깊이의 중첩된 JSON으로 이루어져 있습니다. 이 JSON 데이터를 받아와 다음의 Java 객체로 매핑시키고 싶습니다.

---

매핑될 JAVA Object

public class Person {

    private String nation;
    private String name;
    private String city;
    private String apartName;
    
}

민수가 매핑될 Person 클래스. 국적, 이름, 살고있는 도시와 아파트 이름을 저장하고 있습니다.
이때, JSON이 중첩된 깊이에 따라 Person의 필드들을 다음과 같이 분류할 수 있습니다.

• 0레벨 깊이의 Property
  • nation
  • name
• 1레벨 깊이의 Property
  • city
• 2레벨 깊이의 Property
  • apartName

city 같은 경우는 address 에서 뽑아내야겠고(1레벨 깊이),
apartName 은 중첩된 apart 에서 apartName 을 뽑아내면 되겠네요(2레벨 깊이).

---

매핑 방법 3가지

이제부터 한번 매핑을 진행해봅시다!
매핑하는 방법은 총 3가지가 있는데요, 다음과 같습니다.

1. 어노테이션을 사용한 매핑
2. JsonNode를 사용한 매핑
3. 사용자가 정의한 JsonDeserializer를 이용한 매핑

저는 오늘 1. 어노테이션을 사용한 매핑만을 다룰 예정입니다.

2. JsonNode를 사용한 매핑과, 3. 사용자가 정의한 JsonDeserializer를 이용한 매핑은 구현의 관점에서는 같은 로직이라는 언급이 있고, 저는 일단 어노테이션을 사용한 매핑으로 해결할 것이기에...

만약 어노테이션을 사용한 매핑만으로 해결이 되지 않거나, 토이 프로젝트를 마무리하면 다른 포스트에서 다시 한번 다루어보도록 하겠습니다.
혹시 다른 매핑 방법에 관하여 관심있으신 분들은

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

Baeldung 사이트를 참고하시면 되겠습니다.

---

✨ 어노테이션을 사용한 매핑

먼저, 1레벨 깊이의 city 를 뽑아내기 위해서는, 중첩된 address 정보를 Map으로 풀어내어(unpack), city 속성을 추출해야 합니다.
마찬가지로, 2레벨 깊이의 apartName 를 뽑아내기 위해서, 중첩된 apart JSON 객체를 Map 으로 풀어내, apartName 속성을 추출할 것입니다.

중첩된 속성을 풀어내는 방법은, @JsonProperty 와 약간의 로직을 Person 클래스에 추가하면 됩니다. 말로만하면 이해가 잘 안가니 코드로 한번 보시죠.

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");
    }
}

코드를 살펴보도록 하겠습니다.

@SuppressWarnings("unchecked")

제네릭을 사용하는 경우에, 무점검 형변환을 했을 시 컴파일 경고 메세지를 보게 됩니다. 저희 코드에서는 ( Map<String,String> )address.get("apart"); 부분에서 경고 메세지가 발생할 것입니다. 이때, @SuppressWarings("unchecked") 어노테이션을 통해 경고 메세지를 억제할 수 있습니다. 하지만 @SuppressWarnings("unchecked")는 형 안전성이 확실할 때만 사용해야 합니다.

@JsonProperty("address")

중첩된 JSON 객체인 address를 Map<String,Object> 형식으로 unpackNested 파라미터로 넘어온 address에 매핑시키기 위함입니다. 말이 살짝 헷갈리실 수 있는데, @JsonProperty(이름) 어노테이션에서 괄호 안의 "이름"은 JSON 객체의 key를 의미한다고 생각하시면 됩니다.

private void unpackNested(Map<String,Object> address) {
        this.city = (String)address.get("city");

JSON 객체인 address 는 Map<String,Object> 타입으로 파라미터로 넘어왔죠. 그 Map에서 key가 "city"인 value를 꺼내 String 으로 형변환해주면, 필드의 private String city; 와 매핑됩니다. -> 1레벨 깊이의 매핑 완료

		Map<String,String> apart = (Map<String,String>)address.get("apart");
        this.apartName = apart.get("apartName");

Map<String,Object> 타입의 address에서, key가 "apart"인 Value를 꺼냅니다. 이때 꺼내진 2레벨 깊이의 JSON 객체를 Map<String, String>타입으로 형변환해서 새로운 Map apart를 생성합니다. 마지막으로 Map타입의 apart에서, key가 "apartName" 인 Value를 꺼내 필드의 private String apartName 과 매핑합니다. -> 2레벨 깊이의 매핑 완료

이렇게 매핑이 완료됩니다.

---

마치며..

그런데 작성해놓고 보니, 제 Riot api의 응답처럼 중첩된 depth가 1,2 레벨 수준이 아닌 경우에는 어노테이션을 사용한 매핑이 그닥 효율적으로 느껴지지 않습니다. 매 깊이마다 Map을 생성하면 오버헤드도 증가할 것이고, 무엇보다 코드 상으로 수많은 반복이 발생할 것 같습니다.
오늘 다루지 않은 JsonNode를 사용한 매핑 코드를 읽어보니 이게 낫겠다 싶네요.
그러면 다음은 JsonNode를 사용한 매핑 포스트를 작성하겠습니다.

읽어주셔서 감사합니다! 틀린 내용 지적 환영합니다!

---

📚Reference

https://www.baeldung.com/jackson-nested-values
https://www.baeldung.com/jackson-annotations
https://colinch4.github.io/2020-07-30/24/