GraphQL APIs with Spring Boot · レッスン

SpringへのWebSocket統合

Spring BootアプリケーションでWebSocketを構成し、Subscription向けの永続的なクライアントとサーバー間接続を有効にします。

レッスン 3/411 ステップ

「SpringへのWebSocket統合」はCoddyKit上の無料GraphQL APIs with Spring Bootレッスンです。 これはレッスン3/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはGraphQL APIs with Spring Boot学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 GraphQL APIs with Spring Bootコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

WebSockets for Real-time Data

Welcome! In this lesson, we'll integrate WebSockets with Spring Boot. This is crucial for enabling real-time features like GraphQL Subscriptions.

WebSockets provide a persistent, two-way communication channel between a client and a server over a single, long-lived TCP connection.

Why WebSockets for Subscriptions?

Unlike traditional HTTP requests (which are short-lived), GraphQL Subscriptions require a continuous connection to push data updates to clients as they happen.

WebSockets are the perfect fit because they maintain an open connection, allowing the server to send data to the client at any time without a new request.

Adding the Dependency

First, we need to add the Spring Boot WebSocket starter dependency to our project. This brings in all the necessary libraries to enable WebSocket support.

For Gradle, add this to your build.gradle:

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-websocket'
}

Enabling WebSocket Message Broker

In Spring, we use annotations to enable specific functionalities. For WebSockets with a message broker, we use @EnableWebSocketMessageBroker.

This annotation enables a STOMP over WebSocket message broker, which is a powerful way to handle messaging.

Configuring WebSocket Endpoints

We need a configuration class that extends WebSocketMessageBrokerConfigurer. This class allows us to customize our WebSocket setup.

The registerStompEndpoints() method is used to define the URL endpoint clients will connect to for WebSocket communication.

Adding SockJS Fallback

When registering an endpoint, we often add .withSockJS(). SockJS is a JavaScript library that provides a WebSocket-like API.

It offers fallback options (like HTTP streaming or long polling) for browsers that don't fully support WebSockets or in environments with proxies that interfere.

Configuring the Message Broker

The configureMessageBroker() method sets up the message broker itself. This defines how messages are routed between clients and the application.

  • enableSimpleBroker("/topic"): Enables an in-memory message broker for destinations prefixed with /topic. Clients subscribe to these topics.
  • setApplicationDestinationPrefixes("/app"): Defines prefixes for messages destined for methods annotated with @MessageMapping in our application.

Complete WebSocket Configuration

Here's a minimal Spring Boot application demonstrating the WebSocket configuration. Try running it to see Spring initialize the WebSocket server!

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
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;

@SpringBootApplication
public class Main {
  public static void main(String[] args) {
    SpringApplication.run(Main.class, args);
    System.out.println("WebSocket server ready on port 8080!");
    System.out.println("Connect at ws://localhost:8080/ws-connect");
  }

  @Configuration
  @EnableWebSocketMessageBroker
  static class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

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

      @Override
      public void configureMessageBroker(MessageBrokerRegistry config) {
          config.enableSimpleBroker("/topic");
          config.setApplicationDestinationPrefixes("/app");
      }
  }
}

Bridging to GraphQL Subscriptions

With this WebSocket infrastructure, our GraphQL subscription resolvers (from the previous lesson) can now publish events.

When a resolver publishes an event, Spring's message broker ensures that all clients subscribed to the relevant /topic are immediately notified via their open WebSocket connection.

Quick Check: WebSocket Config

Consider the following line from our WebSocket configuration:

config.enableSimpleBroker("/topic");

What is the primary purpose of the /topic prefix in this context?

Recap: WebSockets in Spring

Great job! You've learned how to integrate WebSockets with Spring Boot to provide a robust real-time communication layer.

  • We added the WebSocket starter dependency.
  • We used @EnableWebSocketMessageBroker and WebSocketMessageBrokerConfigurer.
  • We configured STOMP endpoints (e.g., /ws-connect with SockJS).
  • We set up a message broker with prefixes like /topic for subscriptions and /app for app-specific messages.

This setup is the foundation for delivering real-time GraphQL Subscriptions!

無料で開始

AI チューターと学ぶ GraphQL APIs with Spring Boot — 無料

ブラウザでリアルコードを書いて実行し、24/7 の AI チューターから瞬時にサポートを受け、ウェブまたはアプリで続きから学習できます。

コース
12
レッスン
48

よくある質問

「SpringへのWebSocket統合」レッスンは無料ですか?

はい。「SpringへのWebSocket統合」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し(組み込みコードエディタと24時間対応のAIチューター)、GraphQL APIs with Spring Bootコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 GraphQL APIs with Spring Bootコースには全4レッスンが含まれています。

「SpringへのWebSocket統合」で何を学びますか?

Spring BootアプリケーションでWebSocketを構成し、Subscription向けの永続的なクライアントとサーバー間接続を有効にします。 ブラウザで直接実行するハンズオンコードでGraphQL APIs with Spring Bootを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

GraphQL APIs with Spring Bootを始めるのに経験は必要ですか?

事前経験は必要ありません。CoddyKitのGraphQL APIs with Spring Bootは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン3/4です。

「SpringへのWebSocket統合」レッスンにはどのくらい時間がかかりますか?

ほとんどのCoddyKitレッスンは約5~10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このGraphQL APIs with Spring Bootレッスンでコードを書いて実行できますか?

はい。すべてのGraphQL APIs with Spring Bootレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

  1. GraphQL Subscriptionsを理解する
  2. リアルタイム更新の実装
  3. SpringへのWebSocket統合
  4. サブスクリプションのフィルタリングとスケーリング
← GraphQL APIs with Spring Bootに戻る