Spring-websocket 服务器端点代码学习笔记_concurrent包的线程安全set,用来存放每个客户端对应的websocket对象-CSDN博客

本文链接：https://blog.csdn.net/qq_70143756/article/details/130999804

项目源码地址

Spring-websocket: Spring boot整合websocket实现即时通讯 (gitee.com)

@ServerEndpoint("/webSocket/{username}")
@Component
public class WebSocketServer {
	 //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
    private static AtomicInteger onlineNum = new AtomicInteger();

    //concurrent包的线程安全Set，用来存放每个客户端对应的WebSocketServer对象。
    private static ConcurrentHashMap<String, Session> sessionPools = new ConcurrentHashMap<>();

    //发送消息
    public void sendMessage(Session session, String message) throws IOException {
        if(session != null){
            synchronized (session) {
                System.out.println("发送数据：" + message);
                session.getBasicRemote().sendText(message);
            }
        }
    }
    //给指定用户发送信息
    public void sendInfo(String userName, String message){
        Session session = sessionPools.get(userName);
        try {
            sendMessage(session, message);
        }catch (Exception e){
            e.printStackTrace();
        }
    }
    // 群发消息
    public void broadcast(String message){
    	for (Session session: sessionPools.values()) {
            try {
                sendMessage(session, message);
            } catch(Exception e){
                e.printStackTrace();
                continue;
            }
        }
    }

    //建立连接成功调用
    @OnOpen
    public void onOpen(Session session, @PathParam(value = "username") String userName){
        sessionPools.put(userName, session);
        addOnlineCount();
        System.out.println(userName + "加入webSocket！当前人数为" + onlineNum);
        // 广播上线消息
        Message msg = new Message();
        msg.setDate(new Date());
        msg.setTo("0");
        msg.setText(userName);
        broadcast(JSON.toJSONString(msg,true));
    }

    //关闭连接时调用
    @OnClose
    public void onClose(@PathParam(value = "username") String userName){
        sessionPools.remove(userName);
        subOnlineCount();
        System.out.println(userName + "断开webSocket连接！当前人数为" + onlineNum);
        // 广播下线消息
        Message msg = new Message();
        msg.setDate(new Date());
        msg.setTo("-2");
        msg.setText(userName);
        broadcast(JSON.toJSONString(msg,true));
    }

    //收到客户端信息后，根据接收人的username把消息推下去或者群发
    // to=-1群发消息
    @OnMessage
    public void onMessage(String message) throws IOException{
        System.out.println("server get" + message);
        Message msg=JSON.parseObject(message, Message.class);
		msg.setDate(new Date());
		if (msg.getTo().equals("-1")) {
			broadcast(JSON.toJSONString(msg,true));
		} else {
			sendInfo(msg.getTo(), JSON.toJSONString(msg,true));
		}
    }

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

    public static void addOnlineCount(){
        onlineNum.incrementAndGet();
    }

    public static void subOnlineCount() {
        onlineNum.decrementAndGet();
    }
    
    public static AtomicInteger getOnlineNumber() {
        return onlineNum;
    }
    
    public static ConcurrentHashMap<String, Session> getSessionPools() {
        return sessionPools;
    }
}

`@ServerEndpoint` 是Java WebSocket API中的一个注解。它用于将类描述为WebSocket服务器端点，该类表示为WebSocket API客户端将连接到的端点。

以下是 `@ServerEndpoint` 的用法和示例：

1. 导入 `javax.websocket.*;` 和 `javax.websocket.server.*;` 包

2. 创建一个Java类，并添加 `@ServerEndpoint` 注释。
    import javax.websocket.OnMessage;
    import javax.websocket.OnOpen;
    import javax.websocket.Session;
    import javax.websocket.server.ServerEndpoint;

    @ServerEndpoint("/endpoint")
    public class MyEndpoint {

        @OnOpen
        public void onOpen(Session session) {
            System.out.println("Connected!!!");
        }

        @OnMessage
        public void onMessage(Session session, String message) {
            session.getAsyncRemote().sendText(message);
        }
    }
3. 在 `@ServerEndpoint` 中指定访问服务器端点所需的 URL。
   @ServerEndpoint("/myendpoint")
4. 定义处理来自客户端的消息的方法。
//@OnMessage：当收到消息时触发。
    @OnMessage
    public void handleMessage(String message, Session session) {
        // code to handle received message
    }
5. 可以定义在客户端连接到服务器端点时要执行的操作。
//@OnOpen：当客户端连接到服务器端点时触发。

    @OnOpen    
    public void onConnectionOpen(Session session){
        // code to be executed when a client opens a connection
    }
除了 `@OnOpen` 和 `@OnMessage` 注解之外，还有其他许多用于WebSocket端点的注解。以上仅是一些基本功能的示例。

session.getBasicRemote() 是 Java WebSocket API 提供的一个方法，用于获取与客户端的基本通信功能句柄。

WebSocket 通信是基于会话（Session）的，当客户端和服务器建立连接后，WebSocket API 会创建一个会话（Session），并向客户端发送一个握手请求。如果客户端同意握手协议，则将启动与客户端之间的持久连接，并生成一个唯一的 Session 对象。

在 Session 对象上，我们可以进行与客户端通信的操作。其中 session.getBasicRemote() 就是获取与客户端的基本通信功能句柄。

该句柄提供了一些默认实现，以简化消息发送等常见任务。例如：

sendText(String text)：发送纯文本消息。
sendBinary(ByteBuffer data)：发送二进制数据。
sendObject(Object data)：发送序列化对象。
sendPing(ByteBuffer applicationData)：发送 ping 消息。

同时也提供了以下子接口：

getBatchingAllowed()：返回一个布尔值，表明批处理是否启用。
getSendStream()：返回一个 Binary 通信句柄，用于发送二进制数据流。
getSendWriter()：返回一个 Text 通信句柄，用于发送文本类型数据的输出字符流。

值得注意的是，由于此方法可能将抛出 I/O 异常，因此需要捕获或声明此类异常。在使用 session.getBasicRemote() 方法前，需要对异常自行进行处理或抛出。

AtomicInteger是个支持原子操作的Integer类，就是保证对AtomicInteger类型变量的增加和减少操作是原子性的，不会出现多个线程下的数据不一致问题。

        if(session != null){
            synchronized (session) {
                System.out.println("发送数据：" + message);
                session.getBasicRemote().sendText(message);
            }
        }
这段代码是使用synchronized关键字对session对象进行加锁，保证多线程下操作session对象的线程安全性，从而避免出现竞态条件。

在synchronized块内，先输出一行日志，然后通过session对象的getBasicRemote()方法获取到用于发送消息的远程终端(RemoteEndpoint)，然后调用其sendText方法，将消息发送出去。

这段代码的作用是在保证线程安全的前提下，向会话(session)中发送消息(message)。在多线程的情况下，通过使用synchronized关键字，只有一个线程可以操作session对象，避免了操作混乱的问题。同时，通过将会话对象和发送数据的操作放在一起，使得代码更加简洁明了。