|
| 1 | +# 📔 FlipNote — Notification Service |
| 2 | + |
| 3 | +**FlipNote 서비스의 알림 도메인 백엔드 레포지토리입니다.** |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + |
| 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 | +``` |
0 commit comments