SpringBoot2.1集成websocket

写在前面,IE对websocket支持的不好,IE11偶尔会断开连接,IE8会出现连不上的现象

业务功能:
项目中有一个踢除重复登录账号的功能。A先登录了admin账号,B后登录了admin账号,那么A将会收到提醒"账号已在其他地点登录",并自动登出。

方案A:
项目内原有的解决方案是以拦截器的方式,检测是否存在相同的账号信息,如果存在则提示用户并登出。
弊端是在B登录后,A必须发出请求,此时拦截器才能进行检测,假设A长时间没有操作,那么将无法进行检测,也就无法做到实时性的提示用户账户已在其他地点登录。

方案B:
之前由于工期问题,解决方案改为每个账户登录成功后,都会在一个公共页面中使用定时器去后台查询账号登录状态,如果登录状态标识为过期,则提示用户并退出。
用户A登录成功后,会在redis中存储用户的信息,其中包含用户的名称、允许登录状态标识、sessionId等。当B在登录成功后,会检测redis中是否存在相同的用户信息,如果存在,判断sessionId是否相同,不同的话表示已有其他用户登录该账户,那么把这条记录中的登录状态标识为过期,并把自己的信息存入redis中,当前端的轮询定时器查到用户A的账户登录状态标识为过期,弹出提示信息,然后自动登出。
弊端:需要前端不断的去后台请求,存在消耗服务器资源的问题,假设几十万用户同时发出请求可想而知服务器面临的资源压力多么紧张。

方案C:
利用websocket双向通讯的特点,一次建立通讯便可以保持长连接,服务器可以主动向客户端发送消息,解决了A和B两种方案的弊端(实时性、节省服务端资源开销)。

①集成websocket

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
    <version>2.1.0.RELEASE</version>
</dependency>

②配置websocket

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfiguration implements WebSocketMessageBrokerConfigurer {

    /**
     * 注册一个STOMP的endpoint,并指定使用SockJS协议
     * @param registry
     */
    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/endpointWisely").setAllowedOrigins("*").withSockJS();
    }

    /**
     * 配置消息代理(Message Broker)
     * @param registry
     */
    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
        //点对点应配置一个/user消息代理,广播式应配置一个/topic消息代理
        registry.enableSimpleBroker("/topic","/user");
        //点对点使用的订阅前缀(客户端订阅路径上会体现出来),不设置的话,默认也是/user/
        registry.setUserDestinationPrefix("/user");
    }
}

③前端代码

这个界面是登录成功后跳转的界面,sessionId从后台传到前台的,用于区分不同的用户
connect方法是与后台建立连接,并通过地址“/user/xxxxx/queue/getResponse“订阅广播,当后台有消息推送到该地址时,在回调中将会收到消息。
/endpointWisely是后台配置的通道地址
为什么是/user开头,因为websocket中定义群发是/topic,点对点通信默认为/user,你也可以自定义为其他字符,/queue/getResponse为自定义的地址,前端和后台保持一致才能进行通信

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>首页</title>
    <script src="/jquery-1.11.3.min.js"></script>
    <script src="/sockjs.min.js"></script>
    <script src="/stomp.min.js"></script>
    <script>

        $(function(){
           connect();
        });

        var stompClient = null;
        function disConnect() {
            if (stompClient != null) {
                stompClient.disconnect();
            }
        }
        function connect() {
            var sessionId = $('#sessionIdHidden').val();
            var socket = new SockJS("/endpointWisely");
            stompClient = Stomp.over(socket);
            stompClient.connect({},function(frame){
                stompClient.subscribe("/user/"+sessionId+"/queue/getResponse", function(response){
                    if (response.body == 'logout') {
                        disConnect();
                        alert('当前账号已在其他地点登陆');
                        location.href = '/login/toLogin';
                    }
                })
            })
        }

    </script>
</head>
<body>
<input type="hidden" id="sessionIdHidden" value="${user.sessionId}"/>
欢迎回来${user.username}!
</body>
</html>

④后台代码

账户检验通过后,会从redis中查找是否存在已登录账号,注意redis的key的组成 “LOGIN-” + 用户名 + "-" + sessionId,利用sessionId来区分是否存在已登录,如果存在,则给对应的客户端主动推送消息。
这里要注意的是如何能够找到对应的客户端,关键点就是sessionId,因为在前端代码中,每次登录成功后,会把后台拿到的sessionId传到前端,前端利用sessionId组装成一个url与后台websocket建立了连接,这样后端只要有相同的sessionId,就可以与前端进行通信了。
simpMessagingTemplate.convertAndSendToUser(sessionId, "/queue/getResponse", "logout");
“logout“为推送的内容,前端获取该值后完成提示用户、登出操作即可。

    @Autowired
    RedisTemplate redisTemplate;

    @Autowired
    private SimpMessagingTemplate simpMessagingTemplate;

    /**
     * 登陆
     * @param user
     * @return
     */
    @RequestMapping(value = "/loginSubmit", method = RequestMethod.POST)
    public String loginSubmit(User user, HttpServletRequest request, Model model) {

        if (!"admin".equals(user.getUsername())) {
            return "用户不存在";
        }

        if (!"admin".equals(user.getPassword())) {
            return "密码错误";
        }

        String searchKey = "LOGIN-" + user.getUsername() + "-" + "*";
        String loginKey = "LOGIN-" + user.getUsername() + "-" + request.getRequestedSessionId();
        if (redisTemplate.opsForValue().get(loginKey) == null) {

            // 存储当前用户信息
            HashMap<String,Object> loginInfoMap = new HashMap<>(16);
            loginInfoMap.put("loginTime", new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()));
            loginInfoMap.put("userName", user.getUsername());
            loginInfoMap.put("allowLogin", true);
            redisTemplate.opsForValue().set(loginKey, loginInfoMap);

            // 查询是否存在其他已登陆用户
            Set loginSet = redisTemplate.keys(searchKey);
            if (!loginSet.isEmpty()) {
                for (Object key: loginSet) {
                    if (!key.equals(loginKey)) {
                        // 删除key
                        redisTemplate.delete(key);
                        // 推送消息到客户端
                        String sessionId = String.valueOf(key).split("-")[2];
                        simpMessagingTemplate.convertAndSendToUser(sessionId, "/queue/getResponse", "logout");
                    }
                }
            }
        }

        user.setSessionId(request.getRequestedSessionId());
        model.addAttribute("user", user);
        return "hello";
    }

nginx需要配置一下才能够支持websocket的通讯,http、https都可以
proxy_read_timeout 设置超时,避免websocket短时间内因为没有通讯就自动关闭

location /c/ {
        proxy_pass http://127.0.0.1:8002;
        # WebScoket Support
        proxy_http_version 1.1;
        proxy_read_timeout 3600s;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        ......
    }
websocket的通讯机制
http与websocket的区别

参考文献
https://blog.csdn.net/ouyzc/article/details/79884688
https://www.zhihu.com/question/20215561

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,442评论 25 707
  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,691评论 2 59
  • 下雨的夜最容易洗涤灵魂 雨夜 聆听下雨的声音, 是一种心灵的宣泄, 仰望雨滴滑落的一幕, 是一种情感上的解压, 心...
    擎晨马春燕阅读 186评论 0 1
  • 前两天,马丽也被卓伟拍到了恋情。被拍后,马丽微博大胆认爱,承认现在的恋情。 这张十指紧扣照不禁让人回想起之前沈腾与...
    疯二傻阅读 657评论 0 0
  • 由荤段子引发的“血案” 那天,莫小言在隔壁屋跟一群男同学谈笑晏宴的时候,阿城在自己的店里没吭声,沉默着擦拭着店里角...
    曹佑阅读 671评论 0 1