程序包 net.sohelp.boot.admin.core.service.notice

类 NoticeWebSocket

java.lang.Object
net.sohelp.boot.admin.core.service.notice.NoticeWebSocket
@Component public class NoticeWebSocket extends Object
消息提醒 WebSocket
从以下版本开始:
2024/08/25
作者:
AaronFung

  • 构造器概要

    构造器
    构造器
    说明
    NoticeWebSocket()
     

  • 方法概要

    修饰符和类型
    方法
    说明
    void
    broadcastToAll(String action)
    向所有在线用户广播消息（谨慎使用）
    int
    getOnlineUserCount()
    获取当前在线用户数
    boolean
    isUserOnline(long userId)
    检查指定用户是否在线
    void
    onClose(jakarta.websocket.Session session)
    连接关闭调用的方法
    void
    onError(jakarta.websocket.Session session, Throwable error)
    发生错误时调用
    void
    onMessage(String message, jakarta.websocket.Session session)
    收到客户端消息后调用的方法
    void
    onOpen(jakarta.websocket.Session session, String action)
    连接建立成功调用的方法
    void
    pushAllToUser(long userId)
    向指定用户的所有在线终端推送所有类型的数据更新 包括未读消息数和未读消息列表，确保所有终端都能实时刷新
    void
    pushToUser(long userId, String action)
    向指定用户推送指定类型的消息
    void
    pushUnreadNoticeNumToUser(long userId)
    向指定用户推送未读消息数更新
    void
    pushUnreadNoticeToUser(long userId)
    向指定用户推送未读消息列表更新
    void
    sendToUser(long userId, String message)
    向指定用户的所有在线终端发送自定义消息 用户可能同时登录多个终端（PC、手机等），此方法确保每个终端都能收到消息

    从类继承的方法 java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 构造器详细资料

    • NoticeWebSocket

      public NoticeWebSocket()

  • 方法详细资料

    • onOpen

      public void onOpen(jakarta.websocket.Session session, String action)
      连接建立成功调用的方法

    • onClose

      public void onClose(jakarta.websocket.Session session)
      连接关闭调用的方法

    • onMessage

      public void onMessage(String message, jakarta.websocket.Session session)
      收到客户端消息后调用的方法
      参数:
      message - 客户端发送过来的消息

    • onError

      public void onError(jakarta.websocket.Session session, Throwable error)
      发生错误时调用

    • pushUnreadNoticeNumToUser

      public void pushUnreadNoticeNumToUser(long userId)
      向指定用户推送未读消息数更新
      参数:
      userId - 目标用户ID

    • pushUnreadNoticeToUser

      public void pushUnreadNoticeToUser(long userId)
      向指定用户推送未读消息列表更新
      参数:
      userId - 目标用户ID

    • pushToUser

      public void pushToUser(long userId, String action)
      向指定用户推送指定类型的消息
      参数:
      userId - 目标用户ID
      action - 推送动作类型

    • sendToUser

      public void sendToUser(long userId, String message)
      向指定用户的所有在线终端发送自定义消息 用户可能同时登录多个终端（PC、手机等），此方法确保每个终端都能收到消息
      参数:
      userId - 目标用户ID
      message - 要发送的消息内容（JSON字符串）

    • pushAllToUser

      public void pushAllToUser(long userId)
      向指定用户的所有在线终端推送所有类型的数据更新 包括未读消息数和未读消息列表，确保所有终端都能实时刷新
      参数:
      userId - 目标用户ID

    • broadcastToAll

      public void broadcastToAll(String action)
      向所有在线用户广播消息（谨慎使用）
      参数:
      action - 推送动作类型

    • getOnlineUserCount

      public int getOnlineUserCount()
      获取当前在线用户数
      返回:
      在线用户数量

    • isUserOnline

      public boolean isUserOnline(long userId)
      检查指定用户是否在线
      参数:
      userId - 用户ID
      返回:
      是否在线