chore: add code comments

doocs · Jan 10, 2024 · fa774d8 · fa774d8
1 parent 51c004d
commit fa774d8
Show file tree

Hide file tree

Showing 12 changed files with 68 additions and 137 deletions.
diff --git a/pom.xml b/pom.xml
@@ -157,22 +157,22 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
                 <version>3.0.2</version>
-<!--                <configuration>-->
-<!--                    <excludes>-->
-<!--                        <exclude>**/app.properties</exclude>-->
-<!--                    </excludes>-->
-<!--                </configuration>-->
+                <configuration>
+                    <excludes>
+                        <exclude>**/app.properties</exclude>
+                    </excludes>
+                </configuration>
             </plugin>
         </plugins>
-<!--        <resources>-->
-<!--            <resource>-->
-<!--                <directory>src/main/resources</directory>-->
-<!--                <filtering>true</filtering>-->
-<!--                <excludes>-->
-<!--                    <exclude>app.properties</exclude>-->
-<!--                </excludes>-->
-<!--            </resource>-->
-<!--        </resources>-->
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+                <excludes>
+                    <exclude>app.properties</exclude>
+                </excludes>
+            </resource>
+        </resources>
     </build>
 
     <profiles>

diff --git a/src/main/java/io/github/doocs/im/ImClient.java b/src/main/java/io/github/doocs/im/ImClient.java
@@ -2,17 +2,7 @@
 
 import io.github.doocs.im.constant.ContentType;
 import io.github.doocs.im.constant.Domain;
-import io.github.doocs.im.core.Account;
-import io.github.doocs.im.core.Audit;
-import io.github.doocs.im.core.Group;
-import io.github.doocs.im.core.Member;
-import io.github.doocs.im.core.Message;
-import io.github.doocs.im.core.OfficialAccount;
-import io.github.doocs.im.core.Operation;
-import io.github.doocs.im.core.Profile;
-import io.github.doocs.im.core.RecentContact;
-import io.github.doocs.im.core.Robot;
-import io.github.doocs.im.core.Sns;
+import io.github.doocs.im.core.*;
 import io.github.doocs.im.util.RandomUtil;
 import io.github.doocs.im.util.SigUtil;
 

diff --git a/src/main/java/io/github/doocs/im/model/request/CheckMembersRequest.java b/src/main/java/io/github/doocs/im/model/request/CheckMembersRequest.java
@@ -16,9 +16,15 @@
 public class CheckMembersRequest extends GenericRequest implements Serializable {
     private static final long serialVersionUID = 1773060365482346969L;
 
+    /**
+     * 操作的群 ID
+     */
     @JsonProperty("GroupId")
     private String groupId;
 
+    /**
+     * 查询的用户 UserID 列表
+     */
     @JsonProperty("Member_Account")
     private List<String> memberAccount;
 

diff --git a/src/main/java/io/github/doocs/im/model/request/ClearGroupMsgRequest.java b/src/main/java/io/github/doocs/im/model/request/ClearGroupMsgRequest.java
@@ -14,9 +14,16 @@
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class ClearGroupMsgRequest extends GenericRequest implements Serializable {
     private static final long serialVersionUID = 1822917977659354031L;
+
+    /**
+     * 要清空历史消息的群组 ID
+     */
     @JsonProperty("GroupId")
     private String groupId;
 
+    /**
+     * 清空小于等于 MsgSeq 的历史消息，不填则清空所有的历史消息
+     */
     @JsonProperty("MsgSeq")
     private Long msgSeq;
 

diff --git a/src/main/java/io/github/doocs/im/model/request/DeleteC2cMsgRambleRequest.java b/src/main/java/io/github/doocs/im/model/request/DeleteC2cMsgRambleRequest.java
@@ -15,12 +15,23 @@
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class DeleteC2cMsgRambleRequest extends GenericRequest implements Serializable {
     private static final long serialVersionUID = 7845418223658345469L;
+
+    /**
+     * 发起删除操作的账号，即以 Operator_Account 的身份删除消息。
+     */
     @JsonProperty("Operator_Account")
     private String operatorAccount;
 
+    /**
+     * 会话的另一方账号。
+     */
     @JsonProperty("Peer_Account")
     private String peerAccount;
 
+    /**
+     * 待删除消息的 MsgKey 数组。
+     * 一次最多删除30条消息。
+     */
     @JsonProperty("MsgKeyList")
     private List<String> msgKeyList;
 

diff --git a/src/main/java/io/github/doocs/im/model/request/GetAdminListRequest.java b/src/main/java/io/github/doocs/im/model/request/GetAdminListRequest.java
@@ -15,6 +15,9 @@
 public class GetAdminListRequest extends GenericRequest implements Serializable {
     private static final long serialVersionUID = -4674343475066620157L;
 
+    /**
+     * 直播群 ID
+     */
     @JsonProperty("GroupId")
     private String groupId;
 

diff --git a/src/main/java/io/github/doocs/im/model/request/OfficialAccountMsgRecallRequest.java b/src/main/java/io/github/doocs/im/model/request/OfficialAccountMsgRecallRequest.java
@@ -15,12 +15,22 @@
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class OfficialAccountMsgRecallRequest extends GenericRequest implements Serializable {
     private static final long serialVersionUID = -8441195658528603133L;
+
+    /**
+     * 操作的公众号用户 ID
+     */
     @JsonProperty("Official_Account")
     private String officialAccount;
 
+    /**
+     * 被撤回的消息 MsgKey 列表，一次请求最多可以撤回10条消息
+     */
     @JsonProperty("MsgKeyList")
     private List<String> msgKeyList;
 
+    /**
+     * 撤回消息的原因，长度限制最大100字节
+     */
     @JsonProperty("Reason")
     private String reason;
 

diff --git a/src/main/java/io/github/doocs/im/model/response/CheckMembersResult.java b/src/main/java/io/github/doocs/im/model/response/CheckMembersResult.java
@@ -14,6 +14,9 @@
 public class CheckMembersResult extends GenericResult implements Serializable {
     private static final long serialVersionUID = 983416554639985218L;
 
+    /**
+     * 在直播群内的用户 UserID 列表
+     */
     @JsonProperty("Member_Account")
     private List<String> memberAccount;
 

diff --git a/src/main/java/io/github/doocs/im/model/response/DeleteC2cMsgRambleResult.java b/src/main/java/io/github/doocs/im/model/response/DeleteC2cMsgRambleResult.java
@@ -13,6 +13,10 @@
  */
 public class DeleteC2cMsgRambleResult extends GenericResult implements Serializable {
     private static final long serialVersionUID = -7513216082123424659L;
+
+    /**
+     * 请求中格式非法的 MsgKey
+     */
     @JsonProperty("InvalidMsgKeyList")
     private List<String> invalidMsgKeyList;
 

diff --git a/src/main/java/io/github/doocs/im/model/response/GetAdminListResult.java b/src/main/java/io/github/doocs/im/model/response/GetAdminListResult.java
@@ -14,6 +14,9 @@
 public class GetAdminListResult  extends GenericResult implements Serializable {
     private static final long serialVersionUID = 8209999755430615708L;
 
+    /**
+     * 该群组的直播群管理员列表
+     */
     @JsonProperty("Admin_List")
     private List<AdminResultItem> adminList;
 

diff --git a/src/main/java/io/github/doocs/im/model/response/OfficialAccountMsgRecallResult.java b/src/main/java/io/github/doocs/im/model/response/OfficialAccountMsgRecallResult.java
@@ -14,6 +14,9 @@
 public class OfficialAccountMsgRecallResult extends GenericResult implements Serializable {
     private static final long serialVersionUID = 1567110934824930661L;
 
+    /**
+     * 消息撤回请求的详细结果
+     */
     @JsonProperty("RecallRetList")
     private List<RecallRetItem> recallRetList;
 

diff --git a/src/test/java/io/github/doocs/im/core/GroupTest.java b/src/test/java/io/github/doocs/im/core/GroupTest.java
@@ -2,123 +2,14 @@
 
 import io.github.doocs.im.ClientFactory;
 import io.github.doocs.im.ImClient;
-import io.github.doocs.im.constant.ApplyJoinOption;
-import io.github.doocs.im.constant.ErrorCode;
-import io.github.doocs.im.constant.GroupCounterMode;
-import io.github.doocs.im.constant.GroupType;
-import io.github.doocs.im.constant.MemberRole;
-import io.github.doocs.im.constant.MuteAllMember;
-import io.github.doocs.im.constant.OnlineOnlyFlag;
+import io.github.doocs.im.constant.*;
 import io.github.doocs.im.model.group.GroupAttr;
 import io.github.doocs.im.model.group.GroupCounterItem;
 import io.github.doocs.im.model.group.GroupMemberItem;
 import io.github.doocs.im.model.message.TIMMsgElement;
 import io.github.doocs.im.model.message.TIMTextMsgElement;
-import io.github.doocs.im.model.request.AddGroupMemberRequest;
-import io.github.doocs.im.model.request.BanGroupMemberRequest;
-import io.github.doocs.im.model.request.ChangeGroupOwnerRequest;
-import io.github.doocs.im.model.request.CheckMembersRequest;
-import io.github.doocs.im.model.request.ClearGroupAttrRequest;
-import io.github.doocs.im.model.request.CreateGroupRequest;
-import io.github.doocs.im.model.request.CreateGroupTopicRequest;
-import io.github.doocs.im.model.request.DeleteGroupCounterRequest;
-import io.github.doocs.im.model.request.DeleteGroupMemberRequest;
-import io.github.doocs.im.model.request.DeleteGroupMsgBySenderRequest;
-import io.github.doocs.im.model.request.DestroyGroupRequest;
-import io.github.doocs.im.model.request.DestroyGroupTopicRequest;
-import io.github.doocs.im.model.request.ForbidSendMsgRequest;
-import io.github.doocs.im.model.request.GetAdminListRequest;
-import io.github.doocs.im.model.request.GetAppIdGroupListRequest;
-import io.github.doocs.im.model.request.GetGroupAttrRequest;
-import io.github.doocs.im.model.request.GetGroupBanMemberRequest;
-import io.github.doocs.im.model.request.GetGroupCounterRequest;
-import io.github.doocs.im.model.request.GetGroupInfoRequest;
-import io.github.doocs.im.model.request.GetGroupMemberInfoRequest;
-import io.github.doocs.im.model.request.GetGroupMsgReceiptDetailRequest;
-import io.github.doocs.im.model.request.GetGroupMsgReceiptRequest;
-import io.github.doocs.im.model.request.GetGroupMutedAccountRequest;
-import io.github.doocs.im.model.request.GetGroupTopicRequest;
-import io.github.doocs.im.model.request.GetJoinedGroupListRequest;
-import io.github.doocs.im.model.request.GetMembersRequest;
-import io.github.doocs.im.model.request.GetOnlineMemberNumRequest;
-import io.github.doocs.im.model.request.GetRoleInGroupRequest;
-import io.github.doocs.im.model.request.GroupGetKeyValuesRequest;
-import io.github.doocs.im.model.request.GroupMsgGetSimpleRequest;
-import io.github.doocs.im.model.request.GroupMsgItem;
-import io.github.doocs.im.model.request.GroupMsgRecallRequest;
-import io.github.doocs.im.model.request.GroupSetKeyValuesRequest;
-import io.github.doocs.im.model.request.ImportGroupMemberRequest;
-import io.github.doocs.im.model.request.ImportGroupMsgRequest;
-import io.github.doocs.im.model.request.ImportGroupRequest;
-import io.github.doocs.im.model.request.ImportGroupTopicRequest;
-import io.github.doocs.im.model.request.MemberItem;
-import io.github.doocs.im.model.request.MemberRequestItem;
-import io.github.doocs.im.model.request.ModifyAdminRequest;
-import io.github.doocs.im.model.request.ModifyGroupAttrRequest;
-import io.github.doocs.im.model.request.ModifyGroupBaseInfoRequest;
-import io.github.doocs.im.model.request.ModifyGroupMemberInfoRequest;
-import io.github.doocs.im.model.request.ModifyGroupMsgRequest;
-import io.github.doocs.im.model.request.ModifyGroupTopicRequest;
-import io.github.doocs.im.model.request.ModifyGroupUserInfoRequest;
-import io.github.doocs.im.model.request.MsgSeqItem;
-import io.github.doocs.im.model.request.SendBroadcastMsgRequest;
-import io.github.doocs.im.model.request.SendGroupMsgRequest;
-import io.github.doocs.im.model.request.SendGroupSystemNotificationRequest;
-import io.github.doocs.im.model.request.SetGroupAttrRequest;
-import io.github.doocs.im.model.request.SetUnreadMsgNumRequest;
-import io.github.doocs.im.model.request.UnbanGroupMemberRequest;
-import io.github.doocs.im.model.request.UpdateGroupCounterRequest;
-import io.github.doocs.im.model.response.AddGroupMemberResult;
-import io.github.doocs.im.model.response.BanGroupMemberResult;
-import io.github.doocs.im.model.response.ChangeGroupOwnerResult;
-import io.github.doocs.im.model.response.CheckMembersResult;
-import io.github.doocs.im.model.response.ClearGroupAttrResult;
-import io.github.doocs.im.model.response.CreateGroupResult;
-import io.github.doocs.im.model.response.CreateGroupTopicResult;
-import io.github.doocs.im.model.response.DeleteGroupCounterResult;
-import io.github.doocs.im.model.response.DeleteGroupMemberResult;
-import io.github.doocs.im.model.response.DeleteGroupMsgBySenderResult;
-import io.github.doocs.im.model.response.DestroyGroupResult;
-import io.github.doocs.im.model.response.DestroyGroupTopicResult;
-import io.github.doocs.im.model.response.ForbidSendMsgResult;
-import io.github.doocs.im.model.response.GetAdminListResult;
-import io.github.doocs.im.model.response.GetAppIdGroupListResult;
-import io.github.doocs.im.model.response.GetGroupAttrResult;
-import io.github.doocs.im.model.response.GetGroupBanMemberResult;
-import io.github.doocs.im.model.response.GetGroupCounterResult;
-import io.github.doocs.im.model.response.GetGroupInfoResult;
-import io.github.doocs.im.model.response.GetGroupMemberInfoResult;
-import io.github.doocs.im.model.response.GetGroupMsgReceiptDetailResult;
-import io.github.doocs.im.model.response.GetGroupMsgReceiptResult;
-import io.github.doocs.im.model.response.GetGroupMutedAccountResult;
-import io.github.doocs.im.model.response.GetGroupTopicResult;
-import io.github.doocs.im.model.response.GetJoinGroupListResult;
-import io.github.doocs.im.model.response.GetMembersResult;
-import io.github.doocs.im.model.response.GetOnlineMemberNumResult;
-import io.github.doocs.im.model.response.GetRoleInGroupResult;
-import io.github.doocs.im.model.response.GroupGetKeyValuesResult;
-import io.github.doocs.im.model.response.GroupMsgGetSimpleResult;
-import io.github.doocs.im.model.response.GroupMsgRecallResult;
-import io.github.doocs.im.model.response.GroupSetKeyValuesResult;
-import io.github.doocs.im.model.response.ImportGroupMemberResult;
-import io.github.doocs.im.model.response.ImportGroupMsgResult;
-import io.github.doocs.im.model.response.ImportGroupResult;
-import io.github.doocs.im.model.response.ImportGroupTopicResult;
-import io.github.doocs.im.model.response.KeyValueSeq;
-import io.github.doocs.im.model.response.ModifyAdminResult;
-import io.github.doocs.im.model.response.ModifyGroupAttrResult;
-import io.github.doocs.im.model.response.ModifyGroupBaseInfoResult;
-import io.github.doocs.im.model.response.ModifyGroupMemberInfoResult;
-import io.github.doocs.im.model.response.ModifyGroupMsgResult;
-import io.github.doocs.im.model.response.ModifyGroupTopicResult;
-import io.github.doocs.im.model.response.ModifyGroupUserInfoResult;
-import io.github.doocs.im.model.response.SendBroadcastMsgResult;
-import io.github.doocs.im.model.response.SendGroupMsgResult;
-import io.github.doocs.im.model.response.SendGroupSystemNotificationResult;
-import io.github.doocs.im.model.response.SetGroupAttrResult;
-import io.github.doocs.im.model.response.SetUnreadMsgNumResult;
-import io.github.doocs.im.model.response.UnbanGroupMemberResult;
-import io.github.doocs.im.model.response.UpdateGroupCounterResult;
+import io.github.doocs.im.model.request.*;
+import io.github.doocs.im.model.response.*;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;