RestController에서 오브젝트 반환이 예외 처리

RestController 에서 일반 오브젝트를 반환하면 스프링이 json으로 변환하여 응답한다.

이 과정에서 오브젝트를 json으로 변환할 수 없어 예외가 발생할 수 있다.

변환 못 하는 경우는 특정 오브젝트의 컨버터가 없어서 발생할 수 있는데 getter가 존재하기면 하면 어기간한것들은 다 해줄 수 있다. 그런데 getter가 아얘 없는 클래스의 오브젝트를 반환하려고 하면 예외가 발생한다. 당연하게도 아무것도 없으니. 반환하는것 자체가 문제가 있다. 그런데 정황상 어쩔수 없는 경우 그냥 반환하게 해야할 수도 있는데 빈 오브젝트인 경우 json 생성시 무시하게 옵션을 주면 된다.

spring.jackson.serialization.FAIL_ON_EMPTY_BEANS=false

RestController에서 처리하다가 예외가 발생한 경우 @RestControllerAdvice를 사용해서 예외를 잡을 수 있다.

@RestControllerAdvice
@Slf4j
public class RestResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {
    @ExceptionHandler(
            value = {Exception.class}
    )
    protected ResponseEntity<BizServiceResult> allExceptionHandler(HttpServletResponse response) {
        response.reset(); // #1
        return new ResponseEntity<>(new BizServiceResult(ServiceResultCode.SYSTEM_ERROR,
                String.format("시스템 오류가 발생하였습니다. 담당자에게 문의하세요. 오류 코드[%s]"
                        , MDC.get(TraceConstants.SERVICE_TAG)), Collections.emptyMap()), HttpStatus.OK);
    }
}

예외 타입 별로 잡으면 된다.

문제는 #1 없이 응답 객체만 반환하면 기존에 응답처리하다가 남은 찌꺼기가 스트림에 그대로 남게된다. 변환하다가 중단된 만큼 데이터가 있고 그 위에 새로운 응답 객체가 변환되버린다. 그러면 포멧이 안맞은 json이 생길 수 있다.
#1 response Steram을 리셋시켜서 다 날려버린 후에 응답하도록 조치하면 된다.