Merge pull request #2 from Katchup-dev/task/#1

[KS-3] Exception Handler 구현

.github/workflows/pr-build.yaml

@@ -1,7 +1,7 @@
 name: Katchup PR build
 
 on:
-  push:
+  pull_request:
     branches: [ "main" ]
 
 permissions:

README.md

@@ -0,0 +1 @@
+# Katchup Mobile API Server

src/main/kotlin/site/katchup/springboot/exception/GlobalControllerAdvice.kt

@@ -0,0 +1,25 @@
+package site.katchup.springboot.exception
+
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.ExceptionHandler
+import org.springframework.web.bind.annotation.RestControllerAdvice
+import site.katchup.springboot.config.getLogger
+import site.katchup.springboot.exception.base.KatchupException
+import site.katchup.springboot.global.response.BaseResponse
+
+@RestControllerAdvice
+class GlobalControllerAdvice {
+
+    private val log = getLogger()
+
+    @ExceptionHandler(KatchupException::class)
+    fun handleBadRequestException(exception: KatchupException): ResponseEntity<BaseResponse<Unit>> {
+        return BaseResponse.fail(exception.httpStatus, exception.failMessage)
+    }
+
+    @ExceptionHandler(Exception::class)
+    fun handleException(exception: Exception): ResponseEntity<BaseResponse<Unit>> {
+        log.error(exception.message)
+        return BaseResponse.fail(exception)
+    }
+}

src/main/kotlin/site/katchup/springboot/exception/base/BadRequestException.kt

@@ -1,10 +1,11 @@
 package site.katchup.springboot.exception.base
 
 import org.springframework.http.HttpStatus
+import site.katchup.springboot.global.message.FailMessage
 
 open class BadRequestException(
-    message: String,
+    failMessage: FailMessage,
 ) : KatchupException(
     HttpStatus.BAD_REQUEST,
-    message,
+    failMessage,
 )

src/main/kotlin/site/katchup/springboot/exception/base/ForbiddenException.kt

@@ -1,10 +1,11 @@
 package site.katchup.springboot.exception.base
 
 import org.springframework.http.HttpStatus
+import site.katchup.springboot.global.message.FailMessage
 
 open class ForbiddenException(
-    message: String,
+    failMessage: FailMessage,
 ) : KatchupException(
     HttpStatus.FORBIDDEN,
-    message,
+    failMessage,
 )

src/main/kotlin/site/katchup/springboot/exception/base/InternalServerException.kt

@@ -1,10 +1,11 @@
 package site.katchup.springboot.exception.base
 
 import org.springframework.http.HttpStatus
+import site.katchup.springboot.global.message.FailMessage
 
 open class InternalServerException(
-    message: String,
+    failMessage: FailMessage,
 ) : KatchupException(
     HttpStatus.INTERNAL_SERVER_ERROR,
-    message,
+    failMessage,
 )

src/main/kotlin/site/katchup/springboot/exception/base/KatchupException.kt

@@ -1,8 +1,9 @@
 package site.katchup.springboot.exception.base
 
 import org.springframework.http.HttpStatus
+import site.katchup.springboot.global.message.FailMessage
 
 open class KatchupException(
-    httpStatus: HttpStatus,
-    message: String,
-) : RuntimeException(message)
+    val httpStatus: HttpStatus,
+    val failMessage: FailMessage,
+) : RuntimeException(failMessage.value)

src/main/kotlin/site/katchup/springboot/exception/base/NotFoundException.kt

@@ -1,10 +1,11 @@
 package site.katchup.springboot.exception.base
 
 import org.springframework.http.HttpStatus
+import site.katchup.springboot.global.message.FailMessage
 
 open class NotFoundException(
-    message: String,
+    failMessage: FailMessage,
 ) : KatchupException(
     HttpStatus.NOT_FOUND,
-    message,
+    failMessage,
 )

src/main/kotlin/site/katchup/springboot/exception/base/UnauthorizedException.kt

@@ -1,10 +1,11 @@
 package site.katchup.springboot.exception.base
 
 import org.springframework.http.HttpStatus
+import site.katchup.springboot.global.message.FailMessage
 
 open class UnauthorizedException(
-    message: String,
+    failMessage: FailMessage,
 ) : KatchupException(
     HttpStatus.UNAUTHORIZED,
-    message,
+    failMessage,
 )

src/main/kotlin/site/katchup/springboot/global/response/BaseResponse.kt

@@ -12,6 +12,7 @@ class BaseResponse<T>(
     val data: T?,
 ) {
     constructor(message: String) : this(message, null)
+
     companion object {
         fun <T> ok(message: SuccessMessage, data: T): ResponseEntity<BaseResponse<T>> {
             return ResponseEntity.ok(BaseResponse(message.value, data))
@@ -21,8 +22,13 @@ class BaseResponse<T>(
             return ResponseEntity.status(HttpStatus.CREATED).body(BaseResponse(message.value, data))
         }
 
-        fun <T> fail(message: FailMessage): BaseResponse<T> {
-            return BaseResponse(message.value, null)
+        fun fail(status: HttpStatus, message: FailMessage): ResponseEntity<BaseResponse<Unit>> {
+            return ResponseEntity.status(status).body(BaseResponse(message.value))
+        }
+
+        fun fail(exception: Exception): ResponseEntity<BaseResponse<Unit>> {
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
+                .body(BaseResponse(exception.message ?: "Internal Server Error"))
         }
     }
 }