Merge pull request #64 from kakao-tech-campus-2nd-step3/feature/63-fcm

feat: FCM 푸쉬 알림 구현

.github/workflows/master_weekly_cicd.yml

@@ -20,6 +20,10 @@ jobs:
           distribution: 'corretto'
           java-version: '21'
 
+      - name: FCM 서비스 계정 키 파일 생성
+        run: |
+          echo '${{ secrets.FCM_SERVICE_ACCOUNT_KEY }}' > ./src/main/resources/everymoment.json
+
       - name: AWS S3 관련 정보를 설정 파일에 주입
         uses: microsoft/variable-substitution@v1
         with:

.github/workflows/pr_weekly_ci.yml

@@ -23,6 +23,10 @@ jobs:
           distribution: 'corretto'
           java-version: '21'
 
+      - name: FCM 서비스 계정 키 파일 생성
+        run: |
+          echo '${{ secrets.FCM_SERVICE_ACCOUNT_KEY }}' > ./src/main/resources/everymoment.json
+
       - name: AWS S3 관련 정보를 설정 파일에 주입
         uses: microsoft/variable-substitution@v1
         with:

.gitignore

@@ -6,6 +6,7 @@ build/
 !**/src/test/**/build/
 
 application-dev.yml
+everymoment.json
 
 ### STS ###
 .apt_generated

build.gradle

@@ -32,6 +32,8 @@ dependencies {
     implementation 'com.amazonaws:aws-java-sdk-s3:1.12.657'
     implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.6.0'
 
+    implementation 'com.google.firebase:firebase-admin:9.2.0'
+
     implementation 'io.jsonwebtoken:jjwt-api:0.12.6'
     runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.12.6'
     runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.12.6'

src/main/java/com/potatocake/everymoment/config/FcmConfig.java

@@ -0,0 +1,29 @@
+package com.potatocake.everymoment.config;
+
+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 org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.io.ClassPathResource;
+
+@Configuration
+public class FcmConfig {
+
+    @Bean
+    public FirebaseMessaging firebaseMessaging() throws IOException {
+        GoogleCredentials googleCredentials = GoogleCredentials
+                .fromStream(new ClassPathResource("everymoment.json").getInputStream());
+
+        FirebaseOptions firebaseOptions = FirebaseOptions.builder()
+                .setCredentials(googleCredentials)
+                .build();
+
+        FirebaseApp app = FirebaseApp.initializeApp(firebaseOptions);
+
+        return FirebaseMessaging.getInstance(app);
+    }
+
+}

src/main/java/com/potatocake/everymoment/controller/FcmController.java

@@ -0,0 +1,60 @@
+package com.potatocake.everymoment.controller;
+
+import com.potatocake.everymoment.dto.SuccessResponse;
+import com.potatocake.everymoment.dto.request.FcmTokenRequest;
+import com.potatocake.everymoment.security.MemberDetails;
+import com.potatocake.everymoment.service.FcmService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.tags.Tag;
+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.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@Tag(name = "FCM", description = "FCM 토큰 관리 API")
+@RestController
+@RequestMapping("/api/fcm")
+@RequiredArgsConstructor
+public class FcmController {
+
+    private final FcmService fcmService;
+
+    @Operation(summary = "FCM 토큰 등록/갱신", description = "디바이스의 FCM 토큰을 등록하거나 갱신합니다.")
+    @ApiResponse(responseCode = "200", description = "토큰 등록/갱신 성공")
+    @PostMapping("/token")
+    public ResponseEntity<SuccessResponse> registerToken(
+            @Parameter(description = "인증된 사용자 정보", hidden = true)
+            @AuthenticationPrincipal MemberDetails memberDetails,
+            @Parameter(description = "FCM 토큰 정보", required = true)
+            @RequestBody @Valid FcmTokenRequest request) {
+
+        fcmService.registerToken(memberDetails.getId(), request.getDeviceId(), request.getFcmToken());
+
+        return ResponseEntity.ok()
+                .body(SuccessResponse.ok());
+    }
+
+    @Operation(summary = "FCM 토큰 삭제", description = "디바이스의 FCM 토큰을 삭제합니다.")
+    @ApiResponse(responseCode = "200", description = "토큰 삭제 성공")
+    @DeleteMapping("/token")
+    public ResponseEntity<SuccessResponse> removeToken(
+            @Parameter(description = "인증된 사용자 정보", hidden = true)
+            @AuthenticationPrincipal MemberDetails memberDetails,
+            @Parameter(description = "디바이스 ID", required = true)
+            @RequestParam String deviceId) {
+
+        fcmService.removeToken(memberDetails.getId(), deviceId);
+
+        return ResponseEntity.ok()
+                .body(SuccessResponse.ok());
+    }
+
+}

src/main/java/com/potatocake/everymoment/dto/request/CommentRequest.java

@@ -1,8 +1,12 @@
 package com.potatocake.everymoment.dto.request;
 
+import jakarta.validation.constraints.NotEmpty;
 import lombok.Getter;
 
 @Getter
 public class CommentRequest {
+
+    @NotEmpty(message = "댓글 내용을 입력해 주세요.")
     private String content;
+
 }

src/main/java/com/potatocake/everymoment/dto/request/DiaryManualCreateRequest.java

@@ -1,17 +1,30 @@
 package com.potatocake.everymoment.dto.request;
 
 import com.potatocake.everymoment.dto.LocationPoint;
+import jakarta.validation.constraints.Size;
 import java.util.List;
 import lombok.Getter;
 
 @Getter
 public class DiaryManualCreateRequest {
+
     private List<CategoryRequest> categories;
+
     private LocationPoint locationPoint;
+
+    @Size(max = 50, message = "장소명은 50자를 초과할 수 없습니다")
     private String locationName;
+
+    @Size(max = 200, message = "주소는 200자를 초과할 수 없습니다")
     private String address;
+
     private boolean isBookmark;
     private boolean isPublic;
+
+    @Size(max = 10, message = "이모지는 10자를 초과할 수 없습니다")
     private String emoji;
+
+    @Size(max = 5000, message = "일기 내용은 5000자를 초과할 수 없습니다")
     private String content;
+
 }

src/main/java/com/potatocake/everymoment/dto/request/FcmNotificationRequest.java

@@ -0,0 +1,15 @@
+package com.potatocake.everymoment.dto.request;
+
+import lombok.Builder;
+import lombok.Getter;
+
+@Getter
+@Builder
+public class FcmNotificationRequest {
+
+    private String title;
+    private String body;
+    private String type;
+    private Long targetId;
+
+}

src/main/java/com/potatocake/everymoment/dto/request/FcmTokenRequest.java

@@ -0,0 +1,15 @@
+package com.potatocake.everymoment.dto.request;
+
+import jakarta.validation.constraints.NotBlank;
+import lombok.Getter;
+
+@Getter
+public class FcmTokenRequest {
+
+    @NotBlank(message = "FCM 토큰은 필수입니다.")
+    private String fcmToken;
+
+    @NotBlank(message = "디바이스 ID는 필수입니다.")
+    private String deviceId;
+
+}

src/main/java/com/potatocake/everymoment/entity/DeviceToken.java

@@ -0,0 +1,48 @@
+package com.potatocake.everymoment.entity;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.FetchType;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.Lob;
+import jakarta.persistence.ManyToOne;
+import lombok.AccessLevel;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Entity
+@Getter
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class DeviceToken extends BaseTimeEntity {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @ManyToOne(fetch = FetchType.LAZY)
+    @JoinColumn(nullable = false)
+    private Member member;
+
+    @Column(nullable = false)
+    private String fcmToken;
+
+    @Column(nullable = false)
+    @Lob
+    private String deviceId;
+
+    @Builder
+    public DeviceToken(Member member, String fcmToken, String deviceId) {
+        this.member = member;
+        this.fcmToken = fcmToken;
+        this.deviceId = deviceId;
+    }
+
+    public void updateToken(String fcmToken) {
+        this.fcmToken = fcmToken;
+    }
+
+}

src/main/java/com/potatocake/everymoment/exception/ErrorCode.java

@@ -15,6 +15,7 @@
 public enum ErrorCode {
 
     /* Diary */
+    DIARY_NOT_PUBLIC("비공개 일기입니다.", HttpStatus.FORBIDDEN),
     DIARY_NOT_FOUND("존재하지 않는 일기입니다.", NOT_FOUND),
 
     /* Member */
@@ -60,7 +61,14 @@ public enum ErrorCode {
 
     /* FriendRequestService */
     FRIEND_REQUEST_ALREADY_EXISTS("이미 친구 요청을 보냈습니다.", CONFLICT),
-    FRIEND_REQUEST_NOT_FOUND("존재하지 않는 친구 요청입니다.", NOT_FOUND);
+    FRIEND_REQUEST_NOT_FOUND("존재하지 않는 친구 요청입니다.", NOT_FOUND),
+
+    /* FCM */
+    FCM_TOKEN_NOT_FOUND("FCM 토큰이 존재하지 않습니다.", HttpStatus.NOT_FOUND),
+    FCM_MESSAGE_SEND_FAILED("FCM 메시지 전송에 실패했습니다.", HttpStatus.INTERNAL_SERVER_ERROR),
+
+    /* Friend */
+    ALREADY_FRIEND("이미 친구 관계입니다.", HttpStatus.CONFLICT);
 
     private final String message;
     private final HttpStatus status;

src/main/java/com/potatocake/everymoment/repository/DeviceTokenRepository.java

@@ -0,0 +1,16 @@
+package com.potatocake.everymoment.repository;
+
+import com.potatocake.everymoment.entity.DeviceToken;
+import java.util.List;
+import java.util.Optional;
+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface DeviceTokenRepository extends JpaRepository<DeviceToken, Long> {
+
+    List<DeviceToken> findAllByMemberId(Long memberId);
+
+    Optional<DeviceToken> findByMemberIdAndDeviceId(Long memberId, String deviceId);
+
+    void deleteByMemberIdAndDeviceId(Long memberId, String deviceId);
+
+}

src/main/java/com/potatocake/everymoment/service/CommentService.java

@@ -1,6 +1,7 @@
 package com.potatocake.everymoment.service;
 
 import com.potatocake.everymoment.dto.request.CommentRequest;
+import com.potatocake.everymoment.dto.request.FcmNotificationRequest;
 import com.potatocake.everymoment.dto.response.CommentFriendResponse;
 import com.potatocake.everymoment.dto.response.CommentResponse;
 import com.potatocake.everymoment.dto.response.CommentsResponse;
@@ -30,6 +31,7 @@ public class CommentService {
     private final CommentRepository commentRepository;
     private final DiaryRepository diaryRepository;
     private final MemberRepository memberRepository;
+    private final FcmService fcmService;
 
     // 댓글 목록 조회
     public CommentsResponse getComments(Long diaryId, int key, int size) {
@@ -56,13 +58,27 @@ public void createComment(Long memberId, Long diaryId, CommentRequest commentReq
         Diary diary = diaryRepository.findById(diaryId)
                 .orElseThrow(() -> new GlobalException(ErrorCode.DIARY_NOT_FOUND));
 
+        if (!diary.isPublic()) {
+            throw new GlobalException(ErrorCode.DIARY_NOT_PUBLIC);
+        }
+
         Comment comment = Comment.builder()
                 .content(commentRequest.getContent())
                 .member(currentMember)
                 .diary(diary)
                 .build();
 
         commentRepository.save(comment);
+
+        // 다이어리 작성자에게 FCM 알림 전송 (자신의 댓글에는 알림 안보냄)
+        if (!diary.getMember().getId().equals(memberId)) {
+            fcmService.sendNotification(diary.getMember().getId(), FcmNotificationRequest.builder()
+                    .title("새로운 댓글")
+                    .body(currentMember.getNickname() + "님이 회원님의 일기에 댓글을 남겼습니다.")
+                    .type("COMMENT")
+                    .targetId(diary.getId())
+                    .build());
+        }
     }
 
     // 댓글 수정
@@ -85,15 +101,15 @@ private Comment getExistComment(Long memberId, Long commentId) {
         Comment comment = commentRepository.findById(commentId)
                 .orElseThrow(() -> new GlobalException(ErrorCode.COMMENT_NOT_FOUND));
 
-        if(!Objects.equals(currentMember.getId(), comment.getMember().getId())){
+        if (!Objects.equals(currentMember.getId(), comment.getMember().getId())) {
             throw new GlobalException(ErrorCode.COMMENT_NOT_FOUND);
         }
 
         return comment;
     }
 
     // 친구 프로필 DTO 변환
-    private CommentFriendResponse convertToCommentFriendResponseDTO(Member member){
+    private CommentFriendResponse convertToCommentFriendResponseDTO(Member member) {
         return CommentFriendResponse.builder()
                 .id(member.getId())
                 .nickname(member.getNickname())
@@ -102,13 +118,13 @@ private CommentFriendResponse convertToCommentFriendResponseDTO(Member member){
     }
 
     // 댓글 DTO 변환
-    private CommentResponse convertToCommentResponseDTO(Comment comment){
+    private CommentResponse convertToCommentResponseDTO(Comment comment) {
         return CommentResponse.builder()
                 .id(comment.getId())
                 .commentFriendResponse(convertToCommentFriendResponseDTO(comment.getMember()))
                 .content(comment.getContent())
                 .createdAt(comment.getCreateAt())
                 .build();
     }
-}
 
+}