TOC

Spring Webソケットの@SendToUserアノテーションの簡単な例

Spring Websocketsの@SendToUserアノテーションの簡単な例

1. 概要

このクイックチュートリアルでは、how to send a message to a specific session or particular user using Spring WebSocketsを説明します。

上記のモジュールの概要については、to this articleを参照してください。

2. WebSocket設定

まず、configure our message broker and WebSocket application endpointを実行する必要があります。 

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig
  extends AbstractWebSocketMessageBrokerConfigurer {

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

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

@EnableWebSocketMessageBrokerを使用すると、enabled a broker-backed messaging over WebSocket using*STOMP*,がStreaming Text Oriented Messaging Protocol. It’s important to remark that this annotation needs to be used in conjunction with the @Configuration. を表します。

AbstractWebSocketMessageBrokerConfigurerを拡張することは必須ではありませんが、簡単な例として、インポートされた構成をカスタマイズする方が簡単です。

最初の方法では、“/topic”と“/queue”のプレフィックスが付いた宛先でメッセージをクライアントに戻すために、単純なメモリベースのメッセージブローカーを設定しました。

そして、2番目に、ストンプエンドポイントを“/greeting”に登録しました。

SockJSを有効にしたい場合は、登録部分を修正する必要があります。 

registry.addEndpoint("/greeting").withSockJS();

3. インターセプターによるセッションIDの取得

to obtain the session idの1つの方法は、ハンドシェイク中にトリガーされ、リクエストデータから情報を取得するSpringInterceptorを追加することです。

このインターセプターは、WebSocketConfig:で直接追加できます。 

@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {

registry
  .addEndpoint("/greeting")
  .setHandshakeHandler(new DefaultHandshakeHandler() {

      public boolean beforeHandshake(
        ServerHttpRequest request,
        ServerHttpResponse response,
        WebSocketHandler wsHandler,
        Map attributes) throws Exception {

            if (request instanceof ServletServerHttpRequest) {
                ServletServerHttpRequest servletRequest
                 = (ServletServerHttpRequest) request;
                HttpSession session = servletRequest
                  .getServletRequest().getSession();
                attributes.put("sessionId", session.getId());
            }
                return true;
        }}).withSockJS();
    }

4. WebSocketエンドポイント

Spring 5.0.5.RELEASE以降、「/user/{user}/…」ではなく「/user/{sessionId}/…」を介して@SendToUser annotation, that allows us to send a message to a user destinationが改善されているため、カスタマイズを行う必要はありません。

つまり、注釈は入力メッセージのセッションIDに依存して機能し、セッションに対してプライベートな宛先に効果的に応答を送信します。 

@Controller
public class WebSocketController {

    @Autowired
    private SimpMessageSendingOperations messagingTemplate;

    private Gson gson = new Gson();

    @MessageMapping("/message")
    @SendToUser("/queue/reply")
    public String processMessageFromClient(
      @Payload String message,
      Principal principal) throws Exception {
    return gson
          .fromJson(message, Map.class)
          .get("name").toString();
    }

    @MessageExceptionHandler
    @SendToUser("/queue/errors")
    public String handleException(Throwable exception) {
        return exception.getMessage();
    }
}

@SendToUserは、メッセージ処理メソッドの戻り値をMessageとして指定されたdestination(s) prepended with “/user/{username}“に送信する必要があることを示していることに注意してください。

5. WebSocketクライアント 

function connect() {
    var socket = new WebSocket('ws://localhost:8080/greeting');
    ws = Stomp.over(socket);

    ws.connect({}, function(frame) {
        ws.subscribe("/user/queue/errors", function(message) {
            alert("Error " + message.body);
        });

        ws.subscribe("/user/queue/reply", function(message) {
            alert("Message " + message.body);
        });
    }, function(error) {
        alert("STOMP error " + error);
    });
}

function disconnect() {
    if (ws != null) {
        ws.close();
    }
    setConnected(false);
    console.log("Disconnected");
}

WebSocketConfigurationのマッピングの「/greeting」を指す新しいWebSocketが作成されます。

クライアントを「/user/queue/errors」および「/user/queue/reply」にサブスクライブする場合、前のセクションのコメント情報を使用します。

ご覧のとおり、@SendToUserは「queue/errors」を指していますが、メッセージは「/user/queue/errors」に送信されます。

6. 結論

この記事では、SpringWebSocketを使用してユーザーまたはセッションIDにメッセージを直接送信する方法について説明しました。

いつものように、例の完全なソースコードはover on GitHubで入手できます。

Related