WebSockets & Real-Time Systems with Spring · Lesson

Connection Lifecycle Management

Manage WebSocket connection lifecycles, including opening, closing, and unexpected disconnections.

Connection Lifecycle Management is a free WebSockets & Real-Time Systems with Spring lesson on CoddyKit — lesson 2 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the WebSockets & Real-Time Systems with Spring learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

WebSocket Connection Lifecycle

Every WebSocket connection goes through a lifecycle: it opens, stays active for messaging, and eventually closes. Managing these stages is crucial for building robust real-time applications.

Proper lifecycle management helps ensure resources are used efficiently and that your application responds gracefully to various connection events.

The Initial Handshake

Before a WebSocket connection is established, an initial HTTP handshake occurs. The client sends an HTTP request with an Upgrade header, asking to switch protocols.

If the server agrees, it responds with a 101 Switching Protocols status, and the connection transitions from HTTP to WebSocket.

Client-Side Connection

On the client side, typically in a web browser, you initiate a WebSocket connection using JavaScript. The WebSocket constructor creates a new connection to the specified URL.

This example shows how to connect and log messages when the connection opens or encounters an error.

const socket = new WebSocket("ws://localhost:8080/lifecycle");

socket.onopen = () => {
  console.log("WebSocket Connected!");
};

socket.onerror = (error) => {
  console.error("WebSocket Error:", error);
};

Server-Side: Handling New Connections

In Spring, you can use the @OnOpen annotation to define a method that executes when a new WebSocket connection is established. This is your entry point for handling new clients.

The Session object provides details about the client connection.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;

@SpringBootApplication
public class WebSocketLifecycleApp {
    public static void main(String[] args) {
        SpringApplication.run(WebSocketLifecycleApp.class, args);
    }

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

@ServerEndpoint("/lifecycle")
@Component
class LifecycleHandler {
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Client connected: " + session.getId());
    }
}

Gracefully Closing Connections

A connection can be closed intentionally by either the client or the server. This is called a 'graceful' closure. It's important to close connections properly to release server resources and inform clients.

A close message usually includes a status code and a reason for closure, helping both ends understand why the connection ended.

Client-Side Disconnect

Clients can close a WebSocket connection using the close() method. You can optionally provide a status code and a reason message.

The onclose event listener is triggered when the connection is closed, allowing you to perform cleanup or UI updates.

socket.onclose = (event) => {
  if (event.wasClean) {
    console.log(`Closed cleanly, code=${event.code}, reason=${event.reason}`);
  } else {
    console.log('Connection died unexpectedly');
  }
};

// To close the connection explicitly:
socket.close(1000, "Client leaving");

Server-Side: Handling Disconnections

The @OnClose annotation in Spring allows you to define a method that executes when a WebSocket connection is closed. This is where you can clean up resources associated with that session.

The CloseReason parameter provides details about why the connection was terminated.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
import javax.websocket.OnOpen;
import javax.websocket.OnClose;
import javax.websocket.Session;
import javax.websocket.CloseReason;
import javax.websocket.server.ServerEndpoint;

@SpringBootApplication
public class WebSocketLifecycleApp {
    public static void main(String[] args) {
        SpringApplication.run(WebSocketLifecycleApp.class, args);
    }

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

@ServerEndpoint("/lifecycle")
@Component
class LifecycleHandler {
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Client connected: " + session.getId());
    }

    @OnClose
    public void onClose(Session session, CloseReason reason) {
        System.out.println("Client disconnected: " + session.getId() + " - Reason: " + reason.getReasonPhrase());
    }
}

Handling Unexpected Disconnections & Errors

Sometimes connections don't close gracefully. Network issues, client crashes, or server errors can lead to abrupt disconnections. These are 'unclean' closures.

It's vital to have mechanisms to detect and respond to these unexpected events to maintain application stability and user experience.

Server-Side: Error Handling

The @OnError annotation handles exceptions that occur during a WebSocket session. This could be due to issues like message processing errors or underlying network problems.

Implementing an @OnError handler ensures your server can log errors and potentially close the affected session gracefully, preventing resource leaks.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
import javax.websocket.OnOpen;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.Session;
import javax.websocket.CloseReason;
import javax.websocket.server.ServerEndpoint;

@SpringBootApplication
public class WebSocketLifecycleApp {
    public static void main(String[] args) {
        SpringApplication.run(WebSocketLifecycleApp.class, args);
    }

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

@ServerEndpoint("/lifecycle")
@Component
class LifecycleHandler {
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Client connected: " + session.getId());
    }

    @OnClose
    public void onClose(Session session, CloseReason reason) {
        System.out.println("Client disconnected: " + session.getId() + " - Reason: " + reason.getReasonPhrase());
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        System.err.println("Error on session " + session.getId() + ": " + throwable.getMessage());
    }
}

Detecting Liveness with Heartbeats

When a connection drops unexpectedly (e.g., network cable pulled), neither side might immediately know. Heartbeat mechanisms, often using WebSocket ping/pong frames, help detect unresponsive peers.

By sending periodic pings and expecting pongs, you can determine if a connection is still alive and close it if no response is received.

Lifecycle Management Check

Managing the various stages of a WebSocket connection is key to building reliable real-time applications. Let's test your understanding of Spring's lifecycle annotations.

Recap: Connection Management

In this lesson, you've learned about the crucial aspects of WebSocket connection lifecycle management. We covered:

The initial HTTP handshake.
How clients and servers open connections (@OnOpen).
Graceful client and server disconnections (@OnClose).
Handling unexpected errors during a session (@OnError).
The role of heartbeats in detecting unresponsive connections.

Mastering these concepts is fundamental for developing robust and resilient real-time applications with WebSockets and Spring.

Frequently asked questions

Is the “Connection Lifecycle Management” lesson free?

Yes — the full text of “Connection Lifecycle Management” is free to read here on the web, and the WebSockets & Real-Time Systems with Spring course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the WebSockets & Real-Time Systems with Spring course, upgrade to CoddyKit PRO.

What will I learn in “Connection Lifecycle Management”?

Manage WebSocket connection lifecycles, including opening, closing, and unexpected disconnections. You practise WebSockets & Real-Time Systems with Spring with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.

Do I need any experience to start WebSockets & Real-Time Systems with Spring?

No prior experience is required. WebSockets & Real-Time Systems with Spring on CoddyKit is structured for beginners through advanced learners; this is — lesson 2 of 4, so you can start here or from the beginning and move at your own pace.

How long does the “Connection Lifecycle Management” lesson take?

Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.

Can I write and run code in this WebSockets & Real-Time Systems with Spring lesson?

Yes. Every WebSockets & Real-Time Systems with Spring lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.

All lessons in this course

← Back to WebSockets & Real-Time Systems with Spring