[Swift] WebSocket + STOMP 연동

목차

STOMP Overview

• Simple (Streaming) Text Orientated Messaging Protocol
• 텍스트를 주고 받는 형식을 정의한 프로토콜
• 웹소켓에서 서버와 클라이언트간 데이터를 주고 받을때 정해진 형식이 없음
  • 따라서 메시지를 일정한 규칙에 맞춰서 작성하자 → STOMP 통신 규약
• Frame기반 프로토콜이며 각 Frame은 HTTP 데이터 구조와 유사함 + Publish / Subscribe 구조

STOMP Frame 구성

• Command, Header, Body로 구성

• 해당 구성을 `String`화 하여 보냄

"""
COMMAND
header1:value1
header2:value2
Body^@
"""

• Command, header, Body의 구분을 줄 바꿈으로 구분하여 Parse
• 메시지가 끝났다는것을 null octect (위 예시에는 `^@`로 표현)으로 표시

STOMP Frame - COMMAND (일부)

CONNECT

• 처음 Socket을 열고 서버로부터 연결을 요청
• 필수 헤더:
  • accept-version - STOMP 프로토콜 버전
  • host - Client가 연결하고자 하는 Host 이름
• 선택 헤더: login, passcode, heart-beat

STOMP Frame	CONNECT (Client)	CONNECTED (Server)	ERROR (Server)
Sample Code	CONNECT accept-version:1.0,1.1,2.0 host:stomp.github.org ^@	CONNECTED version:1.1 ^@	ERROR version:1.2,2.1 content-type:text/plain Supported protocol versions are 1.2 2.1 ^@

SEND

• 실제 대상에게 메시지 전송
• 필수 헤더:
  • destination - 메시지를 보낼 위치 (Channel)
• Body에 실제로 보낼 메시지 기입

STOMP Frame	SEND (Client)
Sample Code	SEND destination:/queue/a content-type:text/plain hello queue a ^@

SUBSCRIBE

• 특정 위치 (Channel)의 메시지를 구독
• 필수 헤더:
  • destination - 메시지를 보낼 위치 (Channel)
• 선택 헤더:
  • id - subscription 구분용 ID

STOMP Frame	SUBSCRIBE (Client)
Sample Code	SUBSCRIBE id:0 destination:/queue/foo ack:client ^@

UNSUBSCRIBE

• 구독 취소
• 필수 헤더:
  • id - 구독 취소 할 subscription ID

STOMP Frame	UNSUBSCRIBE (Client)
Sample Code	UNSUBSCRIBE id:0 ^@

DISCONNECT

• 클라이언트와 서버와의 연결 종료
• STOMP에서 권장하는 Flow
  1. DISCONNECT COMMAND Frame을 서버로 송신 (header에 receipt 추가)
  2. 서버로 DISCONNECT Frame에 대한 RECEIPT Frame 수신
  3. receipt-id 확인 후 소켓 닫음

STOMP Frame	DISCONNECT (Client)	RECEIPT (Server)
Sample Code	DISCONNECT receipt:77 ^@	RECEIPT receipt-id:77 ^@

STOMP Frame - Header

• Content-Length, Content-Type을 꼭 Header에 추가시켜 주어야 함 (ver. 1.2)

STOMP Frame - Body

• SEND, MESSAGE, ERROR Command에서만 Body가 포함되어야만 함
• 실제로 메시지가 전달되는 영역 (기존 HTTP API 호출할 때 Response Parameter와 유사)

WebSocket 통신 Sample Diagram

STOMP 통신 Sample Diagram

Reference

STOMP

 

[Swift] STOMP 톺아보기