메시지 브로커라는 것을 활용하여 pub/sub(즉, Publish/Subscribe ) 방식으로 클라이언트와 서버가 쉽게 메시지를 주고 받을 수 있도록하는 프로토콜이다.
pub/sub은 일종의 메시지 패러다임
발신자가 어떠한 범주(예를 들어 경로)로 메시지를 발행하면 이 범주를 구독하고 있는 수신자들이 해당 메시지를 받아볼 수 있는 방식
메시지 브로커는 발신자가 보낸 메시지들을 받아서 수신자들에게 전달해주는것이다.
웹소켓 위에 STOMP를 얹어서 사용하는 이유?
웹소켓은 Text, Binary 타입의 메시지를 양방향으로 주고받을 수 있는 프로토콜인데 메시지를 주고받는 형식이 따로 정해진것이 없다.
웹소켓만 사용하는 프로젝트가 커진다면, 주고 받는 메시지에 대한 형식이 중요해지게 되기 때문에 정의된 메시지 형식대로 파싱하는 로직 또한 따로 구현해야한다.
STOMP를 사용하면 메시지 형식에 대한 고민과 파싱 로직을 위한 코드 구현이 필요없어진다.
웹소켓(왼쪽)은 오고 가는 데이터는 raw한 형태의 메시지
STOMP(오른쪽) 커맨드, 헤더, 바디의 형태로 데이터가 오고간다.
STOMP 프로토콜의 동작 흐름
메시지를 보내려는 발신자, 메시지를 받으려는 구독자가 있고 구독자는 /topic이라는 경로를 구독하고 있다.
발신자는 /topic을 destination 헤더로 넣어 메시지를 메시지 브로커를 통해 구독자들에게 곧바로 송신할 수 있다.
또는 서버 내에서 어떠한 가공처리가 필요하다면 /app 경로로 메시지를 송신할 수 있다.
서버가 가공처리가 끝난 데이터를 /topic 이라는 경로를 담아 메시지 브로커에게 전달하면
메시지 브로커는 전달받은 메시지를 /topic을 구독하는 구독자들에게 최종적으로 전달한다.
STOMP 사용해보기
package com.websocket;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketBrokerConfig implements WebSocketMessageBrokerConfigurer {
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {
registry.enableSimpleBroker("/queue","/topic");
registry.setApplicationDestinationPrefixes("/app");
}
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
registry.addEndpoint("/gs-guide-websocket")
.withSockJS();
}
}
@EnableWebSocketMessageBroker 어노테이션을 달고 WebSocketMessageBrokerConfigurer 인터페이스를 구현
ConfigureMessageBroker는 STOMP에서 사용하는 메시지 브로커를 설정하는 메소드
enableSimpleBroker : 내장 메시지 브로커를 사용하기 위한 메소드이다. 파라미터로 지정한 prefix(/queue 또는 /topic)가 붙은 메시지를 발행할경우, 메시지 브로커가 이를 처리하게 된다.
/queue prefix는 메시지가 1대1로 송신될 때,
/topic prefix는 메시지가 1대다로 브로드캐스팅될 때 사용됨
setApplicationDestinationPrefixes : 메시지 핸들러로 라우팅되는 prefix(/app)를 파라미터로 지정할 수 있다.
메시지 가공 처리가 필요한경우, 가공 핸들러로 메시지를 라우팅 되도록 하는 설정
registerStompEndpoints는 웹소켓 configuration의 addHandler 메소드와 유사하다.
addEndpoint 메소드의 파라미터로 들어가는 /gs-guide-websocket 은 처음 웹소켓 HandShake를 위한 경로
cors,SockJS 설정 또한 할 수 있다.
addHandler와 다른 점은 핸들러를 하나하나 추가해줄 필요가 없다.
STOMP를 사용하면 웹소켓만 사용할 때와 다르게 하나의 연결주소마다 핸들러 클래스를 따로 구현할 필요없이 Controller 방식으로 간편하게 사용할 수 있다.
package com.websocket;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;
import org.springframework.web.util.HtmlUtils;
@Controller
public class GreetingController {
@MessageMapping("/hello")
@SendTo("/topic/greeting")
public Greeting greeting(HelloMessage message) throws Exception {
Thread.sleep(1000);
return new Greeting("Hello" + HtmlUtils.htmlEscape(message.getName()));
}
}
가공 핸들러는 이와 같이 구현한다.
STOMP를 사용하면 따로 인터페이스를 상속받을 필요 없이 @Controller 어노테이션을 사용할 수 있다.
@MessageMapping 어노테이션은 @RequestMapping과 비슷한 역할을 한다.
HTTP 요청의 경로에 맞는 핸들러에게 처리를 위임하듯, STOMP 웹소켓 통신을 통해 메시지가 들어오면 메시지의 destination 헤더와 @MessageMapping에 설정된 경로가 일치한 핸들러를 찾아 해당 핸들러가 이를 처리한다. ->WebSocketBrokerConfig에서 설정한 /app prefix와 합쳐진 /app/hello라는 destination 헤더를 가진 메시지들이 @MessageMapping("/hello")가 붙은 핸들러를 거치게 된다.
@SendTo 어노테이션은 핸들러에서 처리를 마친 후 결과 메시지를 설정한 경로(/topic/greeting)로 보내준다.
앞에 /topic이 붙었으니 SimpleBroker로 전달된다.
STOMP 프로토콜의 장점
하위 프로토콜, 컨벤션을 따로 정의할 필요가 없다.
STOMP가 프레임 단위로 정해줌
연결 주소마다 새로운 Handler를 구현하고 설정해줄 필요가 없다.
@Controller 어노테이션을 사용하면 된다.
외부 Messaging Queue (Kafka, RabbitMQ ....)를 사용할 수 있다.
Spring이 기본적으로 제공하는 내장 메시지 브로커가 아닌 외부 메시지 큐를 연동해서 사용할 수 있다.
