ResponseEntity 대신 Custom DTO 를 리턴할 때 주의할 점 (feat. @ResponseBody)

[ 기존 예외처리 핸들러 코드 ]

리턴 타입이 ResponseEntity 인 클래스다. 문제없이 에러처리를 하고 있었는데,

리턴 타입을 KlagoExceptionDTO 로 바꾸어 보고 싶었습니다. (KlagoExceptionDTO 는 커스텀 예외처리 DTO 입니다.)

 

이유는 ResponseEntity의 두번째 인자로 매번 httpStatus 코드를 삽입해야했기 때문인데,

@ResponseStatus() 어노테이션을 붙이면 조금더 직관적인 코드가 될 것이라 생각했습니다. 

( * 사실 httpStatus 를 넘기는 것과 @ResponseStatus() 어노테이션을 붙이는 것의 차이는 잘 모르겠다. ) 

@ControllerAdvice
public class KlagoExceptionAdvice {

    @ExceptionHandler(KlagoCustomException.class)
    public ResponseEntity<?> invalidParamException(KlagoCustomException e) {
        HttpStatus httpStatus = HttpStatus.BAD_REQUEST;

        KlagoExceptionDTO klagoExceptionDTO = new KlagoExceptionDTO(
                e.getCode(),
                e.getMessage(),
                e
        );
        return new ResponseEntity<>(klagoExceptionDTO, httpStatus);
    }
}

 

 

[ 리턴 타입 변경한 코드 ]

아래처럼 수정하였는데 javax.servlet.ServletException 이 발생했습니다.

@ControllerAdvice
public class KlagoExceptionAdvice {

    @ExceptionHandler(KlagoCustomException.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public KlagoExceptionDTO invalidParamException(KlagoCustomException e) {

        KlagoExceptionDTO klagoExceptionDTO = new KlagoExceptionDTO(
                e.getCode(),
                e.getMessage(),
                e
        );
        return klagoExceptionDTO;
    }
}

[err] javax.servlet.ServletException: Circular view path [selectTest]: would dispatch back to the current handler URL ...

 

---

 

에러 발생의 원인은 @ResponseBody 의 부재 때문입니다. 

서버에서 클라이언트로 응답을 보낼 땐, 본문에 데이터를 담아서 보내야하는데 이 본문이 바로 HTTP 의 body 에 해당됩니다.

즉 요청본문은 requestBody, 응답본문은 responseBody 에 담아서 보내야합니다.

 

그렇다면 수정 전 코드인 ResponseEntity<> 타입을 리턴할 땐 ServletException 이 발생하지 않았던 이유를 추론 할 수 있습니다.

우선 ResponseEntity 내부를 까보겠습니다. 첫번째 파라미터에 body 라고 명시돼 있는걸 확인할 수 있습니다.

 

즉 ResponseEntity 타입을 사용한다는건 자동으로 HTTP 의 body 를 포함한다는 뜻입니다.

그리하여 문제없이 ResponseBody 에 데이터(KlagoExceptionDTO, httpStatus) 를 담아 클라이언트로 보낼 수 있습니다. 

 

 

[ 해결방법 ]

그렇다면 ResponseEntity 를 사용하지 않고 클라이언트에게 응답을 보내려면 어떻게 해야할까요 ?

클라이언트에게 응답을 보내는 Controller 를 생각해보겠습니다. 딱히 ResponseEntity 를 사용하지 않더라도 응답을 잘 보낼 수 있었습니다.

이유는 바로 @ResponseBody  어노테이션 덕분인데요, 해당 어노테이션을 사용하면 자바 객체를 HTTP 응답 본문의 객체로 변환하여 클라이언트로 전송할 수 있기 때문입니다.

 

그렇기에 @ResponseBody 어노테이션을 KlagoExceptionAdvice 클래스에 붙여주면, klagoExceptionDTO 라는 자바 객체를 HTTP Body 에 담아 클라이언트로 보낼 수 있습니다.

코드를 아래와 같이 수정하면 정상적으로 예외를 반환할 수 있습니다.

@ControllerAdvice
@ResponseBody // <- 추가된 부분
public class KlagoExceptionAdvice {

    @ExceptionHandler(KlagoCustomException.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public KlagoExceptionDTO invalidParamException(KlagoCustomException e) {

        KlagoExceptionDTO klagoExceptionDTO = new KlagoExceptionDTO(
                e.getCode(),
                e.getMessage(),
                e
        );
        return klagoExceptionDTO;
    }
}

 

 

+ 조금 더 수정을 하자면, @ControllerAdvice 를 @RestControllerAdvice 로 바꿔주면 @ResponseBody 의 역할까지 할 수 있습니다.

간단하게 표현하자면, @RestControllerAdvice = @ControllerAdvice + @ResponseBody 로 볼 수 있습니다.

 

@RestControllerAdvice  // <- @ControllerAdvice + @ResponseBody
public class KlagoExceptionAdvice {

    @ExceptionHandler(KlagoCustomException.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public KlagoExceptionDTO invalidParamException(KlagoCustomException e) {

        KlagoExceptionDTO klagoExceptionDTO = new KlagoExceptionDTO(
                e.getCode(),
                e.getMessage(),
                e
        );
        return klagoExceptionDTO;
    }
}

 

 

 

[ 결과 ]

그리하여 ResponseEntity<> 대신 KlagoExceptionDTO 타입의 객체를 클라이언트로 리턴할 수 있고, 

@ResponseStatus() 어노테이션도 사용하여 지정한 상태코드를 반환할 수 있게 됐습니다.