Spring | STOMP

해당 내용은 공부의 목적으로 기록되었으며,
아래 내용은 모두 구글 검색으로 공부 블로그를 참고하여 작성했습니다.
열심히 배우는 중입니다. 감사합니다.

 

 

---

 

 

📌 STOMP

STOMP(Streaming Text Oriented Messaging Protocol)은 메세지 기반 통신 프로토콜 중 하나로, 텍스트 기반의 메세지를 전송하기 위해 사용된다.
이 프로토콜은 대부분의 메세지 브로커에서 지원되며, 다른 메세지 기반 프로토콜에 비해 더 가볍고 간단한 구조를 가지고 있다.
STOMP는 서버와 클라이언트 간의 양방향 통신을 제공하며, 하나의 연결로 여러 개의 메세지를 보낼 수 있다. 또한, 메세지의 구독(subscription)과 발행(publish)을 지원하며, 메세지의 큐잉(queueing)과 트랜잭션(transaction) 처리도 가능하다.
많은 언어에서 STOMP를 구현할 수 있으며, 웹 소켓(WevSocket)과 연동하여 실시간 웹 애플리케이션에 활동되기도 한다. 이러한 특징으로 인해 STOMP 는 메세지 기반 시스템을 구현하는데 매우 유용한 프로토콜 중 하나이다.

 

📌 Maven(의존성)

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-messaging</artifactId>
    <version>${Spring 버전과 동일하게}</version>
</dependency>

 

📌 servlet-context.xml

 인터넷에 검색되는 정보들 중 config 를 설정해서 stomp을 설정하는 방법이 흔히 알려져 있다.

나는 Spring-legarcy 프로젝트로 MVC 패턴을 사용했기 때문에 config 보단 servlet-context.xml에 설정해서 stomp를 사용했다.

<!-- chat stomp config -->
<websocket:message-broker application-destination-prefix="/">
    <websocket:stomp-endpoint path="/stompTest">
        <websocket:sockjs/>
    </websocket:stomp-endpoint>
    <websocket:simple-broker prefix="/topic, /queue"/> <!-- /topic + /addr 추가하여 타입별 통신 -->
</websocket:message-broker>

• <websocket:message-broker>
  • WebSocket 메시징을 처리하는 데 사용되며, application-destination-prefix 속성은 메시지 브로커에서 처리되는 메시지의 목적지를 지정한다. 이 경우, 모든 목적지는 루트("/")로 설정했다.
• <websocket:stomp-endpoint>
  • WebSocket 엔드포인트를 설정한다. path 속성은 STOMP 클라이언트가 연결할 경로를 지정한다. 이 예제에서는 "/stompTest" 경로를 사용한다.
  • <websocket:sockjs/> SockJS 프로토콜을 지원하도록 설정.
• <websocket:simple-broker>
  • 메시지 브로커를 설정한다. prefix 속성은 메시지 목적지의 prefix를 지정합니다. 이 예제에서는 "/topic"과 "/queue" prefix를 사용한다. 이렇게 지정한 메시지 목적지에 메시지를 전송하면, 해당 목적지를 구독하는 모든 클라이언트들이 메시지를 수신할 수 있다.

 

📌 StompController

 클라이언트로부터 메세지를 받아 처리하고, 해당 메세지를 다시 클라이언트에게 전송하는 컨트롤러.

@Controller
public class StompController {

    @Autowired
    private SimpMessagingTemplate messagingTemplate;

    @MessageMapping("/{roomNumber}/TTT") // html stompClient.send("/app/send", {}, message);
    public void onReceivedMessage(ChatMessage obj) throws Exception {
        messagingTemplate.convertAndSend("/topic/message/" + obj.getRoomNumber(), obj);
    }
}

• SimpMessagingTemplate
  •  Spring에서 STOMP 메세징 처리를 하기 위해 제공되는 템플릿이다. 사용하기 위해서 @Autowired 어노테이션으로 의존성을 주입한다.
• @MessageMapping("/{roomNumber}/TTT")
  • STOMP 클라이언트에서 메세지를 받을 경로를 설정한다.
• 클라이언트에서 보낸 메세지 처리를 하기 위해서 ChatMessage의 구조 클래스를 만들었다.
• .convertAndSend(' 경로 ', ' 다시 보낼 메세지 ')
  • 메세지를 다시 클라이언트에게 전송한다.
  • "/topic/message"/{roomNumber}" 경로로 메세지를 보내면, 해당 경로를 구독한 모든 클라이언트에게 메세지를 전송한다.

 

📌 Clinent

 서버와 연결하기 위해 SockJS 라이브러리를 사용한다.

function stompOpen() {
    // endpoint 설정
    sock = new SockJS("/stompTest");
    client = Stomp.over(sock);

    // sock connect event 실행
    stompEvent();
}

• new SockJS("/stompTest")
  • STOMP 서버의 endpoint 경로를 설정한다.
• Stomp.over(sock)
  • SockJS 객체를 이용해 STOMP 클라이언트 객체를 생성한다.
  • STOMP 프로토콜을 사용하여 서버와 메세지를 주고받을 수 있다.

 

function stompEvent() {
  // connect 함수 사용
  client.connect({}, function(frame) {
    client.subscribe("/topic/message/" + roomNumber, function(message) {
    console.log(" :: subscribe: ", message);
  
    // msg >>> stomp controller
    client.send("/" + roomNumber + "/TTT", {}, message);
    });
  });
}

• client.connect({}, function(frame)) { ... }
  • STOMP 클라이언트 객체를 통해 서버와 연결하는 함수.
  • 첫 번째 인자: 헤더를 설정하는 객체
  • 두 번쨰 인자: 함수 연결이 성공했을 때 실행되는 콜백 함수
• client.subscribe("/topic/message/" + roomNumber, function(message) { ... }
  • /topic/message/ 경로에 있는 메세지를 구독하는 함수
  • 첫 번째 인자: 경로 + roomNumber 변수 (채팅방을 구분하기 위한 변수)
  • 두 번째 인자: 메세지를 수신했을 때 실행되는 콜백 함수
• client.send("/" + roomNumber + "/TTT", {}, message)
  • 경로에 message 객체를 메세지로 발신하는 함수

 

 

 

출처 | 개발 흔적 남기기