添加注释

2026-02-04 10:39:34 +08:00
parent 298ce69db7
commit c51f523d6e
61 changed files with 2081 additions and 48 deletions
@@ -1,5 +1,12 @@
 package cn.wildfirechat.common;

+/**
+ * API路径接口
+ * <p>
+ * 定义了野火IM服务器所有管理接口的API路径。
+ * 包括聊天室、敏感词、域、用户、好友、黑名单、消息、群组、会议、频道等模块的接口路径。
+ * </p>
+ */
 public interface APIPath {
    String Create_Chatroom = "/admin/chatroom/create";
    String Chatroom_Destroy = "/admin/chatroom/del";
@@ -8,6 +8,25 @@

 package cn.wildfirechat.common;

+/**
+ * 错误码枚举
+ * <p>
+ * 定义了野火IM系统中所有可能的错误码，包括：
+ * <ul>
+ * <li>通用错误（0-5）</li>
+ * <li>认证错误（6-8）</li>
+ * <li>消息错误（9-10）</li>
+ * <li>群组错误（11-12）</li>
+ * <li>用户错误（16-19）</li>
+ * <li>聊天室错误（20）</li>
+ * <li>频道错误（21-25）</li>
+ * <li>会议错误（60-61）</li>
+ * <li>应用错误（70）</li>
+ * <li>密聊错误（81-87）</li>
+ * <li>其他错误（90-255）</li>
+ * </ul>
+ * </p>
+ */
 public enum ErrorCode {
    //General error
    ERROR_CODE_SUCCESS(0, "success"),
@@ -1,6 +1,18 @@
 package cn.wildfirechat.common;

+/**
+ * IM异常事件类
+ * <p>
+ * 用于记录和传递IM系统中的异常事件信息。
+ * </p>
+ */
 public class IMExceptionEvent {
+    /**
+     * 事件类型接口
+     * <p>
+     * 定义了各种异常事件的类型常量。
+     * </p>
+     */
    public interface EventType {
        int RDBS_Exception = 1;
        int MONGO_Exception = 2;
@@ -8,6 +8,13 @@

 package cn.wildfirechat.pojos;

+/**
+ * 会话类
+ * <p>
+ * 表示一个会话对象，包含会话类型、目标ID和线路信息。
+ * 用于标识消息发送或接收的目标会话。
+ * </p>
+ */
 public class Conversation {
    private int type;
    private String target;
@@ -14,6 +14,12 @@ import io.netty.util.internal.StringUtil;

 import java.util.List;

+/**
+ * 添加群组成员输入参数类
+ * <p>
+ * 封装添加群组成员的输入参数，包括群组ID、成员列表、成员额外信息等。
+ * </p>
+ */
 public class InputAddGroupMember extends InputGroupBase {
    private String group_id;
    private List<PojoGroupMember> members;
@@ -14,6 +14,12 @@ import io.netty.util.internal.StringUtil;

 import java.util.List;

+/**
+ * 创建群组输入参数类
+ * <p>
+ * 封装创建群组的输入参数，包括群组信息、成员列表、成员额外信息等。
+ * </p>
+ */
 public class InputCreateGroup extends InputGroupBase {
    private PojoGroup group;
    private String member_extra;
@@ -11,6 +11,21 @@ package cn.wildfirechat.pojos;

 import cn.wildfirechat.proto.WFCMessage;

+/**
+ * 用户信息类
+ * <p>
+ * 封装用户的所有信息，包括：
+ * <ul>
+ * <li>用户ID、用户名、显示名称</li>
+ * <li>头像、性别</li>
+ * <li>手机号、邮箱、地址</li>
+ * <li>公司、社交信息</li>
+ * <li>用户类型、删除状态</li>
+ * <li>更新时间</li>
+ * <li>额外扩展信息</li>
+ * </ul>
+ * </p>
+ */
 public class InputOutputUserInfo {
    private String userId;
    private String name;
@@ -16,6 +16,22 @@ import java.util.ArrayList;
 import java.util.Base64;
 import java.util.List;

+/**
+ * 消息内容负载类
+ * <p>
+ * 封装消息的所有内容信息，包括：
+ * <ul>
+ * <li>消息类型</li>
+ * <li>可搜索内容（文本消息的文本）</li>
+ * <li>推送内容和推送数据</li>
+ * <li>消息内容（二进制数据）</li>
+ * <li>媒体类型和远程URL</li>
+ * <li>持久化标志和过期时间</li>
+ * <li>@提及信息</li>
+ * <li>额外数据</li>
+ * </ul>
+ * </p>
+ */
 public class MessagePayload {
    private int type;
    private String searchableContent;
@@ -10,6 +10,12 @@ package cn.wildfirechat.pojos;

 import java.util.List;

+/**
+ * 群组对象类
+ * <p>
+ * 封装创建群组时使用的参数，包含群组信息和成员列表。
+ * </p>
+ */
 public class PojoGroup {
    private PojoGroupInfo group_info;
    private List<PojoGroupMember> members;
@@ -8,6 +8,19 @@

 package cn.wildfirechat.pojos;

+/**
+ * 群组信息类
+ * <p>
+ * 封装群组的信息，包括：
+ * <ul>
+ * <li>群组ID、名称、头像、所有者</li>
+ * <li>群组类型、成员数量、最大成员数</li>
+ * <li>群组设置（禁言、加群方式、私聊、可搜索、历史消息）</li>
+ * <li>是否超级群、是否已删除</li>
+ * <li>更新时间</li>
+ * </ul>
+ * </p>
+ */
 public class PojoGroupInfo {
    String target_id;
    String name;
@@ -8,6 +8,19 @@

 package cn.wildfirechat.pojos;

+/**
+ * 群组成员类
+ * <p>
+ * 封装群组成员的信息，包括：
+ * <ul>
+ * <li>成员ID</li>
+ * <li>群组内别名</li>
+ * <li>成员类型</li>
+ * <li>扩展信息</li>
+ * <li>更新时间和创建时间</li>
+ * </ul>
+ * </p>
+ */
 public class PojoGroupMember {
    String member_id;
    String alias;
@@ -11,6 +11,12 @@ package cn.wildfirechat.pojos;
 import cn.wildfirechat.proto.WFCMessage;
 import io.netty.util.internal.StringUtil;

+/**
+ * 发送消息结果类
+ * <p>
+ * 封装发送消息后的返回结果，包含消息UID和时间戳。
+ * </p>
+ */
 public class SendMessageResult {
    private long messageUid;
    private long timestamp;