Sring MVC 模式下使用websocket

最新推荐文章于 2023-11-06 18:56:53 发布
最新推荐文章于 2023-11-06 18:56:53 发布
阅读量483 收藏 1
点赞数

支持原创，原文链接

前言

九风的上一篇文章java WebSocket开发入门WebSocket介绍了websocket一些特征和提供了一个简单的demo，但上篇文章中的websocket类不能被Spring MVC中的controller层、server层调用，这篇文章提供了一个可用于MVC模式调用的版本。

程序运行环境说明

Server version ： Apache Tomcat/7.0.65
JVM version： 1.7.0_75-b13

官网介绍

首先推荐大家看官网Oracle的javax.websocket介绍 ，官网对其中的ServerEndpoint的介绍是：ServerEndpoint是web socket的一个端点，用于部署在URI空间的web socket服务，该注释允许开发者去定义公共的URL或URI模板端点和其他一些websocekt运行时的重要属性，例如encoder属性用于发送消息。

上篇文章中的最简单的tomcat的websocket服务器如果需要在MVC模式中被其他类调用，需要配置Configurator属性：用于调用一些自定义的配置算法，如拦截连接握手或可用于被每个端点实例调用的任意的方法和算法；对于服务加载程序，该接口必须提供默认配置器加载平台。

spring MVC模式配置

对于spring MVC模式，ServerEndpoint的代码为：

@ServerEndpoint(value="/websocketTest/{userId}",configurator = SpringConfigurator.class)

需要在maven中导入SpringConfiguator的包：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-websocket</artifactId>
    <version>${spring.version}</version>
</dependency>

目标需求

平台有多个用户，每个用户可能会在多个终端上登录，当有消息到达时，实时将所有消息推送给所有所用登录的当前用户，就像QQ消息一样，用户在PC、pad、phone上同时登录时，将收到的消息同时推送给该用户的所有终端。

数据结构设计

每个用户对应多个终端，多个终端用Set来记录，用户使用Map来记录，所以数据存储结构为Map<userId, Set<Terminal>>，结合具体的数据类型就是如下所示的的存储结构：

//记录每个用户下多个终端的连接
private static Map<Long, Set<WebsocketDemo>> userSocket = new HashMap<>();
操作设计
  1. onOpen: 新建连接时需要判断是否是该用户第一次连接，如果是第一次连接，则对Map增加一个userId；否则将sessionid添加入已有的用户Set中。
    2.onClose：连接关闭时将该用户的Set中记录remove，如果该用户没有终端登录了，则移除Map中该用户的记录
  2. onMessage: 这个根据业务情况详细设计。
  3. 给用户的所有终端发送数据：遍历该用户的Set中的连接即可。
后台websocket连接代码
/**
 * @Class: WebsocketDemo
 * @Description:  给所用户所有终端推送消息
 * @author JFPZ
 * @date 2017年5月15日 上午21:38:08
 */
import java.io.IOException;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.socket.server.standard.SpringConfigurator;

//websocket连接URL地址和可被调用配置
@ServerEndpoint(value="/websocketDemo/{userId}",configurator = SpringConfigurator.class)
public class WebsocketDemo {
    //日志记录      
    private Logger logger = LoggerFactory.getLogger(WebsocketDemo.class);
    //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;
   
    //记录每个用户下多个终端的连接
    private static Map<Long, Set<WebsocketDemo>> userSocket = new HashMap<>();
 
    //需要session来对用户发送数据, 获取连接特征userId
    private Session session;
    private Long userId;
   
    /**
     * @Title: onOpen
     * @Description: websocekt连接建立时的操作
     * @param @param userId 用户id
     * @param @param session websocket连接的session属性
     * @param @throws IOException
     */
    @OnOpen
    public void onOpen(@PathParam("userId") Long userId,Session session) throws IOException{
        this.session = session;
        this.userId = userId;
        onlineCount++;
        //根据该用户当前是否已经在别的终端登录进行添加操作
        if (userSocket.containsKey(this.userId)) {
            logger.debug("当前用户id:{}已有其他终端登录",this.userId);
            userSocket.get(this.userId).add(this); //增加该用户set中的连接实例
        }else {
            logger.debug("当前用户id:{}第一个终端登录",this.userId);
            Set<WebsocketDemo> addUserSet = new HashSet<>();
            addUserSet.add(this);
            userSocket.put(this.userId, addUserSet);
        }
        logger.debug("用户{}登录的终端个数是为{}",userId,userSocket.get(this.userId).size());
        logger.debug("当前在线用户数为：{},所有终端个数为：{}",userSocket.size(),onlineCount);
    }
   
    /**
     * @Title: onClose
     * @Description: 连接关闭的操作
     */
    @OnClose
    public void onClose(){
        //移除当前用户终端登录的websocket信息,如果该用户的所有终端都下线了，则删除该用户的记录
        if (userSocket.get(this.userId).size() == 0) {
            userSocket.remove(this.userId);
        }else{
            userSocket.get(this.userId).remove(this);
        }
        logger.debug("用户{}登录的终端个数是为{}",this.userId,userSocket.get(this.userId).size());
        logger.debug("当前在线用户数为：{},所有终端个数为：{}",userSocket.size(),onlineCount);
    }
   
    /**
     * @Title: onMessage
     * @Description: 收到消息后的操作
     * @param @param message 收到的消息
     * @param @param session 该连接的session属性
     */
    @OnMessage
    public void onMessage(String message, Session session) {    
        logger.debug("收到来自用户id为：{}的消息：{}",this.userId,message);
        if(session ==null)  logger.debug("session null");
    }
   
    /**
     * @Title: onError
     * @Description: 连接发生错误时候的操作
     * @param @param session 该连接的session
     * @param @param error 发生的错误
     */
    @OnError
    public void onError(Session session, Throwable error){
        logger.debug("用户id为：{}的连接发送错误",this.userId);
        error.printStackTrace();
    }
   
  /**
   * @Title: sendMessageToUser
   * @Description: 发送消息给用户下的所有终端
   * @param @param userId 用户id
   * @param @param message 发送的消息
   * @param @return 发送成功返回true，反则返回false
   */
    public Boolean sendMessageToUser(Long userId,String message){
        if (userSocket.containsKey(userId)) {
            logger.debug(" 给用户id为：{}的所有终端发送消息：{}",userId,message);
            for (WebsocketDemo WS : userSocket.get(userId)) {
                logger.debug("sessionId为:{}",WS.session.getId());
                try {
                    WS.session.getBasicRemote().sendText(message);
                } catch (IOException e) {
                    e.printStackTrace();
                    logger.debug(" 给用户id为：{}发送消息失败",userId);
                    return false;
                }
            }
            return true;
        }
        logger.debug("发送错误：当前连接不包含id为：{}的用户",userId);
        return false;
    }
  
}

Service层编写

service层比较简单，不多说，直接看代码就行：

/** 
 * @Class: WebSocketMessageService
 * @Description:  使用webscoket连接向用户发送信息
 * @author JFPZ
 * @date 2017年5月15日 上午20:17:01
 */
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;
import org.springside.modules.mapper.JsonMapper;
import com.hhxk.vrshop.entity.Message;
import com.hhxk.vrshop.web.webSocket.WebsocketDemo;
import com.hhxk.vrshop.web.webSocket.WebSocket;

@Service("webSocketMessageService")
public class WSMessageService {
    private Logger logger = LoggerFactory.getLogger(WSMessageService.class);
    //声明websocket连接类
    private WebsocketDemo websocketDemo = new WebsocketDemo();

    /**
     * @Title: sendToAllTerminal
     * @Description: 调用websocket类给用户下的所有终端发送消息
     * @param @param userId 用户id
     * @param @param message 消息
     * @param @return 发送成功返回true，否则返回false
     */
    public Boolean sendToAllTerminal(Long userId,String message){   
        logger.debug("向用户{}的消息：{}",userId,message);
        if(websocketDemo.sendMessageToUser(userId,message)){
            return true;
        }else{
            return false;
        }   
    }           
}

Controller层

Controller层也简单，只需提供一个http请求的入口然后调用service即可，Controller层请求地址为：http://127.0.0.1:8080/your-project-name/message/TestWS：

@Controller
@RequestMapping("/message")
public class MessageController extends BaseController{
    //websocket服务层调用类
    @Autowired
    private WSMessageService wsMessageService;

  //请求入口
    @RequestMapping(value="/TestWS",method=RequestMethod.GET)
    @ResponseBody
    public String TestWS(@RequestParam(value="userId",required=true) Long userId,
        @RequestParam(value="message",required=true) String message){
        logger.debug("收到发送请求，向用户{}的消息：{}",userId,message);
        if(wsMessageService.sendToAllTerminal(userId, message)){
            return "发送成功";
        }else{
            return "发送失败";
        }   
    }
}
前端连接代码

html支持websocket，将下面代码中的websocket地址中替换即可直接使用：

<!DOCTYPE html>
<html>

    <head lang="en">
        <meta charset="UTF-8">
        <script src="http://cdn.sockjs.org/sockjs-0.3.min.js"></script>
        <link rel="stylesheet" href="//cdn.bootcss.com/bootstrap/3.3.5/css/bootstrap.min.css">
        <link rel="stylesheet" href="//cdn.bootcss.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
        <script src="//cdn.bootcss.com/jquery/1.11.3/jquery.min.js"></script>
        <script src="//cdn.bootcss.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
        <title>webSocket-用户66</title>
        <script type="text/javascript">
            $(function() {
                var websocket;
                if('WebSocket' in window) {
                                        console.log("此浏览器支持websocket");
                    websocket = new WebSocket("ws://127.0.0.1:8080/your-project-name/websocketDemo/66");
                } else if('MozWebSocket' in window) {
                    alert("此浏览器只支持MozWebSocket");
                } else {
                    alert("此浏览器只支持SockJS");
                }
                websocket.onopen = function(evnt) {
                    $("#tou").html("链接服务器成功!")
                };
                websocket.onmessage = function(evnt) {
                    $("#msg").html($("#msg").html() + "<br/>" + evnt.data);
                };
                websocket.onerror = function(evnt) {};
                websocket.onclose = function(evnt) {
                    $("#tou").html("与服务器断开了链接!")
                }
                $('#send').bind('click', function() {
                    send();
                });

                function send() {
                    if(websocket != null) {
                        var message = document.getElementById('message').value;
                        websocket.send(message);
                    } else {
                        alert('未与服务器链接.');
                    }
                }
            });
        </script>
    </head>

    <body>
        <div class="page-header" id="tou">
            webSocket多终端聊天测试
        </div>
        <div class="well" id="msg"></div>
        <div class="col-lg">
            <div class="input-group">
                <input type="text" class="form-control" placeholder="发送信息..." id="message">
                <span class="input-group-btn">
                    <button class="btn btn-default" type="button" id="send" >发送</button>
                </span>
            </div>
        </div>
    </body>

</html>

测试验证

使用用户id为66登录2个终端，用户id为88登录1个终端，服务器中可以看到登录的信息，如下图所示：

用户连接后台websocket服务器

首先验证用户66的两个终端接收是否能同时接收消息：


验证用户66的多终端接收消息


作者：九风萍舟
链接：https://www.jianshu.com/p/3398d0230e5f
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
maozexijr
关注
Spring MVC的WebSocket使用
weixin_43415481的博客
03-08 3649
Spring MVC的WebSocket使用 文章目录Spring MVC的WebSocket使用一、WebSocket概述1.1 建立WebSocket基本流程1.2 WebSocket和HTTP的区别二、Spring的WebSocket使用2.1 WebSocket API2.1.1 WebSocketHandler2.1.2 HandshakeInterceptor 和 WebSocketConfigurer2.1.3 设置跨域请求——setAllowedOrigins2.1.4 SockJS支持——
SpringMVC WebSocket Apache代理 相关技术点总结
海纳百川
08-03 1010
SpringMVC + WebSocket这个技术的文章一大把，最会笔者发现对WebSocket一知半解的情况下使用这个技术，任然会存在问题，又是还会决定莫名其妙，而且是直接使用别人代码的情况下更是如此。本文希望通过简短的文字介绍一下个人经验总结。 如果英语尚可，直接参考SpringMVC官方对WebSocket的支持文档，点击这里 WebSocket 这个技术不神秘，而且简单易用，只需
springmvc-websocket
05-07
使用springmvc实现的websocket，对新入手的人来说是个不错的选择！赞一个！
在SpringMVC中使用WebSocket
山鹰的专栏
02-09 4526
SpringMvc项目的搭建在这里就不做多解释，要在Spring中实现 WebSocket 必须加上 spring-websocket和 spring-messaging两个包，同样，完整的pom.xml给出如下: 1 2 3 4 5 6 7 8 9 10 11 12 13 14
springMVC4使用websocket
lkx94的专栏
01-03 926
转载自：http://blog.csdn.net/stickallthetime/article/details/44587413 一、测试环境  1. Tomcat8.0.18  2. JDK1.8  3. Spring4.1  二、新建一个SpringMVC的工程  1. 使用Maven新建一个web工程，添加SpringMVC和spring websocket依赖，pom.x
利用Spring MVC实现WebSocket实时通信
weixin_42176639的博客
07-10 2489
利用Spring MVC实现WebSocket实时通信，可以集成到SSH项目中 配置的修改： 1.struts.xml，不拦截socket的请求，我的位置为：/pages/mess/gc <constant name="struts.action.excludePattern" value="/pages/mes/TakePhoto.html,/pages/mess/gc"/> ...
WebSocket Day03 : SpringMVC整合WebSocket
zhiqiuqiu2的博客
11-06 1540
在现代Web应用程序中，实时性和即时通信变得越来越重要。传统的HTTP请求-响应模式无法满足实时数据传输和双向通信的需求。随着技术的发展，WebSocket成为了一种强大而灵活的解决方案。WebSocket是HTML5提供的一种新的通信协议，它通过一个持久化的、双向的连接，在客户端和服务器之间实现了实时的数据传输和双向通信。相比传统的HTTP请求-响应模式，WebSocket能够提供更低的延迟、更高的效率和更好的用户体验。
websocket使用实例(spring mvc)
02-24
以上就是Spring MVC中WebSocket的使用实例，通过这些步骤，你可以实现在登录客户端和服务器之间的实时消息推送。在实际项目中，WebSocket常用于实时通知、聊天应用、股票交易系统、在线游戏等场景，为用户提供更流畅...
毕业设计-后端项目-仿微博平台SSM 使用技术：spring mvc，spring，mybatis，websocket
最新发布
04-27
该毕业设计模仿了微博的功能，使用技术：spring mvc，spring，mybatis，websocket，页面较为清爽。 系统功能包括：分享新鲜事，点赞，收藏，回复等。因为使用了websocket，所以当别人点赞或者回复的时候，服务器端会...
websocket-test:测试Spring MVC 5 + WebSocket
05-16
这个“websocket-test”项目显然旨在测试Spring MVC 5框架与WebSocket技术的集成应用。 首先，Spring MVC是Spring框架的一个模块，主要用于构建Web应用程序。它提供了一种模型-视图-控制器（MVC）架构，使得开发者...
SpringMVC使用WebSocket
04-01
使用SpringMVC结合WebSocket实现服务器与客户端双向沟通,程序很简单,只是为了演示配置(hello world),IntelliJ Maven项目,部署好以后测试地址 http://localhost:8080/test
spring mvc集成websocket
08-16
spring mvc集成websocket，无需xml配置，使用@ServerEndpoint注册一个websocket服务器路径就可在html页面用js与websocket_server建立连接，压缩包里附带了html页面，可以作为参考
springMvc-websocket-demo
09-18
springMvc集成websocket的基本版，demo，注意设置tomcat的modules的path为“/”，修改页面上url的端口
Spring MVC websocket整合
12-15
Spring MVC websocket整合
springMVC实现websocket
langqingj的博客
04-09 1140
转载：https://blog.csdn.net/rola0418/article/details/79315607 简单发布一个基于springMVC的websocket的实现配置，springMVC的搭建过程这里就不说明了 。只实现H5的websocket，js实现没有考虑 springMVC的配置文件如下： <?xml version="1.0" encoding="UTF-8"?...
SpringMVC入门 - webSocket
weixin_44115360的博客
09-22 613
由于传统HTTP协议主要是拉取消息，因此一些需要服务器主动推送消息的功能就难以实现，传统上是采用AJAX轮询、长轮询等方法；现在则可以采用webSocket来优雅地实现浏览器和服务器间的双向通信机制。 本demo主要实现了一个简单的聊天室，加入网页的游客可以一起聊天（消息广播）。服务端主要利用了spring的websocket模块，浏览器可以直接利用JS，两端都尽量采用较新的版本。 1、pom.xml依赖 <dependency> <groupId>org
SpringMVC整合WebSocket
hllinc的专栏
10-13 5811
这块功能早就想实现了，但一直忙于其他项目的功能，直到昨天才正式开始研究。 Spring4已经加入了对Websocket支持。 1. 引入Spring4的jar包，以及Spring websocket的jar包，如下图 2. web.xml文件用3.0版本。  web-app       xmlns:xsi= “http://
Spring WebMVC框架详解与WebSocket集成
此外，章节还提到了Spring对WebSocket的支持，尽管这部分内容是在第26章进行详细阐述的，但可以预期这部分内容会涉及如何在Spring框架下利用WebSocket进行实时通信。 第五章"Web"部分是学习和掌握Spring Web开发不...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值