Spring boot websocket消息推送

    **刚接触spring boot，用它做了一个websocket消息推送**

1.首先需要的jar包：spring-websocket-4.2.6.RELEASE.jar，
2.配置maven环境：pom.xml

<dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-websocket</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-messaging</artifactId>
    </dependency>

这里只贴出了需要加入的依赖jar

3.在spring boot启动的时候需要开启websocket，这里是模板class：WebSocketConfig.java 需要实现WebSocketConfigurer接口（java后端代码）

1. WebSocketConfig.java

import org.springframework.context.annotation.Configuration;

import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

import com.dhc.controller.WebSocketHander;
import com.dhc.intercep.HandshakeInterceptor;

@Configuration
@EnableWebSocket//开启websocket,使用注解，在Spring boot的run()之后会加载websocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new WebSocketHander(),"/veg").addInterceptors(new HandshakeInterceptor()); //支持websocket 的访问链接
        registry.addHandler(new WebSocketHander(),"/com/veg").addInterceptors(new HandshakeInterceptor()).withSockJS(); //不支持websocket的访问链接
    }
}

2.拦截器：HandshakeInterceptor 用来client的请求在被处理前拦截

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 javax.servlet.http.HttpSession;
import java.util.Map;

public class HandshakeInterceptor implements org.springframework.web.socket.server.HandshakeInterceptor {

    //进入hander之前的拦截
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Map<String, Object> map) throws Exception {
        if (request instanceof ServletServerHttpRequest) {
            ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
            HttpSession session = servletRequest.getServletRequest().getSession(false);
            if (session != null) {
                 System.out.println("session是否为空"+(session != null));
                //获取客户端的名称，以便可以定向的向某个客户端推送消息
//                String userName = (String) session.getAttribute("WEBSOCKET_USERNAME");
                map.put("WEBSOCKET_USERNAME",userName);
            }
        }
        return true;
    }

    @Override
    public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {

    }
}

3、 保持与client连接和发送消息给client:WebSocketHander.java需要实现WebSocketHandler接口（说明：如果你的项目中没有配置slf4j，请使用log4j的日志输出，需要导入log4j-1.2.17.jar，并配置它）

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.socket.*;
import java.io.IOException;
import java.nio.CharBuffer;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;

public class WebSocketHander implements WebSocketHandler {

    private static Logger logger = LoggerFactory.getLogger(WebSocketHander.class);
    private static final ArrayList<WebSocketSession> users = new ArrayList<>();

    //client第一次连接服务端时执行
    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        logger.debug("连接成功......");
        users.add(session);
        String userName = (String) session.getAttributes().get("WEBSOCKET_USERNAME");
        logger.debug("userName="+userName);
        if(userName!= null){
            int count = 5;
            session.sendMessage(new TextMessage(count + ""));
        }
    }
    //接受客户端的请求处理，这里可以指定方法是给所以在线的client推送消息还是给某个特定的client推送(区别:方法的参数列表)
    @Override
    public void handleMessage(WebSocketSession webSocketSession, WebSocketMessage<?> webSocketMessage) throws Exception {
        sendMessageToUsers(new TextMessage(webSocketMessage.getPayload() + ""));
    }

    @Override
    public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) throws Exception {
        if(webSocketSession.isOpen()){
            webSocketSession.close();
        }
        logger.debug("连接出错，关闭连接......");
        users.remove(webSocketSession);
    }

    @Override
    public void afterConnectionClosed(WebSocketSession webSocketSession, CloseStatus closeStatus) throws Exception {
        logger.debug("连接关闭......" + closeStatus.toString());
        users.remove(webSocketSession);
    }

    @Override
    public boolean supportsPartialMessages() {
        return false;
    }
    /**
     * 给所有在线client发送消息
     *这里的message是client推送给服务端的请求信息，这里假设服务器推     送系统当前时间给client，忽略client传过来的消息，当然你也可以自己处理这个message
     * @param message
     */
    public void sendMessageToUsers(TextMessage message) {
        for (WebSocketSession user : users) {
            try {
                if (user.isOpen()) {
                    System.out.println("msg="+getTime());
                    user.sendMessage(getTime());
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
    /**
     * 获取系统当前时间并转换为TextMessage
     * @return
     */
public TextMessage getTime(){
    Date date = new Date();
    SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    String time =  format.format(date);
     CharBuffer temp=CharBuffer.wrap("系统当前时间："+time);
     TextMessage msg = new TextMessage(temp);
    return msg;
}

    /**
     * 给某个client发送消息
     *
     * @param userName
     * @param message
     */
    public void sendMessageToUser(String userName, TextMessage message) {
        for (WebSocketSession user : users) {
            if (user.getAttributes().get("WEBSOCKET_USERNAME").equals(userName)) {
                try {
                    if (user.isOpen()) {
                        user.sendMessage(getTime());
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
                break;
            }
        }
    }
}

客户端的代码:不全部贴代码，核心部分贴出来

（1）先要导入 （注意js路径）

<script type="text/javascript" src="/js/sockjs-0.3.min.js"></script>

（2）jquery处理websocket：

<script type="text/javascript">
        $(function(){
            var websocket;
            if ('WebSocket' in window) {
                alert("WebSocket");
                websocket = new WebSocket("ws://localhost:8081/veg");
            } else if ('MozWebSocket' in window) {
                alert("MozWebSocket");
                websocket = new MozWebSocket("ws://veg");
            } else {
                alert("SockJS");
                websocket = new SockJS("http://localhost:8081/com/veg");
            }
            websocket.onopen = function (evnt) {
                $("#head").html("连接服务器成功!")
                 send();
            };
            websocket.onmessage = function (evnt) {
                $("#msg").html($("#msg").html() + "<br/>" + evnt.data);
            };
            websocket.onerror = function (evnt) {
            };
            websocket.onclose = function (evnt) {
                $("#head").html("与服务器断开了链接!")
            }
            function send(){
                if (websocket != null) {

                    websocket.send("客户端请求");
                } else {
                    alert('未与服务器链接.');
                }
            }
        });
    </script>

（3）显示消息的DIV

<div  id="head">
    webSocket消息推送
</div>
<div  id="msg">
</div>

5、这样一个简单的Spring boot websocket消息推送就完成了，个别代码可能会出现中文符号（特别是jquery中）