Merge pull request #40 from Anifriends/feat/#39

feat: Exception에 예외코드를 추가한다.
anifriends · Oct 31, 2023 · e935a65 · e935a65
2 parents 1786f59 + b985fe0
commit e935a65
Show file tree

Hide file tree

Showing 10 changed files with 113 additions and 26 deletions.
diff --git a/src/main/java/com/clova/anifriends/global/exception/AniFriendsException.java b/src/main/java/com/clova/anifriends/global/exception/AniFriendsException.java
@@ -0,0 +1,15 @@
+package com.clova.anifriends.global.exception;
+
+public abstract class AniFriendsException extends RuntimeException {
+
+    private final ErrorCode errorCode;
+
+    protected AniFriendsException(ErrorCode errorCode, String message) {
+        super(message);
+        this.errorCode = errorCode;
+    }
+
+    public String getErrorCode() {
+        return errorCode.getValue();
+    }
+}
diff --git a/src/main/java/com/clova/anifriends/global/exception/AuthenticationException.java b/src/main/java/com/clova/anifriends/global/exception/AuthenticationException.java
@@ -1,8 +1,8 @@
 package com.clova.anifriends.global.exception;
 
-public abstract class AuthenticationException extends RuntimeException {
+public abstract class AuthenticationException extends AniFriendsException {
 
-    protected AuthenticationException(String message) {
-        super(message);
+    protected AuthenticationException(ErrorCode errorCode, String message) {
+        super(errorCode, message);
     }
 }
diff --git a/src/main/java/com/clova/anifriends/global/exception/AuthorizationException.java b/src/main/java/com/clova/anifriends/global/exception/AuthorizationException.java
@@ -1,8 +1,8 @@
 package com.clova.anifriends.global.exception;
 
-public abstract class AuthorizationException extends RuntimeException {
+public abstract class AuthorizationException extends AniFriendsException {
 
-    protected AuthorizationException(String message) {
-        super(message);
+    protected AuthorizationException(ErrorCode errorCode, String message) {
+        super(errorCode, message);
     }
 }
diff --git a/src/main/java/com/clova/anifriends/global/exception/BadRequestException.java b/src/main/java/com/clova/anifriends/global/exception/BadRequestException.java
@@ -1,8 +1,8 @@
 package com.clova.anifriends.global.exception;
 
-public abstract class BadRequestException extends RuntimeException{
+public abstract class BadRequestException extends AniFriendsException {
 
-    protected BadRequestException(String message) {
-        super(message);
+    protected BadRequestException(ErrorCode errorCode, String message) {
+        super(errorCode, message);
     }
 }
diff --git a/src/main/java/com/clova/anifriends/global/exception/ConflictException.java b/src/main/java/com/clova/anifriends/global/exception/ConflictException.java
@@ -1,8 +1,8 @@
 package com.clova.anifriends.global.exception;
 
-public abstract class ConflictException extends RuntimeException {
+public abstract class ConflictException extends AniFriendsException {
 
-    protected ConflictException(String message) {
-        super(message);
+    protected ConflictException(ErrorCode errorCode, String message) {
+        super(errorCode, message);
     }
 }
diff --git a/src/main/java/com/clova/anifriends/global/exception/ErrorCode.java b/src/main/java/com/clova/anifriends/global/exception/ErrorCode.java
@@ -0,0 +1,37 @@
+package com.clova.anifriends.global.exception;
+
+import com.clova.anifriends.EnumType;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+
+@AllArgsConstructor(access = AccessLevel.PRIVATE)
+public enum ErrorCode implements EnumType {
+
+    // 400
+    BAD_REQUEST("AF001"), // 잘못된 입력값
+    INVALID_AUTH_INFO("AF002"), // 아이디 비밀번호 매치 안됨
+    // 401
+    TOKEN_EXPIRED("AF101"), // 토큰 만료
+    UN_AUTHENTICATION("AF102"), // 인증 안됨
+    // 403
+    UN_AUTHORIZATION("AF301"), // 권한 없음
+    // 404
+    NOT_FOUND("AF401"), // 존재하지 않는 리소스
+    // 409
+    ALREADY_EXISTS("AF901"), // 이미 존재하는 리소스
+    CONCURRENCY("AF902"), // 선착순 마감
+    // 500
+    INTERNAL_SERVER_ERROR("AF999"); // 서버 내부 에러
+
+    private final String value;
+
+    @Override
+    public String getName() {
+        return name();
+    }
+
+    @Override
+    public String getValue() {
+        return value;
+    }
+}
diff --git a/src/main/java/com/clova/anifriends/global/exception/ErrorResponse.java b/src/main/java/com/clova/anifriends/global/exception/ErrorResponse.java
@@ -1,5 +1,5 @@
 package com.clova.anifriends.global.exception;
 
-public record ErrorResponse(String message) {
+public record ErrorResponse(String errorCode, String message) {
 
 }
diff --git a/src/main/java/com/clova/anifriends/global/exception/GlobalExceptionHandler.java b/src/main/java/com/clova/anifriends/global/exception/GlobalExceptionHandler.java
@@ -6,7 +6,12 @@
 import static org.springframework.http.HttpStatus.NOT_FOUND;
 import static org.springframework.http.HttpStatus.UNAUTHORIZED;
 
+import java.util.Objects;
 import org.springframework.http.ResponseEntity;
+import org.springframework.validation.FieldError;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+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.RestControllerAdvice;
 
@@ -15,26 +20,56 @@ public class GlobalExceptionHandler {
 
     @ExceptionHandler(BadRequestException.class)
     public ResponseEntity<ErrorResponse> badRequestEx(BadRequestException e) {
-        return ResponseEntity.status(BAD_REQUEST).body(new ErrorResponse(e.getMessage()));
+        return ResponseEntity.status(BAD_REQUEST)
+            .body(new ErrorResponse(e.getErrorCode(), e.getMessage()));
     }
 
     @ExceptionHandler(AuthenticationException.class)
     public ResponseEntity<ErrorResponse> authenticationEx(AuthenticationException e) {
-        return ResponseEntity.status(UNAUTHORIZED).body(new ErrorResponse(e.getMessage()));
+        return ResponseEntity.status(UNAUTHORIZED)
+            .body(new ErrorResponse(e.getErrorCode(), e.getMessage()));
     }
 
     @ExceptionHandler(AuthorizationException.class)
     public ResponseEntity<ErrorResponse> authorizationEx(AuthorizationException e) {
-        return ResponseEntity.status(FORBIDDEN).body(new ErrorResponse(e.getMessage()));
+        return ResponseEntity.status(FORBIDDEN)
+            .body(new ErrorResponse(e.getErrorCode(), e.getMessage()));
     }
 
     @ExceptionHandler(NotFoundException.class)
     public ResponseEntity<ErrorResponse> notFoundEx(NotFoundException e) {
-        return ResponseEntity.status(NOT_FOUND).body(new ErrorResponse(e.getMessage()));
+        return ResponseEntity.status(NOT_FOUND)
+            .body(new ErrorResponse(e.getErrorCode(), e.getMessage()));
     }
 
     @ExceptionHandler(ConflictException.class)
     public ResponseEntity<ErrorResponse> conflictEx(ConflictException e) {
-        return ResponseEntity.status(CONFLICT).body(new ErrorResponse(e.getMessage()));
+        return ResponseEntity.status(CONFLICT)
+            .body(new ErrorResponse(e.getErrorCode(), e.getMessage()));
+    }
+
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    protected ResponseEntity<ErrorResponse> handleMethodArgumentNotValidException(
+        MethodArgumentNotValidException e) {
+        FieldError fieldError = Objects.requireNonNull(e.getFieldError());
+        return ResponseEntity.status(BAD_REQUEST)
+            .body(new ErrorResponse(ErrorCode.BAD_REQUEST.getValue(),
+                String.format("%s. (%s)", fieldError.getDefaultMessage(), fieldError.getField())));
+    }
+
+    @ExceptionHandler(MissingRequestHeaderException.class)
+    protected ResponseEntity<ErrorResponse> handleMissingRequestHeaderException(
+        MissingRequestHeaderException e) {
+        return ResponseEntity.status(BAD_REQUEST)
+            .body(new ErrorResponse(ErrorCode.BAD_REQUEST.getValue(),
+                String.format("%s. (%s)", e.getMessage(), e.getHeaderName())));
+    }
+
+    @ExceptionHandler(MissingServletRequestParameterException.class)
+    protected ResponseEntity<ErrorResponse> handleMissingRequestParameterException(
+        MissingServletRequestParameterException e) {
+        return ResponseEntity.status(BAD_REQUEST)
+            .body(new ErrorResponse(ErrorCode.BAD_REQUEST.getValue(),
+                String.format("%s. (%s)", e.getMessage(), e.getParameterName())));
     }
 }
diff --git a/src/main/java/com/clova/anifriends/global/exception/NotFoundException.java b/src/main/java/com/clova/anifriends/global/exception/NotFoundException.java
@@ -1,8 +1,8 @@
 package com.clova.anifriends.global.exception;
 
-public abstract class NotFoundException extends RuntimeException {
+public abstract class NotFoundException extends AniFriendsException {
 
-    protected NotFoundException(String message) {
-        super(message);
+    protected NotFoundException(ErrorCode errorCode, String message) {
+        super(errorCode, message);
     }
 }
diff --git a/src/test/java/com/clova/anifriends/global/exception/ExceptionController.java b/src/test/java/com/clova/anifriends/global/exception/ExceptionController.java
@@ -10,7 +10,7 @@ public class ExceptionController {
 
     @GetMapping("/bad-request")
     public void badRequest() {
-        throw new BadRequestException("bad-request") {
+        throw new BadRequestException(ErrorCode.BAD_REQUEST, "bad-request") {
             @Override
             public String getMessage() {
                 return super.getMessage();
@@ -20,7 +20,7 @@ public String getMessage() {
 
     @GetMapping("/authentication")
     public void authentication() {
-        throw new AuthenticationException("authentication") {
+        throw new AuthenticationException(ErrorCode.TOKEN_EXPIRED, "authentication") {
             @Override
             public String getMessage() {
                 return super.getMessage();
@@ -30,7 +30,7 @@ public String getMessage() {
 
     @GetMapping("/authorization")
     public void authorization() {
-        throw new AuthorizationException("authorization") {
+        throw new AuthorizationException(ErrorCode.UN_AUTHORIZATION, "authorization") {
             @Override
             public String getMessage() {
                 return super.getMessage();
@@ -40,7 +40,7 @@ public String getMessage() {
 
     @GetMapping("/not-found")
     public void notFound() {
-        throw new NotFoundException("notFound") {
+        throw new NotFoundException(ErrorCode.NOT_FOUND, "notFound") {
             @Override
             public String getMessage() {
                 return super.getMessage();
@@ -50,7 +50,7 @@ public String getMessage() {
 
     @GetMapping("/conflict")
     public void conflict() {
-        throw new ConflictException("conflict") {
+        throw new ConflictException(ErrorCode.ALREADY_EXISTS, "conflict") {
             @Override
             public String getMessage() {
                 return super.getMessage();