Springboot(四)使用WebSocket

本文详细介绍如何在Spring Boot项目中利用WebSocket实现全双工通信,包括页面与逻辑代码间的消息传递,通过具体代码示例讲解如何配置WebSocket依赖、创建消息服务及在页面上展示消息。

WebSocket

  • webSocket用于页面与逻辑代码的消息传递,且连接是全双工通信。
  • pom.xml文件中引入spring-boot-starter-websocket依赖。
  • 在需要进行消息展示的页面插入以下代码。
  • 一般页面使用modal组件显示消息内容。
<script>

        if('WebSocket' in window){
            
            //链接地址
            var websocket=new WebSocket("ws://localhost:8080/sell/websocket");

            websocket.onopen=function (ev) {
                console.log("建立websocket链接");
            }

            websocket.onclose=function (ev) {
                console.log("连接取消");
            }

            websocket.onmessage=function (ev) {
                console.log("获取信息:" + ev.data);
                $('#messageModal').html(ev.data);
                $('#myModal').modal('show');
                document.getElementById('message_mp3').play();
                console.log("发送消息");
            }

            websocket.onbeforeunload=function (ev) {
                console.log("链接建立之前先关闭之前的链接");
            }

        }else{
            alert("您的浏览器不支持WebSocket");
        }

</script>
  • 在逻辑代码部分,创建接收页面传递过来的请求服务;
/**
 * websocket配置类  注入对象
 */
@Component
public class WebSocketConfig {

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


/**
 * 消息服务
 */
@Component
@ServerEndpoint("/websocket")//访问路径
public class WebSocketService {

    private Session session;//一次会话

    //用于接收所有的链接请求
    private static CopyOnWriteArraySet<WebSocketService> webSockets=new CopyOnWriteArraySet<WebSocketService>();

    @OnOpen
    public void onOpen(Session session){
        this.session=session;
        webSockets.add(this);//请求接收同时建立链接,将当前WebSocketService加入集合
    }

    @OnClose
    public void onClose(){
        webSockets.remove(this);//取消链接,将当前WebSocketService移出集合
    }

    @OnMessage
    public void onMessage(String message){
        System.out.println(message);//消息获取
    }

    /**
     * 发送消息给页面
     * @param message
     */
    public void sendMessage(String message){
        //广播发送消息
        for(WebSocketService webSocketService:webSockets){
            try {
                webSocketService.session.getBasicRemote().sendText(message);
            }catch (Exception e){
                e.printStackTrace();
            }
        }
    }

}
  • 在需要进行消息通信的地方调用WebSocketService类的sendMessage方法即可。
### Spring Boot 2 中 WebSocket 集成教程 在 Spring Boot 2 中集成和使用 WebSocket 可以为应用程序提供实时通信功能。以下是关于如何在 Spring Boot 2 中设置并使用 WebSocket 的详细介绍。 #### 1. 添加依赖项 为了启用 WebSocket 支持,在项目的 `pom.xml` 文件中需要添加以下 Maven 依赖项: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 此依赖项提供了对 WebSocket 协议的支持以及必要的组件来处理消息传递[^1]。 #### 2. 启用 WebSocket 配置 创建一个配置类以注册 WebSocket 处理器和其他相关 Bean。可以通过实现 `WebSocketConfigurer` 接口完成这一过程。 ```java 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; @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { private final MyWebSocketHandler myWebSocketHandler; public WebSocketConfig(MyWebSocketHandler myWebSocketHandler) { this.myWebSocketHandler = myWebSocketHandler; } @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myWebSocketHandler, "/ws").setAllowedOrigins("*"); } } ``` 上述代码片段展示了如何通过自定义处理器 (`MyWebSocketHandler`) 来管理 WebSocket 请求,并允许跨域访问。 #### 3. 实现 WebSocket Handler 接下来,需编写具体的逻辑来处理传入的消息。这通常由继承 `TextWebSocketHandler` 或者 `BinaryWebSocketHandler` 类的子类完成。 ```java import org.springframework.stereotype.Component; import org.springframework.web.socket.TextMessage; import org.springframework.web.socket.WebSocketSession; import org.springframework.web.socket.handler.TextWebSocketHandler; @Component public class MyWebSocketHandler extends TextWebSocketHandler { @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { String payload = message.getPayload(); System.out.println("Received Message: " + payload); // Echo back the received message to client. session.sendMessage(new TextMessage("Echo: " + payload)); } } ``` 这段代码实现了基本的功能——接收来自客户端的消息并将它们回显给发送方。 #### 4. 测试 WebSocket 连接 可以利用 JavaScript 和 HTML 页面测试已建立的服务端点 `/ws` 是否正常工作。下面是一个简单的前端例子: ```html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>WebSocket Test</title> </head> <body> <script type="text/javascript"> var socket = new WebSocket('ws://localhost:8080/ws'); socket.onopen = function() { console.log('Connected'); socket.send('Hello Server!'); }; socket.onmessage = function(event) { console.log('Message from server:', event.data); }; </script> </body> </html> ``` 当页面加载完成后,它会尝试连接到服务器并通过 WebSocket 发送一条问候语。如果一切顺利的话,应该能看到控制台打印出服务端返回的信息。 --- ### 总结 以上就是在 Spring Boot 2 中集成功能强大的 WebSocket 技术的方法概述。借助这些步骤,开发者能够轻松构建具备双向通讯能力的应用场景,从而提升用户体验质量。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值