SpringBoot – Websockets STOMP 1.2 – How to detect and log heart-beat from client and from server

Detecting and Logging Heartbeats from the Client Side

Now that we’ve covered the basics, let’s get our hands dirty and start implementing heartbeat detection and logging from the client side. We’ll use JavaScript and the popular SockJS library to connect to our SpringBoot server.

Client-Side Code

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/sockjs.min.js"></script>
<script>
  let socket = new SockJS('/websocket');
  let stompClient = Stomp.over(socket);

  stompClient.connect({}, function (frame) {
    console.log('Connected to the server');

    // Subscribe to the heartbeat topic
    stompClient.subscribe('/topic/heartbeat', function (message) {
      console.log('Received heartbeat from the server:', message);
    });
  });
</script>

In the above code, we create a new SockJS instance and connect to our SpringBoot server using the Stomp.over method. Once connected, we subscribe to the /topic/heartbeat topic to receive heartbeat messages from the server.

Detecting and Logging Heartbeats from the Server Side

Now, let’s shift our focus to the server side and explore how to detect and log heartbeats using SpringBoot and STOMP 1.2.

Server-Side Code

@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
  @Override
  public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
    registry.addHandler(myWebSocketHandler(), "/websocket").setHandshakeHandler(new DefaultHandshakeHandler());
  }

  @Bean
  public MyWebSocketHandler myWebSocketHandler() {
    return new MyWebSocketHandler();
  }
}

public class MyWebSocketHandler extends TextWebSocketHandler {
  @Autowired
  private SimpMessagingTemplate messagingTemplate;

  @Override
  public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
    // Handle incoming messages from the client
  }

  @Override
  public void afterConnectionEstablished(WebSocketSession session) throws Exception {
    // Send heartbeats to the client at regular intervals
    messagingTemplate.convertAndSend("/topic/heartbeat", "Heartbeat from the server!");
    // Log heartbeats
    logHeartbeat(session);
  }

  private void logHeartbeat(WebSocketSession session) {
    System.out.println("Received heartbeat from the client: " + session.isOpen());
  }
}

In the above code, we create a SpringBoot WebSocket configuration class and define a custom WebSocket handler. In the afterConnectionEstablished method, we send heartbeats to the client at regular intervals using the SimpMessagingTemplate. We also log heartbeats from the client using the logHeartbeat method.

Configuring STOMP 1.2

To enable STOMP 1.2 in our SpringBoot application, we need to add the following configuration:

@Configuration
public class StompConfig extends StompConfigurerSupport {
  @Override
  public void configureMessageBroker(MessageBrokerRegistry registry) {
    registry.setApplicationDestinationPrefixes("/app");
    registry.enableSimpleBroker("/topic");
  }

  @Override
  public void registerStompEndpoints(StompEndpointRegistry registry) {
    registry.addEndpoint("/websocket").withSockJS();
  }
}

In the above configuration, we enable STOMP 1.2 and define a simple broker that handles messages to and from the client.

Conclusion

And there you have it, folks! In this article, we’ve explored the wonderful world of WebSockets, STOMP 1.2, and heartbeats. We’ve learned how to detect and log heartbeats from both the client and server sides using SpringBoot and STOMP 1.2.

Remember, heartbeats are an essential aspect of WebSocket communication, and their detection and logging can help you build more robust and fault-tolerant systems.

So, next time you’re building a real-time application with WebSockets and STOMP, don’t forget to include heartbeats in your toolkit!

Frequently Asked Question

Get the inside scoop on detecting and logging heart-beats from clients and servers using SpringBoot, Websockets, and STOMP 1.2!