Merge pull request #56 from DropThe8bit/feat/alarm

[feature] 알림 API 구현

Author: s2eojeong

src/main/java/everTale/everTale_be/domain/alarm/controller/AlarmController.java

@@ -0,0 +1,35 @@
+package everTale.everTale_be.domain.alarm.controller;
+
+import everTale.everTale_be.domain.alarm.dto.response.AlarmListResponseDto;
+import everTale.everTale_be.domain.alarm.service.AlarmService;
+import everTale.everTale_be.global.apiPayload.ApiResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.web.PageableDefault;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/alarms")
+@Tag(name = "Alarm", description = "알림 API")
+public class AlarmController {
+
+    private final AlarmService alarmService;
+
+    @Operation(summary = "알림 조회 API", description = "사용자의 알림 목록을 8개씩 조회합니다.")
+    @GetMapping
+    public ApiResponse<AlarmListResponseDto> getAlarms(@PageableDefault(size = 8) Pageable pageable){
+        AlarmListResponseDto responseDto = alarmService.getAlarms(pageable);
+        return ApiResponse.onSuccess(responseDto);
+    }
+
+    @Operation(summary = "알림 읽음 처리", description = "해당 alarmId에 해당하는 알림을 읽음 처리합니다.")
+    @PostMapping("{alarmId}")
+    public ApiResponse<String> readAlarm(@Parameter(description = "알림 ID") @PathVariable("alarmId") Long alarmId){
+        alarmService.readAlarm(alarmId);
+        return ApiResponse.onSuccess("알림 읽음 처리가 되었습니다.");
+    }
+}

src/main/java/everTale/everTale_be/domain/alarm/dto/AlarmSummary.java

@@ -0,0 +1,34 @@
+package everTale.everTale_be.domain.alarm.dto;
+
+import everTale.everTale_be.domain.alarm.entity.Alarm;
+import everTale.everTale_be.domain.alarm.entity.Enum.AlarmType;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Builder;
+import lombok.Getter;
+
+@Getter
+@Builder
+@Schema(description = "알림 요약 정보")
+public class AlarmSummary {
+
+    @Schema(description = "알림 ID", example = "1")
+    private Long alarmId;
+
+    @Schema(description = "알림 타입", example = "EASTEREGG_VOICE")
+    private AlarmType alarmType;
+
+    @Schema(description = "스토리 ID", example = "12")
+    private Long storyId;
+
+    @Schema(description = "읽음 여부", example = "0")
+    private boolean isRead;
+
+    public static AlarmSummary from(Alarm alarm){
+        return AlarmSummary.builder()
+                .alarmId(alarm.getId())
+                .alarmType(alarm.getAlarmType())
+                .storyId(alarm.getStory().getId())
+                .isRead(alarm.isRead())
+                .build();
+    }
+}

src/main/java/everTale/everTale_be/domain/alarm/dto/response/AlarmListResponseDto.java

@@ -0,0 +1,37 @@
+package everTale.everTale_be.domain.alarm.dto.response;
+
+import everTale.everTale_be.domain.alarm.dto.AlarmSummary;
+import everTale.everTale_be.domain.alarm.entity.Alarm;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Builder;
+import lombok.Getter;
+import org.springframework.data.domain.Page;
+
+import java.util.List;
+
+@Getter
+@Builder
+@Schema(description = "알림 목록 응답 DTO")
+public class AlarmListResponseDto {
+
+    @Schema(description = "알림 요약 리스트")
+    private List<AlarmSummary> alarmSummaries;
+
+    @Schema(description = "현재 페이지 번호 (0부터 시작)", example = "0")
+    private int currentPage;
+
+    @Schema(description = "전체 페이지 수", example = "5")
+    private int totalPage;
+
+    @Schema(description = "전체 스토리 개수", example = "123")
+    private long totalCount;
+
+    public static AlarmListResponseDto from(Page<Alarm> alarms){
+        return AlarmListResponseDto.builder()
+                .alarmSummaries(alarms.stream().map(AlarmSummary::from).toList())
+                .currentPage(alarms.getNumber())
+                .totalPage(alarms.getTotalPages())
+                .totalCount(alarms.getTotalElements())
+                .build();
+    }
+}

src/main/java/everTale/everTale_be/domain/alarm/entity/Alarm.java

@@ -0,0 +1,54 @@
+package everTale.everTale_be.domain.alarm.entity;
+
+import everTale.everTale_be.domain.alarm.entity.Enum.AlarmType;
+import everTale.everTale_be.domain.profile.entity.Profile;
+import everTale.everTale_be.domain.story.entity.Story;
+import jakarta.persistence.*;
+import lombok.AccessLevel;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import org.springframework.data.annotation.CreatedDate;
+
+import java.time.LocalDateTime;
+
+@Entity
+@Getter
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class Alarm {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Enumerated(EnumType.STRING)
+    private AlarmType alarmType;
+
+    @Column(nullable = false)
+    private boolean isRead = false;
+
+    @CreatedDate
+    @Column(name="created_at", updatable = false)
+    private LocalDateTime createdAt;
+
+    @ManyToOne(fetch = FetchType.LAZY)
+    @JoinColumn(name = "profile_id", updatable = false, nullable = false)
+    private Profile profile;
+
+    @ManyToOne(fetch = FetchType.LAZY)
+    @JoinColumn(name = "story_id", updatable = false, nullable = false)
+    private Story story;
+
+    @Builder
+    public Alarm(AlarmType alarmType,
+                 Profile profile,
+                 Story story) {
+        this.alarmType = alarmType;
+        this.profile = profile;
+        this.story = story;
+    }
+
+    public void setRead(){
+        isRead = true;
+    }
+}

src/main/java/everTale/everTale_be/domain/alarm/entity/Enum/AlarmType.java

@@ -0,0 +1,5 @@
+package everTale.everTale_be.domain.alarm.entity.Enum;
+
+public enum AlarmType {
+    EASTEREGG_LETTER, EASTEREGG_VOICE
+}

src/main/java/everTale/everTale_be/domain/alarm/repository/AlarmRepository.java

@@ -0,0 +1,15 @@
+package everTale.everTale_be.domain.alarm.repository;
+
+import everTale.everTale_be.domain.alarm.entity.Alarm;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.jpa.repository.JpaRepository;
+
+import java.util.Optional;
+
+public interface AlarmRepository extends JpaRepository<Alarm, Long> {
+
+    Optional<Alarm> findByIdAndProfileId(Long id, Long profileId);
+
+    Page<Alarm> findByProfileId(Long profileId, Pageable pageable);
+}

src/main/java/everTale/everTale_be/domain/alarm/service/AlarmService.java

@@ -0,0 +1,50 @@
+package everTale.everTale_be.domain.alarm.service;
+
+import everTale.everTale_be.domain.alarm.dto.response.AlarmListResponseDto;
+import everTale.everTale_be.domain.alarm.entity.Alarm;
+import everTale.everTale_be.domain.alarm.entity.Enum.AlarmType;
+import everTale.everTale_be.domain.alarm.repository.AlarmRepository;
+import everTale.everTale_be.domain.profile.entity.Profile;
+import everTale.everTale_be.domain.profile.util.ProfileHelper;
+import everTale.everTale_be.domain.story.entity.Story;
+import everTale.everTale_be.global.apiPayload.code.status.ErrorStatus;
+import everTale.everTale_be.global.apiPayload.exception.handler.UnAuthorizedHandler;
+import lombok.AllArgsConstructor;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Service
+@AllArgsConstructor
+@Transactional(readOnly = true)
+public class AlarmService {
+
+    private final AlarmRepository alarmRepository;
+    private final ProfileHelper profileHelper;
+
+    @Transactional
+    public void createAlarm(AlarmType alarmType, Profile profile, Story story){
+        Alarm alarm = Alarm.builder()
+                .alarmType(alarmType)
+                .profile(profile)
+                .story(story)
+                .build();
+        alarmRepository.save(alarm);
+    }
+
+    public AlarmListResponseDto getAlarms(Pageable pageable){
+        Long profileId = profileHelper.getAuthenticatedProfileId();
+        Page<Alarm> alarms = alarmRepository.findByProfileId(profileId, pageable);
+        return AlarmListResponseDto.from(alarms);
+    }
+
+    @Transactional
+    public void readAlarm(Long alarmId){
+        Long profileId = profileHelper.getAuthenticatedProfileId();
+
+        Alarm alarm = alarmRepository.findByIdAndProfileId(alarmId, profileId)
+                .orElseThrow(() -> new UnAuthorizedHandler(ErrorStatus.UNAUTHORIZED_PROFILE_ACCESS));
+        alarm.setRead();
+    }
+}

src/main/java/everTale/everTale_be/domain/easterEgg/dto/easterEggLetter/EasterEggLetterStoriesResponseDto.java

@@ -1,6 +1,6 @@
 package everTale.everTale_be.domain.easterEgg.dto.easterEggLetter;
 
-import everTale.everTale_be.domain.story.dto.StoryCollectionResponseDto;
+import everTale.everTale_be.domain.story.dto.response.StoryCollectionResponseDto;
 import everTale.everTale_be.domain.story.entity.Story;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Builder;

src/main/java/everTale/everTale_be/domain/easterEgg/dto/easterEggVoice/response/EasterEggVoiceStoriesResponseDto.java

@@ -1,6 +1,6 @@
 package everTale.everTale_be.domain.easterEgg.dto.easterEggVoice.response;
 
-import everTale.everTale_be.domain.story.dto.StoryCollectionResponseDto;
+import everTale.everTale_be.domain.story.dto.response.StoryCollectionResponseDto;
 import everTale.everTale_be.domain.story.entity.Story;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Builder;

src/main/java/everTale/everTale_be/domain/easterEgg/repository/EasterEggVoiceRepository.java

@@ -1,6 +1,7 @@
 package everTale.everTale_be.domain.easterEgg.repository;
 
 import everTale.everTale_be.domain.easterEgg.entity.EasterEggVoice;
+import everTale.everTale_be.domain.story.entity.Scene;
 import everTale.everTale_be.domain.story.entity.Story;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
@@ -16,6 +17,8 @@ public interface EasterEggVoiceRepository extends JpaRepository<EasterEggVoice,
 
     Optional<EasterEggVoice> findByScene_Id(Long sceneId);
 
+    boolean existsByScene(Scene scene);
+
     @Query(
             value = """
             SELECT DISTINCT s