Merge pull request #39 from YAPP-Github/feat/PRODUCT-111

leegwichan · web-flow · commit 6df3554919e5 · 2025-07-02T11:18:07.000+09:00
[Feat] 400/500번대 에러 처리
diff --git a/build.gradle b/build.gradle
@@ -12,7 +12,7 @@ plugins {
     id("org.sonarqube") version "6.2.0.5505"
 }
 
-group = 'time-eat'
+group = 'net.eatda'
 version = '0.0.1-SNAPSHOT'
 
 java {
@@ -124,14 +124,22 @@ generateSwaggerUI {
 }
 
 openapi3 {
-    servers = [ // 서버 상황에 맞춰 추가 예정
+    servers = [
+                {
+                    url = "https://api-dev.eatda.net"
+                    description = "Develop Server"
+                },
+                {
+                    url = "https://api.eatda.net"
+                    description = "Production Server"
+                },
                 {
                     url = "http://localhost:8080"
                     description = "Local Server"
                 }
     ]
-    title = "Time Eat API"
-    description = "Time Eat API 명세서"
+    title = "EatDa API"
+    description = "EatDa API 명세서"
     version = "0.0.1"
     format = "yaml"
     outputDirectory = "build/resources/main/static/docs"
diff --git a/settings.gradle b/settings.gradle
@@ -1 +1 @@
-rootProject.name = 'time-eat'
+rootProject.name = 'eatda'
diff --git a/src/main/java/timeeat/client/oauth/OauthProperties.java b/src/main/java/timeeat/client/oauth/OauthProperties.java
@@ -1,12 +1,12 @@
 package timeeat.client.oauth;
 
-import org.springframework.boot.context.properties.ConfigurationProperties;
-import lombok.AllArgsConstructor;
 import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import org.springframework.boot.context.properties.ConfigurationProperties;
 
 @Getter
-@AllArgsConstructor
 @ConfigurationProperties(prefix = "oauth")
+@RequiredArgsConstructor
 public class OauthProperties {
 
     private final String clientId;
diff --git a/src/main/java/timeeat/client/oauth/OauthServerErrorHandler.java b/src/main/java/timeeat/client/oauth/OauthServerErrorHandler.java
@@ -5,13 +5,14 @@
 import org.springframework.http.client.ClientHttpResponse;
 import org.springframework.stereotype.Component;
 import org.springframework.web.client.RestClient.ResponseSpec.ErrorHandler;
+import timeeat.exception.BusinessErrorCode;
+import timeeat.exception.BusinessException;
 
 @Component
 public class OauthServerErrorHandler implements ErrorHandler {
 
     @Override
     public void handle(HttpRequest request, ClientHttpResponse response) throws IOException {
-        // TODO : 500 에러 처리
-        throw new RuntimeException("Oauth server error occurred");
+        throw new BusinessException(BusinessErrorCode.OAUTH_SERVER_ERROR);
     }
 }
diff --git a/src/main/java/timeeat/config/CorsConfig.java b/src/main/java/timeeat/config/CorsConfig.java
@@ -5,6 +5,7 @@
 import org.springframework.http.HttpMethod;
 import org.springframework.web.servlet.config.annotation.CorsRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+import timeeat.exception.InitializeException;
 
 @Configuration
 public class CorsConfig implements WebMvcConfigurer {
@@ -18,11 +19,11 @@ public CorsConfig(CorsProperties corsProperties) {
 
     private void validate(List<String> corsOriginList) {
         if (corsOriginList == null || corsOriginList.isEmpty()) {
-            throw new RuntimeException("Initialization Error: CORS origin cannot be empty.");
+            throw new InitializeException("CORS origin cannot be empty.");
         }
         for (String origin : corsOriginList) {
             if (origin == null || origin.isBlank()) {
-                throw new RuntimeException("Initialization Error: CORS origin string cannot be blank.");
+                throw new InitializeException("CORS origin string cannot be blank.");
             }
         }
     }
diff --git a/src/main/java/timeeat/controller/web/jwt/JwtProperties.java b/src/main/java/timeeat/controller/web/jwt/JwtProperties.java
@@ -1,11 +1,12 @@
 package timeeat.controller.web.jwt;
 
+import io.jsonwebtoken.security.Keys;
 import java.time.Duration;
 import java.util.Base64;
 import javax.crypto.SecretKey;
-import org.springframework.boot.context.properties.ConfigurationProperties;
-import io.jsonwebtoken.security.Keys;
 import lombok.Getter;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import timeeat.exception.InitializeException;
 
 @Getter
 @ConfigurationProperties(prefix = "jwt")
@@ -29,17 +30,16 @@ public JwtProperties(String secretKey, Duration accessTokenExpiration, Duration
 
     private void validate(String secretKey) {
         if (secretKey == null || secretKey.getBytes().length < SECRET_KEY_MIN_BYTES) {
-            // TODO Initialize error 논의
-            throw new RuntimeException("JWT secret key must be at least 32 bytes");
+            throw new InitializeException("JWT secret key must be at least 32 bytes");
         }
     }
 
     private void validate(Duration expiration) {
         if (expiration == null) {
-            throw new RuntimeException("JWT token duration cannot be null");
+            throw new InitializeException("JWT token duration cannot be null");
         }
         if (expiration.isNegative()) {
-            throw new RuntimeException("JWT token duration must be positive");
+            throw new InitializeException("JWT token duration must be positive");
         }
     }
 
diff --git a/src/main/java/timeeat/exception/BusinessErrorCode.java b/src/main/java/timeeat/exception/BusinessErrorCode.java
@@ -1,6 +1,7 @@
 package timeeat.exception;
 
 import lombok.Getter;
+import org.springframework.http.HttpStatus;
 
 @Getter
 public enum BusinessErrorCode {
@@ -41,15 +42,22 @@ public enum BusinessErrorCode {
     BOOKMARK_STORE_REQUIRED("BOK004", "북마크 생성 시 가게 정보는 필수입니다."),
 
     // Auth
-    UNAUTHORIZED_MEMBER("AUTH001", "인증되지 않은 회원입니다."),
-    EXPIRED_TOKEN("AUTH002", "이미 만료된 토큰입니다."),
+    UNAUTHORIZED_MEMBER("AUTH001", "인증되지 않은 회원입니다.", HttpStatus.UNAUTHORIZED),
+    EXPIRED_TOKEN("AUTH002", "이미 만료된 토큰입니다.", HttpStatus.UNAUTHORIZED),
+    OAUTH_SERVER_ERROR("AUTH003", "OAuth 서버와의 통신 오류입니다.", HttpStatus.INTERNAL_SERVER_ERROR),
     ;
 
     private final String code;
     private final String message;
+    private final HttpStatus status;
 
-    BusinessErrorCode(String code, String message) {
+    BusinessErrorCode(String code, String message, HttpStatus status) {
         this.code = code;
         this.message = message;
+        this.status = status;
+    }
+
+    BusinessErrorCode(String code, String message) {
+        this(code, message, HttpStatus.BAD_REQUEST);
     }
 }
diff --git a/src/main/java/timeeat/exception/BusinessException.java b/src/main/java/timeeat/exception/BusinessException.java
@@ -1,6 +1,7 @@
 package timeeat.exception;
 
 import lombok.Getter;
+import org.springframework.http.HttpStatus;
 
 @Getter
 public class BusinessException extends RuntimeException {
@@ -10,4 +11,8 @@ public BusinessException(BusinessErrorCode errorCode) {
         super(errorCode.getMessage());
         this.errorCode = errorCode;
     }
+
+    public HttpStatus getStatus() {
+        return errorCode.getStatus();
+    }
 }
diff --git a/src/main/java/timeeat/exception/ErrorResponse.java b/src/main/java/timeeat/exception/ErrorResponse.java
@@ -0,0 +1,12 @@
+package timeeat.exception;
+
+public record ErrorResponse(String errorCode, String message) {
+
+    public ErrorResponse(BusinessErrorCode errorCode) {
+        this(errorCode.getCode(), errorCode.getMessage());
+    }
+
+    public ErrorResponse(EtcErrorCode errorCode) {
+        this(errorCode.getCode(), errorCode.getMessage());
+    }
+}
diff --git a/src/main/java/timeeat/exception/EtcErrorCode.java b/src/main/java/timeeat/exception/EtcErrorCode.java
@@ -0,0 +1,29 @@
+package timeeat.exception;
+
+import lombok.Getter;
+import org.springframework.http.HttpStatus;
+
+@Getter
+public enum EtcErrorCode {
+
+    CLIENT_REQUEST_ERROR("CLIENT001", "클라이언트 요청이 잘못되었습니다.", HttpStatus.BAD_REQUEST),
+    METHOD_ARGUMENT_TYPE_MISMATCH("CLIENT002", "요청 타입이 일치하지 않습니다.", HttpStatus.BAD_REQUEST),
+    ALREADY_DISCONNECTED("CLIENT003", "이미 클라이언트에서 요청이 종료되었습니다.", HttpStatus.BAD_REQUEST),
+    METHOD_NOT_SUPPORTED("CLIENT004", "허용되지 않은 메서드입니다.", HttpStatus.METHOD_NOT_ALLOWED),
+    MEDIA_TYPE_NOT_SUPPORTED("CLIENT005", "허용되지 않은 미디어 타입입니다.", HttpStatus.UNSUPPORTED_MEDIA_TYPE),
+    NO_RESOURCE_FOUND("CLIENT006", "요청한 리소스를 찾을 수 없습니다.", HttpStatus.NOT_FOUND),
+    NO_COOKIE_FOUND("CLIENT007", "필수 쿠키 값이 존재하지 않습니다.", HttpStatus.BAD_REQUEST),
+
+    INTERNAL_SERVER_ERROR("SERVER001", "서버 내부 에러가 발생했습니다.", HttpStatus.INTERNAL_SERVER_ERROR),
+    ;
+
+    private final String code;
+    private final String message;
+    private final HttpStatus status;
+
+    EtcErrorCode(String code, String message, HttpStatus status) {
+        this.code = code;
+        this.message = message;
+        this.status = status;
+    }
+}
diff --git a/src/main/java/timeeat/exception/GlobalExceptionHandler.java b/src/main/java/timeeat/exception/GlobalExceptionHandler.java
@@ -0,0 +1,81 @@
+package timeeat.exception;
+
+import jakarta.validation.ConstraintViolationException;
+import lombok.RequiredArgsConstructor;
+import org.apache.catalina.connector.ClientAbortException;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.BindException;
+import org.springframework.web.HttpMediaTypeNotSupportedException;
+import org.springframework.web.HttpRequestMethodNotSupportedException;
+import org.springframework.web.bind.MissingRequestCookieException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
+import org.springframework.web.servlet.resource.NoResourceFoundException;
+
+@RestControllerAdvice
+@RequiredArgsConstructor
+public class GlobalExceptionHandler {
+
+    @ExceptionHandler(BindException.class)
+    public ResponseEntity<ErrorResponse> handleBindingException(BindException exception) {
+        return toErrorResponse(EtcErrorCode.CLIENT_REQUEST_ERROR);
+    }
+
+    @ExceptionHandler(ConstraintViolationException.class)
+    public ResponseEntity<ErrorResponse> handleConstraintViolationException(ConstraintViolationException exception) {
+        return toErrorResponse(EtcErrorCode.CLIENT_REQUEST_ERROR);
+    }
+
+    @ExceptionHandler(MethodArgumentTypeMismatchException.class)
+    public ResponseEntity<ErrorResponse> handleMethodArgumentTypeMismatchException(
+            MethodArgumentTypeMismatchException exception) {
+        return toErrorResponse(EtcErrorCode.METHOD_ARGUMENT_TYPE_MISMATCH);
+    }
+
+    @ExceptionHandler(ClientAbortException.class)
+    public ResponseEntity<ErrorResponse> handleClientAbortException(ClientAbortException exception) {
+        return toErrorResponse(EtcErrorCode.ALREADY_DISCONNECTED);
+    }
+
+    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
+    public ResponseEntity<ErrorResponse> handleHttpRequestMethodNotSupportedException(
+            HttpRequestMethodNotSupportedException exception
+    ) {
+        return toErrorResponse(EtcErrorCode.METHOD_NOT_SUPPORTED);
+    }
+
+    @ExceptionHandler(HttpMediaTypeNotSupportedException.class)
+    public ResponseEntity<ErrorResponse> handleHttpMediaTypeNotSupportedException(
+            HttpMediaTypeNotSupportedException exception
+    ) {
+        return toErrorResponse(EtcErrorCode.MEDIA_TYPE_NOT_SUPPORTED);
+    }
+
+    @ExceptionHandler(NoResourceFoundException.class)
+    public ResponseEntity<ErrorResponse> handleNoResourceFoundException(NoResourceFoundException exception) {
+        return toErrorResponse(EtcErrorCode.NO_RESOURCE_FOUND);
+    }
+
+    @ExceptionHandler(MissingRequestCookieException.class)
+    public ResponseEntity<ErrorResponse> handleMissingRequestCookieException(MissingRequestCookieException exception) {
+        return toErrorResponse(EtcErrorCode.NO_COOKIE_FOUND);
+    }
+
+    @ExceptionHandler(BusinessException.class)
+    public ResponseEntity<ErrorResponse> handleBusinessException(BusinessException exception) {
+        ErrorResponse response = new ErrorResponse(exception.getErrorCode());
+        return ResponseEntity.status(exception.getStatus())
+                .body(response);
+    }
+
+    @ExceptionHandler(Exception.class)
+    public ResponseEntity<ErrorResponse> handleException(Exception exception) {
+        return toErrorResponse(EtcErrorCode.INTERNAL_SERVER_ERROR);
+    }
+
+    private ResponseEntity<ErrorResponse> toErrorResponse(EtcErrorCode errorCode) {
+        return ResponseEntity.status(errorCode.getStatus())
+                .body(new ErrorResponse(errorCode));
+    }
+}
diff --git a/src/main/java/timeeat/exception/InitializeException.java b/src/main/java/timeeat/exception/InitializeException.java
@@ -0,0 +1,8 @@
+package timeeat.exception;
+
+public class InitializeException extends RuntimeException {
+
+    public InitializeException(String message) {
+        super(message);
+    }
+}
diff --git a/src/test/java/timeeat/controller/web/jwt/JwtPropertiesTest.java b/src/test/java/timeeat/controller/web/jwt/JwtPropertiesTest.java
@@ -8,6 +8,7 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.NullAndEmptySource;
+import timeeat.exception.InitializeException;
 
 class JwtPropertiesTest {
 
@@ -19,7 +20,7 @@ class ValidateSecretKey {
         void 비밀키가_비어있으면_예외를_발생시킨다(String secretKey) {
 
             assertThatThrownBy(() -> new JwtProperties(secretKey, Duration.ofMinutes(30), Duration.ofDays(14)))
-                    .isInstanceOf(RuntimeException.class)
+                    .isInstanceOf(InitializeException.class)
                     .hasMessage("JWT secret key must be at least 32 bytes");
         }
 
@@ -28,7 +29,7 @@ class ValidateSecretKey {
             String secretKey = "1".repeat(31); // 31 bytes
 
             assertThatThrownBy(() -> new JwtProperties(secretKey, Duration.ofMinutes(30), Duration.ofDays(14)))
-                    .isInstanceOf(RuntimeException.class)
+                    .isInstanceOf(InitializeException.class)
                     .hasMessage("JWT secret key must be at least 32 bytes");
         }
 
@@ -49,14 +50,14 @@ class ValidateExpiration {
         @Test
         void 만료기간이_비어있으면_예외를_발생시킨다() {
             assertThatThrownBy(() -> new JwtProperties(secretKey, null, Duration.ofDays(14)))
-                    .isInstanceOf(RuntimeException.class)
+                    .isInstanceOf(InitializeException.class)
                     .hasMessage("JWT token duration cannot be null");
         }
 
         @Test
         void 만료기간이_음수이면_예외를_발생시킨다() {
             assertThatThrownBy(() -> new JwtProperties(secretKey, Duration.ofHours(1), Duration.ofSeconds(-1)))
-                    .isInstanceOf(RuntimeException.class)
+                    .isInstanceOf(InitializeException.class)
                     .hasMessage("JWT token duration must be positive");
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-rootProject.name = 'time-eat'`
	`1`	`+rootProject.name = 'eatda'`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`import org.springframework.http.HttpMethod;`
`6`	`6`	`import org.springframework.web.servlet.config.annotation.CorsRegistry;`
`7`	`7`	`import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;`
	`8`	`+import timeeat.exception.InitializeException;`
`8`	`9`
`9`	`10`	`@Configuration`
`10`	`11`	`public class CorsConfig implements WebMvcConfigurer {`
`@@ -18,11 +19,11 @@ public CorsConfig(CorsProperties corsProperties) {`
`18`	`19`
`19`	`20`	`private void validate(List<String> corsOriginList) {`
`20`	`21`	`if (corsOriginList == null \|\| corsOriginList.isEmpty()) {`
`21`		`- throw new RuntimeException("Initialization Error: CORS origin cannot be empty.");`
	`22`	`+ throw new InitializeException("CORS origin cannot be empty.");`
`22`	`23`	`}`
`23`	`24`	`for (String origin : corsOriginList) {`
`24`	`25`	`if (origin == null \|\| origin.isBlank()) {`
`25`		`- throw new RuntimeException("Initialization Error: CORS origin string cannot be blank.");`
	`26`	`+ throw new InitializeException("CORS origin string cannot be blank.");`
`26`	`27`	`}`
`27`	`28`	`}`
`28`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package timeeat.exception;`
`2`	`2`
`3`	`3`	`import lombok.Getter;`
	`4`	`+import org.springframework.http.HttpStatus;`
`4`	`5`
`5`	`6`	`@Getter`
`6`	`7`	`public class BusinessException extends RuntimeException {`
`@@ -10,4 +11,8 @@ public BusinessException(BusinessErrorCode errorCode) {`
`10`	`11`	`super(errorCode.getMessage());`
`11`	`12`	`this.errorCode = errorCode;`
`12`	`13`	`}`
	`14`	`+`
	`15`	`+ public HttpStatus getStatus() {`
	`16`	`+ return errorCode.getStatus();`
	`17`	`+ }`
`13`	`18`	`}`