0Pricing
WebSockets & Real-Time Systems with Spring · Lezione

Configurazione degli endpoint WebSocket

Configuri gli endpoint WebSocket in Spring, definendo i percorsi e gestendo le connessioni iniziali.

Configurazione degli endpoint WebSocket è una lezione WebSockets & Real-Time Systems with Spring gratuita su CoddyKit. Questa è la lezione 2 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento WebSockets & Real-Time Systems with Spring, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso WebSockets & Real-Time Systems with Spring include 4 lezioni in totale.

Parti di questa lezione non sono ancora state tradotte e vengono mostrate in inglese.

What are WebSocket Endpoints?

Imagine a special doorway for real-time communication. In Spring, this doorway is called a WebSocket endpoint.

It's a specific URL path, like /ws or /chat, that your clients (e.g., web browsers) connect to for WebSocket communication. Without it, your server wouldn't know where to listen for real-time requests!

Spring Boot App Entry Point

Before configuring WebSockets, let's recall our Spring Boot application's main entry point. This is where your application starts running.

The @SpringBootApplication annotation simplifies setup by bundling common Spring annotations.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

Enabling WebSocket Support

To tell Spring Boot that you want to use WebSockets, you need to enable it. This is done with a simple annotation on a configuration class.

  • Add @Configuration to mark the class as a Spring configuration.
  • Use @EnableWebSocket to activate Spring's WebSocket module.

This sets the stage for defining your endpoints.

The WebSocketConfigurer Interface

To customize how WebSockets are handled, Spring provides the WebSocketConfigurer interface. You'll implement this interface in your configuration class.

It gives you a method to override where you can register your specific WebSocket handlers and their paths.

Registering Your First Endpoint

Inside your WebSocketConfigurer implementation, you'll override the registerWebSocketHandlers method. This method takes a WebSocketHandlerRegistry object.

The registry is used to add your WebSocketHandler instances and map them to specific URL paths.

Defining the Endpoint Path

The core of endpoint configuration is the addHandler() method. It takes two main arguments:

  • Your WebSocketHandler instance (what handles messages).
  • The URL path where clients will connect (e.g., /mywebsocket).

Example: registry.addHandler(myHandler(), "/mywebsocket");

CORS and SockJS Fallback

You might need to allow connections from different domains (CORS) or support older browsers. The addHandler() method offers fluent options:

  • .setAllowedOrigins("*"): Allows connections from any domain. For production, specify exact domains.
  • .withSockJS(): Enables SockJS fallback, providing an alternative transport for browsers that don't fully support WebSockets.

Example: WebSocketConfig Class

Here's how your full configuration class might look. Notice how we implement WebSocketConfigurer and register a handler for the /ws path.

The myHandler() method creates an instance of our custom handler (defined next).

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
import org.springframework.context.annotation.Bean;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

  @Override
  public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
    registry.addHandler(myHandler(), "/ws")
            .setAllowedOrigins("*");
  }

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

Example: Basic WebSocket Handler

This is a very simple MyWebSocketHandler. It extends TextWebSocketHandler and just logs when a connection is established or closed. We'll dive deeper into handling messages in the next lesson!

import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class MyWebSocketHandler extends TextWebSocketHandler {

  @Override
  public void afterConnectionEstablished(WebSocketSession session) throws Exception {
    System.out.println("Connection established: " + session.getId());
  }

  @Override
  public void afterConnectionClosed(WebSocketSession session, 
                                    org.springframework.web.socket.CloseStatus status) 
                                    throws Exception {
    System.out.println("Connection closed: " + session.getId() + " - " + status.getReason());
  }

  // Message handling will go here in a later lesson
  @Override
  protected void handleTextMessage(WebSocketSession session, TextMessage message) {
    // For now, we just acknowledge. Message processing is next lesson.
    System.out.println("Received message (not processed yet): " + message.getPayload());
  }
}

Endpoint Config Check

You want to set up a WebSocket endpoint at the path /chat that allows connections from any origin and uses SockJS fallback. Which configuration snippet is correct?

Recap: WebSocket Endpoints

Great job! You've learned how to configure WebSocket endpoints in Spring Boot:

  • You use @EnableWebSocket on a @Configuration class.
  • You implement WebSocketConfigurer and override registerWebSocketHandlers.
  • Inside, you use registry.addHandler() to map a WebSocketHandler to a URL path.
  • Options like setAllowedOrigins() and withSockJS() enhance compatibility.

Next, we'll dive into how to send and receive messages using these handlers!

Domande Frequenti

La lezione «Configurazione degli endpoint WebSocket» è gratuita?

Sì — il testo completo di «Configurazione degli endpoint WebSocket» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso WebSockets & Real-Time Systems with Spring, passa a CoddyKit PRO. Il corso WebSockets & Real-Time Systems with Spring include 4 lezioni in totale.

Cosa imparerò in «Configurazione degli endpoint WebSocket»?

Configuri gli endpoint WebSocket in Spring, definendo i percorsi e gestendo le connessioni iniziali. Eserciti WebSockets & Real-Time Systems with Spring con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare WebSockets & Real-Time Systems with Spring?

Non è richiesta alcuna esperienza precedente. WebSockets & Real-Time Systems with Spring su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 2 di 4.

Quanto tempo richiede la lezione «Configurazione degli endpoint WebSocket»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione WebSockets & Real-Time Systems with Spring?

Sì. Ogni lezione WebSockets & Real-Time Systems with Spring include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

  1. Spring Boot per WebSockets
  2. Configurazione degli endpoint WebSocket
  3. Messaggistica client-server di base
  4. Gestire gli eventi del ciclo di vita WebSocket in Spring
← Torna a WebSockets & Real-Time Systems with Spring