추가 기능 - 알림 기능 명세서

[Chiman2937]

기능 명세서는 하기의 조건 기준으로 작성되었습니다.

1. 알림 수신 시 알림 아이콘 수치(isRead=false)가 증가한다.
2. 그 외에 메시지는 사용자에게 보여지지 않으며, /notifications 페이지로 접속해야 알림 내용을 확인할 수 있다.
3. 읽지 않은 알림 갯수는 사용자가 알림 내용을 직접 확인하거나 모두 읽음 처리 버튼을 클릭해야 변경된다.

내용 요약

• 자세한 명세는 아래 내용을 확인해주세요

1. 초기 로드 동작(클라이언트)

1.1 A가 웹페이지에 처음 접속했을 때/페이지가 새로고침 될 때

1. 사용자 인증 상태 확인

2. 로그인 상태인 경우

(1) CowBell에 읽지 않은 알림 갯수를 표시하기 위해 API를 호출합니다.

• GET /notifications/unread-count
  • isRead=false 인 알림의 갯수를 Header에 표시

(2) SSE 구독을 시작합니다.

• GET /notifications/subscribe

---

2. 기본 시나리오

상황: B가 A를 팔로우 할 때

2.1 A가 웹페이지에 접속 중일 때(SSE Subscribe 상태)

• 백엔드
  • A의 SSE 연결로 실시간 이벤트 전송
  • 데이터베이스에 알림 저장(isRead: false)
• 프론트엔드
  • 미확인 알림 갯수가 1 증가함
  • 전송받은 알림데이터를 이용해 unReadCount + 1처리

2.2 A가 웹페이지에 접속 중이 아닐 때

• 백엔드
  • 데이터베이스에 알림 저장(isRead: false)

---

3. 알림 페이지 이용 시나리오

3.1 A가 알림페이지(/notifications)에 접속한 경우

(1) 알림 목록을 불러옵니다.

• GET /notifications/list

• 프론트엔드

  • isRead=false 인 알람은 BackGround 색상이 존재합니다.
  • isRead=false 인 알림 데이터를 클릭하면 알림이 읽음 처리 됩니다. (POST notifications/read)

---

결론

• 알림 목록이 데이터베이스에 저장되어야 합니다.
• 읽지 않은 알림 갯수를 불러오는 API가 추가되어야 합니다.(GET /notifications/unread-count)
• 알림 목록을 불러오는 API가 추가되어야 합니다.(GET /notifications/list)
• 알림 목록을 전부 읽음 처리하는 API가 추가되어야 합니다.(POST /notifications/readall)
• 알림 목록을 개별 읽음 처리하는 API가 추가되어야 합니다. (POST /notifications/read)

[Be-HinD]

문서로 잘 정리해주셔서 감사합니다~
명세에 대해 궁금한 점이 몇가지가 있는데 여기에 남겨두겠습니다 ㅎㅎ

• 알림 목록 조회 기능 명세가 현재는 99개까지만 저장이라고 되어 있는데, 초과할 경우의 정책이 추가로 필요할 것 같습니다.
• 알림 목록 조회 시 99개의 모든 데이터를 전달 드리면 되는건지, 읽지 않은 알림만 전달드리면 되는건지 혹은 API 분리가 필요한지 정해주셔야할 것 같습니다.
• SSE 응답 활용이 제가 이해하기로는 알림 카운팅 용도로만 쓰이는 것 같은데, 현재는 알림 DTO를 내려주는 방식으로 적용이 되어 있습니다. 만약 카운팅 용도라면 응답 데이터 크기를 줄여서 단순 알림 타입("FOLLOW", "GROUP")에 대한 데이터만 내려주는걸로 변경하는게 좋아보입니다.

[Chiman2937]

@Be-HinD
남겨주신 내용 답변드립니다!

1. 알림 목록 조회 시

• 최대 99개 => 상한선 없이 모든 목록을 조회할 수 있도록(따라서 99개 초과 정책 불필요)
• 무한스크롤 적용(cursor / 20개)

2. 알림 목록 조회 시

• isRead는 true, false 관계없이 조회 가능합니다!

3. SSE 응답 관련

• SSE는 알림 카운팅 용도로만 사용하게 됩니다! 따라서 말씀하신대로 간소화해서 내려주시는게 좋을 듯 합니다:)