Websocket封装 ¶

功能 ¶

提供原生Websocket 和 SpringWebsocker的连接管理器，支持一个用户同时可以进行多个请求连接
可以配置使Websocket只有登录状态下才可以连接
提供多种到前台的通知方式，如通知框消息，事件通知等
提供用户全局级别的Websocket 服务，方便ws消息推送
前端封装用户全局消息通知的Websocket和对应的事件总线，通过监听指定事件，可以实现将前台消息推送到不同的页面中

使用说明 ¶

TIP

在使用前，需要登录Web管理后台，在系统配置中系统参数里配置 websocket服务器地址。

说明 ¶

系统中使用Websocket推送消息的场景主要有两种，一种是在用户登录的情况下进行推送，一种是在用户未登录的情况下推送。

在用户未登录情况下使用时，一般需要开发者在前后端约定一种通信sessionId的生成方式，来实现双方的通信。而在用户登录情况下进行通信时，一般是使用用户的token作为sessionId，在有些安全性要求比较高的场合，需要校验用户的合法性，通过Spring Websocket提供的能力，使用Spring拦截机制，对连接进行校验用户的合法性。

普通连接 ¶

可以通过javaEE方式或Spring Websocket方式创建一个方法类，然后在选择对应SpringWebSocketSessionManager或WebSocketSessionManager一个作为会话管理器，这两个会话管理器提供了新建、删除会话的管理，以及会话id与用户标识id之间的关联关系。

演示类，见系统中WebSocketDemo。通过WsRes工具类,可以便捷的创建WsResultwebsocket响应消息类

java

/**
 * websocket demo
 *
 * @author xxm
 * @date 2022/3/27
 */
@Slf4j
@Component
@ServerEndpoint("/test/ws/{userId}")
public class WebSocketDemo {

    private final WebSocketSessionManager wsManager = new WebSocketSessionManager();

    /** 记录当前在线连接数 */
    private static final AtomicInteger onlineCount = new AtomicInteger(0);

    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(@PathParam("userId") Long userId, Session session) {
        wsManager.addSession(String.valueOf(userId), session);
        onlineCount.incrementAndGet(); // 在线数加1
        log.info("有新连接加入：{}，当前在线人数为：{}", userId, onlineCount.get());
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        onlineCount.decrementAndGet(); // 在线数减1
        String userId = wsManager.getIdBySession(session);
        wsManager.removeSession(session);
        log.info("有一连接关闭：{}，当前在线人数为：{}", userId, onlineCount.get());
    }

    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        Long userId = Long.valueOf(wsManager.getIdBySession(session));
        log.info("服务端收到客户端[{}]的消息:{}", userId, message);
        this.sendMessage("响应: " + message, userId);
    }

    @OnError
    public void onError(Session session, Throwable error) {
        log.error("{} 发生错误", session.getId());
        error.printStackTrace();
    }

    /**
     * 服务端发送消息给客户端(单发)
     */
    public void sendMessage(String message, Long userId) {
        try {
            List<Session> sessions = wsManager.getSessionsById(String.valueOf(userId));

            for (Session session : sessions) {
                session.getBasicRemote().sendText(message);
            }
        }
        catch (Exception e) {
            log.error("服务端发送消息给客户端失败：", e);
        }
    }

    /**
     * 服务端发送消息给客户端(全发)
     */
    public void sendMessage(String message) {
        try {
            List<Session> sessions = wsManager.getSessions();
            for (Session session : sessions) {
                session.getBasicRemote().sendText(message);
            }
        }
        catch (Exception e) {
            log.error("服务端发送消息给客户端失败：", e);
        }
    }

}

授权连接 ¶

通常异步事件执行完成，或者接收到了新消息，会主动通知到对应的用户，对于这个场景，前提要求就是需要用户进行登录，因为websocket默认是没有提供登录鉴权一系列的能力，所以只能我们自己进行了实现。目前是提供了UserWsNoticeService服务，通过调用它来对用户进行消息的推送，在用户登陆后会自动连接它，退出后后端也会断掉此用户所有的连接。

使用示例注入UserWsNoticeService服务，调用对应方法进行消息的推送，通过WsRes工具类,可以便捷的创建WsResultwebsocket响应消息类