Java/WebSocket的实现

项目开发过程中需要实现一个由服务端主动发送数据至客户端的小功能，简单学习了WebSocket，在此记录一下WebSocket在JavaWeb项目中的实现。

需要添加的依赖

<dependency>
        <groupId>javax</groupId>
        <artifactId>javaee-api</artifactId>
        <version>7.0</version>
        <scope>provided</scope>
</dependency>

前端代码

var websocket = null;
    //判断当前浏览器是否支持WebSocket
    if ('WebSocket' in window) {
        websocket = new WebSocket("ws://localhost:8080/webSocket/1");
    }
    else {
        alert('当前浏览器 Not support websocket');
    }

    //连接发生错误的回调方法
    websocket.onerror = function () {
        alert("WebSocket连接发生错误");
    };

    //连接成功建立的回调方法
    websocket.onopen = function () {
        alert("WebSocket连接成功");
    };

    //接收到消息的回调方法
    websocket.onmessage = function (event) {
        alert(event.data);
    //收到数据后的其他操作
    };

    //连接关闭的回调方法
    websocket.onclose = function () {
        alert("WebSocket连接关闭");
    };

    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
    window.onbeforeunload = function () {
        closeWebSocket();
    };

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

    //关闭WebSocket连接
    function closeWebSocket() {
        websocket.close();
    }

    //发送消息
    function send() {
        var message = document.getElementById('text').value;
        websocket.send(message);
    }

后端代码

import java.io.IOException;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;

/**
 * WebSocket
 * @author 
 */
@ServerEndpoint("/webSocket/{id}")//与前端路径保持一致，其中id为标识
public class WebSocket {
    /**
     * 静态变量 用来记录当前在线连接数
     */
    private static int onlineCount = 0;

    /**
     * 服务端与单一客户端通信 使用Map来存放 其中标识Key为id
     */
    private static ConcurrentMap<Integer,WebSocket> webSocketMap = new ConcurrentHashMap<>();
    //不需要区分可使用set
    //private static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();

    public static ConcurrentMap<Integer, WebSocket> getWebSocketMap() {
        return webSocketMap;
    }
    /**
     * 与某个客户端的连接会话 需要通过它来给客户端发送数据
     */
    private Session session;

    /**
     * 连接建立成功调用的方法
     * @param session 可选的参数 session为与某个客户端的连接会话 需要通过它来给客户端发送数据
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("id")Integer id){
        this.session = session;

        webSocketMap.put(id,this);

        addOnlineCount();
        System.out.println("有新连接加入，当前在线数为" + getOnlineCount());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(){
        Map<String, String> map = session.getPathParameters();
        webSocketMap.remove(Integer.parseInt(map.get("id")));

        subOnlineCount();
        System.out.println("有一连接关闭！当前在线数为" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     * @param session 可选的参数
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("来自客户端的消息:" + message);

        //群发消息
        Set<Integer> keys = webSocketMap.keySet();
        for(Integer key: keys){
            try {
                webSocketMap.get(key).sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
                continue;
            }
        }
    }

    /**
     * 发生错误时调用
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error){
        System.out.println("WebSocket发生错误");
        error.printStackTrace();
    }

    /**
     * 这个方法与上面几个方法不一样。没有用注解，是根据自己需要添加的方法。
     * @param message
     * @throws IOException
     */
    public void sendMessage(String message) throws IOException{
        //如果需要传送bean，可转成json字符串
        this.session.getBasicRemote().sendText(message);
    }

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

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

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

项目中的调用

WebSocket webSocket = WebSocket.getWebSocketMap().get(id);
webSocket.sendMessage(msg);