✨ feat(websocket): 支持事务感知的异步消息推送

实现了在事务中推送 WebSocket 消息的功能，确保在事务提交后再发送消息，避免客户端在查询数据库时看到未提交的变更。新增了 executeAfterTransaction 方法来处理事务同步，优化了私聊和群聊消息的发送逻辑。

✨ feat(websocket): 支持事务感知的异步消息推送
实现了在事务中推送 WebSocket 消息的功能，确保在事务提交后再发送消息，避免客户端在查询数据库时看到未提交的变更。新增了 executeAfterTransaction 方法来处理事务同步，优化了私聊和群聊消息的发送逻辑。
YunaiV
1 parent 736a1a2f
Showing 1 changed file with 59 additions and 5 deletions
yudao-module-im/yudao-module-im-biz/src/main/java/cn/iocoder/yudao/module/im/service/websocket/ImWebSocketServiceImpl.java
 package cn.iocoder.yudao.module.im.service.websocket;
+import cn.hutool.extra.spring.SpringUtil;
 import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
 import cn.iocoder.yudao.framework.websocket.core.sender.WebSocketMessageSender;
 import cn.iocoder.yudao.module.im.service.websocket.dto.ImGroupMessageDTO;
@@ -8,11 +9,17 @@ import jakarta.annotation.Resource;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.scheduling.annotation.Async;
 import org.springframework.stereotype.Service;
+import org.springframework.transaction.support.TransactionSynchronization;
+import org.springframework.transaction.support.TransactionSynchronizationManager;
 import java.util.Collection;
+// TODO @芋艿：后续要分析下，是不是要拆分下 notify（类似好友、群的变更）
 /**
  * IM WebSocket 推送 Service 实现类
+ * <p>
+ * 当调用方处于事务中时，推送会延迟到事务提交后再异步执行，
+ * 避免客户端收到 WebSocket 消息时数据库变更尚未可见。
  *
  * @author 芋道源码
  */
@@ -23,28 +30,75 @@ public class ImWebSocketServiceImpl implements ImWebSocketService {
     @Resource
     private WebSocketMessageSender webSocketMessageSender;
-    @Async
     @Override
     public void sendPrivateMessageAsync(Long userId, ImPrivateMessageDTO dto) {
+        // 说明：通过 executeAfterCommitOrNow 保证事务提交后再推送，避免客户端收到消息后查询数据库时事务尚未提交
+        // 通过 getSelf() 获取 Spring 代理对象调用 @Async 方法，确保异步 AOP 生效（直接 this 调用会绕过代理）
+        executeAfterTransaction(() -> getSelf().doSendPrivateMessage(userId, dto));
+    }
+
+    @Override
+    public void sendGroupMessageAsync(Collection<Long> userIds, ImGroupMessageDTO dto) {
+        executeAfterTransaction(() -> getSelf().doSendGroupMessage(userIds, dto));
+    }
+
+    /**
+     * 异步发送私聊 WebSocket 消息
+     */
+    @Async
+    public void doSendPrivateMessage(Long userId, ImPrivateMessageDTO dto) {
         try {
             webSocketMessageSender.sendObject(UserTypeEnum.ADMIN.getValue(), userId,
                     ImPrivateMessageDTO.TYPE, dto);
         } catch (Exception e) {
-            log.error("[sendPrivateMessageAsync][userId({}) dto({}) 发送失败]", userId, dto, e);
+            log.error("[doSendPrivateMessage][userId({}) dto({}) 发送失败]", userId, dto, e);
         }
     }
+    /**
+     * 异步发送群聊 WebSocket 消息
+     */
     @Async
-    @Override
-    public void sendGroupMessageAsync(Collection<Long> userIds, ImGroupMessageDTO dto) {
+    public void doSendGroupMessage(Collection<Long> userIds, ImGroupMessageDTO dto) {
         for (Long userId : userIds) {
             try {
                 webSocketMessageSender.sendObject(UserTypeEnum.ADMIN.getValue(), userId,
                         ImGroupMessageDTO.TYPE, dto);
             } catch (Exception e) {
-                log.error("[sendGroupMessageAsync][userId({}) dto({}) 发送失败]", userId, dto, e);
+                log.error("[doSendGroupMessage][userId({}) dto({}) 发送失败]", userId, dto, e);
             }
         }
     }
+    /**
+     * 事务感知的任务调度：
+     * - 有事务：注册 afterCommit 回调，事务提交后再执行，防止客户端拿到消息去查库时数据还没落盘
+     * - 无事务：直接执行（如非 @Transactional 方法中的调用）
+     *
+     * @param task 待执行的推送任务（内部通过 getSelf() 走 @Async 异步执行）
+     */
+    private void executeAfterTransaction(Runnable task) {
+        // 情况一：没有事务，直接执行
+        if (!TransactionSynchronizationManager.isSynchronizationActive()) {
+            task.run();
+            return;
+        }
+        // 情况二：有事务，注册 afterCommit 事件，在事务提交后执行
+        TransactionSynchronizationManager.registerSynchronization(new TransactionSynchronization() {
+
+            @Override
+            public void afterCommit() {
+                task.run();
+            }
+
+        });
+    }
+
+    /**
+     * 获得自身的代理对象，解决 @Async AOP 代理问题
+     */
+    private ImWebSocketServiceImpl getSelf() {
+        return SpringUtil.getBean(getClass());
+    }
+
 }