update 优化 统一补全代码注释

ruoyi-common/ruoyi-common-sse/src/main/java/org/dromara/common/sse/controller/SseController.java

@@ -26,7 +26,9 @@ public class SseController implements DisposableBean {
     private final SseEmitterManager sseEmitterManager;
 
     /**
-     * 建立 SSE 连接
+     * 建立当前登录用户的 SSE 连接。
+     *
+     * @return SSE 发射器
      */
     @GetMapping(value = "${sse.path}", produces = MediaType.TEXT_EVENT_STREAM_VALUE)
     public SseEmitter connect() {
@@ -39,7 +41,9 @@ public class SseController implements DisposableBean {
     }
 
     /**
-     * 关闭 SSE 连接
+     * 关闭当前登录用户的 SSE 连接。
+     *
+     * @return 操作结果
      */
     @SaIgnore
     @GetMapping(value = "${sse.path}/close")
@@ -78,7 +82,9 @@ public class SseController implements DisposableBean {
 //    }
 
     /**
-     * 清理资源。此方法目前不执行任何操作，但避免因未实现而导致错误
+     * 容器销毁时释放资源占位实现。
+     *
+     * @throws Exception 销毁异常
      */
     @Override
     public void destroy() throws Exception {

ruoyi-common/ruoyi-common-sse/src/main/java/org/dromara/common/sse/core/SseEmitterManager.java

@@ -116,7 +116,7 @@ public class SseEmitterManager {
     }
 
     /**
-     * SSE 心跳检测，关闭无效连接
+     * 执行 SSE 心跳检测并清理失效连接。
      */
     public void sseMonitor() {
         final SseEmitter.SseEventBuilder heartbeat = SseEmitter.event().comment("heartbeat");
@@ -154,7 +154,7 @@ public class SseEmitterManager {
     }
 
     /**
-     * 订阅SSE消息主题，并提供一个消费者函数来处理接收到的消息
+     * 订阅 SSE 广播主题消息。
      *
      * @param consumer 处理SSE消息的消费者函数
      */
@@ -163,7 +163,7 @@ public class SseEmitterManager {
     }
 
     /**
-     * 向指定的用户会话发送消息
+     * 向指定用户的全部本地 SSE 会话发送消息。
      *
      * @param userId  要发送消息的用户id
      * @param message 要发送的消息内容
@@ -189,7 +189,7 @@ public class SseEmitterManager {
     }
 
     /**
-     * 本机全用户会话发送消息
+     * 向当前节点所有 SSE 会话发送消息。
      *
      * @param message 要发送的消息内容
      */
@@ -200,7 +200,7 @@ public class SseEmitterManager {
     }
 
     /**
-     * 发布SSE订阅消息
+     * 发布 SSE 订阅消息。
      *
      * @param sseMessageDTO 要发布的SSE消息对象
      */
@@ -215,7 +215,7 @@ public class SseEmitterManager {
     }
 
     /**
-     * 向所有的用户发布订阅的消息(群发)
+     * 发布 SSE 广播消息。
      *
      * @param message 要发布的消息内容
      */

ruoyi-common/ruoyi-common-sse/src/main/java/org/dromara/common/sse/utils/SseMessageUtils.java

@@ -26,7 +26,7 @@ public class SseMessageUtils {
     }
 
     /**
-     * 向指定的SSE会话发送消息
+     * 向指定用户的 SSE 会话发送消息。
      *
      * @param userId  要发送消息的用户id
      * @param message 要发送的消息内容
@@ -39,7 +39,7 @@ public class SseMessageUtils {
     }
 
     /**
-     * 本机全用户会话发送消息
+     * 向当前节点上的所有 SSE 会话发送消息。
      *
      * @param message 要发送的消息内容
      */
@@ -51,7 +51,7 @@ public class SseMessageUtils {
     }
 
     /**
-     * 发布SSE订阅消息
+     * 发布 SSE 订阅消息。
      *
      * @param sseMessageDTO 要发布的SSE消息对象
      */
@@ -63,7 +63,7 @@ public class SseMessageUtils {
     }
 
     /**
-     * 向所有的用户发布订阅的消息(群发)
+     * 向所有用户发布 SSE 广播消息。
      *
      * @param message 要发布的消息内容
      */
@@ -75,7 +75,9 @@ public class SseMessageUtils {
     }
 
     /**
-     * 是否开启
+     * 判断 SSE 功能是否启用。
+     *
+     * @return 是否启用
      */
     public static Boolean isEnable() {
         return SSE_ENABLE;