1. 기존의 사용하던 BaseException의 문제점

BaseResponse라는 커스텀 객체에 BaseException 객체를 보내서 결과 코드를 전송하는 방식이었다.

package com.sinor.cache.common;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor
@JsonPropertyOrder({"isSuccess", "code", "message", "data"})
public class BaseResponse<T> {
	@JsonProperty("isSuccess")
	private final Boolean isSuccess;
	private final int code;
	private final String message;
	@JsonInclude(JsonInclude.Include.NON_NULL)
	private T data;

	// 요청에 성공한 경우
	public BaseResponse(BaseResponseStatus status, T data) {
		this.isSuccess = status.isSuccess();
		this.message = status.getMessage();
		this.code = status.getCode();
		this.data = data;
	}

	// 요청에 실패한 경우
	public BaseResponse(BaseResponseStatus status) {
		this.isSuccess = status.isSuccess();
		this.message = status.getMessage();
		this.code = status.getCode();
	}

}

해당 Response에

package com.sinor.cache.common;

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class BaseException extends Exception {
	private BaseResponseStatus status;

	public BaseException(BaseResponseStatus status) {
		super(status.getMessage());
		fillInStackTrace();
		this.status = status;
	}

}

을 담아서 Status를 Body에 담아서 결과를 반환하는 형태였는데 이는 문제점이 많았다.

문제점

• 우선 무조건 200 ok 코드를 반환하고 그 안의 Body에 Status를 반환하기 때문에 클라이언트 입장에서는 안에 있는 Status를 확인해야 성공 여부를 알 수 있다는 점이었다.
  • 즉 일단 무조건 200 ok가 온다는 가정하에 안에 있는 코드를 확인해서 에러 처리를 해줘야하는 불편함이 생긴다.
• 미쳐 정의하지 못한 에러에 대한 문제도 발생한다.
  • 정의 하지 않은 에러가 발생할 경우 200 ok로 날아가는 것이 아닌 실제 에러코드 Response가 반환된다.
  • 클라이언트는 서버가 미쳐 정의하지 못한 예외로 인해 해당 에러 반환에 대한 처리 코드 또한 작성해야된다는 문제가 생긴다.

2. Global Exception Handler

@RestControllerAdvice 와 @ExceptionHandler를 사용하여 전역의 RestController에서 Excetion을 감지하는 클래스를 정의한다.

package com.sinor.cache.common;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@RestControllerAdvice
public class GlobalBindingControllerAdvice {
	@ExceptionHandler(BaseException.class)
	public ResponseEntity<?> customException(BaseException e){
		log.error("Base exception occurred" + e.getStatus().getCode(), e);

		Map<String, Object> responseBody = new HashMap<>();
		responseBody.put("isSuccess", e.getStatus().isSuccess());
		responseBody.put("status", e.getStatus().getCode());
		responseBody.put("message", e.getStatus().getMessage());

		return ResponseEntity.status((e).getStatus().getCode()).body(responseBody);
	}
}

• CustomException에서 전달받은 Status code 값을 이용해서 response를 형성하고 결과코드를 반환한다.

결과

• 기존 방식 결과

  

  • 200 code로 반환된 결과 안 Body안에 500 code로 결과가 전달되어 나온다

• 변경된 방식 결과

  

  • Body에 담긴 status와 같은 500 code 형태로 반환된다.

3. 뭔가 맘에 안든다.

• Handler 클래스의 Map을 사용하는 점.