springboot整合websocket的实现

最新推荐文章于 2024-04-13 05:11:26 发布
最新推荐文章于 2024-04-13 05:11:26 发布
阅读量148 收藏
点赞数
分类专栏： SpringBoot
原文链接：https://www.cnblogs.com/strugglion/p/10021173.html
版权

https://www.cnblogs.com/strugglion/p/10021173.html

 

1.2 第二种实现方法

（1）WebSocket 业务逻辑实现。参数传递采用类似GET请求的方式传递，服务端的参数在拦截器中获取之后通过attributes传递给WebSocketHandler。

复制代码

import java.util.ArrayList;
import java.util.concurrent.atomic.AtomicInteger;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketMessage;
import org.springframework.web.socket.WebSocketSession;

@RestController
public class TestWebSocketController implements WebSocketHandler {
    
    private static AtomicInteger onlineCount = new AtomicInteger(0);
    
    private static final ArrayList<WebSocketSession> sessions = new ArrayList<>();
    
    private final Logger LOGGER = LoggerFactory.getLogger(TestWebSocketController.class);
    
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        sessions.add(session);
        int onlineNum = addOnlineCount();
        LOGGER.info("Oprn a WebSocket. Current connection number: " + onlineNum);
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        sessions.remove(session);
        int onlineNum = subOnlineCount();
        LOGGER.info("Close a webSocket. Current connection number: " + onlineNum);
    }

    @Override
    public void handleMessage(WebSocketSession wsSession, WebSocketMessage<?> message) throws Exception {
        LOGGER.info("Receive a message from client: " + message.toString());
    }

    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        LOGGER.error("Exception occurs on webSocket connection. disconnecting....");
        if (session.isOpen()) {
            session.close();
        }
        sessions.remove(session);
        subOnlineCount();
    }

    /*
     * 是否支持消息拆分发送：如果接收的数据量比较大，最好打开(true), 否则可能会导致接收失败。
     * 如果出现WebSocket连接接收一次数据后就自动断开，应检查是否是这里的问题。
     */
    @Override
    public boolean supportsPartialMessages() {
        return true;
    }

    
    public static int getOnlineCount() {
        return onlineCount.get();
    }
    
    public static int addOnlineCount() {
        return onlineCount.incrementAndGet();
    }
    
    public static int subOnlineCount() {
        return onlineCount.decrementAndGet();
    }

}

复制代码

（2）HandShake 拦截器实现

复制代码

import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;

public class TestHandShakeInterceptor extends HttpSessionHandshakeInterceptor {
    
    private final Logger LOGGER = LoggerFactory.getLogger(TestHandShakeInterceptor.class);
    
    /*
     * 在WebSocket连接建立之前的操作，以鉴权为例
     */
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, 
            WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {
        
        LOGGER.info("Handle before webSocket connected. ");
        
        // 获取url传递的参数，通过attributes在Interceptor处理结束后传递给WebSocketHandler
        // WebSocketHandler可以通过WebSocketSession的getAttributes()方法获取参数
        ServletServerHttpRequest serverRequest = (ServletServerHttpRequest) request;
        String id = serverRequest.getServletRequest().getParameter("id");
        String name = serverRequest.getServletRequest().getParameter("name");

        if (tokenValidation.validateSign()) {
            LOGGER.info("Validation passed. WebSocket connecting.... ");
            attributes.put("id", id);
            attributes.put("name", name);
            return super.beforeHandshake(request, response, wsHandler, attributes);
        } else {
            LOGGER.error("Validation failed. WebSocket will not connect. ");
            return false;
        }
    }
    
    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response,
            WebSocketHandler wsHandler, Exception ex) {
        // 省略
    }

}

复制代码

（3）WebSocket 配置类实现（注册WebSocket实现类，绑定接口，同时将实现类和拦截器绑定）

复制代码

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
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 TestWebSocketController;
import TestHandShakeInterceptor;

@Configuration
@EnableWebMvc
@EnableWebSocket
public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {

    @Autowired
    private TestWebSocketController testWebSocketController;

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(TestWebSocketController, "/testWebSocket")
                .addInterceptors(new TestHandShakeInterceptor()).setAllowedOrigins("*");
    }

}

复制代码

 

1.3 补充说明

（1）在WebSocket实现过程中，尤其是通过“@ServerEndpoint”实现的时候，可能会出现注入失败的问题，即注入的Bean为null的问题。可以通过手动注入的方式来解决，需要改造实现类和SpringBoot启动类，如下：

复制代码

@ServerEndpoint("testWebsocket")
@RestController
public class WebSocketController {

    private TestService testService;
    
    private static ApplicationContext applicationContext;
    
    @OnOpen
    public void onOpen(Session session) {
        testService = applicationContext.getBean(TestService.class);
    }

    @OnClose
    public void onClose() {}

    @OnMessage
    public void onMessage(String message, Session session) {}

    @OnError
    public void onError(Session session, Throwable error) {}

    public static void setApplicationContext(ApplicationContext applicationContext) {
        WebSocketController.applicationContext = applicationContext;
    }
    
}

复制代码

复制代码

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

import WebSocketController;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
//        SpringApplication.run(Application.class, args);
        SpringApplication springApplication = new SpringApplication(Application.class);
        ConfigurableApplicationContext configurableApplicationContext = springApplication.run(args);
        WebSocketController.setApplicationContext(configurableApplicationContext);  // 解决WebSocket不能注入的问题
    }

}

复制代码

 

2. 客户端的实现，我尝试了html和java WebSocketClient两种方式

2.1 html实现

复制代码

<!DOCTYPE html>
<html>
<head>
    <title>WebSocket示例</title>
    <meta content='width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no' name='viewport' />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
</head>
<body>
    <input id="text" type="text"/>
    <button οnclick="send()">发送消息</button>
    <hr/>
    <button οnclick="closeWebSocket()">关闭WebSocket连接</button>
    <hr/>
    <div id="message"></div>
</body>

<script type="text/javascript">
    var websocket = null;
    //判断当前浏览器是否支持WebSocket
    if ('WebSocket' in window) {
        // 不带参数的写法
        websocket = new WebSocket("ws://127.0.0.1:18080/testWebsocket");
        // 通过路径传递参数的方法（服务端采用第一种方法"@ServerEndpoint"实现）
        websocket = new WebSocket("ws://127.0.0.1:18080/testWebsocket/23/Lebron");
        // 通过类似GET请求方式传递参数的方法（服务端采用第二种方法"WebSocketHandler"实现）
        websocket = new WebSocket("ws://127.0.0.1:18080/testWebsocket?id=23&name=Lebron");
    }
    else {
        alert('当前浏览器 Not support websocket')
    }

    //连接发生错误的回调方法
    websocket.onerror = function () {
        setMessageInnerHTML("WebSocket连接发生错误");
    };

    //连接成功建立的回调方法
    websocket.onopen = function () {
        setMessageInnerHTML("WebSocket连接成功");
    }

    //接收到消息的回调方法
    websocket.onmessage = function (event) {
        setMessageInnerHTML(event.data);
    }

    //连接关闭的回调方法
    websocket.onclose = function () {
        setMessageInnerHTML("WebSocket连接关闭");
    }

    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function () {
        closeWebSocket();
    }

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //关闭WebSocket连接
    function closeWebSocket() {
        websocket.close();
    }

    //发送消息
    function send() {
        var message = document.getElementById('text').value;
        websocket.send(message);
    }
</script>
</html>

复制代码

 

2.2 Java WebSocketClient实现

（1）WebSocketClient 实现类

复制代码

import java.net.URI;

import org.java_websocket.client.WebSocketClient;
import org.java_websocket.drafts.Draft;
import org.java_websocket.handshake.ServerHandshake;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TestWebSocketClient extends WebSocketClient {
    
    private final Logger LOGGER = LoggerFactory.getLogger(TestWebSocketClient.class);
    
    public TestWebSocketClient(URI serverUri) {
        super(serverUri);
    }
    
    public TestWebSocketClient(URI serverUri, Draft protocolDraft) {
        super(serverUri, protocolDraft);
    }

    @Override
    public void onOpen(ServerHandshake serverHandshake) {
        LOGGER.info("Open a WebSocket connection on client. ");
    }
    
    @Override
    public void onClose(int arg0, String arg1, boolean arg2) {
        LOGGER.info("Close a WebSocket connection on client. ");
    }

    @Override
    public void onMessage(String msg) {
        LOGGER.info("WebSocketClient receives a message: " + msg);
    }

    @Override
    public void onError(Exception exception) {
        LOGGER.error("WebSocketClient exception. ", exception);
    }

}

复制代码

（2）WebSocketClient 发送数据

String serverUrl = "ws://127.0.0.1:18080/testWebsocket"
URI recognizeUri = new URI(serverUrl);
client = new TestWebSocketClient(recognizeUri, new Draft_6455());
client.connect();
client.send("This is a message from client. ");
宇1990
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Websocet服务端实现
neutrojan的专栏
02-15 6689
Websocet服务端实现 WebSocketConfig.java ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 @Configuration @EnableWebMvc @EnableWebSocket public class WebSocketCo
SpringBoot整合WebSocket实现消息的定时发送
08-08
内容介绍： 本项目主要是使用SpringBoot整合WebSocket并结合定时器共同实现项目的数据定时向页面推送，展示 适用人群： 想要适用WebSocket实现消息推送的功能的人群和想要对SpringBoot整合WebSocket简单学习了解的人。 适用场景： （1）在项目中需要给页面一直推送消息 （2）定期给页面推送相应的数据信息 涉及技术： SpringBoot、WebSocket、定时器、日志、maven 开发工具： Idea 测试可使用Websocket在线模拟请求工具，链接如下： http://www.jsons.cn/websocket/
springboot集成websocket实现简单聊天
03-29
springboot集成websocket实现即时通信，你发的消息将直接显示在另一台pc机的浏览器上
SpringBoot集成websocket(Spring方式)
架构师与哈苏
09-22 266
SpringWebSocketConfig配置 package com.meeno.chemical.socket.task.config; import com.meeno.chemical.socket.task.handler.TaskProgressWebSocketHandler; import org.springframework.context.annotation.Confi...
WEBSOCKET集成指南
woniyu123的博客
07-02 630
WEBSOCKET集成指南 目录 WEBSOCKET集成指南... 1 一、         为何使用websocket. 1 1.         轮询... 1 2.         长轮询... 2 二、         Websocket原理... 2 三、         Websocket与java集成... 2 1.         前置条件... 2 2.         后端集成...
SpringBoot 整合 WebSocket 服务代码教程
2301_76379462的博客
04-13 831
整理面试题，不是让大家去只刷面试题，而是熟悉目前实际面试中常见的考察方式和知识点，做到心中有数，也可以用来自查及完善知识体系。《前端基础面试题》，《前端校招面试题精编解析大全》，《前端面试题宝典》，《前端面试题：常用算法》PDF完整版点击这里领取觉得这些内容对你有帮助，可以扫码获取！！（备注：前端）**整理面试题，不是让大家去只刷面试题，而是熟悉目前实际面试中常见的考察方式和知识点，做到心中有数，也可以用来自查及完善知识体系。
SpringBoot整合websocket实现数据实时推送
08-29
2.SpringBoot如何集成websocket 3.SpringBoot中的定时任务调度 4.前后端分离项目的Cros跨域问题解决 阅读建议： 此资源以案例代入知识点的方式，让你快速上手websocket的相关学习，可针对项目本身向外扩展。
springboot+websocket进度条实战
11-11
在本项目中，"springboot+websocket进度条实战"是一个基于Spring Boot框架和WebSocket技术的实战应用，旨在展示如何在Web应用程序中实现一个实时的进度条功能。Spring Boot简化了Java Web开发，提供了快速构建独立...
springboot整合websocket
02-03
下面将详细介绍 SpringBoot 如何整合 WebSocket，实现实时通信。 依赖配置 要使用 SpringBoot 整合 WebSocket，首先需要在 Maven 项目中添加依赖项。添加以下依赖项到 pom.xml 文件中： ```xml <groupId>org....
springboot整合WebSocket实现即时通信demo源码案例演示
最新发布
07-23
一、简介 二、工程搭建 1、工程结构 2、依赖管理 三、WebSocket用法 1、示意图 2、API参考 四、源码参考
WebSocket的故事（五）—— Springboot中，实现网页聊天室之自定义消息代理
smilehappiness的博客
06-01 674
概述 WebSocket的故事系列计划分五大篇六章，旨在由浅入深的介绍WebSocket以及在Springboot中如何快速构建和使用WebSocket提供的能力。本系列计划包含如下几篇文章： 第一篇，什么是WebSocket以及它的用途第二篇，Spring中如何利用STOMP快速构建WebSocket广播式消息模式第三篇，Springboot中，如何利用WebSocket和STOMP快速构建点对点的消息模式(1)第四篇，Springboot中，如何利用WebSocket和STOMP快速构建点对点的消息
SpringBoot整合WebSocket
Nicholas_GUB的博客
12-01 5184
一、WebSocket与Http的区别 HTTP是应用层上的一个单向的、无状态的、基于请求与响应的协议。http协议本身是没有持久通信能力的，当客户端向服务器发送HTTP请求时，接收到请求后，服务器会将响应发送给客户端。每个请求都与一个对应的响应相关联，在发送响应后客户端与服务器的连接会被关闭。这种的基于请求响应的通讯方式有一点不足，服务器端无法主动向客户端推送数据。 Websocket是应用层上的一个全双工的有状态协议。websocket以ws://或wss://开头，它必须依赖 HTTP 协议进行一次
springboot集成websocket
zhutian0991的博客
12-11 149
前言 服务端一般都是被动接收请求，不主动向客户端发送信息。在某些场景情况下，客户需要及时获取更新的数据，有两种方法解决，一是由前端轮询定时调用接口，二是采用websocket服务端与客户端保持实时通信。 集成说明 采用tomcat自带的websocket实现，其中内置tomcat和外置tomcat集成稍有差别，外置tomcat不需要注入ServerEndpointExporter，因为它由容器自己提供和管理，websocket接收类不需要加@Component注解。如果涉及用户权限的问题，需要定义webso
Spring WebSocket实现实时通信的详细教程
lucky_fd的博客
01-18 1780
WebSocket 是基于TCP/IP协议，独立于HTTP协议的通信协议。WebSocket 连接允许客户端和服务器之间的全双工通信，以便任何一方都可以通过已建立的连接将数据推送到另一方。我们常用的HTTP是客户端通过「请求-响应」的方式与服务器建立通信的，必须是客户端主动触发的行为，服务端只是做好接口被动等待请求。而在某些场景下的动作，是需要服务端主动触发的，比如向客户端发送消息、实时通讯、远程控制等。
Spring4.0.6 Websocket详细配置 之 消息模块
hebeind100的博客
07-10 163
=============================================== 环境介绍： Jdk 1.7 Tomcat7.0.52 （支持Websocket协议） Spring4.0.26 （支持Websocket） web.xml（配置了前端自动优化HtmlCompressor和Druid监控），自动优化会影响Websocket js脚本，后面会讲 =======...
【Spring Boot】WebSocket 的 6 种集成方式
java_2017_csdn的博客
09-19 1773
和WebMVC中的WebSocketClient一样，Reactive包中的WebSocketClient也有很多实现类，比如ReactorNettyWebSocketClient，JettyWebSocketClient，UndertowWebSocketClient，TomcatWebSocketClient等等，也是需要大家基于自身项目的容器使用不同的实现类。@OnOpen用来标记对应的方法作为客户端连接上来之后的回调，Session就相当于和客户端的连接啦，我们可以把它缓存起来用于发送消息；
SpringBoot + WebSocket
weixin_33736649的博客
05-22 86
1. 服务端的实现，我尝试了两种方式： 第一种是用“@ServerEndPoint”注解来实现，实现简单； 第二种稍显麻烦，但是可以添加拦截器在WebSocket连接建立和断开前进行一些额外操作。 　　不管用哪种实现方式，都需要先导入jar包（如下），其中version根据实际springboot版本选择，避免冲突 <dependency> <gro...
vue+springboot之原生websocket长连接实现消息推送
qq_36442061的博客
08-01 2359
vue+springboot+websocket之原生websocket长连接实现消息推送 最近公司需要新增消息通知的功能，首先想到通过websocket长连接实现，由于主要业务还在于服务端的主动推送所以本文重点也是如此。 相信在选择使用websocket实现类似功能的小伙伴肯定对它有一定的了解了，因此本文不在赘述。 ...
vue前后台分离，websocket实现消息提示
猫爪子挠的博客
04-22 1145
前台vue，后台springboot，根据用户需求指定用户，页面显示提示图标闪烁，点击图标弹出后台推送消息，消息接口采用websocket协议
springboot整合websocket实现聊天软件
07-02
总结来说，通过以上的步骤，我们可以使用Spring Boot整合WebSocket来实现聊天软件的功能。当有新的WebSocket连接建立时，我们将其保存在一个静态List中，并在收到消息时将消息发送给所有的连接。通过Spring Boot的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值