Java WebSocket

Posted 2020-12-26 一直在路上行走

本示例的目的，就是通过webSocket向客户端（浏览器端）发送消息.

 

一、什么是WebSocket

 

　　WebSocket协议是基于TCP的一种新的网络协议。它实现了浏览器与服务器全双工(full-duplex)通信——允许服务器主动发送信息给客户端。

WebSocket通信协议于2011年被IETF定为标准RFC 6455，并被RFC7936所补充规范。

 

二、通过Java代码实现从服务端发消息给客户端

 

三、环境说明

　　java1.7、apache-tomcat-7.0.78、maven

　　依赖

　　<dependency>
    　　<groupId>javax</groupId>
    　　<artifactId>javaee-api</artifactId>
    　　<version>7.0</version>
    　　<scope>provided</scope>
　　</dependency>
四、代码

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

/**
 * @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
 * 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
 */
@ServerEndpoint("/websocket/{userId}")
public class NoticeWebSocket {
    //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
    private static int onlineCount = 0;

    //concurrent包的线程安全map，用来存放每个客户端对应的NoticeWebSocket对象
    private static ConcurrentMap<String, NoticeWebSocket> webSocketSet = new ConcurrentHashMap<String, NoticeWebSocket>();

    //与某个客户端的连接会话，需要通过它来给客户端发送数据
    private Session session;

    /**
     * 连接建立成功调用的方法
     *
     * @param session 可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
     */
    @OnOpen
    public void onOpen(@PathParam(value = "userId") String userId, Session session) {
        this.session = session;
        webSocketSet.put(userId, this);     //加入set中
        addOnlineCount();                   //在线数加1
        System.out.println("有新连接加入！当前在线人数为" + getOnlineCount());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(@PathParam(value = "userId") String userId) {
        webSocketSet.remove(userId);    //从set中删除
        subOnlineCount();               //在线数减1
        System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息
     * @param session 可选的参数
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        System.out.println("来自客户端的消息:" + message);
        //群发消息
        for (Map.Entry entry : webSocketSet.entrySet()) {
            try {
                NoticeWebSocket item = (NoticeWebSocket) entry.getValue();
                item.sendMessage(message);
            } catch (IOException e) {
                e.printStackTrace();
                continue;
            }
        }
    }

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

    /**
     * 这个方法与上面几个方法不一样。没有用注解，是根据自己需要添加的方法。
     *
     * @param message
     * @throws IOException
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
        //this.session.getAsyncRemote().sendText(message);
    }

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

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

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

    public static ConcurrentMap<String, NoticeWebSocket> getWebSocketSet() {
        return webSocketSet;
    }

    public static void setWebSocketSet(ConcurrentMap<String, NoticeWebSocket> webSocketSet) {
        NoticeWebSocket.webSocketSet = webSocketSet;
    }
}

页面Js

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

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

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

    //接收到消息的回调方法
    websocket.onmessage = function (event) {
        setMessageInnerHTML(event.data);
    }

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

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

    //将消息显示在网页上
    function setMessageInnerHTML(innerHTML) {
        console.log(innerHTML);
    }

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

    //发送消息
    function send() {
        var message = "牛。。";
        websocket.send(message);
    }

测试

我是用了SpringMvc 写了一个Controller

/**
     * 发送消息给当前登录人 TEST
     *
     * @return
     */
    @RequestMapping(value = "/free/sendMessageTest", method = RequestMethod.GET)
    @ResponseBody
    public Map<String, Object> sendMessageTest(String userId) {
        Map<String, Object> map = new HashMap<String, Object>();
        ConcurrentMap<String, NoticeWebSocket> noticeWebSockets = NoticeWebSocket.getWebSocketSet();
        try {
            map.put("status", 0);
            NoticeWebSocket noticeWebSocket = noticeWebSockets.get(userId);
            if (null != noticeWebSocket) {
                noticeWebSocket.sendMessage("牛逼Class UserId=" + userId);
            }
        } catch (IOException e) {
            e.printStackTrace();
            map.put("status", -1);
        }
        return map;
    }

 

说明 

websocket = new WebSocket("ws://localhost:8080/websocket/xxx"); xxx 代表一个用户唯一标识，当页面加载这段Js时会和服务端建立连接调用后端onOpen(String userId)方法会把"xxx"
传到后台去，然后用map保存，userId 就是key,登录的session 就是value。（如果有多个页面访问就会有多个session）,我这里之所有用ConcurrentMap 是因为它是线程安全的。