Main 병합

README.md

@@ -1,2 +1,177 @@
-# spring-onederful
-기업용 Task 관리 시스템입니다.
+# 💫 아웃소싱 API
+
+<hr>
+
+## 🎀 프로젝트 소개
+
+<hr>
+
+아웃소싱 형태로 진행된 백엔드 프로젝트입니다.
+
+클라이언트 측에서 프론트엔드 개발을 완료한 상태에 참여하였으며,
+
+REST API 기반으로 프론트엔드와 안정적으로 연동되는 백엔드 서버를 설계 및 구축하였습니다.
+
+요구사항 분석부터 API 설계, 예외처리까지 전반적인 서버 개발을 수행한 프로젝트입니다.
+
+> **내일배움캠프 1조**
+>
+> **개발기간 : 2025-06-13 ~ 2025-06-20**
+
+<hr>
+
+## 🧰 기술 스택
+
+![Java17](https://img.shields.io/badge/Java17-red)
+![Springboot3.5](https://img.shields.io/badge/Springboot3.5-yellow)
+![JWT](https://img.shields.io/badge/JWT-orange)
+![Spring Data JPA](https://img.shields.io/badge/Spring_Data_JPA-green)
+![QueryDSL](https://img.shields.io/badge/QueryDSL-blue)
+![MySQL](https://img.shields.io/badge/MySQL-purple)
+![Swagger](https://img.shields.io/badge/Swagger-pink)
+
+<hr>
+
+## 🖼️ ERD
+
+![img.png](img.png)
+
+<hr>
+
+## 📜 API 명세서
+
+API
+명세서는 [OutSourcing Project API 문서](https://teamsparta.notion.site/API-2112dc3ef51480a9a21cf45c77d1e85f)
+를 클릭해주세요
+
+<hr>
+
+## 👥 Team Member
+
+- **이의현 (팀장)**  
+  테스크 도메인 전반 (테스크 생성, 수정 ,조회, 상태변경, 삭제) 담당  
+  GitHub: [leeuihyun](https://github.com/leeuihyun)
+
+
+- **이동근 (팀원)**  
+  회원 도메인 전반 (회원가입, 로그인, 유저 조회, JWT 인증) 담당  
+  GitHub: [DG0702](https://github.com/dg0702)
+
+
+- **김두하 (팀원)**  
+  댓글 도메인 전반 (댓글 생성, 수정, 조회(검색), 삭제) 담당  
+  GitHub: [doohaaa](https://github.com/doohaaa)
+
+
+- **김민성 (팀원)**  
+  대시보드 도메인 전반 (통계 정보 제공, 내 테스크 요약) 담당  
+  GitHub: [urzn](https://github.com/urzn)
+
+
+- **우새빛 (팀원)**  
+  활동로그 도메인 전반 (주요 활동 기록, 활동 로그 조회) 담당  
+  GitHub: [saevit](https://github.com/saevit)
+
+<hr>
+
+## ✨ 주요 기능
+
+- **docker를 이용하여 프론트엔드와 연결**
+
+
+- **프론트엔드, 백엔드의 연결 → 연동 검증 : 브라우저에서 실제 요청/응답 확인**
+
+<hr>
+
+## ✨운영 환경 변수
+
+```json
+DB_URL=jdbc:mysql: //localhost:3306/yourdb
+DB_USERNAME=yourusername
+DB_PASSWORD=youruserpassword
+SECRET_KEY=your_jwt_secret_key
+```
+
+<hr>
+
+## ✨SQL 실행방법
+
+- 데이터베이스 자동생성 X
+- `onederful.sql` 을 본인 데이터베이스에서 실행시켜서 수동 적용합니다.
+- `onederful.sql` 은 최상위 경로에 있습니다.
+
+<hr>
+
+## 🪄 트러블 슈팅
+
+### USER 도메인
+
+- **406 ERROR (회원가입, 로그인)**
+
+    - **응답 할 때 OffsetDateTime 역직렬화 불가 → 의존성을 추가하여 해결**
+
+
+- **JWT 예외처리**
+
+    - **`@ControllerAdvice`를 이용한 JWT 예외를 원하는 응답 형태로 변경 → Controller 보다 먼저 실행 되어 수동으로 응답 형태 생성**
+
+
+- **CORS**
+
+    - **docker 이용하여 프론트엔드 연결 후 백엔드 로직 실행 → CORS 문제 발생하여 CORS 설정하여 해결**
+
+### TASK 도메인
+
+- **DB 정규화 지키기 위한 과도한 설계**
+
+    - **불필요하게 테이블의 복잡성 상승 → Enum을 사용하여 불필요한 분리를 줄이고 타입의 안정성 상승**
+
+
+- **TestCode**
+
+    - **테스트 코드 작성하여 Sturbing 후 실행하였지만 값을 반환하지 않음**
+
+        - **반환값을 직접 지정하여 해결**
+
+### COMMNET 도메인
+
+- **협업의 어려움**
+
+    - **각 도메인 파트별로 개발 → 나중에 연관이 있는 부분을 공통적으로 통일해야하는 문제 발생**
+
+    - **팀원과 소통하며 기본적인 틀에서 조금씩 수정하여 해결**
+
+
+- **프론트엔드 API를 이용한 개발의 어려움**
+
+    - **API 설계를 도메인 위주로 하였으나 프론트 엔드 API와 달라 기능이 구현되지 않음**
+
+    - **프론트엔드 API에 맞추어 API를 일부 수정하여 해결**
+
+### DASHBOARD
+
+- **Priority task 정렬**
+
+    - **Priority`(Enum)` high-medium-low로 정렬하기 위해 `Enum`에 정수 필드를 추가 방식과 `Map<>`을 사용하여 정렬하는 방식을 고민**
+
+    - **`Map<>`을 사용하는것으로 결정 → 순서를 정렬하는 로직이 이 경우밖에 없어서 결정**
+
+        - **추가적으로 순서를 정렬하는 로직이 있을 경우 `Enum`에 정수 필드를 추가하여 사용하는 방향으로 선택**
+
+### LOG
+
+- **AOP 도입 및 책임 분리의 어려움**
+
+    - **로직 분리의 기준을 정하는데 어려움 → 공통 처리와 비즈니스 로직 사이의 경계가 모호**
+
+    - **AOP → 요청 메서드, URL, 로그인 한 유저ID 공통 정보 추출**
+
+        - **추출한 데이터를 서비스 계층으로 전달하여 가공 및 DB 저장을 담당하도록 구조 설계함**
+
+
+
+
+
+
+
+

build.gradle

@@ -1,39 +1,66 @@
 plugins {
-	id 'java'
-	id 'org.springframework.boot' version '3.5.0'
-	id 'io.spring.dependency-management' version '1.1.7'
+    id 'java'
+    id 'org.springframework.boot' version '3.5.0'
+    id 'io.spring.dependency-management' version '1.1.7'
 }
 
 group = 'com.example'
 version = '0.0.1-SNAPSHOT'
 
 java {
-	toolchain {
-		languageVersion = JavaLanguageVersion.of(17)
-	}
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
 }
 
 configurations {
-	compileOnly {
-		extendsFrom annotationProcessor
-	}
+    compileOnly {
+        extendsFrom annotationProcessor
+    }
 }
 
 repositories {
-	mavenCentral()
+    mavenCentral()
 }
 
 dependencies {
-	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
-	implementation 'org.springframework.boot:spring-boot-starter-validation'
-	implementation 'org.springframework.boot:spring-boot-starter-web'
-	compileOnly 'org.projectlombok:lombok'
-	runtimeOnly 'com.mysql:mysql-connector-j'
-	annotationProcessor 'org.projectlombok:lombok'
-	testImplementation 'org.springframework.boot:spring-boot-starter-test'
-	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+    implementation 'org.springframework.boot:spring-boot-starter-validation'
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    compileOnly 'org.projectlombok:lombok'
+    runtimeOnly 'com.mysql:mysql-connector-j'
+    annotationProcessor 'org.projectlombok:lombok'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+
+    // JWT
+    implementation group: 'io.jsonwebtoken', name: 'jjwt-api', version: '0.11.5'
+    runtimeOnly group: 'io.jsonwebtoken', name: 'jjwt-impl', version: '0.11.5'
+    runtimeOnly group: 'io.jsonwebtoken', name: 'jjwt-jackson', version: '0.11.5'
+
+    // bcrypt
+    implementation 'at.favre.lib:bcrypt:0.10.2'
+
+    // OffsetDateTime 역직렬화 하기 위해 필요한 모듈
+    implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310'
+
+    // 테스트용 인메모리 DB
+    testImplementation 'com.h2database:h2'
+
+    // Swagger
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.6'
+
+    //QueryDsl 추가
+    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
+    annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
+    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
+    annotationProcessor "jakarta.persistence:jakarta.persistence-api"
 }
 
 tasks.named('test') {
-	useJUnitPlatform()
+    useJUnitPlatform()
 }
+
+clean {
+    delete file('src/main/generated')
+}

onederful.sql

@@ -0,0 +1,62 @@
+CREATE TABLE users
+(
+    id         BIGINT AUTO_INCREMENT PRIMARY KEY COMMENT '사용자 식별자',
+    username   VARCHAR(100) NOT NULL UNIQUE COMMENT '아이디',
+    email      VARCHAR(100) NOT NULL UNIQUE COMMENT '이메일',
+    password   VARCHAR(255) NOT NULL COMMENT '비밀번호',
+    name       VARCHAR(100) NOT NULL COMMENT '이름',
+    role       VARCHAR(50)  NOT NULL COMMENT '권한 (ENUM)',
+    created_at DATETIME COMMENT '생성일자',
+    updated_at DATETIME COMMENT '수정일자',
+    deleted_at DATETIME COMMENT '삭제날짜',
+    is_deleted BOOLEAN      NOT NULL DEFAULT FALSE COMMENT '삭제여부'
+);
+
+CREATE TABLE tasks
+(
+    id          BIGINT AUTO_INCREMENT PRIMARY KEY COMMENT '업무 식별자',
+    title       VARCHAR(100) NOT NULL COMMENT '제목',
+    description TEXT         NOT NULL COMMENT '설명',
+    priority    VARCHAR(100) NOT NULL COMMENT '우선순위 식별자 (ENUM)',
+    assignee_id BIGINT       NOT NULL COMMENT '담당자 식별자 (FK)',
+    user_id     BIGINT       NOT NULL COMMENT '작성자 식별자 (FK)',
+    status      VARCHAR(100) NOT NULL COMMENT '태스크 상태 (ENUM)',
+    due_date    DATETIME COMMENT '마감일자',
+    started_at  DATETIME COMMENT '시작일자',
+    created_at  DATETIME COMMENT '생성일자',
+    updated_at  DATETIME COMMENT '수정일자',
+    deleted_at  DATETIME COMMENT '삭제날짜',
+    is_deleted  BOOLEAN      NOT NULL DEFAULT FALSE COMMENT '삭제여부',
+
+    FOREIGN KEY (assignee_id) REFERENCES users (id) ON DELETE CASCADE,
+    FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE
+);
+
+CREATE TABLE comments
+(
+    id         BIGINT AUTO_INCREMENT PRIMARY KEY COMMENT '댓글 식별자',
+    content    TEXT    NOT NULL COMMENT '댓글 내용',
+    task_id    BIGINT  NOT NULL COMMENT '업무 식별자 (FK)',
+    user_id    BIGINT  NOT NULL COMMENT '작성자 식별자 (FK)',
+    created_at DATETIME COMMENT '생성일자',
+    updated_at DATETIME COMMENT '수정일자',
+    deleted_at DATETIME COMMENT '삭제날짜',
+    is_deleted BOOLEAN NOT NULL DEFAULT FALSE COMMENT '삭제여부',
+
+    FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE,
+    FOREIGN KEY (task_id) REFERENCES tasks (id) ON DELETE CASCADE
+);
+
+CREATE TABLE logs
+(
+    id          BIGINT AUTO_INCREMENT PRIMARY KEY COMMENT '로그 식별자',
+    user_id     BIGINT       NOT NULL COMMENT '사용자 식별자 (FK)',
+    activity    VARCHAR(100) NOT NULL COMMENT '활동 유형',
+    ip_address  VARCHAR(100) NOT NULL COMMENT 'ip 주소',
+    method      VARCHAR(100) NOT NULL COMMENT '요청 메서드 (ENUM)',
+    target_id   BIGINT       NOT NULL COMMENT '작업 대상 식별자',
+    request_url VARCHAR(200) NOT NULL COMMENT '로그 요청 url',
+    created_at  DATETIME COMMENT '생성일자',
+
+    FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE
+);

src/main/java/com/example/onederful/OnederfulApplication.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 OnederfulApplication {
 

src/main/java/com/example/onederful/common/ApiResponseDto.java

@@ -0,0 +1,27 @@
+package com.example.onederful.common;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+import java.time.OffsetDateTime;
+
+@Getter
+@AllArgsConstructor
+public class ApiResponseDto {
+
+    private boolean success;
+    private String message;
+    private Object data;
+    private OffsetDateTime timestamp;
+
+    // 성공 응답 static 메서드
+    public static ApiResponseDto success(String message,Object date){
+        return new ApiResponseDto(true, message , date, OffsetDateTime.now());
+    }
+
+    // 실패 응답 static 메서드
+    public static ApiResponseDto error(String message){
+        return new ApiResponseDto(false, message, null, OffsetDateTime.now());
+    }
+
+}

src/main/java/com/example/onederful/common/ListResponse.java

@@ -0,0 +1,16 @@
+package com.example.onederful.common;
+
+import java.util.List;
+import lombok.Builder;
+import lombok.Getter;
+
+@Getter
+@Builder
+public class ListResponse<T> {
+
+    private List<T> content;
+    private Long totalElements;
+    private int totalPages;
+    private int size;
+    private int number;
+}