STOMP(Simple Text Oriented Messaging Protocol)๋ž€?

์›น์†Œ์ผ“ ์œ„์—์„œ ๋™์ž‘ํ•˜๋Š” ์„œ๋ธŒ ํ”„๋กœํ† ์ฝœ๋กœ, ํด๋ผ์ด์–ธํŠธ์™€ ์„œ๋ฒ„๊ฐ€ ์„œ๋กœ ํ†ต์‹ ํ•˜๋Š”๋ฐ ์žˆ์–ด ๋ฉ”์‹œ์ง€์˜ ํ˜•์‹, ์œ ํ˜•, ๋‚ด์šฉ ๋“ฑ์„ ์ •์˜ํ•ด์ฃผ๋Š” ํ”„๋กœํ† ์ฝœ์ด๋‹ค.

์›น ์†Œ์ผ“ ํ”„๋กœํ† ์ฝœ์€ Text ๋˜๋Š” binary ๋‘๊ฐ€์ง€ ์œ ํ˜•์˜ ๋ฉ”์‹œ์ง€ ํƒ€์ž…์„ ์ •์˜ํ•˜์ง€๋งŒ ๋ฉ”์‹œ์ง€์˜ ๋‚ด์šฉ์— ๋Œ€ํ•ด์„œ๋Š” ์ •์˜ํ•˜์ง€ ์•Š๋Š”๋‹ค. ์ฆ‰, ์›น ์†Œ์ผ“๋งŒ ์‚ฌ์šฉํ•ด์„œ ๊ตฌํ˜„ํ•˜๊ฒŒ ๋˜๋ฉด ํ•ด๋‹น ๋ฉ”์‹œ์ง€๊ฐ€ ์–ด๋–ค ์š”์ฒญ์ธ์ง€, ์–ด๋–ค ํฌ๋งท์œผ๋กœ ์˜ค๋Š”์ง€ ์ •ํ•ด์ ธ์žˆ์ง€ ์•Š์•„ ์ผ์ผ์ด ๊ตฌํ˜„ํ•ด์•ผํ•œ๋‹ค.

์ด๋•Œ STOMP๋ผ๋Š” ํ”„๋กœํ† ์ฝœ์„ ์„œ๋ธŒ ํ”„๋กœํ† ์ฝœ๋กœ ์‚ฌ์šฉํ•˜์—ฌ, ๋‹จ์ˆœํ•œ binary, text๊ฐ€ ์•„๋‹ˆ๋ผ ๊ทœ๊ฒฉ์„ ๊ฐ–์ถ˜ ๋ฉ”์‹œ์ง€๋ฅผ ๋ณด๋‚ผ ์ˆ˜ ์žˆ๋‹ค.

๋˜ํ•œ ๊ธฐ๋ณธ์ ์œผ๋กœ pub/sub ๊ตฌ์กฐ๋กœ ๋˜์–ด์žˆ์–ด ๋ฉ”์‹œ์ง€๋ฅผ ์ „์†กํ•˜๊ณ  ๋ฉ”์‹œ์ง€๋ฅผ ๋ฐ›์•„ ์ฒ˜๋ฆฌํ•˜๋Š” ๋ถ€๋ถ„์ด ํ™•์‹คํžˆ ์ •ํ•ด์ ธ ์žˆ๊ธฐ ๋•Œ๋ฌธ์— ๊ฐœ๋ฐœ์ž ์ž…์žฅ์—์„œ ๋ช…ํ™•ํ•˜๊ฒŒ ์ธ์ง€ํ•˜๊ณ  ๊ฐœ๋ฐœํ•  ์ˆ˜ ์žˆ๋Š” ์ด์ ์ด ์žˆ๋‹ค.

STOMP๋ฅผ ์ด์šฉํ•˜๋ฉด ๋ฉ”์„ธ์ง€์˜ ํ—ค๋”์— ๊ฐ’์„ ์ค„ ์ˆ˜ ์žˆ์–ด ํ—ค๋” ๊ฐ’์„ ๊ธฐ๋ฐ˜์œผ๋กœ ํ†ต์‹ ์‹œ ์ธ์ฆ ์ฒ˜๋ฆฌ๋ฅผ ๊ตฌํ˜„ํ•˜๋Š” ๊ฒƒ๋„ ๊ฐ€๋Šฅํ•˜๋ฉฐ, STMOP ์ŠคํŽ™์— ์ •์˜ํ•œ ๊ทœ์น™๋งŒ ์ž˜ ์ง€ํ‚ค๋ฉด ์—ฌ๋Ÿฌ ์–ธ์–ด ๋ฐ ํ”Œ๋žซํผ๊ฐ„ ๋ฉ”์‹œ์ง€๋ฅผ ์ƒํ˜ธ ์šด์˜ํ•  ์ˆ˜ ์žˆ๋‹ค.

์Šคํ”„๋ง์€ spring-websocket ๋ชจ๋“ˆ์„ ํ†ตํ•ด์„œ STOMP๋ฅผ ์ œ๊ณตํ•˜๊ณ  ์žˆ๋‹ค.


ํ˜•์‹

ํ˜•์‹

STOMP๋Š” HTTP์—์„œ ๋ชจ๋ธ๋ง๋˜๋Š” Frame ๊ธฐ๋ฐ˜ ํ”„๋กœํ† ์ฝœ์ด๋‹ค. Frame์€ ๋ช‡ ๊ฐœ์˜ Test line์œผ๋กœ ์ง€์ •๋œ ๊ตฌ์กฐ์ธ๋ฐ ์ฒซ๋ฒˆ์งธ ๋ผ์ธ์€ Text์ด๊ณ , ์ดํ›„ Key:Value ํ˜•ํƒœ๋กœ Header์˜ ์ •๋ณด๋ฅผ ํฌํ•จํ•œ๋‹ค. ๊ทธ ๋‹ค์Œ ๋นˆ ๋ผ์ธ์„ ์ถ”๊ฐ€ํ•˜๊ณ  Payload๊ฐ€ ์กด์žฌํ•œ๋‹ค.

์•„๋ž˜ ํ˜•์‹์„ ๋ณด๋ฉด HTTP์™€ ์œ ์‚ฌํ•˜๋‹ค๋Š” ๊ฒƒ์„ ์•Œ ์ˆ˜ ์žˆ๋‹ค.

COMMAND
header1:value1
header2:value2

Body^@
  • COMMAND

    • ํด๋ผ์ด์–ธํŠธ๋Š” ๋ฉ”์‹œ์ง€๋ฅผ ์ „์†กํ•˜๊ธฐ ์œ„ํ•ด COMMAND๋กœ SEND ๋˜๋Š” SUBSCRIBE ๋ช…๋ น์„ ์‚ฌ์šฉํ•œ๋‹ค
    • MESSAGE COMMAND๋Š” ๋ชจ๋“  ๊ตฌ๋…์ž์—๊ฒŒ ๋ฉ”์„ธ์ง€๋ฅผ ๋ธŒ๋กœ๋“œ์บ์ŠคํŒ…ํ•  ๋•Œ ์‚ฌ์šฉํ•œ๋‹ค.
    • ๊ทธ์™ธ ๋‹ค์Œ๊ณผ ๊ฐ™์€ COMMAND๊ฐ€ ์žˆ๋‹ค
      • UNSUBSCRIBE, BEGIN, COMMIT, ABORT, ACK, NACK, DISCONNECT
  • header, value

    • ๋ฉ”์‹œ์ง€์˜ ์ˆ˜์‹  ๋Œ€์ƒ๊ณผ ๋ฉ”์‹œ์ง€์— ๋Œ€ํ•œ ์ •๋ณด๋ฅผ ์„ค๋ช…ํ•œ๋‹ค.

    • ๊ธฐ์กด ์›น์†Œ์ผ“๋งŒ์œผ๋กœ๋Š” ํ‘œํ˜„ํ•  ์ˆ˜ ์—†๋Š” ํ˜•์‹์ด๋‹ค.

    • destination : ํ—ค๋” ์ค‘ ํ•˜๋‚˜๋กœ, ์ด ํ—ค๋”๋กœ ์ง€์ •ํ•œ ์ฃผ์†Œ๋กœ ๋ฉ”์„ธ์ง€๋ฅผ ๋ณด๋‚ด๊ฑฐ๋‚˜ ๊ตฌ๋…ํ•  ์ˆ˜ ์žˆ๋‹ค.

      • destination์€ ์˜๋„์ ์œผ๋กœ ์ •๋ณด๋ฅผ ๋ถˆ๋ถ„๋ช…ํ•˜๊ฒŒ ์ •์˜ํ•˜์˜€๋Š”๋ฐ, ์ด๋Š” STOMP ๊ตฌํ˜„์ฒด์—์„œ ๋ฌธ์ž์—ด ๊ตฌ๋ฌธ์— ๋”ฐ๋ผ ์ง์ ‘ ์˜๋ฏธ๋ฅผ ๋ถ€์—ฌํ•˜๋„๋ก ํ•˜๊ธฐ ์œ„ํ•จ์ด๋‹ค.

      • ์ผ๋ฐ˜์ ์œผ๋กœ ๋‹ค์Œ์˜ ํ˜•์‹์„ ๋”ฐ๋ฅธ๋‹ค.

        "/topic/..." : publish - subscribe(1:N)
        "/queue/..." : point-to-point (1:1)
        

๋ฉ”์‹œ์ง€ ๋ธŒ๋กœ์ปค

publisher๋กœ๋ถ€ํ„ฐ ์ „๋‹ฌ ๋ฐ›์€ ๋ฉ”์‹œ์ง€๋ฅผ subscriber๋กœ ์ „๋‹ฌํ•ด์ฃผ๋Š” ์ค‘๊ฐ„์—ญํ• ์„ ์ˆ˜ํ–‰ํ•œ๋‹ค. ๋™์ž‘๋ฐฉ์‹์€ ๋‹ค์Œ๊ณผ ๊ฐ™๋‹ค.

  1. ๊ฐ๊ฐ A, B, C๋ผ๋Š” ์œ ์ €๊ฐ€ ์ฐจ๋ก€๋กœ 5๋ฒˆ๋ฐฉ์— ์ž…์žฅํ•œ๋‹ค.

    SUBSCRIBE
    destination:/subscribe/chat/room/5
    
    ^@
    
    • ์œ ์ €๊ฐ€ ์ž…์žฅํ•˜๋ฉด์„œ 5๋ฒˆ๋ฐฉ์— ๋Œ€ํ•œ ๊ตฌ๋…์„ ํ•œ๋‹ค.
    • ๋ฉ”์‹œ์ง€ ๋ธŒ๋กœ์ปค๋Š” ํด๋ผ์ด์–ธํŠธ์˜ SUBSCRIBE ์ •๋ณด๋ฅผ ์ž์ฒด์ ์œผ๋กœ ๋ฉ”๋ชจ๋ฆฌ์— ์œ ์ง€ํ•œ๋‹ค.
  2. A๊ฐ€ 5๋ฒˆ๋ฐฉ์—์„œ ์ฑ„ํŒ…์„ ์ „์†กํ•œ๋‹ค.

    SEND
    content-type:application/json
    destination:/publish/chat
    
    {"chatRoomId":5,"type":"MESSAGE","writer":"clientB"}^@
    
  3. 5๋ฒˆ๋ฐฉ ๋ฉ”์‹œ์ง€ ๋ธŒ๋กœ์ปค๊ฐ€ ๋ฉ”์‹œ์ง€๋ฅผ ๋ฐ›๋Š”๋‹ค.

  4. 5๋ฒˆ๋ฐฉ ๋ฉ”์‹œ์ง€ ๋ธŒ๋กœ์ปค๊ฐ€ 5๋ฒˆ๋ฐฉ ๊ตฌ๋…์ž(A, B, C)์—๊ฒŒ ๋ฉ”์‹œ์ง€๋ฅผ ์ „์†กํ•œ๋‹ค.


Spring์—์„œ STOMP๋กœ ๊ตฌํ˜„

์›น ์†Œ์ผ“์— STOMP, ๋ฉ”์‹œ์ง€ ๋ธŒ๋กœ์ปค ์—ฐ๋™

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
      registry.enableSimpleBroker("/subscribe");
      registry.setApplicationDestinationPrefixes("/publish");
    }
    
    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
      registry.addEndpoint("/ws-connection")
              .setAllowedOrigins("*")
              .withSockJS();
    }
}
  • @EnableWebSocketMessageBroker
    • STOMP๋ฅผ ์‚ฌ์šฉํ•˜๊ธฐ ์œ„ํ•ด ์„ ์–ธํ•˜๋Š” ์• ๋…ธํ…Œ์ด์…˜
  • WebSocketMessageBrokerConfigurer
    • ๋ฉ”์‹œ์ง€ ๋ธŒ๋กœ์ปค๊ฐ€ ์ง€์›ํ•˜๋Š” ์›น์†Œ์ผ“ ๋ฉ”์‹œ์ง€ ์ฒ˜๋ฆฌ๋ฅผ ํ™œ์„ฑํ™”ํ•œ๋‹ค.
  • configureMessageBroker()
    • ์ธ ๋ฉ”๋ชจ๋ฆฌ ๊ธฐ๋ฐ˜์˜ Simple Message Broker๋ฅผ ํ™œ์„ฑํ™”ํ•œ๋‹ค.
      • RabbitMQ, ActiveMQ ๊ฐ™์€ ์™ธ๋ถ€ ๋ฉ”์„ธ์ง• ์‹œ์Šคํ…œ์„ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.
    • ๋ฉ”์‹œ์ง€ ๋ธŒ๋กœ์ปค๋Š” enableSimpleBroker()๋กœ ์„ค์ •ํ•œ ๊ฐ’์œผ๋กœ ์‹œ์ž‘ํ•˜๋Š” ์ฃผ์†Œ์˜ subscriber๋“ค์—๊ฒŒ ๋ฉ”์‹œ์ง€๋ฅผ ์ „๋‹ฌํ•˜๋Š” ์—ญํ• ์„ ํ•œ๋‹ค. ์˜ˆ์‹œ์—์„œ๋Š” /subscribe๋กœ ์„ค์ •ํ•˜์—ฌ /subscribe๋กœ ๋“ค์–ด์˜จ ์š”์ฒญ์€ ๊ตฌ๋…์œผ๋กœ ์ •ํ•ด์ง„๋‹ค.
    • ๋งˆ์ฐฌ๊ฐ€์ง€๋กœ setApplicationDestinationPrefixes()๋กœ ์„ค์ •ํ•œ ๊ฐ’์€ publish๋ฅผ ์œ„ํ•ด ์‚ฌ์šฉ๋œ๋‹ค,
  • registerStompEndpionts()
    • HandShake์™€ ํ†ต์‹ ์„ ๋‹ด๋‹นํ•œ EndPoint๋ฅผ ์ง€์ •ํ•œ๋‹ค.
    • ์˜ˆ์‹œ์—์„œ๋Š” ํด๋ผ์ด์–ธํŠธ์—์„œ ์„œ๋ฒ„๋กœ WebSocket ์—ฐ๊ฒฐ์„ ํ•˜๊ณ  ์‹ถ์„ ๋•Œ, /ws-connection์œผ๋กœ ์š”์ฒญ์„ ๋ณด๋‚ด๋„๋ก ์„ค์ •ํ•˜์˜€๋‹ค.

ChatRequest DTO

public class ChatRequest {
    private Long senderId;
    private Long receiverId;
    private Long roomId;
    private String message;
}

Controller

@RestController
@RequiredArgsConstructor
public class ChattingController {
    private final ChattingService chattingService;
    private final SimpMessagingTemplate simpMessagingTemplate;
  
    public ChattingController(ChattingService chattingService, SimpMessagingTemplate simpMessagingTemplate) {
      this.chattingService = chattingService;
      this.simpMessagingTemplate = simpMessagingTemplate;
    }
    
    @MessageMapping("/messages")
    public void chat(@Valid ChatRequest chatRequest) {
      chattingService.save(chatRequest);
      simpMessagingTemplate.convertAndSend("/subscribe/rooms/" + chatRequest.getRoomId(), chatRequest.getMessage());
    }
}
  • SimpMessagingTemplate

    • @EnableWebSocketMessageBroker์„ ํ†ตํ•ด์„œ ๋“ฑ๋ก๋˜๋Š” ๋นˆ์ด๋‹ค. ๋ธŒ๋กœ์ปค๋กœ ๋ฉ”์‹œ์ง€๋ฅผ ์ „๋‹ฌํ•œ๋‹ค.
  • @MessageMapping

    • ํด๋ผ์ด์–ธํŠธ๊ฐ€ SEND ํ•  ์ˆ˜ ์žˆ๋Š” ๊ฒฝ๋กœ.

    • WebSocketConfig ์—์„œ ๋“ฑ๋กํ•œ setApplicationDestinationPrefixes() ์ฃผ์†Œ์™€ ํ•ฉ์ณ์ง„๋‹ค

      /publish/messages

ํด๋ผ์ด์–ธํŠธ ์—ฐ๋™

function connect() {
    var socket = new WebSocket('/ws-connection');
    stompClient = Stomp.over(socket);
    stompClient.connect({}, function () {
        setConnected(true);
        stompClient.subscribe('/subscribe/rooms/5', function (greeting) {
            console.log(greeting.body);
        });
    });
}
 
function sendMessage() {
    stompClient.send("/publish/messages", {}, JSON.stringify({
        'message': $("#name").val(),
        'senderId': 7,
        'receiverId': 14,
        'roomId': 5
    }));
}

์ถœ์ฒ˜

https://tecoble.techcourse.co.kr/post/2021-09-05-web-socket-practice/

https://dev-gorany.tistory.com/235