Spring Websocket 使用笔记

最新推荐文章于 2024-05-21 15:40:10 发布
最新推荐文章于 2024-05-21 15:40:10 发布
阅读量2.2w 收藏 11
点赞数 6
分类专栏： Java Spring 文章标签： websocket spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/manerfan/article/details/48526681
版权
Java 同时被 2 个专栏收录
21 篇文章 0 订阅
订阅专栏
Spring
2 篇文章 0 订阅
订阅专栏

前言

现在主流的web容器基本均已支持websocket，但各容器的websocket接口都不尽相同。为了统一websocket实现，便于今后在不同web容器间的移植，这里使用spring websocket框架集成。

spring依赖

添加spring所需依赖

   <spring.framework.version>4.2.1.RELEASE</spring.framework.version>
   <dependency><!-- spring-core -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>
    <dependency><!-- spring-beans -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-beans</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>
    <dependency><!-- spring-context -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>
    <dependency><!-- spring-context-support -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-context-support</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>
    <dependency><!-- spring-aop -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>
    <dependency><!-- spring-expression -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-expression</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>
    <dependency><!-- spring-aspects -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>
    <dependency><!-- spring-web -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>
    <dependency><!-- spring-websocket -->
        <groupId>org.springframework</groupId>
        <artifactId>spring-websocket</artifactId>
        <version>${spring.framework.version}</version>
    </dependency>

websocket依赖

对于jetty，添加如下依赖

    <dependency>
        <groupId>org.eclipse.jetty.websocket</groupId>
        <artifactId>websocket-server</artifactId>
        <version>9.3.3.v20150827</version>
        <scope>provided</scope>
    </dependency>

对于tomcat，添加如下依赖

    <dependency>
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-websocket</artifactId>
        <version>8.0.23</version>
        <scope>provided</scope>
    </dependency>

对于上述jetty或者tomcat依赖，需要注意依赖版本与容器版本的兼容性，另一方面需要注意将依赖的scope设置为provided

添加Handler

添加HandshakeInterceptor

/**
 * <pre>
 * 豆瓣电台websocket握手接口实现
 * </pre>
 *
 * @author  ManerFan 2015年9月7日
 */
@Component
public class DoubanFMHandshakeInterceptor extends HttpSessionHandshakeInterceptor {

    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response,
            WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception {
        // 握手前的处理逻辑
        return super.beforeHandshake(request, response, wsHandler, attributes);
    }

    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response,
            WebSocketHandler wsHandler, Exception ex) {
        // 握手后的处理逻辑
        super.afterHandshake(request, response, wsHandler, ex);
    }

}

spring提供了多种HandshakeInterceptor实现，可以根据实际需要在其基础上实现自己的逻辑。当然，也可以直接使用spring的默认HandshakeInterceptor

添加WebSocketHandler

/**
 * <pre>
 * 豆瓣FM websocket消息处理
 * </pre>
 *
 * @author ManerFan 2015年9月7日
 */
@Component
public class DoubanFMWebSocketHandler extends TextWebSocketHandler {

    /**
     * logger
     */
    private static final Logger LOGGER = CommonLogger.getLogger();

    /**
     * 记录连接上的所有session
     */
    private Map<String, WebSocketSession> sessionMap = Collections
            .synchronizedMap(new HashMap<String, WebSocketSession>());

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 建立连接之后
        LOGGER.info("[{}:{}] has bean connected", session.getUri(), session.getId());
        sessionMap.put(session.getId(), session);
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message)
            throws Exception {
        // 收到消息之后
        String payload = message.getPayload();
        Signalling signalling = JacksonUtils.instance().readValue(payload, TYPE_REFERENCE);
        if (null == signalling) {
            LOGGER.warn("Receive an Empty Payload [?][{}] from [{}:{}].", payload, session.getUri(),
                    session.getId());
            return;
        }

        switch (signalling.getSignal()) {
            case C_START: /* 播放某一频道 */
                doStart(session, signalling.getMessage());
                break;
            case C_STOP: /* 停止收听 */
                doStop();
                break;
            case C_SKIP: /* 跳过该首 */
                doSkip(signalling.getMessage());
                break;
            case C_RATE: /* 喜欢 */
                doRate(signalling.getMessage());
                break;
            case C_UNRATE: /* 取消喜欢 */
                doUnRate(signalling.getMessage());
                break;
            case C_BYE: /* 不再收听 */
                doBye(signalling.getMessage());
                break;
            default:
                break;
        }
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status)
            throws Exception {
        // 连接断开之后
        LOGGER.info("[{}:{}] has bean closed", session.getUri(), session.getId());
        sessionMap.remove(session.getId());

        if (sessionMap.isEmpty()) {
            /* 没有客户端在线了 */
            doStop();
        }
    }
}

spring同样提供了TextWebSocketHandler BinaryWebSocketHandler等多种WebSocketHandler，可根据实际需要进行选择

初始化websocket

websocket的初始化，可以使用配置方式，也可以使用注解方式，关于spring websocket的使用及配置，详见websocket-doc，这里记录注解方式初始化方法

/**
 * <pre>
 * WebSocket初始化配置
 * 
 * <a href="http://docs.spring.io/spring/docs/current/spring-framework-reference/html/websocket.html">DOC for Spring Websocket</a>
 * </pre>
 *
 * @author  ManerFan 2015年9月7日
 */
@Configuration
@EnableWebMvc
@EnableWebSocket
public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {

    /**
     *  <beans xmlns="http://www.springframework.org/schema/beans"  
     *      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
     *      xmlns:websocket="http://www.springframework.org/schema/websocket"  
     *      xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd  
     *      http://www.springframework.org/schema/websocket http://www.springframework.org/schema/websocket/spring-websocket.xsd">
     * 
     *      <bean id="handler" class="com.manerfan.webapp.controller.douban.fm.websockt.FMWebSocketHandler"/>  
     *
     *      <websocket:handlers>  
     *         <websocket:mapping path="/websocket/doubanfm" handler="handler"/>  
     *         <websocket:handshake-interceptors>  
     *             <bean class="com.manerfan.webapp.controller.douban.fm.websock.FMHandshakeInterceptor"/>  
     *         </websocket:handshake-interceptors> 
     *         <!-- <websocket:sockjs/> --> 
     *      </websocket:handlers>
     *  </beans>
     */

    /** Douban FM */
    @Autowired
    private DoubanFMWebSocketHandler doubanFmWebSocketHandler;
    @Autowired
    private DoubanFMHandshakeInterceptor doubanFMHandshakeInterceptor;

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        /** Douban FM */
        registry.addHandler(doubanFmWebSocketHandler, "/websocket/doubanfm").addInterceptors(
                doubanFMHandshakeInterceptor).setAllowedOrigins("*")/*不加AllowedOrigins，有可能会全拒绝*/;
        /*registry.addHandler(doubanFmWebSocketHandler, "/sockjs/doubanfm")
                .addInterceptors(doubanFMHandshakeInterceptor).withSockJS();*/ /*用于支持SockJS*/
    }

    /**
     * Each underlying WebSocket engine exposes configuration properties 
     * that control runtime characteristics such as the size of message buffer sizes, 
     * idle timeout, and others.
     */

    /**
     * For Tomcat, WildFly, and GlassFish add a ServletServerContainerFactoryBean
     * to your WebSocket Java config:
     */
    /*@Bean
    public ServletServerContainerFactoryBean createWebSocketContainer() {
        ServletServerContainerFactoryBean container = new ServletServerContainerFactoryBean();
        container.setMaxTextMessageBufferSize(8192);
        container.setMaxBinaryMessageBufferSize(8192);
        return container;
    }*/

    /**
     * For Jetty, you’ll need to supply a pre-configured Jetty WebSocketServerFactory
     * and plug that into Spring’s DefaultHandshakeHandler through your WebSocket Java config:
     */
    @Bean
    public DefaultHandshakeHandler handshakeHandler() {

        WebSocketPolicy policy = new WebSocketPolicy(WebSocketBehavior.SERVER);
        policy.setInputBufferSize(8192); /* 设置消息缓冲大小 */
        policy.setIdleTimeout(600000); /* 10分钟read不到数据的话，则断开该客户端 */

        return new DefaultHandshakeHandler(
                new JettyRequestUpgradeStrategy(new WebSocketServerFactory(policy)));
    }

}

setAllowedOrigins用于约束允许建立连接的客户端
withSockJS用于提供SockJS支持

至此，websocket后台框架便搭建完成
javascript可使用如下方式与后台建立连接进行通信

/* 建立连接 */
var ws = new WebSocket("ws://localhost/rasp/websocket/doubanfm");
ws.onopen = function() { /* 连接成功时 */
    ws.send(JSON.stringify({signal:'C_START', message:'179'}));
};
ws.onmessage = function (evt){ /* 收到消息时 */
    var received_msg = evt.data;
    console.info("Message is received... " + received_msg);
};
ws.onclose = function() { /* 连接断开时 */
    console.warn("Connection is closed...");
};
ws.onerror = function(e) { /* 出现错误时 */
    console.error(e);
}

开发时遇到的异常及解决办法

  • No suitable default RequestUpgradeStrategy found

严重: Context initialization failed
org.springframework.beans.factory.BeanCreationException: Error creating bean with name ‘webSocketHandlerMapping’ defined in class path resource [org/springframework/web/socket/config/annotation/DelegatingWebSocketConfiguration.class]: Bean instantiation via factory method failed; nested exception is org.springframework.beans.BeanInstantiationException: Failed to instantiate [org.springframework.web.servlet.HandlerMapping]: Factory method ‘webSocketHandlerMapping’ threw exception; nested exception is java.lang.IllegalStateException: No suitable default RequestUpgradeStrategy found
at org.springframework.beans.factory.support.ConstructorResolver.instantiateUsingFactoryMethod(ConstructorResolver.java:599)
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.instantiateUsingFactoryMethod(AbstractAutowireCapableBeanFactory.java:1111)
at …
Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [org.springframework.web.servlet.HandlerMapping]: Factory method ‘webSocketHandlerMapping’ threw exception; nested exception is java.lang.IllegalStateException: No suitable default RequestUpgradeStrategy found
at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:189)
at …
Caused by: java.lang.IllegalStateException: No suitable default RequestUpgradeStrategy found
at org.springframework.web.socket.server.support.DefaultHandshakeHandler.initRequestUpgradeStrategy(DefaultHandshakeHandler.java:127)
at …

出现上述异常，是由于缺少RequestUpgradeStrategy
对于jetty，需要添加如下依赖

    <dependency>
        <groupId>org.eclipse.jetty.websocket</groupId>
        <artifactId>websocket-server</artifactId>
        <version>9.3.3.v20150827</version>
        <scope>provided</scope>
    </dependency>

对于tomcat，需要添加如下依赖

    <dependency>
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-websocket</artifactId>
        <version>8.0.23</version>
        <scope>provided</scope>
    </dependency>
  • java.lang.ClassCastException: org.eclipse.jetty.server.HttpConnection cannot be cast to org.eclipse.jetty.server.HttpConnection

页面报如下异常

WebSocket connection to ‘ws://localhost/rasp/websocket/doubanfm’ failed: Error during WebSocket handshake: Unexpected response code: 500

后台报如下异常

WARN:oejs.ServletHandler:qtp1237514926-20:
org.springframework.web.util.NestedServletException: Request processing failed; nested exception is org.springframework.web.socket.server.HandshakeFailureException: Uncaught failure for request http://localhost:80/rasp/websocket/doubanfm; nested exception is java.lang.ClassCastException: org.eclipse.jetty.server.HttpConnection cannot be cast to org.eclipse.jetty.server.HttpConnection
at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:978)
at …
Caused by:
org.springframework.web.socket.server.HandshakeFailureException: Uncaught failure for request http://localhost:80/rasp/websocket/doubanfm; nested exception is java.lang.ClassCastException: org.eclipse.jetty.server.HttpConnection cannot be cast to org.eclipse.jetty.server.HttpConnection
at org.springframework.web.socket.server.support.WebSocketHttpRequestHandler.handleRequest(WebSocketHttpRequestHandler.java:135)
at …
Caused by:
java.lang.ClassCastException: org.eclipse.jetty.server.HttpConnection cannot be cast to org.eclipse.jetty.server.HttpConnection
at org.eclipse.jetty.websocket.server.WebSocketServerFactory.acceptWebSocket(WebSocketServerFactory.java:182)
at …

出现此情况，一般是由于工程中引用的javax.servlet与web容器相关jar包冲突导致
将javax.servlet相关依赖scope置为provided即可

    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>servlet-api</artifactId>
        <scope>provided</scope><!-- 只在编译的时候 -->
    </dependency>
  • Unexpected response code: 403

页面报此异常，一般是由于websocket拒绝了此链接请求
在websocket初始化时，将setAllowedOrigins加上即可

ManerFan
关注
  • 6
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 7
    评论
专栏目录
02-spring增强的websocket使用示例
weixin_43716785的博客
01-20 1065
spring的websocket简单使用
Spring Websocket
10-23
我自己整理的类似于聊天室功能，websocket建立长连接，订阅和发送消息功能
webSocket介绍与使用 spring boot 集成 websocket教程 java
最新发布
a360284634的博客
05-21 1921
WebSocket介绍与使用 java spring boot集成WebSocket教程
Spring消息之WebSocket
weixin_34126215的博客
05-06 153
一、WebSocket简介 WebSocket 的定义？WebSocket是HTML5下一种全双工通信协议。在建立连接后，WebSocket服务器端和客户端都能主动的向对方发送和接收数据，就像Socket一样。 WebSocket 的由来？众所周知，HTTP协议有“无连接”、“不可靠”、“尽最大努力”的特点。WebSocket的出现可以看...
Spring 中的WebSocket
书香水墨
08-25 1972
一、WebSocket 按照其最简单的形式，WebSocket只是两个应用之间通信的通道。位于WebSocket一端的应用发送消息，另外一端处理消息。因为它是全双工的，所以每一端都可以发送和处理消息。 WebSocket通信可以应用于任何类型的应用中，但是WebSocket最常见的应用场景是实现服务器和基于浏览器的应用之间的通信。浏览器中的JavaScript客户端开启一个到服务器的连接，服务...
spring websocket
wang1369125334的博客
12-01 2995
一、使用Spring的低层级WebSocket API 为了在Spring使用较低层级的API来处理消息，我们必须编写一个实现WebSocketHandler的类，或继承AbstractWebSocketHandler类。 public class MyWebSocket extends AbstractWebSocketHandler{ @Override//当新连接建立的时候，会调用
详解spring boot Websocket使用笔记
08-31
本文将深入讲解如何在Spring Boot项目中配置和使用WebSocket。 **一、WebSocket简介** WebSocket是一种在客户端和服务器之间建立长连接的协议，允许双方进行全双工通信。相比于传统的HTTP请求，WebSocket提供更低...
spring+springMVC+WebSocket 的学习笔记
10-15
这本学习笔记应该详细介绍了如何在 Spring 应用中集成 Spring MVC 和 WebSocket，包括设置项目结构、配置 Spring 容器、编写 WebSocket 处理端点类、实现客户端连接及消息交互的示例代码，并可能涉及到如何在 Spring...
spring6.0学习笔记
03-03
通过阅读《spring6.0学习笔记.md》这份文档，开发者可以系统地了解这些新特性和变化，逐步掌握Spring 6.0的核心技术，提升自己的开发技能。文档中应该会详细解析每个知识点的应用场景、使用方法以及最佳实践，帮助...
Spring笔记示例源代码
10-09
"Spring笔记示例源代码"这个资源很可能是为了帮助学习者深入理解Spring框架的各种功能和用法而提供的实际代码示例。 1. **Spring IoC**：IoC是Spring的核心特性，它将对象的创建和管理权交给Spring容器，使得开发者...
Spring5笔记.zip
08-26
Spring5提供声明式AOP，通过使用注解或XML配置，可以轻松地在代码中插入切面逻辑。 4. **Spring Boot**： 虽非Spring5的一部分，但Spring Boot与Spring5紧密相关，它简化了Spring应用的初始化和配置。Spring Boot ...
Spring websocket
phoenix0619的专栏
11-18 173
    Spring自从4.0开始提供了对websocket的支持，配合sockjs，可以部分兼容到IE6，websocket终于可以大行其道了。     实际使用中遇到不少问题，逐步列举出来，避免以后忘掉。   由于浏览器设置了http代理，结果创建websocket时失败，提示：Error in connection establishment: net::ERR_TUNNEL_C...
Spring WebSocket
路漫漫其修远兮，吾将上下而求索！
10-24 2345
WebSocket 是 HTML5 开始提供的一种在 TCP 上进行的套接字全双工通讯协议，可以实现客户端与服务器端的异步通信，服务器的推送功能。
Spring使用WebSocket
qq_39768738的博客
12-23 6137
一、WebSocket简介 WebSocket 是 HTML5 一种新的协议。它实现了浏览器与服务器全双工通信，能更好的节省服务器资源和带宽并达到实时通讯，它建立在 TCP 之上，同 HTTP 一样通过 TCP 来传输数据。HTTP有1.1和1.0之说，也就是所谓的keep-alive，把多个HTTP请求合并为一个，但是WebSocket其实是一个新协议，跟HTTP协议基本没有关系，只是为了兼容...
SpringBoot2 整合 WebSocket 简单实现聊天室功能
DoubleFJ の Blog
09-11 3971
一个很简单的 Demo，可以用 WebSocket 实现简易的聊天室功能 个人博客 ： DoubleFJ の Blog 一反常态，我们先来看一下效果，如下： 嫌麻烦的可以直接去我的 GitHub 获取完整无码 Demo。 概述 WebSocket 是什么？ WebSocket 是一种网络通信协议。RFC6455 定义了它的通信标准。 WebSocket 是...
spring中使用webSocket
热门推荐
dawnStart的博客
05-06 1万+
WebSocket介绍 WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。 WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在 WebSocket API 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。 在 WebSocket API 中，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。 协议有两部
黑马程序员websocket笔记
09-23
黑马程序员的Websocket笔记主要包括以下内容： 1. Websocket是HTML5的一种新协议，它实现了浏览器与服务器之间的全双工通信。 2. Websocket在建立连接时需要借助HTTP请求完成握手，之后可以实现真正的全双工通信。 3...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 7
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值