Skip to content

Commit 1b4e0ed

Browse files
authored
Merge pull request #1 from FlipNoteTeam/refactor/project-structure
Refactor: 프로젝트 구조 리팩토링
2 parents aee1bbb + fc781eb commit 1b4e0ed

37 files changed

Lines changed: 490 additions & 187 deletions

‎README.md‎

Lines changed: 239 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,239 @@
1+
# 📔 FlipNote — Notification 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+
![RabbitMQ](https://img.shields.io/badge/RabbitMQ-FF6600?logo=rabbitmq&logoColor=white)
9+
![Firebase](https://img.shields.io/badge/Firebase-FFCA28?logo=firebase&logoColor=black)
10+
![Deploy](https://img.shields.io/badge/Deploy-GHCR%20%2B%20Docker-2496ED?logo=docker&logoColor=white)
11+
12+
---
13+
14+
## 📑 목차
15+
16+
- [시작하기](#시작하기)
17+
- [환경 변수](#환경-변수)
18+
- [실행 및 배포](#실행-및-배포)
19+
- [프로젝트 구조](#프로젝트-구조)
20+
21+
---
22+
23+
<a id="시작하기"></a>
24+
25+
## 🚀 시작하기
26+
27+
### 사전 요구사항
28+
29+
- **Java** 21 이상
30+
- **Gradle** 8 이상
31+
- **MySQL** 8 이상
32+
- **RabbitMQ** 3 이상
33+
- Firebase 프로젝트 생성 및 서비스 계정 JSON 발급
34+
35+
### 설치
36+
37+
```bash
38+
# 의존성 설치 및 빌드
39+
./gradlew build -x test
40+
```
41+
42+
---
43+
44+
<a id="환경-변수"></a>
45+
46+
## 🔐 환경 변수
47+
48+
`application.yaml`에서 참조하는 환경 변수 목록입니다.
49+
50+
```text
51+
# ─── Database ───────────────────────────────────────────
52+
DB_URL=jdbc:mysql://localhost:3306/flipnote_notification
53+
DB_USERNAME=
54+
DB_PASSWORD=
55+
56+
# ─── JPA ────────────────────────────────────────────────
57+
# create | create-drop | update | validate | none
58+
JPA_DDL_AUTO=validate
59+
60+
# ─── RabbitMQ ───────────────────────────────────────────
61+
RABBITMQ_HOST=localhost
62+
RABBITMQ_PORT=5672
63+
RABBITMQ_USERNAME=guest
64+
RABBITMQ_PASSWORD=guest
65+
66+
# ─── Firebase ───────────────────────────────────────────
67+
# 서비스 계정 JSON 전체 내용 (문자열)
68+
FIREBASE_SERVICE_ACCOUNT_JSON=
69+
70+
# ─── Server ─────────────────────────────────────────────
71+
SERVER_PORT=8086
72+
73+
# ─── Async Thread Pool ──────────────────────────────────
74+
ASYNC_CORE_POOL_SIZE=4
75+
ASYNC_MAX_POOL_SIZE=10
76+
ASYNC_QUEUE_CAPACITY=100
77+
78+
# ─── Swagger ────────────────────────────────────────────
79+
SPRINGDOC_SERVER_URL=http://localhost:8086
80+
```
81+
82+
> **⚠️ 주의**: 환경 변수 파일은 절대 git에 커밋하지 마세요. `.gitignore`에 포함되어 있는지 반드시 확인하세요.
83+
84+
---
85+
86+
<a id="실행-및-배포"></a>
87+
88+
## 🖥️ 실행 및 배포
89+
90+
### 로컬 개발 서버 실행
91+
92+
```bash
93+
./gradlew bootRun
94+
```
95+
96+
기본적으로 `http://localhost:8086`에서 실행됩니다.
97+
Swagger UI는 `http://localhost:8086/notifications/swagger-ui.html`에서 확인할 수 있습니다.
98+
99+
### 프로덕션 빌드
100+
101+
```bash
102+
./gradlew bootJar
103+
```
104+
105+
`build/libs/notification-0.0.1-SNAPSHOT.jar` 파일이 생성됩니다.
106+
107+
### 테스트 실행
108+
109+
```bash
110+
./gradlew test
111+
```
112+
113+
### Docker 이미지 빌드 및 실행
114+
115+
```bash
116+
# 이미지 빌드
117+
docker build -t flipnote-notification .
118+
119+
# 컨테이너 실행
120+
docker run -p 8086:8086 \
121+
-e DB_URL=... \
122+
-e FIREBASE_SERVICE_ACCOUNT_JSON=... \
123+
flipnote-notification
124+
```
125+
126+
### 배포 (GitHub Actions)
127+
128+
`main` 브랜치에 push 시 GitHub Actions가 자동으로 아래 과정을 실행합니다.
129+
130+
**CI** (`push` / `pull_request` → `main`)
131+
1. JDK 21 설치
132+
2. `./gradlew build -x test` — 빌드 검증
133+
3. `./gradlew test` — 테스트 실행
134+
4. Dependency-Check — 취약점 분석 리포트 생성
135+
136+
**CD** (`push` → `main`)
137+
1. GitHub Container Registry(GHCR) 로그인
138+
2. Docker 이미지 빌드
139+
3. `ghcr.io/dungbik/flipnote-notification` 이미지 Push
140+
141+
> 배포에 필요한 시크릿(`ORG_PAT`)은 GitHub Repository → Settings → Secrets and variables → Actions에 등록해야 합니다.
142+
143+
---
144+
145+
<a id="프로젝트-구조"></a>
146+
147+
## 📁 프로젝트 구조
148+
149+
- 간략화 버전
150+
151+
```text
152+
src/main/java/flipnote/notification/
153+
├── domain/ # 도메인 레이어 (엔티티, 레포지토리, 에러코드)
154+
├── application/ # 애플리케이션 레이어 (서비스, 커맨드, 결과 객체)
155+
├── infrastructure/ # 인프라 레이어 (Firebase, RabbitMQ, 설정)
156+
└── interfaces/ # 인터페이스 레이어 (HTTP 진입점)
157+
```
158+
159+
```text
160+
FlipNote-Notification/
161+
├── src/
162+
│ ├── main/
163+
│ │ ├── java/flipnote/notification/
164+
│ │ │ ├── FlipNoteNotificationApplication.java
165+
│ │ │ │
166+
│ │ │ ├── domain/ # 도메인 레이어
167+
│ │ │ │ ├── common/ # 도메인 공통
168+
│ │ │ │ │ ├── ErrorCode.java
169+
│ │ │ │ │ ├── BizException.java
170+
│ │ │ │ │ ├── CommonErrorCode.java
171+
│ │ │ │ │ └── BaseEntity.java
172+
│ │ │ │ ├── notification/ # 알림 도메인
173+
│ │ │ │ │ ├── Notification.java
174+
│ │ │ │ │ ├── NotificationType.java
175+
│ │ │ │ │ ├── NotificationRepository.java
176+
│ │ │ │ │ └── NotificationErrorCode.java
177+
│ │ │ │ └── fcmtoken/ # FCM 토큰 도메인
178+
│ │ │ │ ├── FcmToken.java
179+
│ │ │ │ └── FcmTokenRepository.java
180+
│ │ │ │
181+
│ │ │ ├── application/ # 애플리케이션 레이어
182+
│ │ │ │ ├── dto/
183+
│ │ │ │ │ ├── command/ # 서비스 입력 커맨드 (검증 어노테이션 없음)
184+
│ │ │ │ │ │ └── NotificationListCommand.java
185+
│ │ │ │ │ └── result/ # 서비스 출력 결과 객체 (프로토콜 무관)
186+
│ │ │ │ │ ├── FcmSendResult.java
187+
│ │ │ │ │ ├── NotificationResult.java
188+
│ │ │ │ │ └── PagedResult.java
189+
│ │ │ │ ├── FcmSender.java # FCM 아웃바운드 포트 인터페이스
190+
│ │ │ │ ├── FcmTokenService.java
191+
│ │ │ │ ├── NotificationCommandService.java
192+
│ │ │ │ └── NotificationQueryService.java
193+
│ │ │ │
194+
│ │ │ ├── infrastructure/ # 인프라 레이어
195+
│ │ │ │ ├── config/ # 범용 설정
196+
│ │ │ │ │ ├── AppConfig.java
197+
│ │ │ │ │ ├── AsyncConfig.java
198+
│ │ │ │ │ ├── AsyncProperties.java
199+
│ │ │ │ │ └── SwaggerConfig.java
200+
│ │ │ │ ├── persistence/ # JPA 설정 및 변환기
201+
│ │ │ │ │ ├── JpaAuditingConfig.java
202+
│ │ │ │ │ └── MapToJsonConverter.java
203+
│ │ │ │ ├── fcm/ # Firebase Cloud Messaging 어댑터
204+
│ │ │ │ │ ├── FirebaseConfig.java
205+
│ │ │ │ │ ├── FirebaseFcmSender.java # FcmSender 구현체
206+
│ │ │ │ │ └── FcmErrorCode.java
207+
│ │ │ │ └── messaging/ # RabbitMQ 메시지 처리
208+
│ │ │ │ ├── RabbitMQConfig.java
209+
│ │ │ │ ├── GroupInviteMessage.java
210+
│ │ │ │ ├── GroupInviteMessageListener.java
211+
│ │ │ │ ├── GroupJoinRequestMessage.java
212+
│ │ │ │ └── GroupJoinRequestMessageListener.java
213+
│ │ │ │
214+
│ │ │ └── interfaces/ # 인터페이스 레이어
215+
│ │ │ └── http/ # HTTP 진입점
216+
│ │ │ ├── NotificationController.java
217+
│ │ │ ├── NotificationControllerDocs.java
218+
│ │ │ ├── dto/request/ # HTTP Request DTO (@Valid 포함)
219+
│ │ │ │ ├── NotificationListRequest.java
220+
│ │ │ │ └── TokenRegisterRequest.java
221+
│ │ │ └── common/ # HTTP 공통 유틸
222+
│ │ │ ├── ApiResponse.java
223+
│ │ │ ├── ApiResponseAdvice.java
224+
│ │ │ ├── CursorPagingRequest.java
225+
│ │ │ ├── CursorPagingResponse.java
226+
│ │ │ ├── GlobalExceptionHandler.java
227+
│ │ │ └── HttpHeaders.java
228+
│ │ │
229+
│ │ └── resources/
230+
│ │ ├── application.yaml
231+
│ │ └── messages.properties # 알림 메시지 템플릿
232+
│ │
233+
│ └── test/
234+
│ └── java/flipnote/notification/
235+
│
236+
├── Dockerfile
237+
├── build.gradle.kts
238+
└── settings.gradle.kts
239+
```
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
package flipnote.notification.application;
2+
3+
import java.util.List;
4+
5+
import flipnote.notification.application.dto.result.FcmSendResult;
6+
7+
public interface FcmSender {
8+
9+
FcmSendResult sendEachForMulticast(List<String> tokens, String title, String body);
10+
}

src/main/java/flipnote/notification/application/service/FcmTokenService.java renamed to src/main/java/flipnote/notification/application/FcmTokenService.java

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
package flipnote.notification.application.service;
1+
package flipnote.notification.application;
22

33
import java.util.Objects;
44
import java.util.Optional;
55

66
import org.springframework.stereotype.Service;
77
import org.springframework.transaction.annotation.Transactional;
88

9-
import flipnote.notification.application.dto.request.TokenRegisterRequest;
109
import flipnote.notification.domain.fcmtoken.FcmToken;
1110
import flipnote.notification.domain.fcmtoken.FcmTokenRepository;
1211
import lombok.RequiredArgsConstructor;
@@ -19,20 +18,20 @@ public class FcmTokenService {
1918
private final FcmTokenRepository fcmTokenRepository;
2019

2120
@Transactional
22-
public void registerFcmToken(Long userId, TokenRegisterRequest req) {
23-
Optional<FcmToken> existingToken = fcmTokenRepository.findByToken(req.token());
21+
public void registerFcmToken(Long userId, String token) {
22+
Optional<FcmToken> existingToken = fcmTokenRepository.findByToken(token);
2423

2524
if (existingToken.isPresent()) {
26-
FcmToken token = existingToken.get();
25+
FcmToken fcmToken = existingToken.get();
2726

28-
if (Objects.equals(token.getUserId(), userId)) {
29-
token.updateLastUsedAt();
27+
if (Objects.equals(fcmToken.getUserId(), userId)) {
28+
fcmToken.updateLastUsedAt();
3029
} else {
31-
fcmTokenRepository.deleteById(token.getId());
32-
saveFcmToken(userId, req.token());
30+
fcmTokenRepository.deleteById(fcmToken.getId());
31+
saveFcmToken(userId, token);
3332
}
3433
} else {
35-
saveFcmToken(userId, req.token());
34+
saveFcmToken(userId, token);
3635
}
3736
}
3837

src/main/java/flipnote/notification/application/service/NotificationCommandService.java renamed to src/main/java/flipnote/notification/application/NotificationCommandService.java

Lines changed: 13 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
package flipnote.notification.application.service;
1+
package flipnote.notification.application;
22

33
import java.time.LocalDateTime;
4-
import java.util.ArrayList;
54
import java.util.List;
65
import java.util.Locale;
76
import java.util.Map;
@@ -11,19 +10,14 @@
1110
import org.springframework.stereotype.Service;
1211
import org.springframework.transaction.annotation.Transactional;
1312

14-
import com.google.firebase.messaging.BatchResponse;
15-
import com.google.firebase.messaging.FirebaseMessagingException;
16-
import com.google.firebase.messaging.SendResponse;
17-
18-
import flipnote.notification.application.port.FcmSender;
19-
import flipnote.notification.common.exception.BizException;
20-
import flipnote.notification.common.exception.NotificationErrorCode;
13+
import flipnote.notification.application.dto.result.FcmSendResult;
14+
import flipnote.notification.domain.common.BizException;
2115
import flipnote.notification.domain.fcmtoken.FcmToken;
2216
import flipnote.notification.domain.fcmtoken.FcmTokenRepository;
2317
import flipnote.notification.domain.notification.Notification;
18+
import flipnote.notification.domain.notification.NotificationErrorCode;
2419
import flipnote.notification.domain.notification.NotificationRepository;
2520
import flipnote.notification.domain.notification.NotificationType;
26-
import flipnote.notification.infrastructure.fcm.FcmErrorCode;
2721
import lombok.RequiredArgsConstructor;
2822
import lombok.extern.slf4j.Slf4j;
2923

@@ -101,44 +95,20 @@ public void markAllNotificationsAsRead(Long userId) {
10195
}
10296

10397
private void sendFcmNotification(Long userId, String body) {
104-
List<FcmToken> infos = fcmTokenRepository.findByUserId(userId);
105-
if (infos.isEmpty()) {
98+
List<FcmToken> fcmTokens = fcmTokenRepository.findByUserId(userId);
99+
if (fcmTokens.isEmpty()) {
106100
log.warn("No FCM tokens for user {}", userId);
107101
return;
108102
}
109103

110-
List<String> tokens = infos.stream().map(FcmToken::getToken).toList();
111-
try {
112-
BatchResponse response = fcmSender.sendEachForMulticast(tokens, "알림", body);
113-
114-
List<String> validTokens = new ArrayList<>();
115-
List<String> invalidTokens = new ArrayList<>();
116-
for (int i = 0; i < response.getResponses().size(); i++) {
117-
SendResponse res = response.getResponses().get(i);
118-
if (res.isSuccessful()) {
119-
validTokens.add(tokens.get(i));
120-
} else {
121-
String errorName = res.getException().getMessagingErrorCode().name();
122-
FcmErrorCode code = FcmErrorCode.from(errorName);
123-
if (code == FcmErrorCode.UNREGISTERED || code == FcmErrorCode.INVALID_ARGUMENT) {
124-
invalidTokens.add(tokens.get(i));
125-
}
126-
}
127-
}
104+
List<String> tokens = fcmTokens.stream().map(FcmToken::getToken).toList();
105+
FcmSendResult result = fcmSender.sendEachForMulticast(tokens, "알림", body);
128106

129-
if (!invalidTokens.isEmpty()) {
130-
fcmTokenRepository.deleteByUserIdAndTokenIn(userId, invalidTokens);
131-
}
132-
if (!validTokens.isEmpty()) {
133-
fcmTokenRepository.bulkUpdateLastUsedAt(validTokens, LocalDateTime.now());
134-
}
135-
} catch (FirebaseMessagingException e) {
136-
String errorName = e.getMessagingErrorCode() != null ? e.getMessagingErrorCode().name() : "INTERNAL";
137-
FcmErrorCode code = FcmErrorCode.from(errorName);
138-
if (code == FcmErrorCode.UNAVAILABLE) {
139-
throw new BizException(NotificationErrorCode.FCM_SERVER_UNAVAILABLE);
140-
}
141-
throw new BizException(NotificationErrorCode.FCM_INTERNAL_ERROR);
107+
if (!result.invalidTokens().isEmpty()) {
108+
fcmTokenRepository.deleteByUserIdAndTokenIn(userId, result.invalidTokens());
109+
}
110+
if (!result.validTokens().isEmpty()) {
111+
fcmTokenRepository.bulkUpdateLastUsedAt(result.validTokens(), LocalDateTime.now());
142112
}
143113
}
144114

0 commit comments

Comments
 (0)