STOMP (프로토콜)

STOMP란? (Simple Text Oriented Messaging Protocol)

STOMP는 간단한 텍스트 기반 메시징 프로토콜이다.

메시징 브로커를 활용해서 pub/sub 방식으로 Client-Server가 쉽게 메시지를 주고받을 수 있는 프로토콜이다.

• 메시지 브로커: 발신자의 메시지를 받아와서 수신자들에게 메시지를 전달하는 것

• pub/sub: 발신자가 메시지를 발행하면 수신자들은 그것을 수신하는 메시징 패러다임

subscribe 과정

따라서 STOMP는 WebSocket 위에 얹어서 함께 사용할 수 있는 하위(서브) 프로토콜이다.

STOMP를 사용하는 이유? 장점?

WebSocket 프로토콜은 두 가지 유형의 메시지를 정의한다.

1. Text Frame: UTF-8로 인코딩된 텍스트 데이터를 포함하는 메시지이다. 주로 문자열 데이터를 전송할 때 사용된다.

2. Binary Frame: 바이너리 데이터를 포함하는 메시지로 이미지, 비디오, 파일 등 텍스트가 아닌 데이터를 전송할 때 사용된다.

이렇게 두 가지 유형의 메시지를 정의하고 있지만, 메시지의 형식이나 구조에 대한 구체적인 규정을 제공하지 않는다.

따라서 메시지를 어떤 형식으로 주고받을 지 정해진게 없기 때문에 직접 별도의 구현이 필요하다.

• 메시지 형식 정의 (= 애플리케이션 요구사항에 맞는 메시지 포맷 정의), ex) json, xml ..

• 메시징 패턴 구현 (pub/sub 같은 메시징 패턴이나, 라우팅을 관리하는 로직 등)

• 연결 및 세션 관리 (세션 관리나 상태 유지를 위한 추가적인 구현이 필요)

개발자는 Client-Server가 어떠한 형식으로 메시지를 주고 받을지 정의하고 파싱하는 로직을 구현해야 한다.

즉 WebSocket 프로토콜만 사용해서 소켓 서버를 구성한다면 해당 메시지가 어떤 요청인지, 어떻게 처리해야 하는지에 따라서 채팅방과 세션을 일일이 구현해야 하고 메시지 발송을 관리하는 코드를 추가해야 한다.

STOMP를 사용하면 이러한 형식, 파싱 코드를 구현하지 않아도 되고, 기본적으로 pub/sub 구조로 되어있어서 메시지를 전송하고 메시지를 받아 처리하는 부분이 정해져있기 때문에 구현의 복잡성을 줄일 수 있다.

STOMP는 WebSocket 위에서 동작하며, 클라이언트와 서버가 전송할 메시지의 유형, 형식, 내용들을 정의하는 메커니즘이다.

• Frame이라고 해서 "Command, body, Header"로 그 형식을 이미 정해두었다.

이런 식으로 메시지의 헤더에 값을 줄 수 있어서 헤더 값을 기반으로 통신 시 인증 처리를 구현하는 것도 가능하며 STOMP 스펙에 정의한 규칙을 지키면서 여러 언어 및 플랫폼 간 메시지를 상호 운영할 수 있다.

STOMP의 Frame

STOMP는 TCP 또는 WebSocket과 같은 양방향 네트워크 프로토콜 기반으로 동작한다.

HTTP에서 모델링되는 Frame 기반 프로토콜이며, Frame은 몇 개의 Text Line으로 지정된 구조이다.

첫 번째 라인은 Text이다.

• SEND, SUBSCRIBE, UNSUBSCRIBE, ACK 등의 명령어가 있다.

이후에 등장하는 라인은 Key:Value 형태로 Header의 정보를 포함한다. (여러 개의 헤더 존재 가능)

• destination, content-type, subscription 등이 있다.

헤더 다음으로는 빈 라인을 추가하고 실제 데이터가 포함되는 본문(Body, Payload)가 존재한다.

이 구조는 HTTP 요청 형식과 매우 유사하다.

// 기본 구조
COMMAND
header1:value1
header2:value2
..
headerN:valueN

Body:^@

// SEND Frame
SEND
destination:/topic/example
content-type:text/plain

Hello, STOMP!
^@

// SUBSCRIBE Frame
id:sub-0
destination:/topic/example
ack:auto

^@

// desination 정보
"topic/.." --> publish-subscribe (1:N)
"queue/" --> point-to-point (1:1)

Command: SEND, SUBSCRIBE를 지시할 수 있다.

Header: 기존의 WebSocket으로는 표현이 불가능 했었던 header를 작성할 수 있다.

destination: 이 헤더로 메시지를 보내거나 구독 할 수 있다.

• destination은 의도적으로 정보르르 불분명하게 정의했는데, 이는 STOMP 구현체에서 문자열 구문에 따라 직접 의미를 부여하도록 하기 위함이다. 따라서 destination 정보는 STOMP 서버 구현체마다 달라질 수 있지만 일반적으로 위 형식을 따른다.

클라이언트 B에서 채팅을 보내는 예시이다.

SEND
destination: /pub/chat
content-type: application/json

{
 "roomId": 5, 
 "type": "MESSAGE",
 "writer": "clientB"
}

^@

STOMP는 모든 구독자에게 메시지를 브로드캐스트 하기 위해 MESSAGE COMMAND를 사용할 수 있다.

서버는 내용(roomId)를 기반으로 메시지를 전송할 Broker에게 전달한다.

MESSAGE
destination: /topic/chat/room/1
message-id: dedqw2-1
subscription: sub-1

{
 "roomId": 5, 
 "type": "MESSAGE",
 "writer": "clientB"
}

^@

Spring이 STOMP를 사용할 때 동작 흐름

1. 발신자는 구독자에게 메시지를 보내려고 한다. 구독자들은 "/topic"이라는 경로를 구독하고 있다.

2. 발신자는 endpoint에 "/topic"을 넣어서 바로 메시지를 보낼 수 있지만, "/app"이라는 endpoint로 메시지를 송신해서 서버 내에서 메시지를 가공, 처리 할 수 있다. 가공할 필요가 없으면 브로커를 통해 바로 보내도 된다.

3. 서버가 가공을 마치면 "/topic"이라는 경로에 담으면 메시지는 브로커에게 전달되고, 메시지 브로커는 "/topic"을 구독한 구독자에게 메시지를 전달한다.