공통기능 개발 구현 (#9)

* remove : Test용 패키지 및 컨트롤러 삭제

* style : HomeController 위치 변경

* feat : HealthCheck Controller 제작

* feat : BaseException 및 Exception Enum정의
- BaseException 생성
- Exception Enum정의
    - Example용 Error
    - MethodArgumentError
    - InternalServerError
    - DateFormatError정의
- ErrorDetail정의 : Advice에서 반환할 객체

* feat : ExceptionHandlerAdvice 구현
- RestControllerAdvice 구현
- ControllerAdvice 구현

문제점 : 두개가 일단 동일한 작업을 하는 코드여서 추후 기능으로 따로 뺴는 작업 필요

* feat : YML에서 값을 가져오기위한 설정인 EnableConfigurationProperties추가

* feat : footer.html 구현
- Project 명칭, CopyRight,팀원 명칭 기록
- Footer Tag Css를 Style.css 정의
- Config에서 style.css 참조할 수 있도록 수정

* feat : ERD추가
- DBDocs CD 구현
- ERD파일 추가

* docs : ERD, DBDocs관련 내용 README 추가

.github/workflows/DBDOCS_BUILD.yml

@@ -0,0 +1,27 @@
+name: DBDOCS_BUILD
+
+on:
+  push:
+    branches: [ "dev" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      # DBDocs Install
+      - name: Install dbdocs
+        run: sudo npm install -g dbdocs
+
+      #DBDocs Install Check
+      - name: Check dbdocs
+        run: dbdocs
+
+      # Runs a set of commands using the runners shell
+      - name: Update dbdocs project
+
+        env:
+          DBDOCS_TOKEN: ${{ secrets.DBDOCS_TOKEN }}
+        run: dbdocs build ./Docs/Picasso.dbml --project=Picasso

Api/src/main/java/picasso/server/api/test/HomeController.java → Api/src/main/java/picasso/server/api/HomeController.java

@@ -1,18 +1,15 @@
-package picasso.server.api.test;
+package picasso.server.api;
 
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 
 
+@Slf4j
 @Controller
 public class HomeController {
     @GetMapping("/")
     public String index() {
         return "/index";
     }
-
-    @GetMapping("/layout")
-    public String layout() {
-        return "/test_layout";
-    }
 }

Api/src/main/java/picasso/server/api/config/advice/GlobalControllerExceptionHandler.java

@@ -0,0 +1,36 @@
+package picasso.server.api.config.advice;
+
+import jakarta.servlet.http.HttpServletRequest;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import picasso.server.common.dto.ErrorDetail;
+import picasso.server.common.exception.BaseException;
+import picasso.server.common.exception.GlobalException;
+
+//TODO : 현재 `GlobalRestControllerExceptionHandler`와 동일한 코드, 추후 수정 필요
+@Slf4j
+@RequiredArgsConstructor
+@RestControllerAdvice
+public class GlobalControllerExceptionHandler {
+    @ExceptionHandler(BaseException.class)
+    protected ResponseEntity<ErrorDetail> baseExceptionHandle(BaseException e, HttpServletRequest request) {
+        ErrorDetail errorDetail = e.getErrorCode().getErrorDetail();
+        log.warn("ExceptionName >>> {}, ErrorCode >>> {}, ExceptionReason >>> {}",
+                e.getClass(), errorDetail.getStatusCode(), errorDetail.getReason());
+
+        return ResponseEntity.status(errorDetail.getStatusCode()).body(errorDetail);
+    }
+
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    protected ResponseEntity<ErrorDetail> argumentNotValidHandle(MethodArgumentNotValidException e, HttpServletRequest request) {
+        ErrorDetail errorDetail = ErrorDetail.builder()
+                .statusCode(GlobalException.METHOD_ARGUMENT_ERROR.getStatusCode())
+                .reason(GlobalException.METHOD_ARGUMENT_ERROR.getReason())
+                .build();
+        return ResponseEntity.status(errorDetail.getStatusCode()).body(errorDetail);
+    }
+}

Api/src/main/java/picasso/server/api/config/advice/GlobalRestControllerExceptionHandler.java

@@ -0,0 +1,36 @@
+package picasso.server.api.config.advice;
+
+import jakarta.servlet.http.HttpServletRequest;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import picasso.server.common.dto.ErrorDetail;
+import picasso.server.common.exception.BaseException;
+import picasso.server.common.exception.GlobalException;
+
+//TODO : 현재 `GlobalControllerExceptionHandler`와 동일한 코드, 추후 수정 필요
+@Slf4j
+@RequiredArgsConstructor
+@RestControllerAdvice
+public class GlobalRestControllerExceptionHandler {
+    @ExceptionHandler(BaseException.class)
+    protected ResponseEntity<ErrorDetail> baseExceptionHandle(BaseException e, HttpServletRequest request) {
+        ErrorDetail errorDetail = e.getErrorCode().getErrorDetail();
+        log.warn("ExceptionName >>> {}, ErrorCode >>> {}, ExceptionReason >>> {}",
+                e.getClass(), errorDetail.getStatusCode(), errorDetail.getReason());
+
+        return ResponseEntity.status(errorDetail.getStatusCode()).body(errorDetail);
+    }
+
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    protected ResponseEntity<ErrorDetail> argumentNotValidHandle(MethodArgumentNotValidException e, HttpServletRequest request) {
+        ErrorDetail errorDetail = ErrorDetail.builder()
+                .statusCode(GlobalException.METHOD_ARGUMENT_ERROR.getStatusCode())
+                .reason(GlobalException.METHOD_ARGUMENT_ERROR.getReason())
+                .build();
+        return ResponseEntity.status(errorDetail.getStatusCode()).body(errorDetail);
+    }
+}

Api/src/main/java/picasso/server/api/test/TestController.java → Api/src/main/java/picasso/server/api/config/controller/HealthController.java

@@ -1,21 +1,18 @@
-package picasso.server.api.test;
+package picasso.server.api.config.controller;
 
-
-import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 @Slf4j
-@RequestMapping("/test")
-@RequiredArgsConstructor
 @RestController
-public class TestController {
-    private final TestMessage testMessage;
+@RequestMapping("/health")
+public class HealthController {
 
     @GetMapping
-    public String rtnMsg() {
-        return testMessage.toString();
+    public ResponseEntity healthCheck() {
+        return ResponseEntity.ok().build();
     }
 }

Api/src/main/resources/static/css/style.css

@@ -0,0 +1,29 @@
+/* footer */
+footer {
+    border-top: 1px solid #eee;
+    padding-top: 12px;
+    padding-bottom: 10px;
+    background-color: #bdbdbd;
+}
+footer .title {
+    font-weight: 700;
+    font-size: 16px;
+    color: #242424;
+    padding-left: 10px;
+    margin-bottom: 0;
+}
+footer .footer-menu {
+    margin-top: 24px;
+    display: flex;
+    justify-content: space-between;
+}
+footer .footer-menu li a {
+    font-size: 12px;
+    color: #6f6f6f;
+}
+footer .copyright {
+    color: #6f6f6f;
+    font-size: 10px;
+    margin-top: 10px;
+    padding-left: 10px;
+}

Api/src/main/resources/templates/fragment/config.html

@@ -11,6 +11,8 @@
         <link rel="stylesheet" type="text/css" href="/static/css/reset.css" />
         <link rel="stylesheet" type="text/css" href="/static/css/normalize.css" />
 
+        <link rel="stylesheet" type="text/css" href="/static/css/style.css" />
+
 
         <!-- Font -->
         <link rel="stylesheet" as="style" crossorigin

Api/src/main/resources/templates/fragment/footer.html

@@ -1,8 +1,19 @@
 <!DOCTYPE html>
 <html xmlns:th="http://www.thymeleaf.org">
 <footer th:fragment="footerFragment">
-    <div style="background-color: rgba(61,255,37,0.41)">
-        footer.html
+    <div class="row">
+        <div class="col-12">
+            <div class="title">Picasso</div>
+            <ul class="footer-menu clearfix">
+                <li><a href="#">김선래</a></li>
+                <li><a href="#">곽나현</a></li>
+                <li><a href="#">오동현</a></li>
+                <li><a href="#">김현덕</a></li>
+                <li><a href="#">봉세환</a></li>
+                <li><a href="#">김종원</a></li>
+            </ul>
+            <p class="copyright">Copyright © 2023</p>
+        </div>
     </div>
 </footer>
 

Common/src/main/java/picasso/server/common/config/ConfigurationPropertiesConfig.java

@@ -0,0 +1,10 @@
+package picasso.server.common.config;
+
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@EnableConfigurationProperties({
+})
+public class ConfigurationPropertiesConfig {
+}

Common/src/main/java/picasso/server/common/dto/ErrorDetail.java

@@ -0,0 +1,21 @@
+package picasso.server.common.dto;
+
+import lombok.Builder;
+import lombok.Getter;
+
+/**
+ * StatusCode : ControllerAdvice, RestControllerAdvice에서 ResponseEntity의 Status를 찾기 위함.
+ * Reason : ResponseEntity에서 내용반환에 필요한 컬럼
+ */
+@Getter
+@Builder
+public class ErrorDetail {
+    private final Integer statusCode;
+    private final String reason;
+    public static ErrorDetail of(Integer statusCode, String reason ) {
+        return ErrorDetail.builder()
+                .statusCode(statusCode)
+                .reason(reason)
+                .build();
+    }
+}

Common/src/main/java/picasso/server/common/exception/BaseErrorCode.java

@@ -0,0 +1,7 @@
+package picasso.server.common.exception;
+
+import picasso.server.common.dto.ErrorDetail;
+
+public interface BaseErrorCode {
+    ErrorDetail getErrorDetail();
+}

Common/src/main/java/picasso/server/common/exception/BaseException.java

@@ -0,0 +1,15 @@
+package picasso.server.common.exception;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import picasso.server.common.dto.ErrorDetail;
+
+@Getter
+@AllArgsConstructor
+public abstract class BaseException extends RuntimeException {
+    private BaseErrorCode errorCode;
+
+    public ErrorDetail getErrorDetail() {
+        return this.errorCode.getErrorDetail();
+    }
+}

Common/src/main/java/picasso/server/common/exception/ExampleException.java

@@ -0,0 +1,12 @@
+package picasso.server.common.exception;
+
+public class ExampleException extends BaseException {
+
+    public static final BaseException EXCEPTION = new ExampleException();
+
+    private ExampleException() {
+        super(GlobalException.EXAMPLE_ERROR);
+    }
+
+}
+

Common/src/main/java/picasso/server/common/exception/GlobalException.java

@@ -0,0 +1,26 @@
+package picasso.server.common.exception;
+
+import static org.springframework.http.HttpStatus.BAD_REQUEST;
+import static org.springframework.http.HttpStatus.INTERNAL_SERVER_ERROR;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import picasso.server.common.dto.ErrorDetail;
+
+@Getter
+@AllArgsConstructor
+public enum GlobalException implements BaseErrorCode {
+    EXAMPLE_ERROR(BAD_REQUEST.value(), "에러 예시 입니다."),
+    METHOD_ARGUMENT_ERROR(BAD_REQUEST.value(), "메서드 인자가 유효하지 않거나 @Valid를 통과하지 못하여 발생하는 예외입니다."),
+    INTERNAL_SERVER_ERRORS(INTERNAL_SERVER_ERROR.value(), "서버 내부 오류입니다."),
+    DATE_FORMAT_ERROR(BAD_REQUEST.value(), "날짜 형식을 확인해주세요."),
+    ;
+
+    private final Integer statusCode;
+    private final String reason;
+
+    @Override
+    public ErrorDetail getErrorDetail() {
+        return ErrorDetail.of(statusCode, reason);
+    }
+}