feat: 알람 기능 구현

# 변경점 👍
알람 기능을 구현했습니다.

`firebase`를 통한 알람 기능을 구현했습니다. (먼저 킬링파트 좋아요에만 알람 리스너 추가해놨습니다. 먼저 알람 정상
확인하고 추후 확장예정)
알람을 보내기 위해서는 클라이언트에서 발급한 디바이스 토큰을 `POST /api/fcm/tokens` 엔드포인트를 호출해서
저장해야합니다.

`Alarm` 엔티티는 단순히 DB에 저장하기 위한 용도입니다. 

알람 구현에는 `ApplicationEventPublisher`와 `TransactionalEventListener`를
사용해봤습니다.

특정 클래스를 `ApplicationEventPublisher`로 이벤트를 publish하면
`TransactionalEventListener`가 동작합니다.

Author: jinwon1234

.github/workflows/deploy.yml

@@ -34,6 +34,18 @@ jobs:
       - name: 테스트 환경변수 주입
         run: echo "${{ secrets.APPLICATION_TEST_PROPERTIES }}" > ./src/test/resources/application.properties
 
+      - name: firebase 디렉토리 생성
+        run: mkdir -p ./src/main/resources/firebase
+
+      - name: fcm.json 파일 주입
+        id: create-json
+        uses: jsdaniell/create-json@v1.2.2
+        with:
+          name: "killing-part-32870-firebase-adminsdk-fbsvc-f5c0d13f5b.json"
+          json: ${{ secrets.FIREBASE_KEY }}
+          dir: 'src/main/resources/firebase/'
+
+
       - name: 테스트 및 빌드하기
         run: ./gradlew clean build
 

.gitignore

@@ -40,3 +40,4 @@ out/
 .env
 src/main/resources/application-prod.properties
 src/test/resources/application-prod.properties
+src/main/resources/firebase/

build.gradle

@@ -72,6 +72,9 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
 
 	implementation 'org.springframework.ai:spring-ai-starter-model-openai:1.1.0'
+
+	// firebase
+	implementation 'com.google.firebase:firebase-admin:9.2.0'
 }
 
 

src/main/java/apptive/team5/alarm/controller/AlarmController.java

@@ -0,0 +1,44 @@
+package apptive.team5.alarm.controller;
+
+import apptive.team5.alarm.dto.AlarmResponse;
+import apptive.team5.alarm.service.AlarmService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageRequest;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/alarms")
+@RequiredArgsConstructor
+public class AlarmController {
+
+    private final AlarmService alarmService;
+
+    @GetMapping
+    public ResponseEntity<Page<AlarmResponse>> getAlarms(
+            @RequestParam(name = "page", defaultValue = "0") int page,
+            @RequestParam(name = "size", defaultValue = "5") int size,
+            @AuthenticationPrincipal Long userId
+    ) {
+        Pageable pageable = PageRequest.of(
+                page,
+                size,
+                Sort.by(
+                        Sort.Order.desc("createDateTime"),
+                        Sort.Order.desc("id")
+                )
+        );
+        Page<AlarmResponse> alarms = alarmService.getAlarms(userId, pageable);
+
+        return ResponseEntity.status(HttpStatus.OK).body(alarms);
+    }
+}

src/main/java/apptive/team5/alarm/dto/AlarmResponse.java

@@ -0,0 +1,21 @@
+package apptive.team5.alarm.dto;
+
+
+import apptive.team5.alarm.entity.Alarm;
+
+public record AlarmResponse(
+        Long alarmId,
+        String title,
+        String content,
+        String deepLink
+) {
+
+    public AlarmResponse(Alarm alarm) {
+        this(
+                alarm.getId(),
+                alarm.getTitle(),
+                alarm.getContent(),
+                alarm.getDeepLink()
+        );
+    }
+}

src/main/java/apptive/team5/alarm/dto/AlarmSendRequest.java

@@ -0,0 +1,9 @@
+package apptive.team5.alarm.dto;
+
+import apptive.team5.user.domain.UserEntity;
+
+public record AlarmSendRequest(
+        Long diaryId,
+        Long actorId
+) {
+}

src/main/java/apptive/team5/alarm/entity/Alarm.java

@@ -0,0 +1,44 @@
+package apptive.team5.alarm.entity;
+
+
+import apptive.team5.global.entity.BaseTimeEntity;
+import apptive.team5.user.domain.UserEntity;
+import jakarta.persistence.*;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Entity
+@Getter
+@AllArgsConstructor
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class Alarm extends BaseTimeEntity {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(nullable = false, length = 1000)
+    private String title;
+
+    @Column(nullable = false, length = 1000)
+    private String content;
+
+    @Column(nullable = false, length = 1000)
+    private String deepLink;
+
+    @ManyToOne(fetch = FetchType.LAZY, optional = false)
+    @JoinColumn(
+            name = "user_id",
+            nullable = false
+    )
+    private UserEntity user;
+
+    public Alarm(String title, String content, String deepLink, UserEntity user) {
+        this.title = title;
+        this.content = content;
+        this.deepLink = deepLink;
+        this.user = user;
+    }
+}

src/main/java/apptive/team5/alarm/entity/AlarmMessage.java

@@ -0,0 +1,16 @@
+package apptive.team5.alarm.entity;
+
+import lombok.Getter;
+
+@Getter
+public enum AlarmMessage {
+
+    LIKE_ALARM("킬링파트에 좋아요가 도착했어요");
+
+    private final String message;
+
+
+    AlarmMessage(String message) {
+        this.message = message;
+    }
+}

src/main/java/apptive/team5/alarm/event/AlarmCreatedEvent.java

@@ -0,0 +1,9 @@
+package apptive.team5.alarm.event;
+
+public record AlarmCreatedEvent(
+        Long receiverId,
+        String title,
+        String content,
+        String deepLink
+) {
+}

src/main/java/apptive/team5/alarm/event/AlarmEventListener.java

@@ -0,0 +1,19 @@
+package apptive.team5.alarm.event;
+
+import apptive.team5.fcm.service.FcmService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Component;
+import org.springframework.transaction.event.TransactionPhase;
+import org.springframework.transaction.event.TransactionalEventListener;
+
+@Component
+@RequiredArgsConstructor
+public class AlarmEventListener {
+
+    private final FcmService fcmService;
+
+    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
+    public void handleAlarmCreated(AlarmCreatedEvent event) {
+        fcmService.sendAlarm(event.receiverId(), event.title(), event.content(), event.deepLink());
+    }
+}