[KPT] 코드리뷰PR

.gitignore

@@ -115,4 +115,11 @@ fabric.properties
 hs_err_pid*
 replay_pid*
 
-# End of https://www.toptal.com/developers/gitignore/api/java,intellij+all
+# End of https://www.toptal.com/developers/gitignore/api/java,intellij+all
+
+HELP.md
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/

README.md

@@ -1 +1,268 @@
-# MiniProject
+![header](https://capsule-render.vercel.app/api?type=waving&color=auto&height=200&section=header&text=MiniProject;%20On_n_Off&fontSize=50)
+<a name="readme-top"></a>
+
+
+
+<!-- PROJECT LOGO -->
+<div align="center">
+<img src="https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/fd50b2a5-5247-4ca8-9b79-1567cce90e3c">
+</div>
+
+
+
+<!-- PROJECT SHIELDS -->
+# 온앤오프
+### 🏆 프로젝트 소개
+프론트(React), 백엔드(SpringBoot/Java) 각팀이 협업하여 ui/ux부터 배포작업까지 완료한 사이드프로젝트입니다.
+프로젝트명은 온앤오프(On&Off)이며, 해당 프로젝트는 클라이언트의 일정관리를 손쉽게 유지관리 할 수 있습니다.
+<br>
+>**배포링크 : https://on-n-off-mini.netlify.app/**
+><br>
+>**개발기간 : 2023.07.24 ~ 2023.08.11**
+
+
+
+<br><!-- TABLE OF CONTENTS -->
+## 📌 프로젝트 구조
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#온앤오프">프로젝트 소개</a>
+      <ul>
+        <li><a href="#프로젝트 소개">배포링크</a></li>
+        <li><a href="#프로젝트 소개">개발기간</a></li>
+      </ul>
+    </li>
+    <li><a href="#프로젝트 구조">프로젝트 구조</a></li>
+    <li><a href="#프로젝트 구조">프로젝트 시현</a></li>
+    <li><a href="#팀원 및 역할">팀원 및 역할</a></li>
+    <li>
+      <a href="#프로젝트 구성">프로젝트 스택</a>
+      <ul>
+        <li><a href="#">개발환경</a></li>
+        <li><a href="#">사용기술</a></li>
+      </ul>
+    </li>
+    <li><a href="#ERD">ERD</a></li>
+    <li><a href="#테이블 설계">테이블 설계</a></li>
+    <li>
+      <a href="#주요 기능">주요 기능</a>
+      <ul>
+        <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>
+    </li>
+    <li><a href="API 명세서"></a>API 명세서</li>
+  </ol>
+</details>
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- PROJECT IMG -->
+> **로그인 / 회원관리**
+> 
+| 로그인 | 회원관리 |
+| :------------: | :------------: |
+| ![로그인](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/6b54f779-71b3-476e-87fb-518ca6ce88ea)   |   ![회원가입](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/f3664f54-95c5-44cf-8f86-a0bd1d348a8d)   |  
+<br>
+
+> **메인(일반) / 메인(관리자)**
+>
+| 메인(일반) | 메인(관리자) |
+| :------------: | :------------: |
+| ![메인_일반](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/80bc9c83-ba70-43db-a6f7-4fd8f8ac78ed)  |   ![메인_관리자](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/767be3bc-bb80-483f-bcfe-ee46401813a0)   |  
+<br>
+
+> **관리자**
+> 
+| 당직휴가관리 | 사원관리 | 사원관리_세부 정보 |
+| :------------: | :------------: | :------------: |
+| ![관리자_당직휴가관리](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/91635bd8-8922-4a62-8799-72638014a8ae)   |   ![관리자_사원관리](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/61c28bf7-9b06-4d7c-b94d-d5ac4018b740)   |    ![관리자_사원관리_세부 정보](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/091fc659-e093-490b-b9d6-7710b621d8b5) |
+<br>
+
+> **휴가/당직**
+> 
+| 휴가/당직관리 | 휴가등록 | 당직등록 |
+| :------------: | :------------: | :------------: |
+| ![휴가당직관리](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/c0ba7031-a346-4b72-a23d-ff897c0727f5)   |   !![휴가등록](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/272b7b58-b9c1-4e13-a2a3-77d8bcc2893d)   |    ![당직등록](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/fd815383-5247-40ba-8b8e-04e7d4a81f73) |
+
+| 당직신청내역 | 휴가신청내역 |
+| :------------: | :------------: |
+| ![나의당직신청](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/9953028c-a67d-41cc-b0b8-f271eb6173e8)   |   ![나의휴가신청](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/ae5394ef-d7af-493a-8bea-740477326997)   |
+<br>
+
+> **개인정보수정**
+> 
+| 변경_전화번호 | 변경_비밀번호 | 캘린더 |
+| :------------: | :------------: | :------------: |
+| ![내정보변경_전화번호](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/77f38877-a119-4120-955c-01cba08e29e2)   |   ![내정보변경_비밀번호](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/c14ece09-9bcf-404b-853f-e8a1ecbabeab)   |    ![캘린더](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/16e67ea1-4ae0-4d8d-a2a7-650729f2c68b) |
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- PROJECT PEOPLE -->
+## ✨ 팀원 및 역할
+| <a href="https://github.com/dali186" class="size">김주원</a> | <a href="https://github.com/gosuuk" class="size">박성욱</a> | <a href="https://github.com/bornin23" class="size">한혜지</a> | <a href="https://github.com/jinakim8" class="size">김지나</a> |
+| :----------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: 
+| 초기 개발 세팅<br/> 회원가입<br/> 로그인<br/> 개인정보수정<br/> 관리자<br/> 배포<br/> | 연차 페이지<br/> 당직 페이지<br/> 캘린더<br/> 배포<br/> | 연차 페이지<br/> 당직 페이지<br/> 개인정보수정<br/> 캘린더<br/> | 프로젝트 팀장<br/> 프로젝트세팅<br/> 로그인<br/> 
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- PROJECT IDE -->
+## 🛠 프로젝트 스택(백엔드)
+* 개발환경 : JAVA 11
+* IDE: IntelliJ
+* Build: Gradle
+* Framework: Spring-Boot 2.7.14
+* Database: MySQL
+* ORM: Mybatis
+* 사용기술
+  - Spring Web
+  - Spring Data JPA
+  - Spring DevTools
+  - Spring Security
+  - JWT 4.3.0
+  - h2database
+  - lombok
+  - Postman
+  - AWS EC2
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- PROJECT ERD -->
+## 📖 ERD
+![image](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/c1b9c922-338e-4bb4-8316-752b248585b6)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- PROJECT TABLE -->
+## ⚖ 테이블 설계
+**1. 유저**
+```
+CREATE TABLE user_tb
+(
+    id           INT PRIMARY KEY AUTO_INCREMENT,
+    email        VARCHAR(20) NOT NULL UNIQUE, --로그인 ID로 사용
+    password     VARCHAR(20) NOT NULL, --유효성검사
+    username     VARCHAR(20) NOT NULL, --실명,유효성검사
+    phone_number VARCHAR(20) NOT NULL, --유효성검사
+    position     VARCHAR(20) NOT NULL, --사원, 주임, 대리, 과장, 차장, 부장
+    roles        VARCHAR(10) NOT NULL, --note: 일반, 관리자 / ENUM DEFAULT '일반'
+    update_date  TIMESTAMP             --개인정보 최종 수정일/논의
+);
+```
+**2. 로그인**
+```
+CREATE TABLE login_tb
+(
+    id         INT PRIMARY KEY AUTO_INCREMENT,
+    user_id    INT         NOT NULL,
+    ip         VARCHAR(50) NOT NULL,
+    user_agent VARCHAR(10) NOT NULL,
+    login_at   TIMESTAMP,
+
+    FOREIGN KEY (user_id) REFERENCES user_tb(id)
+);
+```
+**3. 연차**
+```
+CREATE TABLE dayoff_tb
+(
+    id             INT PRIMARY KEY AUTO_INCREMENT,
+    user_id        INT         NOT NULL,
+    num_of_dayoff  FLOAT       NOT NULL, --남은 연차 일수
+    start_date     DATE        NOT NULL, --시작일
+    end_date       DATE        NOT NULL, --종료일
+    reason         VARCHAR(30) NOT NULL, --사유
+    type           VARCHAR(10) NOT NULL, --연차, 오전반차, 오후반차
+    status         VARCHAR(10) NOT NULL, --대기, 승인, 반려 ENUM DEFAULT '대기'
+    apply_at       DATE        NOT NULL,
+    process_at     DATE,    
+
+    FOREIGN KEY (user_id) REFERENCES user_tb(id)
+);
+```
+**4.당직**
+```
+CREATE TABLE duty_tb
+(
+    id          INT PRIMARY KEY AUTO_INCREMENT,
+    user_id     INT         NOT NULL,
+    date        DATE        NOT NULL, --당직 날짜
+    reason      VARCHAR(30) NOT NULL, --사유
+    status      VARCHAR(10) NOT NULL, --대기, 승인, 반려
+    apply_at    DATE        NOT NULL,
+    process_at  DATE,
+
+    FOREIGN KEY (user_id) REFERENCES user_tb(id)
+);
+```
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- PROJECT Functional Specification  -->
+## 🎀 주요 기능
+<h3>🔹 회원가입</h3>
+<ol>
+  <li>jwt이용, 비밀번호 단방향 암호화</li>
+  <li>개인정보있는경우(이름,휴대폰,이메일) AES256양방향 암호화적용,복호화</li>
+  <li>관련필드에 DB검색할떄도 검색조건을 암호화</li>
+</ol>
+<h3>🔹 로그인</h3>
+<ol>
+  <li>jwt token 인증방식, spring security적용</li>
+  <li>login 성공 후 마지막 로그인 성공 날짜 업데이트 적용</li>
+  <li>login 성공 후 회원번호, user-agent, client ip, 시간 로그 등록처리</li>
+  <li>일반로그인/관리자로그인</li>
+</ol>
+<h3>🔹 개인정보수정</h3>
+<ol>
+  <li>개인정보 수정,삭제, 수정된 일자 업데이트</li>
+  <li>개인연차/당직 등록</li>
+  <li>관리자 (유저의 권한 설정), 로그인 발급된 jwt token검증</li>
+  <li>비밀번호변경(단방향 암호화), 전화번호변경</li>
+</ol>
+<h3>🔹 연차/당직</h3>
+<ol>
+  <li>신청내역, 사용내역, 등록, 조회, 취소(crud)</li>
+  <li>연차/당직 구분컬럼구성, 테이블1개설계</li>
+  <li>저장/삭제 api구현필요</li>
+  <li>내 연차일 수</li>
+</ol>
+<h3>🔹 관리자기능</h3>
+<ol>
+  <li>연차 승인</li>
+  <li>연차 반려</li>
+</ol>
+<h3>🔹 사용자간공유</h3>
+<ol>
+  <li>데이터 내려줄 조회 api 구현</li>
+  <li>월별 캘린더 주간/일간 등 다양하게 표현</li>
+</ol>
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- PROJECT API -->
+## 📌 API 명세서
+![image](https://github.com/FC-MINI-6/MiniProject_BE/assets/78328327/eabdf3c6-c6df-44e9-a6b1-8d868c3f9e44)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+

build.gradle

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = 'com.example'
-version = '0.0.1-SNAPSHOT'
+version = '1.0'
 
 java {
     sourceCompatibility = '11'
@@ -32,8 +32,15 @@ dependencies {
     annotationProcessor 'org.projectlombok:lombok'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testImplementation 'org.springframework.security:spring-security-test'
+    implementation group: 'com.auth0', name: 'java-jwt', version: '4.3.0'
+    implementation group: 'org.mariadb.jdbc', name: 'mariadb-java-client', version: '3.1.4'
 }
 
 tasks.named('test') {
+    systemProperty 'file.encoding', 'UTF-8'
     useJUnitPlatform()
 }
+
+jar {
+    enabled = false
+}

src/main/java/com/example/kdtbe5_miniproject/Kdtbe5MiniProjectApplication.java

@@ -2,7 +2,9 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
 
+@EnableJpaAuditing
 @SpringBootApplication
 public class Kdtbe5MiniProjectApplication {
 

src/main/java/com/example/kdtbe5_miniproject/_core/errors/MyExceptionHandler.java

@@ -0,0 +1,48 @@
+package com.example.kdtbe5_miniproject._core.errors;
+
+import com.example.kdtbe5_miniproject._core.errors.exception.*;
+import com.example.kdtbe5_miniproject._core.util.ApiUtils;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+
+@Slf4j
+@RequiredArgsConstructor
+@RestControllerAdvice
+public class MyExceptionHandler {
+
+    @ExceptionHandler(Exception400.class)
+    public ResponseEntity<?> badRequest(Exception400 e) {
+        return new ResponseEntity<>(e.body(), e.status());
+    }
+
+    @ExceptionHandler(Exception401.class)
+    public ResponseEntity<?> unAuthorized(Exception401 e) {
+        return new ResponseEntity<>(e.body(), e.status());
+    }
+
+    @ExceptionHandler(Exception403.class)
+    public ResponseEntity<?> forbidden(Exception403 e) {
+        return new ResponseEntity<>(e.body(), e.status());
+    }
+
+    @ExceptionHandler(Exception404.class)
+    public ResponseEntity<?> notFound(Exception404 e) {
+        return new ResponseEntity<>(e.body(), e.status());
+    }
+
+    @ExceptionHandler(Exception500.class)
+    public ResponseEntity<?> serverError(Exception500 e) {
+        return new ResponseEntity<>(e.body(), e.status());
+    }
+
+    @ExceptionHandler(Exception.class)
+    public ResponseEntity<?> unknownServerError(Exception e) {
+        ApiUtils.ApiMessageResult<?> apiResult = ApiUtils.error(e.getMessage());
+        return new ResponseEntity<>(apiResult, HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+}