[공공데이터] @JsonProperty 활용법

최근 개인 프로젝트를 진행하면서 공공데이터 포털에서 제공하는  『식품영양성분DB정보 API』를 연동해 활용해 보고 있다.

 

📩 Postman 요청 테스트

먼저 포스트맨으로 API 요청을 보내봤다. 그런데 받은 응답이 다음과 같았다.

 

응답 메시지를 보고 처음 든 생각은 이랬다.

"amtNum1": "75.00", "amtNum2": "83.70"......? 엥?

 

필드명이 정확히 어떤 정보를 담고 있는지 바로 이해할 수 없었다.

아마 XML 원본 데이터의 네이밍을 그대로 JSON으로 변환하면서 이런 결과가 나온 것 같다.

 

프로젝트를 진행할 때, 이렇게 의미가 모호한 필드명을 프론트엔드 개발자나 최종 사용자에게 그대로 전달하는 것은 좋지 않은 방법이라고 배웠다.

그래서 어떻게 하면 좋을까 고민하다가, Spring에서 제공하는 Jackson의 @JsonProperty를 사용하면 key를 매핑 시킬수 있다는 것을 알게 되었다.

@JsonProperty란?

@JsonProperty는 Java 객체 필드와 JSON 키 값을 서로 다르게 지정할 때 사용하는 어노테이션이다. 즉, DTO 클래스 내부 필드명과 JSON 응답으로 내려가는 필드명을 다르게 설정할 수 있다.

@JsonProperty("원하는_필드명")
private String 실제필드명;

 

이렇게 선언하면, Java DTO 내부에서는 실제필드명을 그대로 사용하지만,

JSON 응답에서는 "원하는_필드명"으로 나타난다.

 

현재 DTO 클래스에 @JsonProperty을 적용해 보았다.

@Getter
@NoArgsConstructor
public class FoodItemResponseDto {

    private String foodCd;
    private String foodNmKr;
    private String dbGrpNm;
    private String dbClassNm;
    private String servingSize;
    private String amtNum1;
    private String amtNum2;

    public FoodItemResponseDto(String foodCd, String foodNmKr,
                               String dbGrpNm, String dbClassNm,
                               String servingSize, String amtNum1,
                               String amtNum2) {
        this.foodCd = foodCd;
        this.foodNmKr = foodNmKr;
        this.dbGrpNm = dbGrpNm;
        this.dbClassNm = dbClassNm;
        this.servingSize = servingSize;
        this.amtNum1 = amtNum1;
        this.amtNum2 = amtNum2;
    }
}

---

@Getter
@NoArgsConstructor
public class FoodItemResponseDto {

    @JsonProperty("식품코드")
    private String foodCd;

    @JsonProperty("식품명")
    private String foodNmKr;

    @JsonProperty("식품 그룹명")
    private String dbGrpNm;

    @JsonProperty("식품 분류명")
    private String dbClassNm;

    @JsonProperty("1회 제공량")
    private String servingSize;

    @JsonProperty("에너지(Kcal)")
    private String amtNum1;

    @JsonProperty("탄수화물(g)")
    private String amtNum2;

적용 후 다시 API 요청을 보냈더니, 결과는!!

📩 응답 결과 확인

 

이제 API 응답 결과를 보면 정확히 어떤 데이터를 의미하는지 한눈에 알 수 있게 되었다.

---

👩🏻‍💻 마무리

@JsonProperty 어노테이션을 사용하면서 협업과 유지보수 관점에서 큰 장점이 있다는 걸 알게 되었다.

 

특히 공공데이터 포털이나 외부 API를 연동할 때는 이런 네이밍 이슈가 종종 발생하기 때문에, 더욱 유용한 방법인 것 같다.

앞으로도 프로젝트를 진행하면서 얻은 간단하지만 유용한 경험들을 꾸준히 기록해봐야겠다!