欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

使用 Spring Boot 实现 WebSocket实时通信

程序员文章站 2024-02-16 13:37:28
在开发 web 应用程序时,我们有时需要将服务端事件推送到连接的客户端。但 http 并不能做到。客户端打开与服务端的连接并请求数据,但服务端不能打开与客户端的连接并推送数...

在开发 web 应用程序时,我们有时需要将服务端事件推送到连接的客户端。但 http 并不能做到。客户端打开与服务端的连接并请求数据,但服务端不能打开与客户端的连接并推送数据。

为了解决这个限制,我们可以建立了一个轮询模式,网页会间隔地轮询服务器以获取新事件。但这种模式不太理想,因为它增加了 http 开销,速度也只能达到与轮询的速率一样快,并且给服务器增加了不必要的负载。

幸运的是,html5 websocket 出现了。websocket 协议允许浏览器与 web 服务器之间进行低开销的交互。在文中,我们将介绍 websockets api,并展示如何使用 spring boot 实现 websockets。

html5 来救场!

websockets 通过浏览器和服务器之间的单连接提供全双工通信。它不存在 http 开销,并且允许服务器将消息实时推送到客户端。

websocket api 实际上很简单。您只需要创建一个 websocket 对象,附加事件监听器和发送消息即可。

以下是一个例子:

var socket = new websocket('ws://' + window.location.host + '/my-websocket-endpoint');
 
// add an event listener for when a connection is open
socket.onopen = function() {
 console.log('websocket connection opened. ready to send messages.');
 
 // send a message to the server
 socket.send('hello, from websocket client!');
};
 
// add an event listener for when a message is received from the server
socket.onmessage = function(message) {
 console.log('message received from server: ' + message);
};

spring boot

spring 对 websockets 接口提供了很好的支持。

首先,我们需要创建一个类,继承 spring 的 textwebsockethandler 类。

public class mymessagehandler extends textwebsockethandler {
 
  @override
  public void afterconnectionclosed(websocketsession session, closestatus status) throws exception {
    // the websocket has been closed
  }
 
  @override
  public void afterconnectionestablished(websocketsession session) throws exception {
    // the websocket has been opened
    // i might save this session object so that i can send messages to it outside of this method
 
    // let's send the first message
    session.sendmessage(new textmessage("you are now connected to the server. this is the first message."));
  }
 
  @override
  protected void handletextmessage(websocketsession session, textmessage textmessage) throws exception {
    // a message has been received
    system.out.println("message received: " + textmessage.getpayload());
  }
}

接下来,我们需要配置 websocket 端点。

@configuration
@enablewebsocket
public class websocketconfig implements websocketconfigurer {
 
  @bean
  public websockethandler mymessagehandler() {
    return new mymessagehandler();
  }
 
  @override
  public void registerwebsockethandlers(websockethandlerregistry registry) {
    registry.addhandler(mymessagehandler(), "/my-websocket-endpoint");
  }
 
}

由于 websockets api 是纯 javascript,您可以在大多数前端框架中它。包括 angular,您可以在 typescript 中包含 javascript 代码。

总结

是不是相当简单?它解决了服务端和客户端之间传输数据的一大困扰。spring boot 使它变得更加简单。

原文链接:
作者:thomas kendall
译者:oopsguy.com

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。