[SpringBoot] 7강. 응답처리 ApiResponse, HttpStatus, Exception

스프링부트에서 API 응답 처리하기

스프링부트에서 API 응답은 주로 DTO(Data Transfer Object)를 사용해 처리해요. DTO는 클라이언트와 서버 간의 데이터 전송에 사용되는 객체로, 필요한 데이터만을 포함하여 응답할 수 있도록 도와줍니다. 예를 들어, 메모를 추가하고 조회할 때, 매번 모든 필드를 노출하는 것이 아니라 필요한 정보만을 전달할 수 있도록 DTO를 설계할 수 있어요.

기본적으로, 메모 컨트롤러에서 모든 메모를 조회할 때는 findAll() 메서드를 통해 DB에서 데이터를 가져오고, 이 데이터를 가공해 DTO 형태로 변환하게 됩니다. 이렇게 하면 DB의 데이터를 클라이언트에게 안전하게 전달할 수 있죠. 이를 통해 보안과 성능을 모두 고려한 API 응답을 만들 수 있어요.

이제 DTO를 만들고, 메모 엔티티를 DTO로 변환하는 과정도 살펴볼게요. 메모 리스폰스라는 DTO를 생성하고, 필요한 필드만 포함하여 데이터 응답 형식을 정리해주는 것이죠. 이 과정을 통해 클라이언트는 필요한 정보만을 받아볼 수 있게 됩니다.

공통 응답 처리와 DTO 활용하기

응답 처리에서 중요한 것은 공통 응답 형식을 만드는 것이에요. API 응답은 성공과 실패로 나눌 수 있는데, 이 두 가지 경우를 모두 처리할 수 있는 공통 클래스를 만들어야 합니다. 예를 들어, APIResponse라는 클래스를 만들어서 메시지와 데이터를 포함하도록 할 수 있어요.

이 클래스는 성공적인 응답일 때와 실패한 응답일 때 모두 사용할 수 있죠. 예를 들어, 성공 시에는 "성공"이라는 메시지와 함께 데이터를 전달하고, 실패 시에는 "실패"라는 메시지와 에러 내용을 전달할 수 있도록 설계할 수 있어요. 이때, 제네릭을 사용해 다양한 타입의 데이터를 처리할 수 있도록 하면 훨씬 유용하답니다.

이렇게 공통 응답 클래스를 활용하면, 코드의 재사용성이 높아지고, 일관된 응답 형식을 유지할 수 있어요. 이를 통해 API의 유지보수성이 크게 향상될 거예요.

HTTP 상태 코드와 예외 처리하기

HTTP 상태 코드는 클라이언트에게 요청 처리 결과를 알려주는 중요한 요소입니다. 예를 들어, 데이터 추가에 성공했을 때는 201 Created 상태 코드를, 데이터 조회 시에는 200 OK 상태 코드를 반환해야 해요. 이 상태 코드를 적절하게 설정하는 것이 API 설계에서 매우 중요합니다.

스프링부트에서는 ResponseEntity 클래스를 사용하여 HTTP 상태 코드를 쉽게 설정할 수 있어요. 이를 통해 클라이언트에게 성공, 실패 여부를 명확하게 전달할 수 있죠. 예를 들어, 삭제 요청이 성공했을 때는 204 No Content를 반환하고, 잘못된 요청이 들어왔을 때는 400 Bad Request를 반환하는 식으로요.

또한, 예외 처리를 통해 다양한 상황에서 발생할 수 있는 에러를 관리할 수 있어요. 커스텀 예외 클래스를 만들고, 이를 핸들링하는 메서드를 작성하여 클라이언트에게 적절한 에러 메시지를 전달할 수 있습니다. 이렇게 하면 클라이언트는 보다 나은 사용자 경험을 제공받을 수 있게 되죠.