test：优化 IM 单测注释风格

- 统一 IM 单测类注释为 {@link Xxx} 的单元测试 - 保留方法分组注释，收敛不符合规范的分组文案 - 删除少量冗余字段说明注释

test：优化 IM 单测注释风格
- 统一 IM 单测类注释为 {@link Xxx} 的单元测试 - 保留方法分组注释，收敛不符合规范的分组文案 - 删除少量冗余字段说明注释
YunaiV
1 parent bca66fee
Showing 18 changed files with 36 additions and 36 deletions
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/dal/mysql/friend/ImFriendRequestMapperTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/dal/mysql/message/ImPrivateMessageMapperTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/dal/mysql/statistics/ImStatisticsManagerMapperTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/face/ImFacePackItemServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/face/ImFacePackServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/face/ImFaceUserItemServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/friend/ImFriendRequestServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/friend/ImFriendServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/group/ImGroupMemberServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/group/ImGroupRequestServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/group/ImGroupServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/message/ImGroupMessageServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/message/ImPrivateMessageServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/rtc/ImRtcCallServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/sensitiveword/ImSensitiveWordServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/statistics/ImStatisticsManagerServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/service/websocket/ImWebSocketServiceImplTest.java
yudao-module-im/src/test/java/cn/iocoder/yudao/module/im/util/ImMessageUtilsTest.java
@@ -11,7 +11,7 @@ import java.util.List;
 import static org.junit.jupiter.api.Assertions.*;
 /**
- * IM 好友申请记录 Mapper 单元测试
+ * {@link ImFriendRequestMapper} 的单元测试
  *
  * @author 芋道源码
  */
@@ -12,7 +12,7 @@ import java.util.List;
 import static org.junit.jupiter.api.Assertions.*;
 /**
- * IM 私聊消息 Mapper 单元测试
+ * {@link ImPrivateMessageMapper} 的单元测试
  *
  * @author 芋道源码
  */
@@ -21,9 +21,6 @@ public class ImPrivateMessageMapperTest extends BaseDbUnitTest {
     @Resource
     private ImPrivateMessageMapper mapper;
-    /**
-     * 一个足够早的时间作为 minSendTime，避免把测试数据过滤掉
-     */
     private static final LocalDateTime FAR_PAST = LocalDateTime.of(2000, 1, 1, 0, 0, 0);
     // ========== selectListByMinId ==========
@@ -25,7 +25,7 @@ import java.util.Map;
 import static org.junit.jupiter.api.Assertions.*;
 /**
- * IM 数据看板 Mapper 单元测试
+ * {@link ImStatisticsManagerMapper} 的单元测试
  *
  * @author 芋道源码
  */
@@ -26,7 +26,7 @@ import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 /**
- * IM 表情包项 Service 单元测试
+ * {@link ImFacePackItemServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -25,7 +25,7 @@ import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 /**
- * IM 表情包 Service 单元测试
+ * {@link ImFacePackServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -26,7 +26,7 @@ import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 /**
- * IM 用户私有表情 Service 单元测试
+ * {@link ImFaceUserItemServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -141,7 +141,7 @@ public class ImFaceUserItemServiceImplTest extends BaseMockitoUnitTest {
         verify(faceUserItemMapper, never()).deleteById(anyLong());
     }
-    // ========== deleteFaceUserItem（管理后台 by id） ==========
+    // ========== deleteFaceUserItem（管理后台） ==========
     @Test
     public void testDeleteFaceUserItemAdmin_success() {
@@ -35,7 +35,7 @@ import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 /**
- * IM 好友申请 Service 单元测试
+ * {@link ImFriendRequestServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -29,7 +29,7 @@ import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 /**
- * IM 好友关系 Service 单元测试
+ * {@link ImFriendServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -141,7 +141,7 @@ public class ImFriendServiceImplTest extends BaseMockitoUnitTest {
         verify(imWebSocketService, never()).sendNotificationAsync(any(Long.class), anyInt(), anyInt(), any());
     }
-    // ========== addFriend0（内部方法，被 becomeFriends / silentReAddFriend 调用） ==========
+    // ========== 建立好友 ==========
     @Test
     public void testAddFriend0_existingEnabledSkip() {
@@ -24,7 +24,7 @@ import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 /**
- * IM 群成员 Service 单元测试
+ * {@link ImGroupMemberServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -34,7 +34,7 @@ import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 /**
- * IM 加群申请 Service 单元测试
+ * {@link ImGroupRequestServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -48,7 +48,7 @@ import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 /**
- * IM 群 Service 单元测试
+ * {@link ImGroupServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -40,7 +40,7 @@ import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 /**
- * IM 群聊消息 Service 单元测试
+ * {@link ImGroupMessageServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -62,7 +62,6 @@ public class ImGroupMessageServiceImplTest extends BaseMockitoUnitTest {
     @Mock
     private ImWebSocketService imWebSocketService;
-    /** 用真实实例避免 NPE；默认值与生产保持一致（recallTimeoutMinutes=5、private/group read enabled=true、maxPullSize=1000）；个别用例可改字段测分支 */
     @Spy
     private ImProperties imProperties = new ImProperties();
@@ -546,7 +545,7 @@ public class ImGroupMessageServiceImplTest extends BaseMockitoUnitTest {
         assertEquals(GROUP_MEMBER_NOT_IN_GROUP.getCode(), exception.getCode());
     }
-    // ========== 发送：补充边界 ==========
+    // ========== 发送边界 ==========
     @Test
     public void testSendMessage_receiptPending() {
@@ -600,7 +599,7 @@ public class ImGroupMessageServiceImplTest extends BaseMockitoUnitTest {
         verify(imWebSocketService, never()).sendNotificationAsync(anyCollection(), anyInt(), anyInt(), any());
     }
-    // ========== 撤回：补充边界 ==========
+    // ========== 撤回边界 ==========
     @Test
     public void testRecallMessage_notExists() {
@@ -630,7 +629,7 @@ public class ImGroupMessageServiceImplTest extends BaseMockitoUnitTest {
         verify(groupMessageMapper, never()).insert(any(ImGroupMessageDO.class));
     }
-    // ========== 已读：happy path + 跳过 ==========
+    // ========== 已读事件 ==========
     @Test
     public void testReadGroupMessages_success() {
@@ -769,7 +768,7 @@ public class ImGroupMessageServiceImplTest extends BaseMockitoUnitTest {
         }
     }
-    // ========== 回执：DONE 状态迁移 ==========
+    // ========== 回执状态迁移 ==========
     @Test
     public void testReadGroupMessageEvent_receiptDoneTransition() {
@@ -850,7 +849,7 @@ public class ImGroupMessageServiceImplTest extends BaseMockitoUnitTest {
         verify(imWebSocketService).sendNotificationAsync(eq(5L), anyInt(), anyInt(), any());
     }
-    // ========== sendGroupMessage(senderId, dto)：receiverUserIds 定向过滤 ==========
+    // ========== 定向群消息 ==========
     @Test
     public void testSendGroupMessage_noReceiverUserIds_broadcastsToAllMembers() {
@@ -907,7 +906,7 @@ public class ImGroupMessageServiceImplTest extends BaseMockitoUnitTest {
                 anyInt(), anyInt(), any());
     }
-    // ========== sendGroupMessage(senderId, dto)：helper 行为 ==========
+    // ========== DTO 群消息 ==========
     @Test
     public void testSendGroupMessage_dto_persistsAndSerializesPojoContent() {
@@ -36,7 +36,7 @@ import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 /**
- * IM 私聊消息 Service 单元测试
+ * {@link ImPrivateMessageServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -56,7 +56,6 @@ public class ImPrivateMessageServiceImplTest extends BaseMockitoUnitTest {
     @Mock
     private ImWebSocketService imWebSocketService;
-    /** 用真实实例避免 NPE；默认值与生产保持一致（recallTimeoutMinutes=5、private/group read enabled=true）；个别用例可改字段测分支 */
     @Spy
     private ImProperties imProperties = new ImProperties();
@@ -380,7 +379,7 @@ public class ImPrivateMessageServiceImplTest extends BaseMockitoUnitTest {
         assertEquals(MESSAGE_PRIVATE_READ_DISABLED.getCode(), exception.getCode());
     }
-    // ========== sendPrivateMessage(senderId, dto)：helper 行为 ==========
+    // ========== DTO 私聊消息 ==========
     @Test
     public void testSendPrivateMessage_dto_persistsAndSerializesPojoContent() {
@@ -43,6 +43,11 @@ import static org.junit.jupiter.api.Assertions.*;
 import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
+/**
+ * {@link ImRtcCallServiceImpl} 的单元测试
+ *
+ * @author 芋道源码
+ */
 public class ImRtcCallServiceImplTest extends BaseMockitoUnitTest {
     @InjectMocks
@@ -63,7 +68,7 @@ public class ImRtcCallServiceImplTest extends BaseMockitoUnitTest {
     @Mock
     private ImGroupMemberService groupMemberService;
-    // ========== timeoutInvitingParticipants（Job 入口）==========
+    // ========== timeoutInvitingParticipants ==========
     @Test
     public void testTimeoutInvitingParticipants_emptyCandidates_returnsZeroAndNoDownstream() {
@@ -166,7 +171,7 @@ public class ImRtcCallServiceImplTest extends BaseMockitoUnitTest {
         verifyNoInteractions(webSocketService);
     }
-    // ========== noAnswerCallCheck（前端 timer 入口）==========
+    // ========== noAnswerCallCheck ==========
     @Test
     public void testNoAnswerCallCheck_authFails_silentNoOp() {
@@ -24,7 +24,7 @@ import static org.junit.jupiter.api.Assertions.*;
 import static org.mockito.Mockito.*;
 /**
- * IM 敏感词 Service 单元测试
+ * {@link ImSensitiveWordServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -19,7 +19,7 @@ import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.when;
 /**
- * IM 数据看板 Service 单元测试
+ * {@link ImStatisticsManagerServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -72,7 +72,7 @@ public class ImStatisticsManagerServiceImplTest extends BaseMockitoUnitTest {
         assertEquals(456L, service.getGroupMessageCount(BEGIN, END));
     }
-    // ========== 每日序列 toDailyCountMap ==========
+    // ========== 每日序列 ==========
     @Test
     public void testGetNewUserDailyCountMap_dateConvert() {
@@ -28,7 +28,7 @@ import static org.mockito.ArgumentMatchers.argThat;
 import static org.mockito.Mockito.*;
 /**
- * IM WebSocket 推送 Service 单元测试
+ * {@link ImWebSocketServiceImpl} 的单元测试
  *
  * @author 芋道源码
  */
@@ -48,7 +48,7 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
         }
     }
-    // ========== sendNotificationAsync ==========
+    // ========== 私聊推送 ==========
     @Test
     public void testSendNotificationAsync_private_noTransactionSendsImmediately() {
@@ -108,7 +108,7 @@ public class ImWebSocketServiceImplTest extends BaseMockitoUnitTest {
         }
     }
-    // ========== sendNotificationAsync ==========
+    // ========== 群聊推送 ==========
     @Test
     public void testSendNotificationAsync_group_fanOutToAllUsers() {
@@ -12,7 +12,7 @@ import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 /**
- * IM 消息内容工具类单元测试
+ * {@link ImMessageUtils} 的单元测试
  *
  * @author 芋道源码
  */