使用spring boot +WebSocket实现（后台主动）消息推送 (一)

最近有一个优化需求，将浏览器轮询获取后台消息改成实时获取并且不轮询，轮询太膈应了。

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

后来了解到WebSocket，网上看了很多文档都是类似聊天室的场景，并不适用。在此，我主要介绍下 服务器主动推送，由服务端来触发而不是浏览器端发起。

WebSocket 主要能实现的场景：

1、网页聊天室

2、服务器消息实时通知

WebSocket 使用方法应该有很多，在次介绍下使用  spring boot（集成了tomcat8）+h5 环境下的实现。

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

1.pom

<dependency>
           <groupId>org.springframework.bootgroupId>
           <artifactId>spring-boot-starter-websocketartifactId>
       dependency>

2. 使用@ServerEndpoint创立websocket endpoint

@Configuration
public 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")
@Component
public 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 {
    }
    }

    public static synchronized int getOnlineCount() {
        return onlineCount;
    }

    public static synchronized void addOnlineCount() {
        WebSocketServer.onlineCount++;
    }

    public static synchronized void subOnlineCount() {
        WebSocketServer.onlineCount--;
    }
}

后台触发有多种，controller，定时任务，mq等，这贴一个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);
}

简单说说：

当有新连接进来，记录在静态成员变量webSocketSet里面，相当于一个缓存。后台服务调用sendMessage或sendInfo方法，即可向已登录的客户端推送消息。

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();
//                                  });
        }

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

如果你恰好也有可以用WebSocket实现的类似场景，希望对你有帮助。我实现的这个功能，当然也是网上看资料学习的，得到很多同行的帮助，在次只是整理下，突出主动推送也能实现（之前认为这个只能实现聊天室），再次感谢帮助过我的

同行们，祝你们在写bug路上，越走越远。。。