추가 기능 - 채팅 기능 명세서

[wooktori]

💬 채팅 기능 명세서 (추가기능)

0. WebSocket 연결

• 로그인 성공 이후 WebSocket 연결
• accessToken을 이용하여 인증
• 로그인 로직 내부에서 WebSocket 초기화 및 연결 수행

---

1. 기본 시나리오

1. 채팅 진입 경로

   • 1 : 1 채팅

     • 팔로잉 탭에서 메세지 버튼 클릭
     • 메세지 탭에서 기존 채팅방 클릭

   • 그룹 채팅

     • 참가한 모임에서 채팅 입장 버튼 클릭
     • 메세지 탭에서 기존 채팅방 클릭

2. 채팅방 입장 처리

   • 기존 채팅방이 존재하면 입장
   • 존재하지 않으면 새 채팅방 입장

3. 채팅 기능

   • 메세지 송·수신
   • 읽음 처리 (카카오톡 방식과 유사)
   • 확장 기능 ( 기본적인 기능 완료 후 가능하다면 추가하려고 합니다. )
     • 이미지
     • 이모티콘 등

---

2. API 명세 (HTTP)📌

• GET /chat/rooms

  • 채팅 목록 조회
  • 1대1 / 그룹 채팅 구분 없이 한 번에 조회
  • 가장 최근 온 메세지 기준 정렬

• POST /chat/room

  • 채팅방 생성
  • (1대1 / 그룹 여부는 요청 데이터로 구분)

• GET /chat/{roomId}

  • 채팅방 최초 진입 시 호출
  • 메세지 목록 조회

---

3. WebSocket (STOMP)📌

• 메세지 송신

  • client.publish

• 메세지 수신

  • client.subscribe

---

4. 추가 정보

구분	1대1 채팅	그룹 채팅
이미지	상대방 프로필 이미지	모임 대표 이미지
제목	상대방 닉네임	모임 이름
지속 기간	영구	모임 종료 후 1일 뒤 자동 삭제

---

5. 논의 필요 사항

• WebSocket 기술 스택 => STOMP
• 데이터 구조
  • 채팅방 데이터 모델
  • 메세지 데이터 모델
• (팔로우 탭에서) 채팅방을 어떻게 찾고 접속할 것인지 ? => roomID 정보X
  => 내 유저ID와 상대방 유저ID의 값으로 roomID 값을 찾고, roomID를 이용해 통신 (12/26 업데이트)

// 채팅방 초안
{
  "roomId": number; // 채팅방 ID
  "unreadCount": number; // 읽지 않은 메세지 수
  "name": string; // 채팅방 이름 (1:1일 경우 상대방 닉네임, 그룹채팅일 경우 모임 제목)
  "lastMessage": { // 가장 최근 메세지
    "content": string;
    "createdAt": string;
  };
  "imageUrl": string; // 채팅방 이미지
  "type": 'PRIVATE' | 'GROUP'; // 채팅방 타입
}

// 메세지 초안
{
  "messageId": number, // 메세지 ID
  "roomId": number, // 채팅방 ID
  "senderId": number, // 송신자 ID
  "senderName": string, // 송신자 이름
  "senderImageUrl": string, // 송신자 프로필 이미지
  "content": string, // 메세지 내용
  "createdAt": string, // 메세지 보낸 시각
  "readCount": number, // 메세지 읽은 숫자
}