怎么利用spring boot+WebSocket实现后台主动消息推送功能

这篇文章主要讲解了"怎么利用spring boot+WebSocket实现后台主动消息推送功能"，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习"怎么利用spring boot+WebSocket实现后台主动消息推送功能"吧！

前言：

使用此webscoket务必确保生产环境能兼容/支持！使用此webscoket务必确保生产环境能兼容/支持！使用此webscoket务必确保生产环境能兼容/支持！主要是tomcat的兼容与支持。

有个需求：

APP用户产生某个操作，需要让后台管理系统部分人员感知（表现为一个页面消息）。

最早版本是后台管理系统轮训，每隔一段时间轮训一次，由于消息重要，每隔几秒就查一次。这样做明显很不雅！会消耗大量资源，并且大部分请求是没有用的（查不到数据进来），很蓝瘦。

后来，想着用消息推送的方式来处理这个逻辑。用户在app产生了目标操作，即产生一个消息，推送给后台管理系统的对应用户。

然后我就找各种资料，一开始同事推荐dwz，后来发现不太适用于目前的项目（也许能实现只是我不知道如何实现）。

后来了解到WebSocket，网上看了很多文档都是类似聊天室的场景，有些不同。在此，我主要侧重介绍下 服务器主动推送，由服务端来触发。

WebSocket 主要能实现的场景：

1、网页聊天室

2、服务器消息实时通知

WebSocket 使用方法应该有很多，在次介绍下使用 tomcat8+h6 环境下的实现。

话不多说，直接上代码，想深入了解WebSocket 的请查阅相关介绍。

1.pom

                org.springframework.boot            spring-boot-starter-websocket        

2. 使用@ServerEndpoint创立websocket endpoint

@Configurationpublic class WebSocketConfig {    @Bean    public ServerEndpointExporter serverEndpointExporter() {        return new ServerEndpointExporter();    }}

3.具体实现类 可自己选择url要不要带参数

package com.star.manager.service;import java.io.IOException;import java.util.concurrent.CopyOnWriteArraySet;import javax.websocket.OnClose;import javax.websocket.OnError;import javax.websocket.OnMessage;import javax.websocket.OnOpen;import javax.websocket.Session;import javax.websocket.server.ServerEndpoint;import lombok.extern.slf4j.Slf4j;import org.springframework.stereotype.Component;@Slf4j//@ServerEndpoint("/websocket/{user}")@ServerEndpoint(value = "/websocket")@Componentpublic class WebSocketServer {    //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。    private static int onlineCount = 0;    //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。    private static CopyOnWriteArraySet webSocketSet = new CopyOnWriteArraySet();    //与某个客户端的连接会话，需要通过它来给客户端发送数据    private Session session;    /**     * 连接建立成功调用的方法*/    @OnOpen    public void onOpen(Session session) {        this.session = session;        webSocketSet.add(this);     //加入set中        addOnlineCount();           //在线数加1        log.info("有新连接加入！当前在线人数为" + getOnlineCount());        try {             sendMessage("连接成功");        } catch (IOException e) {            log.error("websocket IO异常");        }    }    //    //连接打开时执行    //    @OnOpen    //    public void onOpen(@PathParam("user") String user, Session session) {    //        currentUser = user;    //        System.out.println("Connected ... " + session.getId());    //    }     /**     * 连接关闭调用的方法     */    @OnClose    public void onClose() {        webSocketSet.remove(this);  //从set中删除        subOnlineCount();           //在线数减1        log.info("有一连接关闭！当前在线人数为" + getOnlineCount());    }     /**     * 收到客户端消息后调用的方法     *     * @param message 客户端发送过来的消息*/    @OnMessage    public void onMessage(String message, Session session) {        log.info("来自客户端的消息:" + message);         //群发消息        for (WebSocketServer item : webSocketSet) {            try {                item.sendMessage(message);            } catch (IOException e) {                e.printStackTrace();            }        }    }     /**     *      * @param session     * @param error     */    @OnError    public void onError(Session session, Throwable error) {        log.error("发生错误");        error.printStackTrace();    }     public void sendMessage(String message) throws IOException {        this.session.getBasicRemote().sendText(message);    }     /**     * 群发自定义消息     * */    public static void sendInfo(String message) throws IOException {        log.info(message);        for (WebSocketServer item : webSocketSet) {            try {                item.sendMessage(message);            } catch (IOException e) {                continue;            }        }    }     public static synchronized int getOnlineCount() {        return onlineCount;    }     public static synchronized void addOnlineCount() {        WebSocketServer.onlineCount++;    }     public static synchronized void subOnlineCount() {        WebSocketServer.onlineCount--;    }}

产生一个消息：产生消息场景有多种，http（s），定时任务，mq等，这贴一个httpq请求的controller代码

     @RequestMapping(value="/pushVideoListToWeb",method=RequestMethod.POST,consumes = "application/json")     public @ResponseBody Map pushVideoListToWeb(@RequestBody Map param) {         Map result =new HashMap();         try {             WebSocketServer.sendInfo("有新客户呼入,sltAccountId:"+CommonUtils.getValue(param, "sltAccountId"));             result.put("operationResult", true);         }catch (IOException e) {             result.put("operationResult", true);         }         return result;     }

重要的地方我都加粗了，主要是这段，使用这个方法，可以实现服务器主动推送。

    public void sendMessage(String message) throws IOException {        this.session.getBasicRemote().sendText(message);    }

4.js（html就不写了，随便找个能触发这个js的就可以）

//socket = new WebSocket("ws://localhost:9094/starManager/websocket/张三");        var socket;        if(typeof(WebSocket) == "undefined") {            console.log("您的浏览器不支持WebSocket");        }else{            console.log("您的浏览器支持WebSocket");                        //实现化WebSocket对象，指定要连接的服务器地址与端口  建立连接            //socket = new WebSocket("ws://localhost:9094/starManager/websocket/张三")

            socket = new WebSocket("ws://localhost:9094/starManager/websocket");            //打开事件            socket.onopen = function() {                console.log("Socket 已打开");                //socket.send("这是来自客户端的消息" + location.href + new Date());            };            //获得消息事件            socket.onmessage = function(msg) {                console.log(msg.data);                //发现消息进入    调后台获取                getCallingList();            };            //关闭事件            socket.onclose = function() {                console.log("Socket已关闭");            };            //发生了错误事件            socket.onerror = function() {                alert("Socket发生了错误");            }             $(window).unload(function(){                  socket.close();                }); //                                    $("#btnSend").click(function() {//                                        socket.send("这是来自客户端的消息" + location.href + new Date());//                                    });////                                    $("#btnClose").click(function() {//                                        socket.close();//                                    });        }

简单说说：

通过前端代码

socket = new WebSocket("ws://localhost:9094/starManager/websocket");

其中，starManager是工程名，/webscoket是访问路径名

建立连接，前端调用scoket.open() 会使后台在静态成员变量webSocketSet里面增加一个元素，相当于一个缓存。后台服务调用sendMessage

（指定某个用户，定向）或sendInfo（遍历webSocketSet逐个发送，类似群发）方法，即可向已登录的客户端推送消息。

代码就这么多。我的用这些代码就跑的起来。做的时候出现过页面报404等错误，如果也是spring boot+h6，仔细核对下和我代码有无区别，加配置 路径是有ok，问题应该不大。

感谢各位的阅读，以上就是"怎么利用spring boot+WebSocket实现后台主动消息推送功能"的内容了，经过本文的学习后，相信大家对怎么利用spring boot+WebSocket实现后台主动消息推送功能这一问题有了更深刻的体会，具体使用情况还需要大家实践验证。这里是，小编将为大家推送更多相关知识点的文章，欢迎关注！