#14 [feat] Spring Rest Controller Advice 구현

src/main/java/com/universe/uni/controller/ControllerExceptionAdvice.java

@@ -0,0 +1,90 @@
+package com.universe.uni.controller;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.MissingPathVariableException;
+import org.springframework.web.bind.MissingRequestHeaderException;
+import org.springframework.web.bind.MissingServletRequestParameterException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseStatus;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+
+import com.universe.uni.exception.ApiException;
+import com.universe.uni.exception.dto.ErrorResponse;
+import com.universe.uni.exception.dto.ErrorType;
+
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+@RestControllerAdvice
+public class ControllerExceptionAdvice extends ResponseEntityExceptionHandler {
+
+	/**
+	 * 400 BAD_REQUEST
+	 */
+	@Override
+	protected ResponseEntity<Object> handleMethodArgumentNotValid(
+		MethodArgumentNotValidException exception,
+		HttpHeaders headers,
+		HttpStatus status,
+		WebRequest request
+	) {
+		ErrorResponse errorResponse = ErrorResponse.error(ErrorType.VALIDATION_REQUEST_MISSING_EXCEPTION);
+		return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
+	}
+
+	@Override
+	protected ResponseEntity<Object> handleMissingServletRequestParameter(
+		MissingServletRequestParameterException exception,
+		HttpHeaders headers,
+		HttpStatus status,
+		WebRequest request
+	) {
+		ErrorResponse errorResponse = ErrorResponse.error(ErrorType.VALIDATION_REQUEST_MISSING_EXCEPTION);
+		return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
+	}
+
+	@Override
+	protected ResponseEntity<Object> handleMissingPathVariable(
+		MissingPathVariableException exception,
+		HttpHeaders headers,
+		HttpStatus status,
+		WebRequest request
+	) {
+		ErrorResponse errorResponse = ErrorResponse.error(ErrorType.VALIDATION_REQUEST_MISSING_EXCEPTION);
+		return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
+	}
+
+	@ExceptionHandler(MissingRequestHeaderException.class)
+	protected ResponseEntity<Object> handleMissingRequestHeaderException(
+		MissingRequestHeaderException exception
+	) {
+		ErrorResponse errorResponse = ErrorResponse.error(ErrorType.VALIDATION_EXCEPTION);
+		return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
+	}
+
+	/**
+	 * 500 Internal Server
+	 */
+	@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
+	@ExceptionHandler(Exception.class)
+	protected ErrorResponse handleException(
+		final Exception exception
+	) {
+		return ErrorResponse.error(ErrorType.INTERNAL_SERVER_ERROR);
+	}
+
+	/**
+	 * Api custom error
+	 */
+	@ExceptionHandler(ApiException.class)
+	protected ResponseEntity handleCustomException(
+		ApiException exception
+	) {
+		return ResponseEntity.status(exception.getHttpStatus()).body(ErrorResponse.error(exception.getError()));
+	}
+}

src/main/java/com/universe/uni/exception/ApiException.java

@@ -0,0 +1,20 @@
+package com.universe.uni.exception;
+
+import com.universe.uni.exception.dto.ErrorType;
+
+public class ApiException extends RuntimeException {
+	private final ErrorType error;
+
+	public ApiException(ErrorType error, String message) {
+		super(message);
+		this.error = error;
+	}
+
+	public int getHttpStatus() {
+		return this.error.getHttpStatusCode();
+	}
+
+	public ErrorType getError() {
+		return this.error;
+	}
+}

src/main/java/com/universe/uni/exception/BadRequestException.java

@@ -0,0 +1,10 @@
+package com.universe.uni.exception;
+
+import com.universe.uni.exception.dto.ErrorType;
+
+public class BadRequestException extends ApiException {
+
+	public BadRequestException(ErrorType error) {
+		super(error, error.getMessage());
+	}
+}

src/main/java/com/universe/uni/exception/ConflictException.java

@@ -0,0 +1,10 @@
+package com.universe.uni.exception;
+
+import com.universe.uni.exception.dto.ErrorType;
+
+public class ConflictException extends ApiException {
+
+	public ConflictException(ErrorType error) {
+		super(error, error.getMessage());
+	}
+}

src/main/java/com/universe/uni/exception/NotFoundException.java

@@ -0,0 +1,10 @@
+package com.universe.uni.exception;
+
+import com.universe.uni.exception.dto.ErrorType;
+
+public class NotFoundException extends ApiException {
+
+	public NotFoundException(ErrorType error) {
+		super(error, error.getMessage());
+	}
+}

src/main/java/com/universe/uni/exception/UnauthorizedException.java

@@ -0,0 +1,10 @@
+package com.universe.uni.exception;
+
+import com.universe.uni.exception.dto.ErrorType;
+
+public class UnauthorizedException extends ApiException {
+
+	public UnauthorizedException(ErrorType error) {
+		super(error, error.getMessage());
+	}
+}

src/main/java/com/universe/uni/exception/dto/ErrorResponse.java

@@ -0,0 +1,19 @@
+package com.universe.uni.exception.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class ErrorResponse {
+
+	private final String uniErrorCode;
+
+	public static ErrorResponse error(ErrorType error) {
+		return new ErrorResponse(error.getUniErrorCode());
+	}
+}

src/main/java/com/universe/uni/exception/dto/ErrorType.java

@@ -0,0 +1,47 @@
+package com.universe.uni.exception.dto;
+
+import org.springframework.http.HttpStatus;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+
+@AllArgsConstructor(access = AccessLevel.PRIVATE)
+public enum ErrorType {
+
+	/**
+	 * 400 BAD REQUEST
+	 */
+	VALIDATION_EXCEPTION(HttpStatus.BAD_REQUEST, "", "잘못된 요청입니다."),
+	VALIDATION_REQUEST_MISSING_EXCEPTION(HttpStatus.BAD_REQUEST, "", "요청값이 입력되지 않았습니다."),
+
+	/**
+	 * 404 NOT FOUND
+	 */
+	NOT_FOUND_USER_EXCEPTION(HttpStatus.NOT_FOUND, "", "존재하지 않는 유저입니다"),
+
+	/**
+	 * 409 CONFLICT
+	 */
+	ALREADY_EXIST_USER_EXCEPTION(HttpStatus.CONFLICT, "", "이미 존재하는 유저입니다"),
+
+	/**
+	 * 500 INTERNAL SERVER ERROR
+	 */
+	INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "", "예상치 못한 서버 에러가 발생하였습니다.");
+
+	private final HttpStatus httpStatus;
+	private String uniErrorCode;
+	private final String message;
+
+	public int getHttpStatusCode() {
+		return httpStatus.value();
+	}
+
+	public String getUniErrorCode() {
+		return uniErrorCode;
+	}
+
+	public String getMessage() {
+		return message;
+	}
+}