Spring API에서 객체를 JSON 형태로 return 할 때 주의사항

API 객체 JSON return

JSON을 return하는 API형태에는 몇가지 규칙이 있다.
해당 내용은 상당히 내부적인 부분에 의거해서 동작한다.

첫째, 객체를 return 시 해당 원본 클래스의 멤버변수에는 반드시 "게터" 존재해야 한다.

쉽게 말해, 객체에 세터는 없어도 게터는 존재해야한다.

그 이유는 return 시, 객체 내 세터 유무에 따라서 응답 헤더의 타입이 달라진다.

즉, 멤버변수에 게터가 없으면 객체 내 값을 가져올 수 없기에 JSON 형태로 반환해 줄 수가 없기에 다음과 같은 에러 페이지가 표시된다.

쉽게 생각하자면 사실상 게터, 세터가 없는 경우는 드물기에, JSON을 반환 한다면 그냥 반드시 둘 다 존재해야 한다고 생각하자.

둘째, Class내 여러 멤버변수가 있을 때, 하나의 멤버변수의 "게터"만 있어도 오류는 나지 않는다.

"1"번에 의해 쉽게 예상할 수 있는데, 만약 풍선 클래스에 "풍선 가격" 과 "풍선 이름" 2가지 멤버변수가 있을 때, "풍선 가격"에만 게터가 정의되어 있고, 풍선 이름은 게터가 없는 상태라도 오류는 나지 않는다.

그 이유는 게터가 하나라도 있기에, 객체를 리턴할 때 리턴되는 Content-Type이 JSON이 되기 때문이다.

하지만, 당연하게도 "풍선 이름"은 값을 가져올 수 있는 게터가 없으므로 JSON 파일 내 reutrn 되지 않는다.

셋째, 게터로 결국 JSON 반환의 형태가 결정된다.

JSON은 key와 value로 구성된 파일 형식이다.

이 때 JSON에 들어가는 Key 값은 게터 함수 명의 get + {keyName}에서의 뒤쪽 KeyName이고

value 값은 실제 매개변수에 저장된 값이다.

무슨 말인 즉슨 아래와 같은 Price 매개변수에 대한 게터가 2개인 소스코드가 있을 때,

게터의 get을 제외한 부분이 KEY 값으로 들어간, 2개의 JSON 데이터가 출력된다.

실제로 굳이 이와같은 오류를 만날 가능성은 크지 않지만, 왜 굳이 게터가 필요할까 세터가 필요할까 등..소스코드의 기본 동작원리를 궁금해서 이것저것 테스트 해보다가 알게된 내용이다.