[문은서] Sprint12

[kosy00]

요구사항

• 웹소켓과 SSE를 활용한 실시간 통신
• Nginx를 활용한 배포 아키텍처 구성

기본

웹소켓 구현하기

• 웹소켓 환경 구성
  • spring-boot-starter-websocket 의존성을 추가하세요.

implementation 'org.springframework.boot:spring-boot-starter-websocket'

- 웹소켓 메시지 브로커 설정

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {...}

  - 메모리 기반 SimpleBroker를 사용하세요.

@Override
public void configureMessageBroker(MessageBrokerRegistry config) {...}

  - SimpleBroker의 Destination Prefix는 /sub 으로 설정하세요.
    - 클라이언트에서 메시지를 구독할 때 사용합니다.
  - Application Destination Prefix는 /pub 으로 설정하세요.
    - 클라이언트에서 메시지를 발행할 때 사용합니다.

@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {...}

- STOMP 엔드포인트는 /ws로 설정하고, SockJS 연결을 지원해야 합니다.

• 메시지 송신
  • 첨부파일이 없는 단순 텍스트 메시지인 경우 STOMP를 통해 메시지를 전송할 수 있도록 컨트롤러를 구현하세요.

@Controller
public class MessageWebSocketController {
    ...
    @MessageMapping(...)
}

  - 클라이언트는 웹소켓으로 /pub/messages 엔드포인트에 메시지를 전송할 수 있어야 합니다.
    - @MessageMapping을 활용하세요.
  - 메시지 전송 요청의 페이로드 타입은 MessageCreateRequest 를 그대로 활용합니다.
- 첨부파일이 포함된 메시지는 기존의 API (POST /api/messages)를 그대로 활용합니다.

• 메시지 수신
  • 클라이언트는 채널 입장 시 웹소켓으로 /sub/channels.{channelId}.messages 를 구독해 메시지를 수신합니다.
  • 이를 고려해 메시지가 생성되면 해당 엔드포인트로 메시지를 보내는 컴포넌트를 구현하세요.

@Component
public class WebSocketRequiredEventListener {
    ...
    private final SimpMessagingTemplate messagingTemplate;
    
  @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
  public void handleMessage(MessageCreatedEvent event) {...}
}

• MessageCreatedEvent를 통해 새로운 메시지 생성 이벤트를 확인하세요.
• SimpMessagingTemplate를 통해 적절한 엔드포인트로 메시지를 전송하세요.

SSE 구현하기

• SSE 환경을 구성하세요.

  • 클라이언트에서 SSE 연결을 위한 엔드포인트를 구현하세요.
    • GET /api/sse
  • 사용자별 SseEmitter 객체를 생성하고 메시지를 전송하는 컴포넌트를 구현하세요.

@Service
public class SseService {

  public SseEmitter connect(UUID receiverId, UUID lastEventId) {...}

  public void send(Collection<UUID> receiverIds, String eventName, Object data) {...}

  public void broadcast(String eventName, Object data) {...}

  @Scheduled(fixedDelay = 1000 * 60 * 30)
  public void cleanUp() {...}

  private boolean ping(SseEmitter sseEmitter) {...}
}

• connect: SseEmitter 객체를 생성합니다.

• send, broadcast: SseEmitter 객체를 통해 이벤트를 전송합니다.

• cleanUp: 주기적으로 ping을 보내서 만료된 SseEmitter 객체를 삭제합니다.

• ping: 최초 연결 또는 만료 여부를 확인하기 위한 용도로 더미 이벤트를 보냅니다.

  • SseEmitter 객체를 메모리에서 저장하는 컴포넌트를 구현하세요.

@Repository
public class SseEmitterRepository {
  private final ConcurrentMap<UUID, List<SseEmitter>> data = new ConcurrentHashMap<>();
    ...
}

  - ConcurrentMap: 스레드 세이프한 자료구조를 사용합니다.
  - List<SseEmitter>: 사용자 당 N개의 연결을 허용할 수 있도록 합니다. (예: 다중 탭)

- 이벤트 유실 복원을 위해 SSE 메시지를 저장하는 컴포넌트를 구현하세요.

@Repository
public class SseMessageRepository {

  private final ConcurrentLinkedDeque<UUID> eventIdQueue = new ConcurrentLinkedDeque<>();
  private final Map<UUID, SseMessage> messages = new ConcurrentHashMap<>();
    ...
}

• 각 메시지 별로 고유한 ID를 부여합니다.

• 클라이언트에서 LastEventId를 전송해 이벤트 유실 복원이 가능하도록 해야 합니다.

• 기존에 클라이언트에서 폴링 방식으로 주기적으로 요청하던 데이터를 SSE를 이용해 서버에서 실시간으로 전달하는 방식으로 리팩토링하세요.

  • 새로운 알림 이벤트 전송

    • 새 알림이 생성되었을 때 클라이언트에 이벤트를 전송하세요.

    • 클라이언트는 이 이벤트를 수신하면 알림 목록에 알림을 추가합니다.

    • 이벤트 명세

- 파일 업로드 상태 변경 이벤트 전송
  - 파일 업로드 상태가 변경될 때 이벤트를 발송하세요.
  - 클라이언트는 해당 상태를 수신하면 파일 상태 UI를 다시 렌더링합니다.
  - 이벤트 명세

- 채널 갱신 이벤트 전송
- 채널 정보가 변경될 때, 이벤트를 발송하세요.
  - 클라이언트는 해당 이벤트를 수신하면 채널 UI를 다시 렌더링합니다.
  - 이벤트 명세

- 사용자 갱신 이벤트 전송 - 사용자 정보 또는 로그인 상태가 변경될 때, 이벤트를 발송하세요. - 클라이언트는 해당 이벤트를 수신하면 사용자 UI를 다시 렌더링합니다. - 이벤트 명세

배포 아키텍처 구성하기

• 다음의 다이어그램에 부합하는 배포 아키텍처를 Docker Compose를 통해 구현하세요.

• Reverse Proxy
  • Nginx 기반의 리버스 프록시 컨테이너를 구성하세요.
  • 역할 및 설정은 다음과 같습니다:
    • /api/, /ws/ 요청은 Backend 컨테이너로 프록시 처리합니다.
    • 이 외의 모든 요청은 정적 리소스(프론트엔드 빌드 결과)를 서빙합니다.
      • 프론트엔드 정적 리소스는 Nginx 컨테이너 내부의 적절한 경로(/usr/share/nginx/html 등)에 복사하세요.
  • 외부에서 접근 가능한 유일한 컨테이너이며, 3000번 포트를 통해 접근할 수 있어야 합니다.
  • Backend
    • Spring Boot 기반의 백엔드 서버를 Docker 컨테이너로 구성하세요.
    • Reverse Proxy를 통해 /api/, /ws/ 요청이 이 서버로 전달됩니다.
  • DB, Memory DB, Message Broker
    • Backend 컨테이너가 접근 가능한 다음의 인프라 컨테이너들을 구성하세요
      • DB: PostgreSQL
      • Memory DB: Redis
      • Message Broker: Kafka
    • 각 컨테이너는 Docker Compose 네트워크를 통해 백엔드에서 통신할 수 있어야 합니다.
    • 외부 네트워크와 단절되어야 합니다.

심화

• 심화 항목 1
• 심화 항목 2

주요 변경사항

스크린샷

멘토에게

• 셀프 코드 리뷰를 통해 질문 이어가겠습니다.

[joonfluence]

WebSocket 클래스 설정

[joonfluence]

메세지 송신 처리

[joonfluence]

메세지 수신 처리

[joonfluence]

이벤트 발행

[joonfluence]

이벤트 순서 보장 및 동시성 보장

[joonfluence]

SSE 관련 로직 처리

[joonfluence]

docker-compose 설정 완료

[joonfluence]

주기적으로 응답 없는 연결 제외

[joonfluence]

WebSocketMessageBrokerConfigurer 통해 HTTP 요청 간 JWT 인증 수행