Messagerie privée avec STOMP

Welcome! In this lesson, we'll learn how to build private messaging functionality into our chat application using WebSockets and STOMP.

Unlike public chat rooms where everyone receives messages, private messages (like direct messages or DMs) are sent specifically from one user to another. This requires a way to route messages directly to an individual's unique session.

STOMP provides a special destination prefix: /user. When a client subscribes to a destination like /user/queue/private-messages, the STOMP broker (and Spring) automatically translate this into a unique, session-specific queue for that particular authenticated user.

• /user prefix: Indicates a user-specific destination.
• Unique per user: Each user gets their own 'inbox' for private messages.
• Abstracted routing: You don't need to know the actual session ID.

Spring's WebSocket and STOMP integration works hand-in-hand with the /user prefix. When you configure your message broker, you tell Spring to enable user destinations:

This setting ensures that messages addressed to /user/{username}/queue/{destination} are correctly routed by Spring to the WebSocket session(s) associated with {username}.

On the server, Spring provides the SimpMessagingTemplate. This powerful tool allows you to send messages to various STOMP destinations, including user-specific ones.

The key method for private messaging is convertAndSendToUser(). It takes three main arguments:

1. username: The identifier of the recipient user.
2. destination: The specific queue within that user's private space (e.g., /queue/private-messages).
3. payload: The actual message content.

Try running this simplified Spring Boot application. It shows a controller method that sends a private message using SimpMessagingTemplate. Remember, in a real app, the recipient's username would come from the client's message payload or other context.

On the client side, a user needs to subscribe to their own private destination to receive messages. If a user's principal name is 'alice', they would subscribe to:

Spring automatically maps this to /queue/private-messages-user{sessionId} internally, ensuring only 'alice' receives messages sent to her.

Using a STOMP client library (like Stomp.js), the subscription process is straightforward:

stompClient.subscribe('/user/queue/private-messages', function(message) {
    // Handle the private message
    console.log("Received private message: " + message.body);
});

This ensures that any message sent to the currently authenticated user's /queue/private-messages destination will be received by this client.

For robust private chat, your message payload should contain structured data. A typical private message model might include:

• senderId: The ID of the user who sent the message.
• recipientId: The ID of the user intended to receive the message.
• content: The actual text or data of the message.
• timestamp: When the message was sent.

This allows clients to display messages correctly, identifying who sent what to whom.

How does Spring know which user is 'alice' for the /user destination? It relies on the Principal object, which is usually populated by Spring Security or another authentication mechanism.

When a WebSocket connection is established, Spring associates a Principal with that session. The convertAndSendToUser() method uses the getName() of this Principal to identify the target user.

Great job! You've learned the fundamentals of implementing private messaging with STOMP and Spring.

• The /user destination prefix routes messages to individual users.
• Spring's SimpMessagingTemplate.convertAndSendToUser() sends messages to specific user destinations.
• Clients subscribe to /user/queue/{your-private-destination} to receive their DMs.
• User identity (Principal) is crucial for correct routing.

This knowledge allows you to build sophisticated, personalized real-time interactions in your applications!