spirng项目中集成webSocket踩到的坑

最新推荐文章于 2024-08-07 09:33:45 发布
最新推荐文章于 2024-08-07 09:33:45 发布
阅读量1.4k 收藏
点赞数
文章标签： 网络
原文链接：https://my.oschina.net/u/3267498/blog/2980800
版权

2019独角兽企业重金招聘Python工程师标准>>> hot3.png

 

 

花费了将近一周的时间终于将webSocket 集成到了原来的springmvc+spring +mybatis 项目中了，一路心酸一路的泪水啊，网上的技术文档都没有解决我的问题，（很多文章都是你抄我的我抄你的）。

先来说一下我的环境：

windows  10, myeclipse 2014,orcale11 ,jdk 1.7.0.79 ,spring 4.3.8   springmvc 4.2.4.RELEASE  

 

websocket jar

           <dependency>
			    <groupId>javax.websocket</groupId>
			    <artifactId>javax.websocket-api</artifactId>
			    <version>1.0</version>
			    <scope>provided</scope>
			</dependency>
	        <dependency>
	            <groupId>org.springframework</groupId>
	            <artifactId>spring-websocket</artifactId>
	            <version>4.2.4.RELEASE</version>
	        </dependency>
	        <dependency>
	            <groupId>org.springframework</groupId>
	            <artifactId>spring-messaging</artifactId>
	            <version>4.2.4.RELEASE</version>
	        </dependency>

下面就记录一下自己遇到的问题，以及如何解决的问题

想贴上自己的代码

SpringWebSocketConfig.java  文件

/**
 * 
 * 
 * @Description: TODO <p>SpringWebSocketConfig.java</p>
 * @作者: 王彦宝
 * @时间: 2018年10月24日下午3:52:57
 * @version V1.0
 * @see java.lang.Class
 * @since JDK{jdk1.7}
 */
//@EnableWebMvc//测试这个注解可以不要
@Configuration
@EnableWebSocket
public class SpringWebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{

	
	@Override
	public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(webSocketHandler(),"/webSocketIMServer.json").addInterceptors(myInterceptor()).setAllowedOrigins("*");
        registry.addHandler(webSocketHandler(), "/sockjs/webSocketIMServer.json").withSockJS();
	}
	
	@Bean
    public SpringWebSocketHandler webSocketHandler(){
        return new SpringWebSocketHandler();
    }

	 @Bean
    public SpringWebSocketHandlerInterceptor myInterceptor(){
        return new SpringWebSocketHandlerInterceptor();
    }
}

 SpringWebSocketHandler.java  文件

import java.io.IOException;
import java.util.ArrayList;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

/**
 * 
 * 
 * @Description: TODO <p>SpringWebSocketHandler.java</p>
 * @作者: 王彦宝
 * @时间: 2018年10月24日下午3:55:49
 * @version V1.0
 * @see java.lang.Class
 * @since JDK{jdk1.7}
 */
public class SpringWebSocketHandler extends TextWebSocketHandler{
	
	private static final Logger LOGGER = LoggerFactory.getLogger(SpringWebSocketHandler.class);
	
	private static final ArrayList<WebSocketSession> users;//这个会出现性能问题，最好用Map来存储，key用userid
	
	 static {
        users = new ArrayList<WebSocketSession>();
    }
	    
    public SpringWebSocketHandler() {
        // TODO Auto-generated constructor stub
    }
	
	/**
     * 连接成功时候，会触发页面上onopen方法
     */
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
    	LOGGER.info("connect to the websocket success......当前数量:"+users.size());
        users.add(session);
        //这块会实现自己业务，比如，当用户登录后，会把离线消息推送给用户,这里需要查询数据库把待发送的消息发送给医生
        TextMessage returnMessage = new TextMessage("你将收到的离线");
        session.sendMessage(returnMessage);
    }
    
   
   /**
    * 关闭连接时触发
    */
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        String username= (String) session.getAttributes().get("WEBSOCKET_EDU_SESSION_USERID");
        LOGGER.info("用户"+username+"已退出！");
        users.remove(session);
        LOGGER.info("剩余在线用户"+users.size());
    }

    /**
     * 给某个用户发送消息
     * @param userAndHosId
     * @param message
     * @作者: 王彦宝
     * @时间: 2018年11月30日下午1:51:32
     * @返回 void
     */
    public void sendMessageToUser(String username, TextMessage message) {
    	LOGGER.info("发送消息："+message);
        for (WebSocketSession user : users) {
            if (user.getAttributes().get("WEBSOCKET_SESSION_USERID").equals(username)) {
                try {
                    if (user.isOpen()) {
                    	LOGGER.info("发送消息："+message);
                        user.sendMessage(message);
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
                break;
            }
        }
    }
    
    /**
     * 群发所有在线用户消息
     *
     * @param userName
     * @param message
     */
    public void sendMessage(TextMessage message) {
    	LOGGER.info("发送消息："+message);
        for (WebSocketSession user : users) {
            try {
                if (user.isOpen()) {
                	LOGGER.info("发送消息："+message);
                    user.sendMessage(message);
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
    
    /**
     * js调用websocket.send时候，会调用该方法
     */
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
 
        super.handleTextMessage(session, message);
 
        /**
         * 收到消息，自定义处理机制，实现业务
         */
        System.out.println("服务器收到消息："+message);
 
        if(message.getPayload().startsWith("#anyone#")){ //单发某人
 
             sendMessageToUser((String)session.getAttributes().get("WEBSOCKET_SESSION_USERID"), new TextMessage("服务器单发：" +message.getPayload())) ;
 
        }else if(message.getPayload().startsWith("#everyone#")){
 
        	sendMessage(new TextMessage("服务器群发：" +message.getPayload()));
 
        }else{
 
        }
 
    }
}

SpringWebSocketHandlerInterceptor.java 文件

import java.util.Map;

import javax.servlet.http.HttpSession;

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;

/**
 * 
 * WebSocket拦截器
 * @Description: TODO <p>SpringWebSocketHandlerInterceptor.java</p>
 * @作者: 王彦宝
 * @时间: 2018年10月24日下午3:58:34
 * @version V1.0
 * @see java.lang.Class
 * @since JDK{jdk1.7}
 */
public class SpringWebSocketHandlerInterceptor extends HttpSessionHandshakeInterceptor{

	
	@Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
            Map<String, Object> attributes) throws Exception {
        // TODO Auto-generated method stub
        System.out.println("Before Handshake");
        if (request instanceof ServletServerHttpRequest) {
            ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
            HttpSession session = servletRequest.getServletRequest().getSession(false);
            if (session != null) {
                //使用userName区分WebSocketHandler，以便定向发送消息
                String username = (String) session.getAttribute("SESSION_USERID");
                if (username==null) {
                	username="default-system";
                }
                attributes.put("WEBSOCKET_SESSION_USERID",username);
            }
        }
        return super.beforeHandshake(request, response, wsHandler, attributes);
        
    }
    
    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
            Exception ex) {
        // TODO Auto-generated method stub
        super.afterHandshake(request, response, wsHandler, ex);
    }
}

这就是核心的代码了。在spring  的配置文件中加入  SpringWebSocketConfig  文件的扫描路径，然后启动项目在前端进行访问

ws://localhost:8081/XXXXX/webSocketIMServer.json");  这样访问就OK 了。

遇到的问题我总结一下：

1、404问题：

    在第一次访问的时候报出了404  的错误，找不到路径，最后发现问题在这里

        registry.addHandler(webSocketHandler(),"/webSocketIMServer.json").addInterceptors(myInterceptor()).setAllowedOrigins("*");
        registry.addHandler(webSocketHandler(), "/sockjs/webSocketIMServer.json").withSockJS();

前端访问的方法必须和后台写的这个方法名一致（包括后缀名，如果后台代码没有后缀，前端访问时候就不要加后缀，不然就是访问不到）"/webSocketIMServer.json"。

2、403问题：

    上面解决了404 的问题就又报出了403 的问题，然后我就在网上各种搜索，有各种各样的方案，都试过了，没有解决问题，然后搜到了这个

博客：https://blog.csdn.net/goxidono/article/details/53414897

和我的问题一模一样，说的挺详细，spring-webSocket.jar  里面自动实现了HandshakeInterceptor  接口 

public class OriginHandshakeInterceptor implements HandshakeInterceptor {

 

然后再执行到这个方法的时候，this.interceptors   就会又两个 interceptors,  第一个是我们自己实现的SpringWebSocketHandlerInterceptor  这个接口实现类，第二个就是   spring-webSocket  自动帮你实现的  OriginHandshakeInterceptor  这个接口实现类，

public boolean applyBeforeHandshake(ServerHttpRequest request, ServerHttpResponse response,
			Map<String, Object> attributes) throws Exception {

		for (int i = 0; i < this.interceptors.size(); i++) {
			HandshakeInterceptor interceptor = this.interceptors.get(i);
			if (!interceptor.beforeHandshake(request, response, this.wsHandler, attributes)) {
				if (logger.isDebugEnabled()) {
					logger.debug(interceptor + " returns false from beforeHandshake - precluding handshake");
				}
				applyAfterHandshake(request, response, null);
				return false;
			}
			this.interceptorIndex = i;
		}
		return true;
	}

就在这个方法中会被拦截，然后我就改变了写法，

下面是我刚开始的写法：

public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        //WebIM WebSocket通道
        registry.addHandler(webSocketHandler(),"/webSocketIMServer").addInterceptors(myInterceptor());
        registry.addHandler(webSocketHandler(), "/sockjs/webSocketIMServer").addInterceptors(myInterceptor()).withSockJS();
    }

改变后的写法：

public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
		//WebIM WebSocket通道
        registry.addHandler(webSocketHandler(),"/webSocketIMServer.json").addInterceptors(myInterceptor()).setAllowedOrigins("*");
        registry.addHandler(webSocketHandler(), "/sockjs/webSocketIMServer.json").withSockJS();
	}

然后继续测试，发现还是不行，原因在执行到  applyBeforeHandshake 方法时有两个拦截器，按照上面的写法我们自己实现的拦截器时通过了，但是spring-webSocket 实现的拦截器没有通过，然后又被拦截了报403 ，但是还是没有解决我的问题。文章里用的jdk 8 ,tomcat 8 ,和我的问题相似但是环境不同，用不了他的写法，测试到这里的时候我用的spirng 的版本  时4.2.4  ，然后我就想想换一个高点的spring  的版本试试看，之后就换了Spirng 4.3.8 的版本，启动测试，居然OK了。好吧原来时版本的问题  最后的的环境是：

    

windows  10, myeclipse 2014,orcale11 ,jdk 1.7.0.79 ,spring 4.3.8   springmvc 4.2.4.RELEASE  

 

websocket jar

           <dependency>
			    <groupId>javax.websocket</groupId>
			    <artifactId>javax.websocket-api</artifactId>
			    <version>1.0</version>
			    <scope>provided</scope>
			</dependency>
	        <dependency>
	            <groupId>org.springframework</groupId>
	            <artifactId>spring-websocket</artifactId>
	            <version>4.2.4.RELEASE</version>
	        </dependency>
	        <dependency>
	            <groupId>org.springframework</groupId>
	            <artifactId>spring-messaging</artifactId>
	            <version>4.2.4.RELEASE</version>
	        </dependency>

这样就可以了。在此做一个记录。

 

 

转载于:https://my.oschina.net/u/3267498/blog/2980800

weixin_34151004
关注
Spring Websocket 开发
小程序
09-18 1万+
Websocket Spring 搭建网页聊天 注册服务 package com.web.socket; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframewor
nimble 蓝牙开发三：nimble BLE 应用介绍
尝尝你工人爷爷的铁拳
10-27 5119
本文用来介绍使用 nimble 开发的蓝牙应用的逻辑与流程，帮助正在学习使用 nimble 蓝牙协议栈的人更快速的进行蓝牙应用开发
spring boot配置好websocket后访问端点连接失败
最新发布
m0_52908452的博客
08-07 464
【代码】spring boot配置好websocket后访问端点失败。
SpringBoot整合原生webSocket实现聊天室
热门推荐
一恍过去
01-20 1万+
SpringBoot整合原生webSocket实现聊天室
netty-websocket-spring-boot-starter客户端连接失败
weixin_59750951的博客
05-08 1283
报错：结论：OpOpen、OnMessage...包导错了!!! BeforeHandshake时由于逻辑原因导致session.close()连接路径未加上context-path1. 报错404原因报错代码中导入的包 虽然已经导入了第一行，但是如果也一起导入下面的几行，系统会优先使用下面的注解，导致Unexpected response code: 404错误为写context-path也会导致404错误2.连接失败原因报错在代码中，如果在BeforeHandshake中调用了session.cl
Websocket拦截器HandshakeInterceptor
weixin_30507481的博客
07-30 8851
https://www.jianshu.com/p/7c98820f0364 org.springframework.web.socket.server Interface HandshakeInterceptor 所有已知实现类 HttpSessionHandshakeInterceptor public interface HandshakeIntercepto...
Spring集成webSocket页面访问404问题的解决方法
08-28
Spring集成webSocket页面访问404问题的解决...Spring集成webSocket页面访问404问题的解决方法需要通过在 DispatchServlet 中添加拦截器和配置访问地址时设置连接的域名地址，以便正确地处理webSocket请求和跨域请求。
Spring Boot 集成 WebSocket（原生注解与Spring封装方式）
09-29
能学到什么：Spring Boot 快速集成 WebSocket（原生注解与Spring封装方式） 阅读建议：此资源以开发 Spring Boot 集成 WebSocket 学习其原理和内核，不仅是代码编写实现也更注重内容上的需求分析和方案设计，所以在...
spring集成webSocket
09-25
**Spring 集成 WebSocket 知识点详解** ...通过以上步骤，你可以成功地在Spring项目中集成WebSocket，并实现站内消息的实时推送。在实际开发中，应根据项目需求灵活调整配置和实现策略，确保系统的稳定性和高性能。
springcloud下通过gateway转发websocket
07-14
1. 添加依赖：在项目pom.xml中添加Spring Cloud Gateway和WebSocket的相关依赖，如`spring-boot-starter-websocket`和`spring-cloud-starter-gateway`。 2. 配置WebSocket路由：在Spring Cloud Gateway的配置文件...
Spring3如何集成WebSocket服务
qq_37553238的博客
01-12 4656
Spring3没有提供原生的对于websocket的支持，但是如果你的项目的架构基础都是spring3(出于种种原因迟迟无法升级到spring4)，但是又想集成websocket的服务，怎么办？有办法解决吗？当然可以啦 既然没有原生的支持，那么为什么我们不直接自己写一个实现呢？于是说干就干， 首先我们需要实现websocket的协议，这个协议的具体我就不说了，想了解的朋友可以自己在百度上谷歌一
spring boot 环境下websocket 开发简单示例
u013958151的博客
12-10 438
示例如下，需要注意的是， 类上需要打上@Scope("prototype")注解，否则socket就是单例的 socket的configurator属性的配置类需要实现ApplicationContextAware，和代码里面一样的配置之后，server里面才能成功注入spring管理的对象   package com.xiaogang.websocketdemo.web.socket; ...
记一次接入websocket过程中@ServerEndpoint和@Scope(“prototype“)、@Autowire、@Postconstruct一起使用不生效的原因分析
ZixiangLi的博客
06-22 2394
记一次接入websocket过程中@ServerEndpoint和@Scope(“prototype“)、@Autowire、@Postconstruct一起使用不生效的原因分析
WebSocket 连接失败的原因及解决方法
LiamHong_的博客
06-25 7724
目前已经成为了一项极为重要的技术，其允许客户端和服务器之间进行实时、全双工的通信。然而，在实际项目中，开发者时常会遇到 WebSocket 连接失败的情况。这不仅影响了用户体验，还可能导致不可预见的系统错误或数据丢失。那么，造成 WebSocket 连接失败的原因有哪些？又该如何解决这些问题呢？本文将逐一分析常见的 WebSocket 连接失败原因，并提供详细的解决方案。
SpringBoot实现WebSocket心跳机制
qq_35019521的博客
11-16 6968
SpringBoot实现WebSocket心跳检测，检测数据写入CSV文件
WebSocket 协议及其使用案例
qq_61635026的博客
08-31 3581
WebSocket 协议是一种允许服务器和客户端之间进行全双工、实时通信的协议。它克服了 HTTP 协议的请求-响应模式，通过在客户端和服务器之间建立持久性的连接，实现了数据的实时传输。传统的 HTTP 连接每次请求都需要建立和关闭，而 WebSocket 连接则能够一直保持开放状态，避免了频繁的连接建立和关闭开销。
springboot整合websocket
m0_49382941的博客
04-10 1151
handleTextMessage()方法通过英文方法名可知，用于处理文本信息。WebSocketSession的方法sendMessage可以向前台发送消息，CloseStatus的getReason方法获得关闭的原因。通过WebSocketSession的sendMessage方法，将创建的TextMessage对象给前台。afterConnectionEstablished方法通过英文方法名可知，用于连接确立之后。setAllowedOrigins()方法设置允许源，传递星号，否则跨域。
springcloud 集成websocket
07-27
Spring Cloud可以集成WebSocket，让你能够在分布式系统中使用实时的双向通信。下面是一些步骤来集成WebSocket： 1. 首先，你需要在Spring Boot项目中添加WebSocket的依赖。可以在pom.xml文件中添加以下依赖： ```...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值