Commit c13ca7b4d8e48891a8ccfb759cf437806fa9bdff

Authored by YunaiV
1 parent 92c0ea30

feat(im): 统一 WebSocket 推送依赖

- 移除 IM 对 websocket starter 的直接依赖
- 改为通过 infra WebSocketSenderApi 发送推送消息
- 同步调整已有 WebSocket 推送单测
yudao-module-im/pom.xml
... ... @@ -23,6 +23,11 @@
23 23 <artifactId>yudao-module-system</artifactId>
24 24 <version>${revision}</version>
25 25 </dependency>
  26 + <dependency>
  27 + <groupId>cn.iocoder.boot</groupId>
  28 + <artifactId>yudao-module-infra</artifactId>
  29 + <version>${revision}</version>
  30 + </dependency>
26 31  
27 32 <dependency>
28 33 <groupId>cn.iocoder.boot</groupId>
... ... @@ -40,11 +45,6 @@
40 45 <artifactId>yudao-spring-boot-starter-security</artifactId>
41 46 </dependency>
42 47  
43   - <dependency>
44   - <groupId>cn.iocoder.boot</groupId>
45   - <artifactId>yudao-spring-boot-starter-websocket</artifactId>
46   - </dependency>
47   -
48 48 <!-- DB 相关 -->
49 49 <dependency>
50 50 <groupId>cn.iocoder.boot</groupId>
... ...
yudao-module-im/src/main/java/cn/iocoder/yudao/module/im/service/websocket/ImWebSocketServiceImpl.java
... ... @@ -2,10 +2,10 @@ package cn.iocoder.yudao.module.im.service.websocket;
2 2  
3 3 import cn.hutool.extra.spring.SpringUtil;
4 4 import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
5   -import cn.iocoder.yudao.framework.websocket.core.sender.WebSocketMessageSender;
6 5 import cn.iocoder.yudao.module.im.service.websocket.dto.ImChannelMessageDTO;
7 6 import cn.iocoder.yudao.module.im.service.websocket.dto.ImGroupMessageDTO;
8 7 import cn.iocoder.yudao.module.im.service.websocket.dto.ImPrivateMessageDTO;
  8 +import cn.iocoder.yudao.module.infra.api.websocket.WebSocketSenderApi;
9 9 import jakarta.annotation.Resource;
10 10 import lombok.extern.slf4j.Slf4j;
11 11 import org.springframework.scheduling.annotation.Async;
... ... @@ -33,7 +33,7 @@ import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.
33 33 public class ImWebSocketServiceImpl implements ImWebSocketService {
34 34  
35 35 @Resource
36   - private WebSocketMessageSender webSocketMessageSender;
  36 + private WebSocketSenderApi webSocketSenderApi;
37 37  
38 38 @Override
39 39 public void sendPrivateMessageAsync(Collection<Long> userIds, ImPrivateMessageDTO dto) {
... ... @@ -64,7 +64,7 @@ public class ImWebSocketServiceImpl implements ImWebSocketService {
64 64 public void doSendPrivateMessage(Collection<Long> userIds, ImPrivateMessageDTO dto) {
65 65 for (Long userId : getDistinctUserIds(userIds)) {
66 66 try {
67   - webSocketMessageSender.sendObject(UserTypeEnum.ADMIN.getValue(), userId,
  67 + webSocketSenderApi.sendObject(UserTypeEnum.ADMIN.getValue(), userId,
68 68 ImPrivateMessageDTO.TYPE, dto);
69 69 } catch (Exception e) {
70 70 log.error("[doSendPrivateMessage][userId({}) dto({}) 发送失败]", userId, dto, e);
... ... @@ -79,7 +79,7 @@ public class ImWebSocketServiceImpl implements ImWebSocketService {
79 79 public void doSendGroupMessage(Collection<Long> userIds, ImGroupMessageDTO dto) {
80 80 for (Long userId : getDistinctUserIds(userIds)) {
81 81 try {
82   - webSocketMessageSender.sendObject(UserTypeEnum.ADMIN.getValue(), userId,
  82 + webSocketSenderApi.sendObject(UserTypeEnum.ADMIN.getValue(), userId,
83 83 ImGroupMessageDTO.TYPE, dto);
84 84 } catch (Exception e) {
85 85 log.error("[doSendGroupMessage][userId({}) dto({}) 发送失败]", userId, dto, e);
... ... @@ -94,7 +94,7 @@ public class ImWebSocketServiceImpl implements ImWebSocketService {
94 94 public void doSendChannelMessage(Collection<Long> userIds, ImChannelMessageDTO dto) {
95 95 for (Long userId : getDistinctUserIds(userIds)) {
96 96 try {
97   - webSocketMessageSender.sendObject(UserTypeEnum.ADMIN.getValue(), userId,
  97 + webSocketSenderApi.sendObject(UserTypeEnum.ADMIN.getValue(), userId,
98 98 ImChannelMessageDTO.TYPE, dto);
99 99 } catch (Exception e) {
100 100 log.error("[doSendChannelMessage][userId({}) dto({}) 发送失败]", userId, dto, e);
... ... @@ -104,12 +104,12 @@ public class ImWebSocketServiceImpl implements ImWebSocketService {
104 104  
105 105 /**
106 106 * 异步广播频道 WebSocket 消息给当前所有在线管理端用户;
107   - * 依赖 WebSocketMessageSender 按 UserType 广播能力,离线用户由客户端上线 pull 兜底
  107 + * 依赖 infra WebSocketSenderApi 按 UserType 广播能力,离线用户由客户端上线 pull 兜底
108 108 */
109 109 @Async
110 110 public void doBroadcastChannelMessage(ImChannelMessageDTO dto) {
111 111 try {
112   - webSocketMessageSender.sendObject(UserTypeEnum.ADMIN.getValue(),
  112 + webSocketSenderApi.sendObject(UserTypeEnum.ADMIN.getValue(),
113 113 ImChannelMessageDTO.TYPE, dto);
114 114 } catch (Exception e) {
115 115 log.error("[doBroadcastChannelMessage][dto({}) 广播失败]", dto, e);
... ...
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/websocket/ImWebSocketServiceImplTest.java
... ... @@ -4,9 +4,9 @@ import cn.hutool.core.collection.ListUtil;
4 4 import cn.hutool.extra.spring.SpringUtil;
5 5 import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
6 6 import cn.iocoder.yudao.framework.test.core.ut.BaseMockitoUnitTest;
7   -import cn.iocoder.yudao.framework.websocket.core.sender.WebSocketMessageSender;
8 7 import cn.iocoder.yudao.module.im.service.websocket.dto.ImGroupMessageDTO;
9 8 import cn.iocoder.yudao.module.im.service.websocket.dto.ImPrivateMessageDTO;
  9 +import cn.iocoder.yudao.module.infra.api.websocket.WebSocketSenderApi;
10 10 import org.junit.jupiter.api.AfterEach;
11 11 import org.junit.jupiter.api.Test;
12 12 import org.mockito.InjectMocks;
... ... @@ -34,7 +34,7 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
34 34 private ImWebSocketServiceImpl imWebSocketService;
35 35  
36 36 @Mock
37   - private WebSocketMessageSender webSocketMessageSender;
  37 + private WebSocketSenderApi webSocketSenderApi;
38 38  
39 39 @AfterEach
40 40 public void tearDown() {
... ... @@ -59,7 +59,7 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
59 59 imWebSocketService.sendPrivateMessageAsync(2L, dto);
60 60  
61 61 // 断言
62   - verify(webSocketMessageSender).sendObject(
  62 + verify(webSocketSenderApi).sendObject(
63 63 eq(UserTypeEnum.ADMIN.getValue()), eq(2L), eq(ImPrivateMessageDTO.TYPE), eq(dto));
64 64 }
65 65 }
... ... @@ -79,7 +79,7 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
79 79 imWebSocketService.sendPrivateMessageAsync(2L, dto);
80 80  
81 81 // 断言:事务未提交,未推送
82   - verify(webSocketMessageSender, never()).sendObject(anyInt(), anyLong(), anyString(), any());
  82 + verify(webSocketSenderApi, never()).sendObject(anyInt(), anyLong(), anyString(), any());
83 83  
84 84 // 模拟事务提交
85 85 List<TransactionSynchronization> syncs =
... ... @@ -88,7 +88,7 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
88 88 syncs.forEach(TransactionSynchronization::afterCommit);
89 89  
90 90 // 断言:提交后推送
91   - verify(webSocketMessageSender).sendObject(
  91 + verify(webSocketSenderApi).sendObject(
92 92 eq(UserTypeEnum.ADMIN.getValue()), eq(2L), eq(ImPrivateMessageDTO.TYPE), eq(dto));
93 93 } finally {
94 94 TransactionSynchronizationManager.clear();
... ... @@ -110,11 +110,11 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
110 110  
111 111 imWebSocketService.sendGroupMessageAsync(ListUtil.of(1L, 2L, 3L), dto);
112 112  
113   - verify(webSocketMessageSender).sendObject(
  113 + verify(webSocketSenderApi).sendObject(
114 114 eq(UserTypeEnum.ADMIN.getValue()), eq(1L), eq(ImGroupMessageDTO.TYPE), eq(dto));
115   - verify(webSocketMessageSender).sendObject(
  115 + verify(webSocketSenderApi).sendObject(
116 116 eq(UserTypeEnum.ADMIN.getValue()), eq(2L), eq(ImGroupMessageDTO.TYPE), eq(dto));
117   - verify(webSocketMessageSender).sendObject(
  117 + verify(webSocketSenderApi).sendObject(
118 118 eq(UserTypeEnum.ADMIN.getValue()), eq(3L), eq(ImGroupMessageDTO.TYPE), eq(dto));
119 119 }
120 120 }
... ... @@ -129,13 +129,13 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
129 129 dto.setGroupId(10L);
130 130 // 给 1 号用户推送时抛异常,不能影响 2/3 号
131 131 doThrow(new RuntimeException("user offline"))
132   - .when(webSocketMessageSender).sendObject(anyInt(), eq(1L), anyString(), any());
  132 + .when(webSocketSenderApi).sendObject(anyInt(), eq(1L), anyString(), any());
133 133  
134 134 imWebSocketService.sendGroupMessageAsync(ListUtil.of(1L, 2L, 3L), dto);
135 135  
136 136 // 2L 和 3L 也都被推送
137   - verify(webSocketMessageSender).sendObject(anyInt(), eq(2L), anyString(), any());
138   - verify(webSocketMessageSender).sendObject(anyInt(), eq(3L), anyString(), any());
  137 + verify(webSocketSenderApi).sendObject(anyInt(), eq(2L), anyString(), any());
  138 + verify(webSocketSenderApi).sendObject(anyInt(), eq(3L), anyString(), any());
139 139 }
140 140 }
141 141  
... ... @@ -146,7 +146,7 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
146 146 imWebSocketService.doSendGroupMessage(Collections.emptyList(), dto);
147 147 imWebSocketService.doSendGroupMessage(null, dto);
148 148  
149   - verifyNoInteractions(webSocketMessageSender);
  149 + verifyNoInteractions(webSocketSenderApi);
150 150 }
151 151  
152 152 @Test
... ... @@ -155,11 +155,11 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
155 155  
156 156 imWebSocketService.doSendGroupMessage(Arrays.asList(1L, 2L, 1L, null), dto);
157 157  
158   - verify(webSocketMessageSender).sendObject(
  158 + verify(webSocketSenderApi).sendObject(
159 159 eq(UserTypeEnum.ADMIN.getValue()), eq(1L), eq(ImGroupMessageDTO.TYPE), eq(dto));
160   - verify(webSocketMessageSender).sendObject(
  160 + verify(webSocketSenderApi).sendObject(
161 161 eq(UserTypeEnum.ADMIN.getValue()), eq(2L), eq(ImGroupMessageDTO.TYPE), eq(dto));
162   - verifyNoMoreInteractions(webSocketMessageSender);
  162 + verifyNoMoreInteractions(webSocketSenderApi);
163 163 }
164 164  
165 165 @Test
... ... @@ -171,12 +171,12 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
171 171 // 准备:sender 抛异常
172 172 ImPrivateMessageDTO dto = new ImPrivateMessageDTO().setSenderId(1L).setReceiverId(2L);
173 173 doThrow(new RuntimeException("user offline"))
174   - .when(webSocketMessageSender).sendObject(anyInt(), anyLong(), anyString(), any());
  174 + .when(webSocketSenderApi).sendObject(anyInt(), anyLong(), anyString(), any());
175 175  
176 176 // 调用:异常应被吞掉,不向上抛
177 177 imWebSocketService.sendPrivateMessageAsync(2L, dto);
178 178  
179   - verify(webSocketMessageSender).sendObject(anyInt(), eq(2L), anyString(), any());
  179 + verify(webSocketSenderApi).sendObject(anyInt(), eq(2L), anyString(), any());
180 180 }
181 181 }
182 182  
... ... @@ -191,7 +191,7 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
191 191  
192 192 imWebSocketService.sendGroupMessageAsync(42L, dto);
193 193  
194   - verify(webSocketMessageSender).sendObject(
  194 + verify(webSocketSenderApi).sendObject(
195 195 eq(UserTypeEnum.ADMIN.getValue()), eq(42L), eq(ImGroupMessageDTO.TYPE), eq(dto));
196 196 }
197 197 }
... ...