Merge pull request #12 from SEMOSAN/feat/#11-fcm

[Feat] FCM 푸시 알림 구현

Author: howooyeon

.gitignore

@@ -45,4 +45,11 @@ application-local.yaml
 k8s/app/secret.yaml
 k8s/postgres/secret.yaml
 
+# OMC
 .omc
+
+# Firebase
+src/main/resources/firebase/
+
+## docs
+docs/**

build.gradle

@@ -39,6 +39,9 @@ dependencies {
 	implementation 'io.jsonwebtoken:jjwt-api:0.12.3'
 	implementation 'io.jsonwebtoken:jjwt-impl:0.12.3'
 	implementation 'io.jsonwebtoken:jjwt-jackson:0.12.3'
+
+	// FCM
+	implementation 'com.google.firebase:firebase-admin:9.8.0'
 }
 
 tasks.named('test') {

src/main/java/com/semosan/api/common/config/AsyncConfig.java

@@ -0,0 +1,27 @@
+package com.semosan.api.common.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.EnableAsync;
+import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
+
+import java.util.concurrent.Executor;
+import java.util.concurrent.ThreadPoolExecutor;
+
+@Configuration
+@EnableAsync
+public class AsyncConfig {
+
+    @Bean(name = "notificationTaskExecutor")
+    public Executor notificationTaskExecutor() {
+        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
+        executor.setCorePoolSize(5);
+        executor.setMaxPoolSize(20);
+        executor.setQueueCapacity(500);
+        executor.setThreadNamePrefix("notif-async-");
+        // 큐 가득 차면 호출 스레드가 직접 실행 → 메시지 유실 방지
+        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
+        // executor.initialize() 호출 안 함 → Spring이 afterPropertiesSet()에서 자동 호출
+        return executor;
+    }
+}

src/main/java/com/semosan/api/common/config/FirebaseConfig.java

@@ -0,0 +1,42 @@
+package com.semosan.api.common.config;
+
+import com.google.auth.oauth2.GoogleCredentials;
+import com.google.firebase.FirebaseApp;
+import com.google.firebase.FirebaseOptions;
+import jakarta.annotation.PostConstruct;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.io.ClassPathResource;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+@Slf4j
+@Configuration
+public class FirebaseConfig {
+
+    @Value("${firebase.service-account-path}")
+    private String serviceAccountPath;
+
+    // 이 빈 만들어진 직후에 이 메서드 자동 실행, 앱 시작할 때 딱 한 번 실행됨
+    @PostConstruct
+    public void initialize() throws IOException {
+        if (!FirebaseApp.getApps().isEmpty()) {
+            log.info("FirebaseApp already initialized, skipping");
+            return;
+        }
+
+        // new File() 안 쓰는 이유는 jar로 빌드하면 파일들이 jar 안에 들어가는데, new File()은 jar 내부 파일을 못 읽음
+        // ClassPathResource는 잘 읽는다고 함
+        try (InputStream serviceAccount = new ClassPathResource(serviceAccountPath).getInputStream()) {
+            FirebaseOptions options = FirebaseOptions.builder()
+                    .setCredentials(GoogleCredentials.fromStream(serviceAccount))
+                    .build();
+
+            FirebaseApp.initializeApp(options);
+            log.info("FirebaseApp initialized successfully");
+        }
+    }
+
+}

src/main/java/com/semosan/api/common/fcm/FcmService.java

@@ -0,0 +1,35 @@
+package com.semosan.api.common.fcm;
+
+import com.google.firebase.messaging.FirebaseMessaging;
+import com.google.firebase.messaging.FirebaseMessagingException;
+import com.google.firebase.messaging.Message;
+import com.google.firebase.messaging.Notification;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+
+import java.util.Map;
+
+@Slf4j
+@Service
+public class FcmService {
+
+    public String sendMessage(String token, String title, String body, Map<String, String> data) throws FirebaseMessagingException {
+        Notification notification = Notification.builder()
+                .setTitle(title)
+                .setBody(body)
+                .build();
+
+        Message.Builder builder = Message.builder()
+                .setToken(token)
+                .setNotification(notification);
+
+        if (data != null && !data.isEmpty()) {
+            builder.putAllData(data);
+        }
+
+        String response = FirebaseMessaging.getInstance().send(builder.build());
+        log.info("FCM 발송 성공: {}", response);
+        return response;
+    }
+
+}

src/main/java/com/semosan/api/common/status/ErrorStatus.java

@@ -50,6 +50,11 @@ public enum ErrorStatus implements BaseStatus {
      */
     USER_NOT_FOUND(HttpStatus.NOT_FOUND, "USER_404_1", "사용자를 찾을 수 없습니다."),
 
+    /**
+     * Notification
+     */
+    NOTIFICATION_PARAMS_INVALID(HttpStatus.BAD_REQUEST, "NOTIF_400_1", "알림 파라미터가 유효하지 않습니다."),
+
     /**
      * Apple OAuth
      */

src/main/java/com/semosan/api/common/status/SuccessStatus.java

@@ -20,7 +20,14 @@ public enum SuccessStatus implements BaseStatus {
     /**
      * User
      */
-    WITHDRAW_SUCCESS(HttpStatus.OK, "USER_200_1", "회원 탈퇴가 완료되었습니다.");
+    WITHDRAW_SUCCESS(HttpStatus.OK, "USER_200_1", "회원 탈퇴가 완료되었습니다."),
+
+    /**
+     * FCM / Notification
+     */
+    FCM_TOKEN_REGISTER_SUCCESS(HttpStatus.OK, "FCM_200_1", "FCM 토큰이 등록되었습니다."),
+    FCM_TOKEN_DELETE_SUCCESS(HttpStatus.OK, "FCM_200_2", "FCM 토큰이 삭제되었습니다."),
+    NOTIFICATION_SEND_SUCCESS(HttpStatus.OK, "NOTIF_200_1", "알림 발송 요청에 성공했습니다.");
 
     private final HttpStatus httpStatus;
     private final String code;

src/main/java/com/semosan/api/domain/notification/controller/FcmTokenController.java

@@ -0,0 +1,42 @@
+package com.semosan.api.domain.notification.controller;
+
+import com.semosan.api.common.response.ApiResponse;
+import com.semosan.api.common.status.SuccessStatus;
+import com.semosan.api.domain.notification.dto.FcmTokenDeleteRequest;
+import com.semosan.api.domain.notification.dto.FcmTokenRegisterRequest;
+import com.semosan.api.domain.notification.service.FcmTokenService;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/fcm")
+@RequiredArgsConstructor
+public class FcmTokenController {
+
+    private final FcmTokenService fcmTokenService;
+
+    @PostMapping("/tokens")
+    public ResponseEntity<ApiResponse<Void>> register(
+            @AuthenticationPrincipal Long userId,
+            @Valid @RequestBody FcmTokenRegisterRequest request
+    ) {
+        fcmTokenService.register(userId, request.token(), request.deviceType());
+        return ApiResponse.success(SuccessStatus.FCM_TOKEN_REGISTER_SUCCESS);
+    }
+
+    @DeleteMapping("/tokens")
+    public ResponseEntity<ApiResponse<Void>> delete(
+            @AuthenticationPrincipal Long userId,
+            @Valid @RequestBody FcmTokenDeleteRequest request
+    ) {
+        fcmTokenService.delete(userId, request.token());
+        return ApiResponse.success(SuccessStatus.FCM_TOKEN_DELETE_SUCCESS);
+    }
+}

src/main/java/com/semosan/api/domain/notification/controller/NotificationTestController.java

@@ -0,0 +1,34 @@
+package com.semosan.api.domain.notification.controller;
+
+import com.semosan.api.common.response.ApiResponse;
+import com.semosan.api.common.status.SuccessStatus;
+import com.semosan.api.domain.notification.dto.NotificationTestRequest;
+import com.semosan.api.domain.notification.service.NotificationService;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.annotation.Profile;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * 알림 테스트용 컨트롤러. local 프로필에서만 활성화 (운영 배포 시 자동 비활성화).
+ */
+@Profile("local")
+@RestController
+@RequestMapping("/api/notifications")
+@RequiredArgsConstructor
+public class NotificationTestController {
+
+    private final NotificationService notificationService;
+
+    @PostMapping("/test")
+    public ResponseEntity<ApiResponse<Void>> send(
+            @Valid @RequestBody NotificationTestRequest request
+    ) {
+        notificationService.send(request.receiverId(), request.type(), request.params());
+        return ApiResponse.success(SuccessStatus.NOTIFICATION_SEND_SUCCESS);
+    }
+}

src/main/java/com/semosan/api/domain/notification/dispatcher/AsyncNotificationDispatcher.java

@@ -0,0 +1,68 @@
+package com.semosan.api.domain.notification.dispatcher;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.firebase.messaging.FirebaseMessagingException;
+import com.google.firebase.messaging.MessagingErrorCode;
+import com.semosan.api.common.fcm.FcmService;
+import com.semosan.api.domain.notification.service.FcmTokenService;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Component;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+public class AsyncNotificationDispatcher implements NotificationDispatcher {
+
+    private final FcmService fcmService;
+    private final FcmTokenService fcmTokenService;
+    private final ObjectMapper objectMapper;
+
+    /**
+     * @Async 가 같은 클래스에 있는 함수를 호출 할 때는 비동기로 작동하지 않으니 주의해야함
+     * AOP 프록시를 사용해서 그렇고, 그래서 빈으로 등록된 다른 클래스에서 호출해야함
+     */
+    @Override
+    @Async("notificationTaskExecutor")
+    public void dispatch(NotificationDispatchCommand cmd) {
+        Map<String, String> dataPayload = buildDataPayload(cmd);
+
+        for (String token : cmd.tokens()) {
+            try {
+                fcmService.sendMessage(token, cmd.title(), cmd.body(), dataPayload);
+            } catch (FirebaseMessagingException e) {
+                handleSendError(token, e);
+            } catch (Exception e) {
+                log.error("FCM 발송 중 알 수 없는 에러 (token={}): {}", token, e.getMessage(), e);
+            }
+        }
+    }
+
+    private Map<String, String> buildDataPayload(NotificationDispatchCommand cmd) {
+        Map<String, String> data = new HashMap<>();
+        data.put("type", cmd.type().name());
+        data.put("notificationId", String.valueOf(cmd.notificationId()));
+        try {
+            data.put("extras", objectMapper.writeValueAsString(cmd.extras()));
+        } catch (JsonProcessingException e) {
+            log.error("extras 직렬화 실패", e);
+            data.put("extras", "{}");
+        }
+        return data;
+    }
+
+    private void handleSendError(String token, FirebaseMessagingException e) {
+        MessagingErrorCode code = e.getMessagingErrorCode();
+        if (code == MessagingErrorCode.UNREGISTERED || code == MessagingErrorCode.INVALID_ARGUMENT) {
+            log.warn("만료/잘못된 토큰 삭제 (token={}, code={})", token, code);
+            fcmTokenService.deleteExpired(token);
+        } else {
+            log.error("FCM 발송 실패 (token={}, code={}): {}", token, code, e.getMessage());
+        }
+    }
+}