Merge pull request #145 from CommitField/feat/#81

docs : 알림 메서드 설명 주석 추가

Author: skyeong42

src/main/java/cmf/commitField/domain/commit/scheduler/CommitScheduler.java

@@ -1,9 +1,6 @@
 package cmf.commitField.domain.commit.scheduler;
 
 import cmf.commitField.domain.commit.totalCommit.service.TotalCommitService;
-import cmf.commitField.domain.noti.noti.entity.NotiDetailType;
-import cmf.commitField.domain.noti.noti.entity.NotiType;
-import cmf.commitField.domain.noti.noti.event.NotiEvent;
 import cmf.commitField.domain.noti.noti.service.CommitSteakNotiService;
 import cmf.commitField.domain.noti.noti.service.NotiService;
 import cmf.commitField.domain.user.entity.User;
@@ -29,8 +26,6 @@ public class CommitScheduler {
     private final UserRepository userRepository;
     private final StringRedisTemplate redisTemplate;
     private final AtomicInteger counter = new AtomicInteger(0);
-    private final SimpMessagingTemplate messagingTemplate;
-    private final NotiService notiService;
     private final CommitSteakNotiService commitSteakNotiService;
 
     private final ApplicationEventPublisher eventPublisher;
@@ -110,6 +105,7 @@ private void processUserCommit(String username) {
             CommitUpdateEvent event = new CommitUpdateEvent(this, username, newCommitCount);
             eventPublisher.publishEvent(event); // 이벤트 발생
 
+            // 커밋 업데이트가 있고, 연속 커밋이 3일 이상, 10의 배수 이상인 경우 알림 생성
             commitSteakNotiService.checkAndCreateSteakNoti(user, currentStreakCommit);
 
             System.out.println("CommitCreatedEvent published for user: " + username);

src/main/java/cmf/commitField/domain/noti/noti/controller/ApiV1NotiController.java

@@ -4,6 +4,7 @@
 import cmf.commitField.domain.noti.noti.service.NotiService;
 import cmf.commitField.domain.user.entity.User;
 import cmf.commitField.domain.user.repository.UserRepository;
+import cmf.commitField.domain.user.service.UserService;
 import cmf.commitField.global.error.ErrorCode;
 import cmf.commitField.global.exception.CustomException;
 import cmf.commitField.global.globalDto.GlobalResponse;
@@ -29,32 +30,22 @@
 @Slf4j
 public class ApiV1NotiController {
     private final NotiService notiService;
-    private final UserRepository userRepository;
-
-//    private final NotiWebSocketHandler notiWebSocketHandler;
-    private final ApplicationEventPublisher eventPublisher;
+    private final UserService userService;
 
 
     @GetMapping("")
     public GlobalResponse<List<NotiDto>> getNoti(@AuthenticationPrincipal OAuth2User oAuth2User) {
         String username = oAuth2User.getName();
-        User user = userRepository.findByUsername(username).orElseThrow(() -> new CustomException(ErrorCode.NOT_FOUND_USER));
+        User user = userService.findByUsername(username);
         List<NotiDto> notis = notiService.getNotReadNoti(user);
         return GlobalResponse.success(notis);
     }
 
     @PostMapping("/read")
-    public GlobalResponse<Object> readNoti() {
-        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
-
-        if (authentication instanceof OAuth2AuthenticationToken) {
-            OAuth2User principal = (OAuth2User) authentication.getPrincipal();
-            Map<String, Object> attributes = principal.getAttributes();
-            String username = (String) attributes.get("login");  // GitHub ID
-            User user = userRepository.findByUsername(username).orElseThrow(() -> new CustomException(ErrorCode.NOT_FOUND_USER));
-            notiService.read(user);
-            return GlobalResponse.success("알림을 읽음 처리했습니다.");
-        }
-        return GlobalResponse.error(ErrorCode.LOGIN_REQUIRED);
+    public GlobalResponse<Object> readNoti(@AuthenticationPrincipal OAuth2User oAuth2User) {
+        String username = oAuth2User.getName();
+        User user = userService.findByUsername(username);
+        notiService.read(user);
+        return GlobalResponse.success("알림을 읽음 처리했습니다.");
     }
 }

src/main/java/cmf/commitField/domain/noti/noti/dto/NotiDto.java

@@ -12,13 +12,14 @@ public class NotiDto {
     private String message;
     private String formattedCreatedAt; // 변환된 날짜를 저장할 필드
 
-    // JPQL에서 사용할 수 있도록 필드 값 직접 받는 생성자 추가
+    // 필드 값 직접 받는 생성자 추가
     public NotiDto(Long id, String message, LocalDateTime createdAt) {
         this.id = id;
         this.message = message;
         this.formattedCreatedAt = formatCreatedAt(createdAt); // 변환된 날짜 저장
     }
 
+    // 날짜 변환 메서드 (오늘, 어제, 3일 전까지 이후 yyyy-MM-dd)
     private String formatCreatedAt(LocalDateTime createdAt) {
         LocalDateTime today = LocalDateTime.now();
         long daysBetween = ChronoUnit.DAYS.between(createdAt, today);

src/main/java/cmf/commitField/domain/noti/noti/entity/NotiDetailType.java

@@ -27,6 +27,12 @@ public String[] getParamNames() {
         return paramNames;
     }
 
+    /**
+     * 메시지 포맷팅입니다.
+     * 잘못된 파라미터 개수일 경우 IllegalArgumentException을 던집니다.
+     * @param params
+     * @return template에 파라미터를 적용한 메시지
+     */
     public String formatMessage(Object... params) {
         if (paramNames.length != params.length) {
             throw new IllegalArgumentException("🚨 잘못된 파라미터 개수! 필요: " +

src/main/java/cmf/commitField/domain/noti/noti/repository/NotiRepository.java

@@ -25,5 +25,6 @@ public interface NotiRepository extends JpaRepository<Noti, Long> {
     // 최근 10일 내 동일한 커밋 부재 알림이 있는지 확인
     boolean existsByReceiverAndTypeCodeAndType2CodeAndCreatedAtAfter(User receiver, NotiType type, NotiDetailType detailType, LocalDateTime after);
 
+    // 해당 타입의 알림이 오늘 이후에 있는지 확인
     boolean existsByReceiverAndType2CodeAndCreatedAtAfter(User receiver, NotiDetailType notiDetailType, LocalDateTime todayStart);
 }

src/main/java/cmf/commitField/domain/noti/noti/service/CommitAbsenceNotiService.java

@@ -42,7 +42,11 @@ public void sendCommitAbsenceNoti() {
         }
     }
 
-    // 최근 10일 내 커밋 부재 알림이 있었는지 확인
+    /**
+     * 최근 10일 내 커밋 부재 알림이 있었는지 확인
+     * @param user
+     * @return
+     */
     private boolean hasRecentAbsenceNoti(User user) {
         log.info("커밋 부재 알림 확인: {}", user.getUsername());
         LocalDateTime checkDate = LocalDateTime.now().minusDays(10);

src/main/java/cmf/commitField/domain/noti/noti/service/CommitSteakNotiService.java

@@ -42,6 +42,11 @@ public void sendCommitSteakNoti() {
         }
     }
 
+    /**
+     * 연속 커밋 알림을 생성
+     * @param user
+     * @param currentStreakCommit
+     */
     public void checkAndCreateSteakNoti(User user, int currentStreakCommit) {
         boolean alreadyNotified = notiRepository.existsByReceiverAndType2CodeAndCreatedAtAfter(
                 user, NotiDetailType.STREAK_CONTINUED, LocalDate.now().atStartOfDay()
@@ -57,7 +62,7 @@ public void checkAndCreateSteakNoti(User user, int currentStreakCommit) {
 
 
     /**
-     * 특정 연속 커밋 횟수에 도달했는지 확인
+     * 특정 연속 커밋 횟수(3회, 10의 배수 횟수)에 도달했는지 확인
      */
     public boolean shouldNotify(int streak) {
         return streak == 3 || (streak % 10 == 0);

src/main/java/cmf/commitField/domain/noti/noti/service/NotiService.java

@@ -27,7 +27,19 @@ public class NotiService {
     private final NotiRepository notiRepository;
     private final ApplicationEventPublisher eventPublisher;
 
-    // 알림 생성
+    /**
+     * 알림 생성 공통 로직입니다.
+     * 받아온 params를 이용하여 메시지를 생성하고 알림 엔티티를 생성합니다.
+     * 메시지에 필요한 파라미터는 NotiDetailType에 정의된 순서대로 전달해야 합니다.
+     * 만약 NotiDetailType에 정의된 파라미터가 없는 경우에는 빈 배열을 전달해야 합니다.
+     * 데이터베이스에 알림 엔티티를 저장하고 WebSocket 이벤트를 발생시킵니다.
+     * @param receiver
+     * @param notiType
+     * @param notiDetailType
+     * @param relId
+     * @param relTypeCode
+     * @param params
+     */
     @Transactional
     public void createNoti(User receiver, NotiType notiType, NotiDetailType notiDetailType, Long relId, String relTypeCode, Object... params) {
         // 메시지 생성
@@ -53,66 +65,109 @@ public void createNoti(User receiver, NotiType notiType, NotiDetailType notiDeta
         eventPublisher.publishEvent(event);
     }
 
-    // 알림 조회
+    /**
+     * 알림 조회
+     * @param receiver
+     * @return
+     */
     public List<NotiDto> getNotReadNoti(User receiver) {
         List<NotiDto> notis = notiRepository.findNotiDtoByReceiverId(receiver.getId(), false).orElse(null);
         return notis;
     }
 
-    // 시즌 알림 확인
+    /**
+     * 시즌 알림 확인
+     * 알림이 없을 경우 예외 발생
+     * @param receiver
+     * @param seasonId
+     * @return List
+     */
     public List<Noti> getSeasonNotiCheck(User receiver, long seasonId) {
         return notiRepository.findNotiByReceiverAndRelId(receiver, seasonId)
                 .orElseThrow(() -> new CustomException(ErrorCode.ERROR_CHECK)); // 알림이 없을 경우 예외 발생
     }
 
-    // 새 시즌 알림 생성
+    /**
+     * 새 시즌 알림 생성
+     * @param season
+     * @param user
+     */
     @Transactional
     public void createNewSeasonNoti(Season season, User user) {
         createNoti(user, NotiType.SEASON, NotiDetailType.SEASON_START, season.getId(), season.getModelName(), season.getName());
     }
 
-    // 랭킹 업 알림 생성
+    /**
+     * 랭킹 업 알림 생성
+     * @param user
+     */
     @Transactional
     public void createRankUpNoti(User user) {
         createNoti(user, NotiType.RANK, NotiDetailType.RANK_UP, 0L, null, getDisplayName(user), user.getTier().name());
     }
 
-    // 연속 커밋 축하 알림 생성
+    /**
+     * 연속 커밋 축하 알림 생성
+     * @param user
+     * @param days
+     */
     @Transactional
     public void createStreakCommitNoti(User user, String days) {
         createNoti(user, NotiType.STREAK, NotiDetailType.STREAK_CONTINUED, 0L, null, getDisplayName(user), days);
     }
 
-    // 커밋 부재 알림 생성
+    /**
+     * 커밋 부재 알림 생성
+     * @param user
+     */
     @Transactional
     public void createStreakBrokenNoti(User user) {
         createNoti(user, NotiType.STREAK, NotiDetailType.STREAK_BROKEN, 0L, null, getDisplayName(user));
     }
 
-    // 업적 알림 생성
+    /**
+     * 업적 알림 생성
+     * @param user
+     * @param achievementName
+     */
+    // TODO: 업적 로직 구현 후 사용
     @Transactional
     public void createAchievementNoti(User user, String achievementName) {
         createNoti(user, NotiType.ACHIEVEMENT, NotiDetailType.ACHIEVEMENT_COMPLETED, 0L, null, getDisplayName(user), achievementName);
     }
 
-    // 공지사항 알림 생성
+    /**
+     * 공지사항 알림 생성
+     * @param user
+     * @param noticeTitle
+     */
+    // TODO: 공지사항 로직 구현 후 사용
     @Transactional
     public void createNoticeNoti(User user, String noticeTitle) {
         createNoti(user, NotiType.NOTICE, NotiDetailType.NOTICE_CREATED, 0L, null, noticeTitle);
     }
 
-    // 읽음 처리
+    /**
+     * 알림 읽음 처리:
+     * 알림 버튼 클릭 시 모든 알림이 읽음 상태로 변경되기 때문에
+     * 사용자의 모든 알림의 상태를 true로 변경하는 메서드
+     * @param receiver
+     */
     @Transactional
-    public List<Noti> read(User receiver) {
-        System.out.println("알림 읽음 처리");
+    public void read(User receiver) {
+        log.info("✅ read notis");
         List<Noti> notis = notiRepository.findNotiByReceiver(receiver).orElseThrow(() -> new CustomException(ErrorCode.NOT_FOUND_USER));
         notis.forEach(noti -> {
             noti.setRead(true);
         });
-        System.out.println("알림 읽음 처리 끝");
-        return notis;
     }
 
+    /**
+     * 닉네임 여부에 따라 표시 이름 반환:
+     * 닉네임이 있으면 닉네임, 없으면 유저네임 반환
+     * @param user
+     * @return
+     */
     private String getDisplayName(User user) {
         return user.getNickname() != null ? user.getNickname() : user.getUsername();
     }

src/main/java/cmf/commitField/domain/user/service/UserService.java

@@ -14,6 +14,8 @@
 import cmf.commitField.domain.user.entity.User;
 import cmf.commitField.domain.user.repository.TierRegacyRepository;
 import cmf.commitField.domain.user.repository.UserRepository;
+import cmf.commitField.global.error.ErrorCode;
+import cmf.commitField.global.exception.CustomException;
 import lombok.RequiredArgsConstructor;
 import org.springframework.data.redis.core.StringRedisTemplate;
 import org.springframework.stereotype.Service;
@@ -120,4 +122,9 @@ public void updateUserCommitCount(String username, long count){
         user.addCommitCount(count);
         userRepository.save(user);
     }
+
+    public User findByUsername(String username) {
+        return userRepository.findByUsername(username).orElseThrow(() -> new
+                CustomException(ErrorCode.NOT_FOUND_USER));
+    }
 }