Skip to content

Commit adc2bfa

Browse files
authored
Merge pull request #11 from FlipNoteTeam/refactor/project-structure
Refactor: 프로젝트 구조 리팩토링
2 parents 9d8831e + 3894f45 commit adc2bfa

95 files changed

Lines changed: 1417 additions & 1076 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ RUN apt-get update \
1818

1919
COPY --from=build /app/build/libs/user-0.0.1-SNAPSHOT.jar .
2020

21-
EXPOSE 8080
21+
EXPOSE 8081
2222

2323
ENTRYPOINT ["java", "-jar", "user-0.0.1-SNAPSHOT.jar"]

‎README.md‎

Lines changed: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
# 📒 FlipNote — User Service
2+
3+
**FlipNote 서비스의 유저 도메인 백엔드 레포지토리입니다.**
4+
5+
![Spring Boot](https://img.shields.io/badge/Spring_Boot-6DB33F?logo=springboot&logoColor=white)
6+
![Java](https://img.shields.io/badge/Java_21-007396?logo=openjdk&logoColor=white)
7+
![MySQL](https://img.shields.io/badge/MySQL-4479A1?logo=mysql&logoColor=white)
8+
![Redis](https://img.shields.io/badge/Redis-FF4438?logo=redis&logoColor=white)
9+
![Deploy](https://img.shields.io/badge/Deploy-GHCR%20%2B%20Docker-2496ED?logo=docker&logoColor=white)
10+
11+
---
12+
13+
## 📑 목차
14+
15+
- [시작하기](#시작하기)
16+
- [환경 변수](#환경-변수)
17+
- [실행 및 배포](#실행-및-배포)
18+
- [프로젝트 구조](#프로젝트-구조)
19+
20+
---
21+
22+
<a id="시작하기"></a>
23+
24+
## 🚀 시작하기
25+
26+
### 사전 요구사항
27+
28+
- **Java** 21 이상
29+
- **Gradle** 8 이상
30+
- **MySQL** 8 이상
31+
- **Redis** 6 이상
32+
- Google OAuth2 클라이언트 생성 및 API 키 발급
33+
- Resend 계정 생성 및 API 키 발급
34+
35+
### 설치
36+
37+
```bash
38+
# 의존성 설치 및 빌드
39+
./gradlew build -x test
40+
```
41+
42+
---
43+
44+
<a id="환경-변수"></a>
45+
46+
## 🔐 환경 변수
47+
48+
`application.yml`에서 참조하는 환경 변수 목록입니다. 로컬 실행 시 `.env` 또는 IDE 실행 구성에 아래 변수를 설정합니다.
49+
50+
```text
51+
# ─── Database ───────────────────────────────────────────
52+
DB_URL=jdbc:mysql://localhost:3306/flipnote_user
53+
DB_USERNAME=
54+
DB_PASSWORD=
55+
56+
# ─── Redis ──────────────────────────────────────────────
57+
REDIS_HOST=localhost
58+
REDIS_PORT=6379
59+
REDIS_PASSWORD=
60+
61+
# ─── JPA ────────────────────────────────────────────────
62+
# create | create-drop | update | validate | none
63+
DDL_AUTO=update
64+
65+
# ─── gRPC ───────────────────────────────────────────────
66+
GRPC_PORT=9092
67+
68+
# ─── JWT ────────────────────────────────────────────────
69+
JWT_SECRET=
70+
# 액세스 토큰 만료 시간 (ms), 기본값 900000 (15분)
71+
JWT_ACCESS_EXPIRATION=900000
72+
# 리프레시 토큰 만료 시간 (ms), 기본값 604800000 (7일)
73+
JWT_REFRESH_EXPIRATION=604800000
74+
75+
# ─── Email (Resend) ─────────────────────────────────────
76+
APP_RESEND_API_KEY=
77+
78+
# ─── Client ─────────────────────────────────────────────
79+
# 프론트엔드 URL (CORS, 리다이렉트에 사용)
80+
APP_CLIENT_URL=http://localhost:3000
81+
82+
# ─── Google OAuth2 ──────────────────────────────────────
83+
GOOGLE_CLIENT_ID=
84+
GOOGLE_CLIENT_SECRET=
85+
```
86+
87+
> **⚠️ 주의**: 환경 변수 파일은 절대 git에 커밋하지 마세요. `.gitignore`에 포함되어 있는지 반드시 확인하세요.
88+
89+
---
90+
91+
<a id="실행-및-배포"></a>
92+
93+
## 🖥️ 실행 및 배포
94+
95+
### 로컬 개발 서버 실행
96+
97+
```bash
98+
./gradlew bootRun
99+
```
100+
101+
기본적으로 `http://localhost:8081`에서 실행됩니다.
102+
Swagger UI는 `http://localhost:8081/users/swagger-ui.html`에서 확인할 수 있습니다.
103+
104+
### 프로덕션 빌드
105+
106+
```bash
107+
./gradlew bootJar
108+
```
109+
110+
`build/libs/user-0.0.1-SNAPSHOT.jar` 파일이 생성됩니다.
111+
112+
### 테스트 실행
113+
114+
```bash
115+
./gradlew test
116+
```
117+
118+
### Docker 이미지 빌드 및 실행
119+
120+
```bash
121+
# 이미지 빌드
122+
docker build -t flipnote-user .
123+
124+
# 컨테이너 실행
125+
docker run -p 8081:8081 \
126+
-e DB_URL=... \
127+
-e JWT_SECRET=... \
128+
flipnote-user
129+
```
130+
131+
### 배포 (GitHub Actions)
132+
133+
`main` 브랜치에 push 시 GitHub Actions가 자동으로 아래 과정을 실행합니다.
134+
135+
**CI** (`push` / `pull_request` → `main`)
136+
1. JDK 21 설치
137+
2. `./gradlew build -x test` — 빌드 검증
138+
3. `./gradlew test` — 테스트 실행
139+
4. Dependency-Check — 취약점 분석 리포트 생성
140+
141+
**CD** (`push` → `main`)
142+
1. GitHub Container Registry(GHCR) 로그인
143+
2. Docker 이미지 빌드
144+
3. `ghcr.io/dungbik/flipnote-user` 이미지 Push
145+
146+
> 배포에 필요한 시크릿(`ORG_PAT`)은 GitHub Repository → Settings → Secrets and variables → Actions에 등록해야 합니다.
147+
148+
---
149+
150+
<a id="프로젝트-구조"></a>
151+
152+
## 📁 프로젝트 구조
153+
154+
- 간략화 버전
155+
156+
```text
157+
src/main/java/flipnote/user/
158+
├── domain/ # 도메인 레이어 (엔티티, 레포지토리, 에러코드, 이벤트)
159+
├── application/ # 애플리케이션 레이어 (서비스)
160+
├── infrastructure/ # 인프라 레이어 (JWT, Redis, 메일, OAuth, 설정)
161+
└── interfaces/ # 인터페이스 레이어 (HTTP, gRPC 진입점)
162+
```
163+
164+
```text
165+
FlipNote-User/
166+
├── src/
167+
│ ├── main/
168+
│ │ ├── java/flipnote/user/
169+
│ │ │ ├── UserApplication.java
170+
│ │ │ │
171+
│ │ │ ├── domain/ # 도메인 레이어
172+
│ │ │ │ ├── common/ # 도메인 공통
173+
│ │ │ │ │ ├── ErrorCode.java
174+
│ │ │ │ │ ├── BizException.java
175+
│ │ │ │ │ └── EmailSendException.java
176+
│ │ │ │ ├── entity/ # JPA 엔티티
177+
│ │ │ │ │ ├── User.java
178+
│ │ │ │ │ ├── OAuthLink.java
179+
│ │ │ │ │ └── BaseEntity.java
180+
│ │ │ │ ├── repository/ # 레포지토리 인터페이스
181+
│ │ │ │ │ ├── UserRepository.java
182+
│ │ │ │ │ └── OAuthLinkRepository.java
183+
│ │ │ │ ├── event/ # 도메인 이벤트
184+
│ │ │ │ │ ├── EmailVerificationSendEvent.java
185+
│ │ │ │ │ └── PasswordResetCreateEvent.java
186+
│ │ │ │ ├── AuthErrorCode.java
187+
│ │ │ │ ├── UserErrorCode.java
188+
│ │ │ │ ├── ImageErrorCode.java
189+
│ │ │ │ ├── TokenClaims.java
190+
│ │ │ │ ├── TokenPair.java
191+
│ │ │ │ ├── PasswordResetConstants.java
192+
│ │ │ │ └── VerificationConstants.java
193+
│ │ │ │
194+
│ │ │ ├── application/ # 애플리케이션 레이어
195+
│ │ │ │ ├── AuthService.java
196+
│ │ │ │ ├── OAuthService.java
197+
│ │ │ │ └── UserService.java
198+
│ │ │ │
199+
│ │ │ ├── infrastructure/ # 인프라 레이어
200+
│ │ │ │ ├── config/ # 범용 설정 (App, JPA, Swagger, gRPC 클라이언트)
201+
│ │ │ │ ├── jwt/ # JWT 발급/검증 + 설정
202+
│ │ │ │ ├── mail/ # 메일 발송 서비스 + 설정
203+
│ │ │ │ ├── oauth/ # Google OAuth2 클라이언트 + 설정
204+
│ │ │ │ ├── redis/ # Redis 저장소 (토큰, 인증코드 등)
205+
│ │ │ │ └── listener/ # 도메인 이벤트 리스너
206+
│ │ │ │
207+
│ │ │ └── interfaces/ # 인터페이스 레이어
208+
│ │ │ ├── http/ # HTTP 진입점
209+
│ │ │ │ ├── AuthController.java # 인증 (회원가입, 로그인, 비밀번호 등)
210+
│ │ │ │ ├── OAuthController.java # 소셜 로그인 (Google OAuth2)
211+
│ │ │ │ ├── UserController.java # 유저 정보 조회/수정
212+
│ │ │ │ ├── dto/
213+
│ │ │ │ │ ├── request/ # Request DTO
214+
│ │ │ │ │ └── response/ # Response DTO
215+
│ │ │ │ └── common/ # ApiResponse, 예외 처리, 쿠키 유틸
216+
│ │ │ └── grpc/ # gRPC 진입점
217+
│ │ │ ├── GrpcUserQueryService.java # 유저 조회 gRPC 서비스
218+
│ │ │ └── GrpcExceptionHandlerImpl.java # gRPC 전역 예외 처리
219+
│ │ │
220+
│ │ ├── proto/ # gRPC proto 파일
221+
│ │ │ ├── user_query.proto
222+
│ │ │ └── image.proto
223+
│ │ │
224+
│ │ └── resources/
225+
│ │ ├── application.yml
226+
│ │ └── templates/email/ # 이메일 HTML 템플릿 (Thymeleaf)
227+
│ │ ├── email-verification.html
228+
│ │ └── password-reset.html
229+
│ │
230+
│ └── test/
231+
│ └── java/flipnote/user/
232+
│
233+
├── Dockerfile
234+
├── build.gradle.kts
235+
└── settings.gradle.kts
236+
```

‎build.gradle.kts‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,6 @@ repositories {
2323

2424
extra["springGrpcVersion"] = "1.0.2"
2525

26-
27-
dependencyManagement {
28-
imports {
29-
mavenBom("org.springframework.grpc:spring-grpc-dependencies:1.0.2")
30-
}
31-
}
32-
3326
dependencies {
3427
implementation("org.springframework.boot:spring-boot-starter-data-jpa")
3528
implementation("org.springframework.boot:spring-boot-starter-web")

0 commit comments

Comments
 (0)