Feat/#52 fcm token

src/main/java/io/oeid/mogakgo/common/swagger/template/NotificationSwagger.java

@@ -0,0 +1,32 @@
+package io.oeid.mogakgo.common.swagger.template;
+
+import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
+
+import io.oeid.mogakgo.core.properties.swagger.error.SwaggerProjectErrorExamples;
+import io.oeid.mogakgo.domain.notification.presentation.dto.req.FCMTokenApiRequest;
+import io.oeid.mogakgo.exception.dto.ErrorResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.http.ResponseEntity;
+
+@Tag(name = "Notification", description = "알림 관련 API")
+@SuppressWarnings("unused")
+public interface NotificationSwagger {
+
+    @Operation(summary = "FCM 토큰 저장", description = "회원의 FCM 토큰을 저장할 때 사용하는 API")
+    @ApiResponse(responseCode = "200", description = "FCM 토큰 저장 성공")
+    @ApiResponse(responseCode = "404", description = "요청한 유저가 존재하지 않음", content = @Content(
+        mediaType = APPLICATION_JSON_VALUE,
+        schema = @Schema(implementation = ErrorResponse.class),
+        examples = {
+            @ExampleObject(name = "E020301", value = SwaggerProjectErrorExamples.USER_NOT_FOUND)
+        })
+    )
+    ResponseEntity<Void> manageFCMToken(@Parameter(hidden = true) Long userId,
+        FCMTokenApiRequest request);
+}

src/main/java/io/oeid/mogakgo/core/configuration/FCMConfig.java

@@ -0,0 +1,43 @@
+package io.oeid.mogakgo.core.configuration;
+
+import com.google.auth.oauth2.GoogleCredentials;
+import com.google.firebase.FirebaseApp;
+import com.google.firebase.FirebaseOptions;
+import com.google.firebase.messaging.FirebaseMessaging;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+import java.util.Objects;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class FCMConfig {
+
+    private FirebaseApp firebaseApp;
+
+    public FCMConfig(@Value("${firebase.key-path}") String keyPath) throws IOException {
+        try (InputStream credentials = getClass().getClassLoader().getResourceAsStream(keyPath)) {
+            List<FirebaseApp> firebaseApps = FirebaseApp.getApps();
+            if (firebaseApps != null && !firebaseApps.isEmpty()) {
+                for (FirebaseApp app : firebaseApps) {
+                    if (app.getName().equals(FirebaseApp.DEFAULT_APP_NAME)) {
+                        firebaseApp = app;
+                    }
+                }
+            } else {
+                FirebaseOptions options = FirebaseOptions.builder()
+                    .setCredentials(GoogleCredentials.fromStream(
+                        Objects.requireNonNull(credentials)))
+                    .build();
+                firebaseApp = FirebaseApp.initializeApp(options);
+            }
+        }
+    }
+
+    @Bean
+    public FirebaseMessaging firebaseMessaging() {
+        return FirebaseMessaging.getInstance(firebaseApp);
+    }
+}

src/main/java/io/oeid/mogakgo/core/properties/swagger/error/SwaggerProjectErrorExamples.java

@@ -10,6 +10,7 @@ public class SwaggerProjectErrorExamples {
     public static final String PROJECT_NOT_FOUND = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":404,\"code\":\"E030301\",\"message\":\"해당 프로젝트가 존재하지 않습니다.\"}";
     public static final String PROJECT_FORBIDDEN_OPERATION = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":403,\"code\":\"E030201\",\"message\":\"해당 프로젝트에 대한 권한이 없습니다.\"}";
     public static final String PROJECT_DELETION_NOT_ALLOWED = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":400,\"code\":\"E030106\",\"message\":\"매칭 중이거나 대기중인 프로젝트는 삭제할 수 없습니다.\"}";
+    public static final String USER_NOT_FOUND = "{\"timestamp\":\"2024-02-17T10:07:31.404Z\",\"statusCode\":404,\"code\":\"E020301\",\"message\":\"해당 유저가 존재하지 않습니다.\"}";
     private SwaggerProjectErrorExamples() {
     }
 

src/main/java/io/oeid/mogakgo/domain/notification/application/FCMNotificationService.java

@@ -0,0 +1,62 @@
+package io.oeid.mogakgo.domain.notification.application;
+
+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 io.oeid.mogakgo.domain.notification.domain.vo.FCMToken;
+import io.oeid.mogakgo.domain.notification.exception.NotificationException;
+import io.oeid.mogakgo.domain.notification.infrastructure.FCMTokenJpaRepository;
+import io.oeid.mogakgo.domain.user.application.UserCommonService;
+import io.oeid.mogakgo.exception.code.ErrorCode404;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class FCMNotificationService {
+
+    private final FCMTokenJpaRepository fcmTokenRepository;
+    private final UserCommonService userCommonService;
+    private final FirebaseMessaging firebaseMessaging;
+
+    @Transactional
+    public void manageToken(Long userId, String fcmToken) {
+        log.info("manageToken Start");
+        FCMToken token = fcmTokenRepository.findById(userCommonService.getUserById(userId).getId())
+            .orElseGet(() -> new FCMToken(userId, fcmToken));
+        token.updateToken(fcmToken);
+        fcmTokenRepository.save(token);
+        log.info("manageToken End");
+    }
+
+    public void sendNotification(Long userId, String title, String body) {
+        log.info("sendNotification Start");
+        String fcmToken = getFCMToken(userId);
+        // send notification
+        Message message = Message.builder()
+            .setNotification(Notification.builder()
+                .setTitle(title)
+                .setBody(body)
+                .build())
+            .setToken(fcmToken)
+            .build();
+        try {
+            String response = firebaseMessaging.send(message);
+            log.info("Successfully sent message: " + response);
+        } catch (FirebaseMessagingException e) {
+            log.error("Error sending message: " + e.getMessage());
+        }
+        log.info("sendNotification End");
+    }
+
+    private String getFCMToken(Long userId) {
+        return fcmTokenRepository.findById(userId)
+            .map(FCMToken::getToken)
+            .orElseThrow(
+                () -> new NotificationException(ErrorCode404.NOTIFICATION_FCM_TOKEN_NOT_FOUND));
+    }
+}

src/main/java/io/oeid/mogakgo/domain/notification/domain/vo/FCMToken.java

@@ -0,0 +1,48 @@
+package io.oeid.mogakgo.domain.notification.domain.vo;
+
+import io.oeid.mogakgo.domain.notification.exception.NotificationException;
+import io.oeid.mogakgo.exception.code.ErrorCode400;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+import jakarta.persistence.Table;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+@Table(name = "fcm_token_tb")
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@Entity
+public class FCMToken {
+
+    @Id
+    @Column(name = "id")
+    private Long userId;
+
+    @Column(name = "token")
+    private String token;
+
+    public FCMToken(Long userId, String token) {
+        this.userId = verifyUserId(userId);
+        this.token = verifyToken(token);
+    }
+
+    public Long verifyUserId(Long userId) {
+        if (userId == null) {
+            throw new NotificationException(ErrorCode400.USER_ID_NOT_NULL);
+        }
+        return userId;
+    }
+
+    public String verifyToken(String fcmToken) {
+        if (fcmToken == null || fcmToken.isBlank()) {
+            throw new NotificationException(ErrorCode400.NOTIFICATION_FCM_TOKEN_NOT_NULL);
+        }
+        return fcmToken;
+    }
+
+    public void updateToken(String token) {
+        this.token = verifyToken(token);
+    }
+}

src/main/java/io/oeid/mogakgo/domain/notification/infrastructure/FCMTokenJpaRepository.java

@@ -0,0 +1,10 @@
+package io.oeid.mogakgo.domain.notification.infrastructure;
+
+import io.oeid.mogakgo.domain.notification.domain.vo.FCMToken;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface FCMTokenJpaRepository extends JpaRepository<FCMToken, Long> {
+
+}

src/main/java/io/oeid/mogakgo/domain/notification/infrastructure/NotificationJpaRepository.java

@@ -2,7 +2,9 @@
 
 import io.oeid.mogakgo.domain.notification.domain.Notification;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.stereotype.Repository;
 
+@Repository
 public interface NotificationJpaRepository extends JpaRepository<Notification, Long> {
 
 }

src/main/java/io/oeid/mogakgo/domain/notification/presentation/NotificationController.java

@@ -0,0 +1,30 @@
+package io.oeid.mogakgo.domain.notification.presentation;
+
+import io.oeid.mogakgo.common.annotation.UserId;
+import io.oeid.mogakgo.common.swagger.template.NotificationSwagger;
+import io.oeid.mogakgo.domain.notification.application.FCMNotificationService;
+import io.oeid.mogakgo.domain.notification.presentation.dto.req.FCMTokenApiRequest;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+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;
+
+@RestController
+@RequestMapping("/api/v1/notification")
+@RequiredArgsConstructor
+public class NotificationController implements NotificationSwagger {
+
+    private final FCMNotificationService fcmNotificationService;
+
+    @PostMapping("/fcm")
+    public ResponseEntity<Void> manageFCMToken(@UserId Long userId, @RequestBody @Valid
+    FCMTokenApiRequest request) {
+        fcmNotificationService.manageToken(userId, request.getFcmToken());
+        return ResponseEntity.ok().build();
+    }
+
+
+}

src/main/java/io/oeid/mogakgo/domain/notification/presentation/dto/req/FCMTokenApiRequest.java

@@ -0,0 +1,14 @@
+package io.oeid.mogakgo.domain.notification.presentation.dto.req;
+
+import jakarta.validation.constraints.NotBlank;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor(access = AccessLevel.PRIVATE)
+public class FCMTokenApiRequest {
+
+    @NotBlank(message = "FCM 토큰은 필수입니다.")
+    private final String fcmToken;
+}

src/main/java/io/oeid/mogakgo/exception/code/ErrorCode400.java

@@ -10,6 +10,7 @@ public enum ErrorCode400 implements ErrorCode {
 
     NOTIFICATION_TAG_NOT_NULL("E060001", "알림 태그는 필수값입니다."),
     NOTIFICATION_DETAIL_DATA_NOT_NULL("E060002", "알림 상세 데이터는 필수값입니다."),
+    NOTIFICATION_FCM_TOKEN_NOT_NULL("E060003", "FCM 토큰은 필수값입니다."),
 
     INVALID_PROJECT_MEETING_TIME("E030101", "프로젝트 만남 시간이 유효하지 않습니다."),
     INVALID_PROJECT_TAG_COUNT("E030102", "프로젝트 태그 갯수가 유효하지 않습니다. 1개 이상 3개 이하로 입력해야 합니다."),
@@ -23,6 +24,7 @@ public enum ErrorCode400 implements ErrorCode {
     USER_WANTED_JOB_BAD_REQUEST("E020102", "희망 직무는 3개까지만 등록 가능합니다."),
     USERNAME_SHOULD_BE_NOT_EMPTY("E020103", "유저 이름은 비어있을 수 없습니다."),
     USER_REGION_SHOULD_BE_NOT_EMPTY("E020104", "유저 지역은 비어있을 수 없습니다."),
+    USER_ID_NOT_NULL("E020001", "유저 아이디는 필수값입니다."),
     ;
 
     private final HttpStatus httpStatus = HttpStatus.BAD_REQUEST;

src/main/java/io/oeid/mogakgo/exception/code/ErrorCode404.java

@@ -7,6 +7,7 @@
 public enum ErrorCode404 implements ErrorCode {
     USER_NOT_FOUND("E020301", "해당 유저가 존재하지 않습니다."),
     PROJECT_NOT_FOUND("E030301", "해당 프로젝트가 존재하지 않습니다."),
+    NOTIFICATION_FCM_TOKEN_NOT_FOUND("E060301", "해당 유저의 FCM 토큰이 존재하지 않습니다."),
     ;
 
     private final HttpStatus httpStatus = HttpStatus.NOT_FOUND;