Spring boot에서 STOMP 사용하기 [ 간단한 채팅 용 ]

 

 

 

---

 

Spring boot에서 STOMP는 어떻게 사용할까?

 

 

---

 

 

 

 

STOMP이란?

 

--

STOMP (Simple/Streaming Text Oriented Messaging Protocol)

--

 

 

 

 

환경

 

--

• Spring boot  :  3.4.0
• build  :  Gradle
• Java  :  17

--

 

 

 

 

STOMP 의존성 추가

 

--

build.gradle

implementation 'org.springframework.boot:spring-boot-starter-websocket'

--

 

 

 

 

DTO

 

--

MessageDto.java

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class MessageDto {

    private Long roomNumber;		// 방 코드
    private String sender;		// 유저 닉네임
    private String message;		// 메시지
}

양방향 연결 후 채팅방에서 메시지를 주고받을 때 사용된다.

 

 

RoomNumberResponseDto.java

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class RoomNumberResponseDto {

    private String roomNumber;		// 방 코드
}

 

 

SenderRequestDto.java

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class SenderRequestDto {

    private String sender;		// 유저 닉네임
}

--

 

 

 

 

웹 소켓, 브로커 설정

 

--

WebSocketStomConfig.java

import lombok.RequiredArgsConstructor;
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
@RequiredArgsConstructor
public class WebSocketStompConfig implements WebSocketMessageBrokerConfigurer {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry){
    
        registry.setApplicationDestinationPrefixes("/app");	// 클라이언트가 서버로 요청하기 위한 URL의 접두사 설정
        registry.enableSimpleBroker("/topic", "/queue");	// 브로커가 해당 접두사를 구독하고 있는 클라이언트에게 전달할 수 있도록 설정
        registry.setUserDestinationPrefix("/user");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry){
        registry.addEndpoint("/ws/connect")		// 웹소켓 연결 요청 경로
                .setAllowedOrigins("*")			// 웹소켓 연결 요청 허용 도메인 (CORS 설정)
                .withSockJS();				// 웹 소켓을 지원하지 않는 경우 대체 프로토콜을 사용하여 통신하도록 설정
    }
}

 

configureMessageBroker() 메서드

브로커에 대한 설정을 위한 메서드다.

 

setApplicationDestinationPrefixes()는
클라이언트가 보낸 메시지를 "어떤 핸들러 메서드"로 전달되어야 하는지 지정하는 "접두사(prefix)"를 설정하는 것으로
"/app"를 접두사로 설정했다면, 클라이언트가 "/app"으로 시작하는 경로로 요청하면
해당 메시지를 컨트롤러에서 @MessageMapping이 붙은 메서드로 라우팅 된다.
(@MessageMapping에서는 "/app"접두사 경로를 생략 가능)
즉, 클라이언트가 "/app"으로 시작하는 경로로 요청을 보내면 컨트롤러로 전달된다.

 

enableSimpleBroker()는
요청받은 메시지를 다시 클라이언트에게 전달할 "브로커"를 설정하는 것으로
"/topic"를 접두사로 설정했다면, "topic"으로 시작하는 경로를 구독한 클라이언트에게 메시지를 전달한다.

일반적으로
"/topic"은 여러 클라이언트에게 전달할 때 (브로드 캐스트) 사용하며,
"/queue"는 하나의 클라이언트에게 전달할 때 사용된다.

 

setUserDestinationPrefix()는

특정 사용자에게 1:1 메시지를 보내기 위한 "접두사"를 설정하는 것으로

"/user"로 접두사를 설정했다면, "/user"로 시작하는 경로를 구독하고 있는 클라이언트로 전달한다.

(기본값은 "/user"로 되어 있으며, 따로 다른 접두사로 변경하는 것이 아니라면 해당 코드는 생략도 가능하다.)

여기서 서버는 해당 요청 사용자를 자동으로 식별하여

"/user/{username}/..."로 전달하고

클라이언트도 "/user/{username}/..." 경로를 구독하고 있어야 한다.

즉, 요청한 자기 자신에게 응답을 보내는 결과가 된다.

여기서 /{username}은
기본적으로 sessionId 또는 user정보를 자동으로 삽입하여 사용되기 때문에
따로 설정한 것이 아니라면 클라이언트에서 구독하거나, 서버에서 응답하는 경로를 작성할 때 생략하여 사용한다.

 

 

enableSimpleBroker("/user")와 setUserDestinatinoPrefix("/user")의 차이

enableSimpleBroker("/user")는
브로커가 "/user" 경로를 포함한 메시지 전달을 처리할 수 있도록 설정하는 것으로
브로커가 메시지를 해당 경로를 구독한 사용자에게 전달하는 역할을 수행

setUserDesinationPrefix("/user")는
서버가 클라이언트의 요청 경로 "/user/..."를 사용자별 경로 "/user/{username}/..."로 변환하도록 설정하는 것으로
클라이언트에서는 단순한 경로를 사용할 수 있다.

하지만 Spring에서는 기본적으로 setUserDestinationPrefix("/user")로 설정되어 있기 때문에 그대로 "/user" 접두사를 사용할꺼라면 굳이 작성하지 않고 생략해도 된다.
다만 "/user"가 아닌 다른 접두사로 커스텀해서 사용하고 싶다면
setUserDestinationPrefix(접두사)를 작성해서 명시해줘야 한다.
즉, 비유하자면 오버라이딩해야 한다고 생각하면 된다.

정리하면
enableSimpleBroker("/user")는
메시지 브로커가 특정 경로(/user 접두사로 시작하는 경로)를 관리하도록 설정하며,
주로 브로드캐스트 통신을 위해 사용되는 경로고,
setUserDesinationPrefix("/user")는
클라이언트와 서버 간의 1:1 통신을 위해 경로를 설정하는 것으로
특정 사용자 세션으로 메시지를 라우팅한다.

즉, 두 파트 모두 "/user" 접두사를 작성하면 충돌하거나 의도하지 않은 동작이 발생할 수 있으므로 주의해야 한다.

 

 

--

 

 

 

 

컨트롤러

 

--

ChatController.java

import com.example.SimpleChat_Stomp.dto.MessageDto;
import com.example.SimpleChat_Stomp.dto.RoomNumberResponseDto;
import com.example.SimpleChat_Stomp.dto.SenderRequestDto;
import com.example.SimpleChat_Stomp.service.ChatService;
import lombok.RequiredArgsConstructor;
import org.springframework.messaging.handler.annotation.DestinationVariable;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.Payload;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.messaging.simp.SimpMessageHeaderAccessor;
import org.springframework.messaging.simp.annotation.SendToUser;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequiredArgsConstructor
public class ChatController {

    private final ChatService chatService;

    @MessageMapping("/room/create")         // 클라이언트에서 /api/room/create 요청을 보내면 실행(호출)되는 메서드
    @SendToUser("/queue/game")              // /user/queue/game을 구독한 클라이언트에게 return값 응답 (요청한 사용자에게만 응답)
    public RoomNumberResponseDto roomCreate(@Payload SenderRequestDto request, SimpMessageHeaderAccessor headerAccessor){

        String roomNumber = chatService.roomCreate(request.getSender());

        RoomNumberResponseDto response = new RoomNumberResponseDto(roomNumber);

        // 현재 사용자의 세션 (웹소켓 연결된 세션)에 참여 중인 방 코드, 사용자 닉네임을 담아서 관리
        headerAccessor.getSessionAttributes().put("roomNumber", roomNumber);
        headerAccessor.getSessionAttributes().put("sender", request.getSender());

        return response;
    }

    @MessageMapping("/room/join/{roomNumber}")
    @SendTo("/topic/room/{roomNumber}")         // /topic/room/{roomNumber}를 구독한 클라이언트들에게 return 값(메시지) 전달
    public RoomNumberResponseDto roomJoin(@DestinationVariable String roomNumber, @Payload SenderRequestDto request, SimpMessageHeaderAccessor headerAccessor){

        // 고유한 값으로 한다면 아래처럼 닉네임이 아닌 headerAccessor.getSessionId()로 세션ID를 사용하는 것이 좋다.
        // 다만 여기서는 그냥 닉네임은 고유하다고 가정하고 닉네임으로 사용했다.
        // 닉네임과 세션모두 사용해도 된다.
        chatService.roomJoin(roomNumber, request.getSender());

        headerAccessor.getSessionAttributes().put("roomNumber", roomNumber);
        headerAccessor.getSessionAttributes().put("sender", request.getSender());

        RoomNumberResponseDto response = new RoomNumberResponseDto(roomNumber);

        return response;
    }

    @MessageMapping("/room/remove/{roomNumber}")
    @SendTo("/topic/room/{roomNumber}")
    public RoomNumberResponseDto roomRemove(@DestinationVariable String roomNumber, @Payload SenderRequestDto request, SimpMessageHeaderAccessor headerAccessor){

        chatService.roomRemove(roomNumber, request.getSender());

        headerAccessor.getSessionAttributes().remove("roomNumber");
        headerAccessor.getSessionAttributes().put("sender", request.getSender());

        RoomNumberResponseDto response = new RoomNumberResponseDto(roomNumber);

        return response;
    }

    @MessageMapping("/room/chat/{roomNumber}")
    @SendTo("/topic/room/{roomNumber}")
    public MessageDto roomChat(@DestinationVariable String roomNumber, @Payload MessageDto request, SimpMessageHeaderAccessor headerAccessor){

        return request;
    }
}

컨트롤러에서 브로커로 전달할 때
@SendTo()나 @SendToUser() 대신 SimpMessagingTemplate를 사용할 수도 있다.

@MessageMapping("/room/chat/{roomNumber}")
@SendTo("/topic/room/{roomNumber}")
public MessageDto roomChat(@DestinationVariable String roomNumber, @Payload MessageDto request, SimpMessageHeaderAccessor headerAccessor){

    return request;
}​

위 코드를 아래처럼도 사용이 가능하다.

private final SimpMessagingTemplate messagingTemplate;

...

@MessageMapping("/room/chat/{roomNumber}")
public void roomChat(@DestinationVariable String roomNumber, @Payload MessageDto request, SimpMessageHeaderAccessor headerAccessor){

    messagingTemplate.convertAndSend("/topic/room" + roomNumber, request);
}​

- @SendTo()  =  convertAndSend(경로, 데이터)
- @SendToUser()  =  convertAndSendToUser(Principal, 경로, 데이터)

Principal은 /{username}의 값을 의미하는데
Spring Security에서 사용자 정보를 표현하는 인터페이스로
주로 인증된 사용자를 식별하거나 사용자 정보를 구분하는 정보다.

 

 

@MessageMapping()은

일반적으로 HTTP 통신할 때

컨트롤러에서 @GetMapping()으로 HTTP Patch를 지정하는 것처럼

@MessageMapping()으로 각 요청마다 호출할 컨트롤러 메서드를 지정할 수 있다.

일반적으로 웹소켓 설정에서 "/app"으로 설정했다면
@MessageMapping()에 "/app" 접두사를 생략할 수 있다.
즉, @MessageMapping("/room/create")로 정의했다면
클라이언트가 "/app/room/create"로 요청할 때 해당 컨트롤러가 호출되어 실행된다.

 

@SendTo()는

컨트롤러에서 return으로 응답하는 메시지(데이터)를 브로커로 넘겨주는 것으로

@SendTo()에 정의한 경로를 구독하는 모든 클라이언트에게 전달해 달라고 브로커에게 전달하는 것이다.

일반적으로 웹소켓 설정에서 "/topic"을 설정했다면
@SendTo()에 "/topic" 접두사를 생략할 수 있다.
즉, @SendTo("/room/2342")로 정의했다면
브로커는 "/topic/room/2342"를 구독한 모든 클라이언트에게 전달해 준다.

다만 웹소켓 설정에서 "/queue"를 설정했도 "/queue"는 생략이 불가능하다.

@SendTo("/queue/room/2342")처럼 앞에 "/queue" 접두사를 직접 작성해줘야 하며
이런 경우에는 "/topic"이 자동으로 붙여지지 않는다.

 

@SendToUser()는

컨트롤러에서 return으로 응답하는 메시지(데이터)를 브로커로 넘겨주는 것으로

여기서 @SendTo()와는 다르게 특정 사용자에게만 전달해 달라고 브로커에게 전달하는 것이다.

일반적으로 웹소켓 설정에서 "/user"를 설정했다면
@SendToUser()에 "/user" 접두사를 생략할 수 있다.
즉, @SentToUser("/room/2342")로 정의했다면
브로커는 "/user/room/2342"를 구독한 클라이언트에게 전달하는데
여기서 사실은 "/user/{username}/room/2342"로 전달한다.

여기서 {username}은
특정 사용자의 고유 값을 사용하게 되어 특정 사람에게만 전달되도록 하는 것으로
일반적으로 sessionId 또는 User(인증, 인가 정보)로 각 클라이언트를 구분하며,
특별한 설정을 하지 않았다면 자동으로 삽입하여 보내지기 때문에 경로에 {username}은 생략하여 사용할 수 있다.

 

@DestinationVariable은

STOMP 메시지에서 경로에 지정한 변수 값을 추출하는 것으로

@MessageMapping("/chat/{roomNumber}")에서 roomNumber의 값을 가져온다.

HTTP 통신에서 @GetMapping("/member/{id}")에서 @PathVariable로 id값을 추출하는 것과 동일하다.

 

@Payload는

STOMP 메시지에서 본문(Payload)을 특정 객체로 변환하여 가져오는 것이다.

HTTP 통신에서 전달한 데이터를 @RequestBody로 객체에 담아서 가져오는 것과 동일하다.

 

SimpMessageHeaderAccessor는

현재 요청한 STOMP 메시지의 헤더 정보에 접근할 수 있도록 도와주는 유틸리티 객체로

세션 ID, 사용자 정보, 기타 헤더 데이터를 추출하거나 추가로 설정할 수 있다.

주요 메서드
- getSessionId(): WebSocket 세션 ID를 반환.
- getUser(): 메시지를 보낸 사용자의 인증 정보를 반환.
- getNativeHeader(String headerName): STOMP 메시지에 포함된 원시 헤더 값을 반환.
- setHeader(String key, Object value): 커스텀 헤더를 설정.

 

"/queue"와 "/user"의 차이

"/queue"는 특정 클라이언트에게만 메시지를 전송하는 것이고,
"/user"는 특정 사용자에게만 메시지를 전송하는 것이다.

같은 사용자가 여러 클라이언트로 접속하여 요청을 보낼 수 있다.
여기서 "/queue"는 특정 클라이언트에게만 메시지를 전송하는 것으로
같은 사용자가 접속한 클라이언트 중에서 특정 클라이언트에게만 메시지를 전달하는 것이고

"/user"는 특정 사용자에게만 메시지를 전송하는 것으로
같은 사용자가 접속한 모든 클라이언트들에게 메시지를 전달하게 된다.

--

 

 

 

 

서비스

 

--

ChatService.java

import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.*;

@Service
public class ChatService {

    private final Map<String, Set<String>> rooms = new HashMap<>();

    @Transactional
    public String roomCreate(String sender) {

        String roomNumber;

        // 랜덤 방 코드 생성 및 중복 검사
        do {
            roomNumber = randomRoomNumber();
        } while (rooms.containsKey(roomNumber));

        // Map에서 해당 방 코드와 Set<String>(사용자)을 매핑하여 추가
        Set<String> players = new HashSet<>();
        players.add(sender);
        rooms.put(roomNumber, players);

        return roomNumber;
    }


    @Transactional
    public void roomJoin(String roomNumber, String sender) {

        // 해당 방이 존재하는지 확인 후 해당 방에 유저 담기
        if (rooms.containsKey(roomNumber)){
            Set<String> players = rooms.get(roomNumber);
            players.add(sender);
        }
    }

    @Transactional
    public void roomRemove(String roomNumber, String sender) {

        Set<String> players = rooms.get(roomNumber);

        if(players != null){
            players.remove(sender);
        }
    }

    //------------------------------------------

    // 랜덤 방코드 발급
    private String randomRoomNumber() {
        return UUID.randomUUID().toString().substring(0, 6).toUpperCase();
    }

}

참고.
간단하게 어떤 식으로 구성했는지 보여주기 위해서
방 번호를 검사하거나 다른 검증 로직은 작성하지 않았으니
필요한 로직이 보이면 추가하면 된다.

 

Map에서는 <방 번호, Set<유저 닉네임>>으로 간단하게 정보를 관리하고 있다.

즉, 해당 Map을 통해 어떤 방에 어떤 유저들이 있는지 참고할 수 있게 된다.

--

 

 

 

 

이벤트 리스너

 

--

WebSocketEventListener.java

import com.example.SimpleChat_Stomp.service.ChatService;
import lombok.RequiredArgsConstructor;
import org.springframework.context.event.EventListener;
import org.springframework.messaging.simp.SimpMessageHeaderAccessor;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.messaging.SessionDisconnectEvent;


// 예기치 못한 세션 종료(브라우저 강제 종료, 네트워크 연결 끊김 등)가 발생할 때 Spring에서 자동으로 호출
@Component
@RequiredArgsConstructor
public class WebSocketEventListener {

    private final ChatService chatService;

    @EventListener
    public void handleWebSocketDisconnectListener(SessionDisconnectEvent event){

        SimpMessageHeaderAccessor headerAccessor = SimpMessageHeaderAccessor.wrap(event.getMessage());

        // 세션 속성에서 사용자 정보 가져오기
        String roomNumber = (String) headerAccessor.getSessionAttributes().get("roomNumber");
        String sender = (String) headerAccessor.getSessionAttributes().get("sender");

        if (roomNumber != null && sender != null) {
            // chatService를 통해 채팅방 관리 Map에서 사용자 제거
            chatService.roomRemove(roomNumber, sender);
            // 세션에 roomNumber와 sender는 지울 필요가 없다.
            // 웹소켓 연결이 종료되면 세션도 종료가 되며, 추가로 저장했던 속성(roomNumber, Sender)도 자동으로 제거된다.
        }
    }
}

 

예기치 못한 세션 종료가 발생할 때

Spring에서 이를 감지하고 호출하는 파트로

Map에서 관리하고 있던 데이터들을 정리하는 로직을 추가했다.

 

참고로

사용자 세션에 추가했던 속성(roomNumber, sender)은

웹소켓 연결이 종료되면 같이 종료되면서 추가된 속성들은 자동으로 제거되어 리셋된다.

그래서 굳이 삭제할 코드를 작성하지 않아도 된다.

--

 

 

동작 흐름

 

--

클라이언트에서 메시지 요청 흐름

[클라이언트]
"/app/room"으로 메시지 요청
->
[서버, WebSocketConfig 설정 파일] 
경로의 접두사가 "/app"으로 시작하면 어떻게 처리해야 하는지 확인
("/app"은 컨트롤러로 전달하는 것으로 설정되어 있으므로 컨트롤러로 전달)
->
[서버, ChatController 파일]
@MessageMapping()에서 접두사 "/app"을 뺀 나머지 동일한 경로를 지정한 컨트롤러 탐색 후
해당 컨트롤러 로직 처리 후 @SendTo("/topic/room/{roomNumber}")로 브로커에 메시지 전달
->
[내장 브로커, SimpleBroker 파일]
"/topic/room/{roomNumber}"를 구독 중인 클라이언트에게 메시지 그대로 전달
->
[클라이언트]
"/topic/room/{roomNumber}"를 구독 중인 파트로 메시지 응답받음

 

 

클라이언트가 경로 구독 요청 흐름

[클라이언트]
"/topic/room/2342"로 구독 요청
->
[브로커, SimpleBroker]
요청 온 클라이언트는 "/topic/room/2342" 경로를 구독한다고 등록 후
구독 리스트에 해당 클라이언트 추가

참고.
서버가 따로 특정 클라이언트를 특정 경로에 구독하도록 요청은 불가능
꼭 클라이언트가 구독하는 요청을 보내야 가능하다.

 

 

config.java 파일에서 각 코드 동작

[ registry.setApplicationDestinationPrefixes("/app"); ]
-> 클라이언트가 "/app/room"경로로 요청
-> config.java 파일에서 ApplicationDestinationPrefixes가 접두사("/app")를 제거한 경로를
    컨트롤러 메서드의 @MessageMapping("/room")으로 전달

[ registry.enableSimpleBroker("/topic"); ]
-> 클라이언트가 "/topic/room/234" 경로로 요청
-> SimpleBroker에서 바로 해당 경로를 구독하고 있는 클라이언트에게 브로드 캐스트

 

 

 

 

 

 

 

--

 

 

 

 

주고받는 데이터 구조

 

--

ChatMessage.java

public class ChatMessage {
    private String sender;
    private String content;
}

 

컨트롤러

@MessageMapping("/sendMessage")
@SendTo("/topic/room/222")
public ChatMessage sendMessage(ChatMessage message) {

    message.setContent(message.getContent().toUpperCase());
    return message; // 반환값을 브로커로 전송
}

 

전달되는 데이터

{
    “sender”: “User1”,
    “content”: “HELLO”
}

 

정확하게 전달되는 데이터 형식

데이터 형식

COMMAND
header1:value1
header2:value2

Body^@
----------------------------------------------------------------------
SEND
destination:/topic/room/222
content-type:application/json

{"sender": “User1”, "content": "HELLO"} ^@

--

 

 

 

 

데이터를 DB(Entity)로 관리하지 않고 Map으로 하는 이유

 

--

물론 저장해야 하는 데이터가 많거나, 복잡한 구조라면

Entity를 사용해서 DB로 관리하는 것이 좋지만

 

DB를 사용하면 데이터를 가져오기 위해 DB에 접근하고 가져오고 하는 과정이 하나가 더 추가되어

실시간으로 빠르게 정보를 가져와야 하는 환경에서는 DB보다 Map을 사용하게 되면

보다 빠르게 데이터 정보를 가져올 수 있게 된다.

 

다만 데이터 관리를 구체적으로 해야 한다거나 오래 보관해야 한다거나 구조를 잘 짜야한다면 DB를 사용하는 것이 좋다.

 

즉, 간단한 구조면서 빠르게 데이터를 주고받기 위해서 Map을 사용했다.

만약 회원 관리도 해야 하고 서버가 꺼졌다가 다시 켜야 하는 상황에서도 데이터를 유지해야 한다면

DB를 사용해야 한다.

 

Map을 사용할 때
HashMap보다는 ConcurrentHashMap을 사용하는 것이 좋다.
HashMap은 동기화되지 않은 클래스로
여러 스레드가 동시에 읽고 쓰기를 하면 데이터 충돌이 일어날 수 있기 때문이다.
즉, 단일 스레드 환경에서는 HashMap이 성능이 뛰어나고 사용하기 적합하다.

하지만 ConcurrentHashMap은 동기화된 클래스로
멀티 스레드 환경에서 안전하게 사용이 가능하여,
데이터를 자주 읽거나 쓰는 멀티스레드 환경에서 사용하기 적합하다.

--