common: exception handling policy - takeoff-26/logistics-service GitHub Wiki

exception handling policy

MSA에서도 전역적인 exception에 대한 관리가 필요하다.
exception에 대해 공통된 처리, 반환되는 에러 코드나 응답 형식을 통일해야 하며 각각 비즈니스에 맞춰 해당 오류를 처리해 반환하게 되는 메시지는 다를 것이다.
응답과 코드에 대해서는 통일성을 가지되 사용되고 반환되는 메시지에 대한 값을 일관적으로 관리하고 번환하기 위해 생성했다.
공통으로 적용될 부분이다 보니 역시 Common에 위치하게 되었고 이번에는 exception에 대한 처리를 더 세분화해 처리하게 되었다.
에러처리에 대한 흐름은 이전과 비슷하니 그림으로 확인하고 로직으로 진행하도록 하겠다.

---

@Getter
public class BusinessException extends RuntimeException {

	private final ErrorCode errorCode;

	public static BusinessException from(ErrorCode errorCode) {
		return new BusinessException(errorCode);
	}

	protected BusinessException(ErrorCode errorCode) {
		super(errorCode.getMessage());
		this.errorCode = errorCode;
	}
}

---

public record ErrorResponse(String code, String message, int status, List<ValidationError> errors) {

	static final String ILLEGAL_ERROR_CODE = "ILL_001";

	public static ErrorResponse of(ErrorCode errorCode) {
		return new ErrorResponse(
			errorCode.getCode(),
			errorCode.getMessage(),
			errorCode.getStatus(),
			Collections.emptyList()
		);
	}

	public static ErrorResponse of(String message, int status) {
		return new ErrorResponse(
			ILLEGAL_ERROR_CODE,
			message,
			status,
			Collections.emptyList()
		);
	}

	public static ErrorResponse of(BindingResult bindingResult) {
		return new ErrorResponse(
			VALIDATION_ERROR.getCode(),
			VALIDATION_ERROR.getMessage(),
			VALIDATION_ERROR.getStatus(),
			ValidationError.ofFieldErrors(bindingResult.getFieldErrors())
		);
	}

	public static ErrorResponse of(Set<ConstraintViolation<?>> violations) {
		return new ErrorResponse(
			CONSTRAINT_VIOLATION.getCode(),
			CONSTRAINT_VIOLATION.getMessage(),
			CONSTRAINT_VIOLATION.getStatus(),
			ValidationError.ofConstraintViolations(violations)
		);
	}

	public record ValidationError(
		String field,
		String rejectedValue,
		String reason
	) {

		private static List<ValidationError> ofFieldErrors(
			List<org.springframework.validation.FieldError> fieldErrors) {
			return fieldErrors.stream()
				.map(error -> new ValidationError(
					error.getField(),
					error.getRejectedValue() == null ?
						"" : String.valueOf(error.getRejectedValue()),
					error.getDefaultMessage()))
				.toList();
		}

		private static List<ValidationError> ofConstraintViolations(
			Set<ConstraintViolation<?>> constraintViolations) {
			return constraintViolations.stream()
				.map(violation -> new ValidationError(
					violation.getPropertyPath().toString(),
					violation.getInvalidValue() == null ?
						"" : String.valueOf(violation.getInvalidValue()),
					violation.getMessage()))
				.toList();
		}
	}
}

---

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

	@ExceptionHandler(BusinessException.class)
	public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException e) {
		ErrorResponse errorResponse = ErrorResponse.of(e.getErrorCode());
		return ResponseEntity.status(errorResponse.status()).body(errorResponse);
	}

	@ExceptionHandler(MethodArgumentNotValidException.class)
	public ResponseEntity<ErrorResponse> handleMethodArgumentNotValidException(
		MethodArgumentNotValidException e) {
		ErrorResponse errorResponse = ErrorResponse.of(e.getBindingResult());
		return ResponseEntity.status(errorResponse.status()).body(errorResponse);
	}

	@ExceptionHandler(ConstraintViolationException.class)
	public ResponseEntity<ErrorResponse> handleConstraintViolationException(
		ConstraintViolationException e) {
		ErrorResponse errorResponse = ErrorResponse.of(e.getConstraintViolations());
		return ResponseEntity.status(errorResponse.status()).body(errorResponse);
	}

	@ExceptionHandler(HttpRequestMethodNotSupportedException.class)
	public ResponseEntity<ErrorResponse> handleHttpRequestMethodNotSupportedException(
		HttpRequestMethodNotSupportedException e) {
		log.error(e.getMessage(), e);
		ErrorResponse errorResponse = ErrorResponse.of(METHOD_NOT_ALLOWED);
		return ResponseEntity.status(errorResponse.status()).body(errorResponse);
	}

	@ExceptionHandler(Exception.class)
	public ResponseEntity<ErrorResponse> handleException(Exception e) {
		log.error(e.getMessage(), e);
		ErrorResponse errorResponse = ErrorResponse.of(INTERNAL_SERVER_ERROR);
		return ResponseEntity.status(errorResponse.status()).body(errorResponse);
	}

	@ExceptionHandler(IllegalStateException.class)
	public ResponseEntity<ErrorResponse> handleIllegalStateException(IllegalStateException e) {
		ErrorResponse errorResponse = ErrorResponse.of(e.getMessage(), HttpStatus.CONFLICT.value());
		return ResponseEntity.status(errorResponse.status()).body(errorResponse);
	}

	@ExceptionHandler(IllegalArgumentException.class)
	public ResponseEntity<ErrorResponse> handleIllegalArgumentException(IllegalArgumentException e) {
		ErrorResponse errorResponse = ErrorResponse.of(e.getMessage(), HttpStatus.BAD_REQUEST.value());
		return ResponseEntity.status(errorResponse.status()).body(errorResponse);
	}
}

---

public interface ErrorCode {

	String getCode();
	String getMessage();
	int getStatus();
}

---

위 ErrorCode를 상속 받아 각 비즈니스에서 본인의 에러처리에 맞는 메시지를 설정하고 사용하게 된다.