From c4b6449ae2686772c4ab318ba75389b6a4df21ea Mon Sep 17 00:00:00 2001 From: mb7o3ja5v <969685829@qq.com> Date: Wed, 27 Nov 2024 10:23:50 +0800 Subject: [PATCH 01/17] Initial commit --- README.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e17b963 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# wx-dump-4j + -- 2.34.1 From 7deb3dfa65a0d9910fe26753eeda5454f70a9ae5 Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Sun, 15 Dec 2024 20:09:39 +0800 Subject: [PATCH 02/17] 1 --- .../com/xcs/wx/domain/vo/MsgTypeDistributionVO.java | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgTypeDistributionVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgTypeDistributionVO.java index 11195b3..ae589cd 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgTypeDistributionVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgTypeDistributionVO.java @@ -4,22 +4,25 @@ import lombok.AllArgsConstructor; import lombok.Data; /** - * MsgTypeDistributionVO + * MsgTypeDistributionVO类是一个值对象（Value Object，VO），通常用于在不同层之间传递数据， + * 在这里可能是用于传递消息类型分布相关的数据结构。 * * @author xcs - * @date 2024年01月05日 15时25分 + * @date 2024年0月05日 15时25分 **/ @Data +// @Data注解用于自动生成该类的getter、setter方法、toString方法、hashCode方法以及equals方法等，简化代码编写。 @AllArgsConstructor +// @AllArgsConstructor注解会自动生成一个包含所有参数的构造函数，方便对象的初始化。 public class MsgTypeDistributionVO { /** - * 类型 + * 用于表示消息的类型，比如可能是文本消息类型、图片消息类型等具体的分类标识。 */ private String type; /** - * 数量 + * 表示对应消息类型的数量，例如某类消息出现的次数等。 */ private Integer value; -} +} \ No newline at end of file -- 2.34.1 From b0133fb39ed0cf4699a8fb25277cc8eae6c01f5c Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Sun, 15 Dec 2024 20:30:22 +0800 Subject: [PATCH 03/17] 1 --- .../wx/domain/vo/MsgTypeDistributionVO.java | 31 ++++++++++++++----- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgTypeDistributionVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgTypeDistributionVO.java index ae589cd..f3ba2da 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgTypeDistributionVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgTypeDistributionVO.java @@ -4,25 +4,42 @@ import lombok.AllArgsConstructor; import lombok.Data; /** - * MsgTypeDistributionVO类是一个值对象（Value Object，VO），通常用于在不同层之间传递数据， - * 在这里可能是用于传递消息类型分布相关的数据结构。 + * MsgTypeDistributionVO类是一个值对象（Value Object，VO），在分层架构的软件系统中， + * VO通常扮演着在不同层（比如业务逻辑层与表现层之间）传递数据的角色，它可以将相关的数据进行封装， + * 以一种简单、清晰的结构进行传递，避免各层之间直接传递复杂的数据结构或者过多零散的数据， + * 在这里它的作用大概率是用于传递消息类型分布相关的数据结构，例如统计不同类型消息各自出现的频次等情况时， + * 方便在系统内不同模块间进行数据的流转和共享。 * * @author xcs - * @date 2024年0月05日 15时25分 + **/ @Data -// @Data注解用于自动生成该类的getter、setter方法、toString方法、hashCode方法以及equals方法等，简化代码编写。 +// @Data注解由Lombok库提供，它的功能非常实用，会自动为该类生成一系列常用的方法。 +// 具体来说，它会为类中的每一个私有属性自动生成对应的getter方法（用于获取属性的值）和setter方法（用于设置属性的值）， +// 同时还会生成toString方法（方便将对象以字符串形式展示，常用于调试或者日志输出等场景，能直观看到对象的属性值情况）、 +// hashCode方法（在涉及基于哈希的数据结构，如HashMap等，进行对象存储和查找等操作时会用到，用于快速定位对象）以及 +// equals方法（用于比较两个对象是否在逻辑上相等，即属性值是否都相等）等，通过使用这个注解，大大简化了代码编写过程中 +// 手动去编写这些重复且常规的方法的工作量，让代码更加简洁、易读和易维护。 @AllArgsConstructor -// @AllArgsConstructor注解会自动生成一个包含所有参数的构造函数，方便对象的初始化。 +// @AllArgsConstructor注解同样来自Lombok库，它会自动为这个类生成一个包含所有参数的构造函数。 +// 例如对于这个MsgTypeDistributionVO类，就会生成一个构造函数，其参数顺序和类型与类中的属性声明顺序和类型一致， +// 像这样：public MsgTypeDistributionVO(String type, Integer value) {...}， +// 这样在创建该类的对象实例时，就可以很方便地通过传入对应参数来完成对象的初始化，提高了代码的便利性和可读性， +// 尤其是当需要一次性为对象的多个属性赋值时，不用再逐个调用setter方法来设置属性值了。 public class MsgTypeDistributionVO { /** - * 用于表示消息的类型，比如可能是文本消息类型、图片消息类型等具体的分类标识。 + * 用于表示消息的类型，此处定义为字符串类型（String），是因为消息类型往往具有多样化的特点， + * 比如可能是文本消息类型（可以用类似"TEXT"这样的字符串表示）、图片消息类型（如"IMAGE"）等具体的分类标识， + * 通过这样的字符串形式，可以方便地进行消息类型的区分、判断以及后续基于类型的业务逻辑处理等操作。 */ private String type; /** - * 表示对应消息类型的数量，例如某类消息出现的次数等。 + * 表示对应消息类型的数量，定义为整数类型（Integer），它的含义通常是统计某类消息出现的次数等情况， + * 例如在一个聊天记录的统计分析场景中，可能会统计出文本消息出现了100次，那么对于消息类型为"TEXT"的这个对象实例， + * 其value属性的值就会被设置为100，以此来反映不同消息类型在数量方面的分布情况，方便后续进行数据展示、 + * 分析对比或者基于数量的业务规则判断等操作。 */ private Integer value; } \ No newline at end of file -- 2.34.1 From 67ece6cb44426fa1e0eae91662a1d587efc36dad Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Sun, 15 Dec 2024 22:18:26 +0800 Subject: [PATCH 04/17] 1 --- .../main/java/com/xcs/wx/domain/vo/MsgVO.java | 131 ++++++++++++++---- .../java/com/xcs/wx/domain/vo/PageVO.java | 45 ++++-- .../xcs/wx/domain/vo/RecentUsedKeyWordVO.java | 29 +++- .../xcs/wx/domain/vo/RecoverContactVO.java | 39 +++++- .../java/com/xcs/wx/domain/vo/ResponseVO.java | 85 +++++++++--- .../java/com/xcs/wx/domain/vo/SessionVO.java | 43 ++++-- .../com/xcs/wx/domain/vo/StatsPanelVO.java | 41 +++++- .../com/xcs/wx/domain/vo/TopContactsVO.java | 36 ++++- .../java/com/xcs/wx/domain/vo/UserInfoVO.java | 45 ++++-- .../java/com/xcs/wx/domain/vo/UserVO.java | 42 ++++-- .../com/xcs/wx/domain/vo/WeAppInfoVO.java | 38 +++-- .../com/xcs/wx/domain/vo/WeChatConfigVO.java | 65 +++++++-- 12 files changed, 509 insertions(+), 130 deletions(-) diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgVO.java index 1c39928..2cfc7d1 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/MsgVO.java @@ -4,118 +4,193 @@ import com.fasterxml.jackson.annotation.JsonIgnore; import lombok.Data; /** - * MsgVO + * MsgVO类作为一个值对象（Value Object，VO），在整个系统架构中起着传递消息相关数据的重要作用。 + * 它将各类与消息相关的属性整合在一起，方便在不同的业务层（如数据访问层、业务逻辑层、展示层等）之间进行数据传递， + * 确保各层之间对于消息数据的交互具有统一、清晰的格式，避免了数据传递的混乱和复杂性。 * * @author xcs - * @date 2023年12月22日 14时43分 + **/ @Data +// @Data注解是由Lombok库提供的便捷注解，它会自动为该类生成多个实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，通过这些方法，外部代码可以方便地获取类中各个属性的值， +// 这在访问对象的具体属性信息时非常有用，例如获取消息的类型、内容等。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够对类中的属性进行赋值操作， +// 便于根据业务需求动态地修改对象的属性值，比如更新消息的创建时间、聊天者信息等。 +// - 自动生成toString方法，该方法将对象以一种易于阅读的字符串形式表示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速直观地查看对象的具体状态，了解各个属性的当前取值情况。 +// - 自动生成hashCode方法，这个方法在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会被用到， +// 它根据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便快速查找和比较对象。 +// - 自动生成equals方法，用于比较两个MsgVO对象是否在逻辑上相等，即判断它们的所有属性值是否都完全相同， +// 在涉及对象比较的业务逻辑中（如判断两条消息是否完全一致），该方法起着关键作用。 +// 通过使用@Data注解，大大减少了手动编写这些重复且基础的方法的工作量，使代码更加简洁、易读和易维护。 public class MsgVO { /** - * 本地唯一标识符，自增。 + * 本地唯一标识符，通常由数据库系统按照自增规则来生成，用于在本地环境中唯一地标识每一条消息记录。 + * 例如，在数据库的消息表中，每当插入一条新的消息数据时，这个标识符的值就会自动增加一个固定的步长（常为1）， + * 这使得在本地进行消息的查询、排序、关联其他相关数据表（如通过外键关联消息与发送者、接收者等信息）时， + * 能够准确无误地定位到具体的某条消息，保证了数据操作的准确性和唯一性，是消息在本地存储和管理中的重要标识。 */ private Integer localId; /** - * 消息服务器 ID + * 消息服务器 ID，由消息服务器端为每一条消息分配的独一无二的标识符，在整个消息服务器的运行环境中， + * 凭借这个ID，服务器能够精准地对消息进行各种操作，比如消息的存储（确定消息在服务器存储系统中的具体位置）、 + * 转发（根据ID找到要转发的消息并发送到指定的目标地址）、检索（按照不同的查询条件通过这个ID快速定位消息）等， + * 它是消息在服务器层面进行管理和流转的核心依据，确保了服务器对大量消息处理的有序性和准确性。 */ private String msgSvrId; /** - * 消息类型 + * 消息类型，采用整数类型来表示不同种类的消息，这是一种常见的消息分类方式。 + * 例如，在一个具体的业务系统中，可以定义1代表文本消息，2代表图片消息，3代表语音消息，4代表视频消息等等， + * 具体的数值与消息类型的对应规则由系统的业务逻辑所确定。通过这个字段，在处理消息的各个环节（如消息展示、 + * 存储格式选择、业务规则应用等）中，能够快速判断出消息所属的大致类别，进而采取相应的、符合该类型特点的处理方式。 */ private Integer type; /** - * 消息子类型 + * 消息子类型，是对消息类型进一步细化的分类标识，用于在同一大类消息下更精确地区分不同的消息变体或特性。 + * 以图片消息为例（当type字段表示图片消息对应的数值时），子类型可以根据图片的分辨率高低（如高清图片、普通图片）、 + * 图片的格式（如JPEG格式、PNG格式）、图片的来源渠道（是用户上传的、系统自动生成的还是从第三方获取的）等因素进行细分， + * 这样在具体的业务处理过程中，就可以针对这些不同的子类型情况，执行更为细致、贴合实际需求的操作， + * 比如对不同格式的图片采用不同的解码方式进行展示等，使消息处理更加精准和灵活。 */ private Integer subType; /** - * 序列号 + * 序列号，主要用于体现消息的发送顺序或者在一组相关消息中的排列次序。 + * 在很多实际应用场景中，比如即时通讯软件的聊天会话里，每发送一条消息，服务器或客户端会为其分配一个递增的序列号， + * 按照消息发送的先后顺序依次编号。这个序列号在多个方面有着重要作用，例如在消息的排序展示上，确保用户看到的消息 + * 按照正确的时间顺序排列；在消息重传、丢失检测等网络传输相关的业务逻辑中，可以通过比较序列号来判断消息的完整性 + * 和先后顺序；在多端同步消息时，也依靠序列号来保证不同设备上消息顺序的一致性，维持消息流的连贯性和逻辑性。 */ private Long sequence; /** - * 是否为发送者 + * 是否为发送者，使用整数来表示消息的来源角色，常见的约定是1表示该消息是由发送方发出的，而0表示这条消息是接收方收到的。 + * 通过这个简单的标识字段，在消息处理的业务逻辑中，能够清晰地区分消息的流向，从而针对发送方和接收方的不同情况， + * 实施不同的处理策略。例如对于发送方，可能需要关注消息发送是否成功、是否需要记录发送时间等；对于接收方，则着重考虑 + * 消息的展示方式、是否已读标记等相关处理，有助于将消息处理流程按照发送和接收两个不同的方向进行合理划分和细化。 */ private Integer isSender; /** - * 消息创建时间 + * 消息创建时间，以时间戳的形式进行记录，时间戳一般是指从某个特定的起始时间点（通常是1970年1月1日00:00:00 UTC，即Unix时间戳的起始时间） + * 到消息实际创建那一刻所经过的毫秒数或者秒数（具体取决于系统的时间精度设置）。借助这个时间戳，在众多业务场景中都能发挥重要作用， + * 比如可以通过比较不同消息的创建时间来确定消息的先后顺序，实现消息按时间排序展示；也可以根据创建时间筛选出特定时间段内的消息， + * 满足用户查看某一时刻或某一区间内消息记录的需求；在数据分析方面，还能基于时间戳统计不同时间段内消息的发送量等情况， + * 对消息的时效性和时间维度的分析提供了有力的数据支持。 */ private Long createTime; /** - * 消息创建时间 + * 消息创建时间的字符串表示形式，它是将前面提到的时间戳按照一定的日期时间格式转换而来的，便于在需要将时间信息以更直观、 + * 符合人类阅读习惯的方式展示给用户或者在某些特定业务要求必须使用字符串格式时间的场景中使用。常见的格式可能有"yyyy-MM-dd HH:mm:ss" + * （表示年-月-日 时:分:秒）等，例如在即时通讯软件的聊天界面上，消息旁边显示的发送时间就是以这种易于理解的字符串形式呈现的， + * 让用户能够清晰地知晓消息的发送时刻，提升了用户体验和对时间信息的可读性。 */ private String strCreateTime; /** - * 消息内容字符串 + * 消息内容字符串，对于文本消息而言，这个字段直接承载了具体的文本内容，也就是用户实际输入并发送的文字信息。 + * 而对于其他非文本类型的消息（如图像、语音、视频等），它可能会以一种特定的、与业务相关的字符串格式来表示该消息的核心内容 + * 或者相关描述信息。例如对于图片消息，可能存储的是图片的一些基本属性信息以字符串形式拼接而成的内容；对于语音消息， + * 也许是语音的时长、格式等相关信息组成的字符串。总之，这个字段是消息承载具体信息的关键部分，在消息展示、内容处理等 + * 业务逻辑中处于核心地位，是用户最为关注的消息属性之一。 */ private String strContent; /** - * 引用消息内容 + * 引用消息内容，主要用于在回复消息、转发消息或者引用消息进行其他操作的场景中，存储被引用的那条消息的部分内容。 + * 比如在回复他人消息时，为了让回复内容更具针对性和连贯性，常常会引用对方之前发送的部分关键文字内容，此时这个字段就会 + * 保存被引用的那部分文字，以便在展示回复消息时，能够清晰地呈现出消息之间的引用关系，让接收方更好地理解整个消息的上下文， + * 知晓回复内容与之前消息的关联，增强消息交互的逻辑性和连贯性。 */ private String referMsgContent; /** - * 聊天者字符串 + * 聊天者字符串，通常以字符串的形式存储参与聊天的主体的相关标识信息，这可能是聊天对方的用户名、昵称， + * 也有可能是在整个系统内为该用户分配的唯一标识字符串（如用户ID的字符串表示形式）等。在多用户聊天的环境中， + * 通过这个字段可以快速且准确地确定每一条消息对应的聊天对象是谁，方便在查找特定用户的聊天记录、对不同用户的消息 + * 进行分类展示以及实现基于用户的消息统计等业务场景中使用，确保消息与具体的聊天者能够紧密关联起来，避免消息归属的混淆。 */ private String strTalker; /** - * 头像 + * 头像，用于存放与聊天者或者消息相关主体的头像相关的信息，其存储形式多样，常见的有头像对应的网络链接（例如在网页应用中， + * 通过这个链接可以从服务器上获取头像图片进行展示）、本地文件路径（如果是桌面应用，头像文件存储在本地磁盘时的路径）， + * 或者是将头像图片经过某种编码方式（如Base64编码）转换后的字符串形式等。无论采用哪种存储形式，目的都是为了在界面上能够 + * 正确地展示出聊天相关人员的头像，使用户可以直观地识别聊天对象的身份特征，提升用户体验和界面的友好性。 */ private String avatar; /** - * 图片地址Md5 + * 图片地址Md5，它是通过对图片的地址（这个地址可以是网络上的图片URL，也可以是本地存储图片的文件路径等）运用MD5算法计算 + * 得到的一个哈希值，并以字符串形式进行存储。MD5哈希值具有唯一性和固定长度的特点，利用这一特性，在很多业务场景中可以发挥作用， + * 比如验证图片地址的唯一性，避免重复添加相同的图片资源；在图片缓存机制中，通过比较图片地址的MD5值来判断是否已经缓存过该图片， + * 进而决定是否需要重新下载；在图片资源管理方面，也可以通过MD5值来快速查找和比对图片地址，确保图片相关操作的准确性和高效性。 */ private String imgMd5; /** - * 图片缩略图 + * 图片缩略图，用于存储图片的缩略图相关信息，其存储形式通常与图片本身类似，可能是缩略图对应的网络链接（方便在网页端快速加载展示）、 + * Base64编码后的字符串表示（便于在某些特定的数据传输或存储场景中使用）等。缩略图的主要作用在于，在需要展示图片的场景中， + * 尤其是当图片数量较多或者网络环境不佳、加载完整图片速度较慢的情况下，先展示缩略图能够让用户快速了解图片的大致内容和外观， + * 起到一个预览的效果，同时也能提高页面的整体加载速度，改善用户的浏览体验，而当用户需要查看图片的详细内容时，再加载完整图片。 */ private String thumb; /** - * 图片 + * 图片，这个字段用于存储图片的完整信息，同样，其存储形式可以是图片的网络链接（比如在网页应用中通过链接获取并展示图片）、 + * Base64编码后的字符串（在一些需要将图片数据嵌入到其他数据结构中传输或存储的场景下使用）等，具体取决于业务系统中图片的 + * 存储和传递策略。当需要在界面上完整地展示图片的详细内容、对图片进行进一步的操作（如放大查看、编辑等）时，就会依赖这个字段 + * 所存储的图片信息来实现相应功能。 */ private String image; /** - * 表情Url + * 表情Url，主要用于存储表情符号对应的网络链接信息，在即时通讯、社交软件等应用场景中，用户在发送消息时常常会使用表情来丰富 + * 表达内容，而系统则需要根据这个表情Url去获取对应的表情图片，并在消息展示界面上正确地加载和显示出来，让用户看到生动形象的表情， + * 增强消息的趣味性和情感表达，提升用户之间的交互体验。 */ private String emojiUrl; /** - * compressContent + * compressContent，用于存储经过压缩处理后的消息内容，以字节数组的形式存在。之所以采用字节数组，是因为消息内容经过压缩后， + * 通常呈现为二进制数据的形式，字节是表示二进制数据的基本单位，所以用字节数组来存储最为合适。同时，这个字段标注了@JsonIgnore注解， + * 意味着在进行JSON序列化（将Java对象转换为JSON格式的字符串，常用于网络传输、数据存储等场景）和反序列化（将JSON格式的字符串转换回Java对象）操作时， + * 这个字段会被忽略，不会被包含在最终生成的JSON数据或者从JSON数据解析生成的对象中。这通常是因为该字段所存储的压缩内容主要是为了在系统内部 + * 节省网络传输带宽、减少存储体积等目的而存在的，不需要对外进行展示或者传输给其他外部系统，仅在内部处理消息相关逻辑时发挥作用。 */ @JsonIgnore private byte[] compressContent; /** - * bytesExtra + * bytesExtra，同样是以字节数组的形式来存储一些与消息相关的额外数据，这些数据的具体内容和用途取决于具体的业务需求， + * 它可能包含消息的加密校验信息（例如对消息进行加密后，存储一些用于验证解密后消息是否正确的校验码等信息）、特定的元数据（如消息的来源IP地址、 + * 消息经过的中间服务器标识等额外的描述性信息）等。与compressContent字段一样，也标注了@JsonIgnore注解，在JSON序列化和反序列化时会被忽略， + * 只在系统内部针对消息的特殊处理逻辑中使用，辅助完成一些特定的业务功能，保障消息处理的完整性和准确性。 */ @JsonIgnore private byte[] bytesExtra; /** - * 小程序信息 + * 小程序信息，通过WeAppInfoVO这个自定义的值对象来承载小程序相关的详细信息。WeAppInfoVO类应该是另外定义的一个专门用于描述小程序属性的数据结构， + * 在这里的MsgVO类中，weAppInfo字段通过引用这个值对象来存储小程序的各种相关信息，例如小程序的名称（方便用户识别是哪个小程序）、小程序的ID（在系统中唯一标识该小程序）、 + * 小程序页面路径（用于指定进入小程序后展示的具体页面等情况）等内容。当消息中涉及小程序相关的展示、交互等业务场景时（比如用户在聊天窗口中分享小程序链接， + * 接收方收到消息后需要展示小程序的相关信息并支持点击进入小程序等操作），这个字段所包含的WeAppInfoVO对象就能够完整地传递小程序的各项属性， + * 便于在不同的业务层之间进行数据传递和处理，确保小程序相关的功能能够正常实现。 */ private WeAppInfoVO weAppInfo; /** - * 卡片链接 + * 卡片链接，借助CardLinkVO这个自定义的值对象来存储卡片链接相关的详细信息。CardLinkVO类想必也是专门为描述卡片链接属性而设计的， + * 它可以存储卡片标题（用于在界面上展示卡片时让用户快速了解链接的大致内容）、卡片描述（提供更详细的关于链接指向内容的介绍）、 + * 链接地址（明确点击卡片后要跳转到的具体网址等信息）等内容。在消息中如果包含了卡片形式的内容（比如分享网页链接时，在消息中以卡片样式展示链接信息）， + * 利用这个字段所包含的CardLinkVO对象，就可以准确无误地传递卡片的完整信息，方便在界面上以美观、直观的方式展示卡片外观，并且实现用户点击卡片后 + * 顺利跳转到对应链接的功能，提升消息中链接分享等场景下的用户体验。 */ - private CardLinkVO cardLink; + private CardLinkVO cardLink;} - /** - * 聊天人Id - */ - private String wxId; -} diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/PageVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/PageVO.java index 609e466..fad4e2e 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/PageVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/PageVO.java @@ -2,36 +2,65 @@ package com.xcs.wx.domain.vo; import lombok.AllArgsConstructor; import lombok.Data; - import java.util.List; /** - * PageVO + * PageVO类是一个通用的分页数据值对象（Value Object，VO），在处理分页相关业务逻辑时发挥着重要作用。 + * 它通过使用泛型 ，使得这个类能够灵活适配不同类型的数据分页需求，无论是存储用户信息、商品信息，还是其他任何业务对象的分页数据， + * 都可以借助该类进行统一的封装和传递，增强了代码的通用性和复用性。常用于在数据访问层获取分页数据后，传递给业务逻辑层进行处理， + * 或者从业务逻辑层传递到展示层用于页面展示等场景，确保分页相关的数据在不同层之间能够清晰、规范地流转。 * * @author xcs - * @date 2023年12月29日 16时19分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体包括： +// - 为类中的每一个私有属性自动生成对应的getter方法，方便外部代码获取各个属性的值。例如，在其他类中可以通过调用getCurrent()方法获取当前页数， +// 调用getPageSize()方法获取每页显示的数据条数等，这有助于对分页相关属性进行访问和使用。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值。比如，根据用户的选择改变当前页数或者每页显示的数量等， +// 增强了对象属性值的可修改性和灵活性。 +// - 生成toString方法，该方法能将PageVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前分页对象的具体状态，了解各个分页属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将PageVO对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个PageVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及分页数据比较的业务逻辑中（如判断两个分页结果是否一致），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 @AllArgsConstructor +// @AllArgsConstructor注解同样来自Lombok库，它会自动为这个类生成一个包含所有参数的构造函数。 +// 对于PageVO类来说，这个构造函数的参数顺序和类型与类中的属性声明顺序和类型是一一对应的， +// 即构造函数形如：public PageVO(Long current, Long pageSize, Long total, List records) {...}。 +// 这样在创建PageVO对象实例时，就可以很方便地一次性传入当前页数、页数大小、总页数以及查询结果数据列表这些参数来完成对象的初始化， +// 提高了代码创建分页对象的便利性和可读性，尤其是在需要同时为多个属性赋值时，避免了逐个调用setter方法来设置属性值的繁琐操作。 public class PageVO { /** - * 当前页数 + * 当前页数，表示当前所处的页码位置，通常从1开始计数（具体计数起始值可能根据业务约定有所不同，但多数情况下为1）。 + * 例如，当用户在分页列表中查看第三页的数据时，这个属性的值就会被设置为3。它是用户在分页浏览数据时进行定位和导航的重要依据， + * 通过改变这个值，用户可以切换到不同的页面查看相应的数据内容，同时在业务逻辑中，也常依据当前页数来计算数据的偏移量等信息， + * 以便从数据源准确地获取对应页面的数据记录。 */ private Long current; /** - * 页数大小 + * 页数大小，指的是每页显示的数据记录数量，例如每页显示10条记录时，该属性的值就会被设置为10。 + * 它决定了每次分页查询时返回的数据量多少，合理设置页数大小有助于在展示大量数据时，既保证页面不会一次性加载过多数据导致性能问题， + * 又能让用户方便地浏览和查找所需信息，是分页展示数据时控制数据量的关键因素，同时也会影响总页数的计算以及分页导航的相关逻辑。 */ private Long pageSize; /** - * 总页数 + * 总页数，是根据总的数据记录数量以及设定的每页大小计算得出的，表示整个数据集按照当前设定的每页显示数量划分后，总共会形成的页数。 + * 比如，总共有100条数据记录，每页大小设置为10条，那么总页数就是10页（计算方式通常为总记录数除以每页大小，向上取整得到总页数）。 + * 总页数用于界定分页导航的边界范围，在界面上展示分页导航栏（如显示上一页、下一页、跳转到指定页等操作按钮）时，会依据总页数来判断是否显示相应的按钮， + * 防止出现超出总页数范围的无效操作，同时也有助于在业务逻辑中对分页整体情况进行判断和控制。 */ private Long total; /** - * 查询条件 + * 查询条件，使用泛型List来存储具体的查询结果数据记录，这里的T可以是任意类型，具体取决于实际业务中分页查询所针对的数据类型。 + * 例如，如果是对用户信息进行分页查询，T就可以是代表用户信息的自定义类（如UserVO类），这个列表中就会存放当前页所包含的具体用户信息对象； + * 如果是对商品信息进行分页查询，T则可以是商品信息类（如ProductVO类），列表中就存储相应的商品信息对象。它承载了当前页要展示给用户的数据内容， + * 是分页数据值对象的核心部分，通过这个属性可以方便地获取和操作当前页的具体数据记录，用于页面展示、后续的数据处理等业务场景。 */ private List records; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/RecentUsedKeyWordVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/RecentUsedKeyWordVO.java index f30d185..fc21349 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/RecentUsedKeyWordVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/RecentUsedKeyWordVO.java @@ -4,17 +4,38 @@ import lombok.AllArgsConstructor; import lombok.Data; /** - * RecentUsedKeyWordVO + * RecentUsedKeyWordVO类是一个值对象（Value Object，VO），在系统中主要用于封装和传递与最近使用的关键字相关的数据。 + * 它在涉及搜索功能、消息处理、数据分析等诸多业务场景中发挥作用，通过将关键字信息整合在这个VO类中，方便在系统的不同模块、 + * 不同层次之间进行统一的传递和处理，确保各个部分对关键字相关的数据有着清晰、一致的操作对象，有助于提高代码的可读性和可维护性。 * * @author xcs - * @date 2024年01月23日 11时27分 + **/ @Data +// @Data注解由Lombok库提供，它为该类自动生成了多个常用的方法，具体如下： +// - 自动生成对应的getter方法，通过这个方法（名为getText()）可以方便地从对象中获取关键字的字符串内容， +// 在其他类需要访问这个关键字信息时，只需调用该方法即可，使得对关键字属性的访问更加便捷、规范。 +// - 自动生成对应的setter方法（名为setText(String text)），允许外部代码根据业务需求对关键字进行修改， +// 例如当用户输入了新的最近使用关键字时，可以通过调用这个setter方法来更新对象中的关键字内容，增强了对象属性的可操作性。 +// - 生成toString方法，该方法能将RecentUsedKeyWordVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及关键字的具体值， +// 在调试程序或者记录日志等场景下，通过打印对象的toString结果，可以快速查看当前关键字的具体情况，有助于排查问题和了解对象状态。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它根据对象的关键字属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便快速查找和比较对象。 +// - 生成equals方法，用于比较两个RecentUsedKeyWordVO对象是否在逻辑上相等，也就是判断它们所包含的关键字内容是否完全相同， +// 在涉及关键字比较的业务逻辑中（比如判断两个最近使用的关键字是否一致），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 @AllArgsConstructor +// @AllArgsConstructor注解同样来自Lombok库，它会自动为这个类生成一个包含所有参数的构造函数， +// 对于RecentUsedKeyWordVO类而言，构造函数的形式为：public RecentUsedKeyWordVO(String text) {...}， +// 这意味着在创建该类的对象实例时，只需要传入表示关键字的字符串参数即可完成对象的初始化，操作非常简便， +// 提高了创建对象时传递关键字数据的便利性和代码的可读性，使得代码在实例化这类对象时更加简洁明了。 public class RecentUsedKeyWordVO { /** - * 关键字 + * 关键字，以字符串（String）类型来存储具体的关键字内容。在实际应用场景中，这个关键字可以是用户在搜索框中近期输入的搜索词语， + * 比如在搜索引擎应用里，用户多次搜索“旅游攻略”“美食推荐”等，这些词语就可以作为最近使用的关键字被封装在这个对象中进行传递和处理； + * 也可以是在聊天应用中用户近期频繁使用的聊天关键词，像“工作进展”“周末活动”等，方便根据这些关键字进行相关的聊天记录查找、统计分析， + * 或者为用户提供更贴合其使用习惯的智能回复等功能，它代表了系统中需要重点关注、传递以及后续进行业务逻辑处理的关键文本信息。 */ private String text; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/RecoverContactVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/RecoverContactVO.java index 11210d3..e6b518a 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/RecoverContactVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/RecoverContactVO.java @@ -6,38 +6,63 @@ import com.alibaba.excel.annotation.write.style.ColumnWidth; import lombok.Data; /** - * RecoverContactVO + * RecoverContactVO类是一个值对象（Value Object，VO），通常用于在系统不同模块之间传递与恢复联系人相关的数据结构， + * 例如在从数据存储层获取联系人恢复相关信息后传递给业务逻辑层进行处理，或者将处理后的联系人信息传递给导出工具（如用于Excel导出）等场景中使用， + * 起到整合和传递联系人关键数据的作用，使数据流转更加清晰、规范。 * * @author xcs - * @date 2024年6月14日15:29:54 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体包括： +// - 自动生成所有私有属性对应的getter方法，方便外部代码获取各个属性的值，例如通过调用getDocId()、getAlias()等方法来获取相应属性内容， +// 这有助于在其他类中访问RecoverContactVO对象的具体属性信息。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，比如可以通过调用setAlias(String alias)等方法来更新属性值， +// 增强了对象属性的可操作性，便于数据的动态变化和处理。 +// - 生成toString方法，该方法能将RecoverContactVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个RecoverContactVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及对象比较的业务逻辑中（如判断两个联系人信息是否一致），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 public class RecoverContactVO { /** - * 本地唯一标识符，自增。 + * 本地唯一标识符，通常由数据库等存储机制按照自增规则来生成，用于在本地系统环境中唯一地标识每一条联系人相关的记录。 + * 例如在数据库的联系人表中，每当插入一条新的联系人数据时，这个标识符的值就会自动增加一个固定的步长（常为1）， + * 方便后续对联系人信息进行查询、排序、关联其他相关数据表（如通过外键关联联系人与所属分组等信息）时，能够准确无误地定位到具体的某条联系人记录， + * 保证了数据操作的准确性和唯一性。这里使用了@ExcelIgnore注解，表示在使用阿里巴巴的Excel操作相关工具进行数据导出或导入等操作时， + * 忽略这个字段，即不会将该字段的数据写入到Excel文件中，也不会从Excel文件中读取对应的数据到这个字段，因为该字段可能主要用于本地系统内部的标识， + * 对外导出展示等场景通常不需要体现。 */ @ExcelIgnore private Integer docId; /** - * alias + * alias，从语义上看可能表示联系人的别名（比如在微信中可能类似微信号等），使用了@ExcelProperty注解来指定在Excel文件中的表头名称为“微信号”， + * 这意味着当使用阿里巴巴的Excel操作工具将RecoverContactVO对象的数据导出到Excel文件时，这个字段的数据会对应到表头为“微信号”的列下。 + * 同时，使用了@ColumnWidth注解并设置宽度为50，表示在Excel文件中该列的宽度会被设置为50个单位（具体单位根据Excel操作库的设定来确定）， + * 这样可以控制该列在Excel中展示时的宽度，使表格展示更加美观、清晰，方便查看相应的数据内容。 */ @ExcelProperty("微信号") @ColumnWidth(50) private String alias; /** - * nickname + * nickname，很明显表示联系人的昵称，通过@ExcelProperty注解将其在Excel文件中的表头名称指定为“昵称”， + * 当进行Excel相关操作时，这个字段的数据就会准确地填充到对应表头为“昵称”的列中，便于直观地展示联系人的昵称信息。 + * 并且使用@ColumnWidth注解设置列宽为100，确保昵称列在Excel文件中有合适的宽度来展示可能较长的昵称内容，避免出现数据显示不全的情况。 */ @ExcelProperty("昵称") @ColumnWidth(100) private String nickname; /** - * c2remark + * c2remark，从命名推测可能是联系人的备注信息，同样使用@ExcelProperty注解将其对应的Excel表头名称定义为“备注”， + * 使得在导出到Excel文件时，该字段的数据能正确地放置在表头为“备注”的列下，方便查看联系人对应的备注内容。 + * 而@ColumnWidth(100)的设置也是为了给备注列提供足够的宽度，以完整展示可能较为详细的备注信息，提升Excel文件中数据展示的可读性和完整性。 */ @ExcelProperty("备注") @ColumnWidth(100) private String remark; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/ResponseVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/ResponseVO.java index 5ea97d6..f3b7d66 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/ResponseVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/ResponseVO.java @@ -3,55 +3,86 @@ package com.xcs.wx.domain.vo; import lombok.Data; /** - * ResponseVO + * ResponseVO类是一个通用的响应数据值对象（Value Object，VO），常用于在系统不同模块或层之间传递操作的响应结果信息， + * 例如在服务层处理完业务逻辑后，将处理结果封装到该对象中返回给控制层，再由控制层将其转换为合适的格式（如JSON格式）返回给前端等调用方， + * 使得响应数据的结构清晰、规范，便于调用方统一处理不同操作的结果情况。 * * @author xcs - * @date 2023年12月25日 17时31分 + * @date 2023年12月25日 17时31分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 为类中的每一个私有属性自动生成对应的getter方法，方便外部代码获取各个属性的值，例如可以通过调用getSuccess()获取业务编码状态， +// 通过getErrorCode()获取错误编码等，便于对响应结果中的各部分信息进行访问和后续处理。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，比如在构建响应对象时， +// 通过调用setSuccess(boolean success)方法来设置业务是否成功等，增强了对象属性值的可修改性和灵活性。 +// - 生成toString方法，该方法能将ResponseVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前响应对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个ResponseVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及响应结果比较的业务逻辑中（如判断两次相同操作的响应是否一致），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 public class ResponseVO { /** - * 业务编码 + * 业务编码，使用布尔类型（Boolean）来表示业务操作是否成功，通常true表示业务处理成功，false表示业务处理出现问题或失败， + * 这是调用方首先关注的关键信息之一，用于快速判断整体业务的执行情况，以便后续根据该状态进行不同的处理逻辑，例如成功时展示数据， + * 失败时提示相应的错误信息等。 */ private Boolean success; /** - * 错误编码 + * 错误编码，当业务操作出现错误时，通过这个整数类型（Integer）的字段来记录具体的错误代码，不同的错误代码可以对应不同类型的错误情况， + * 例如在一个Web应用中，1001可能表示数据库连接错误，1002表示参数验证不通过等，方便在系统中对错误进行分类、定位以及统一的处理， + * 特别是在日志记录、错误提示给前端等场景下，可以依据错误编码快速知晓具体的错误原因类别，进而采取相应的解决措施。 */ private Integer errorCode; /** - * 错误消息 + * 错误消息，以字符串（String）类型存储详细的错误描述信息，当业务出现错误时，这个字段会给出具体的错误提示内容， + * 相比于错误编码更加直观易懂，例如“数据库连接超时，请检查网络配置”“用户名格式不符合要求，请重新输入”等，方便开发人员调试问题以及将 + * 具体的错误情况反馈给前端展示给用户，让用户清楚了解操作失败的原因所在。 */ private String errorMessage; /** - * 页数 + * 页数，用于在涉及分页相关业务操作的响应结果中，表示当前返回数据所在的页码信息，通常在查询列表数据并分页返回时使用， + * 例如当查询用户列表数据分页展示时，这个字段会告知调用方当前返回的这部分数据是第几页的内容，方便前端进行分页导航等相关逻辑的处理， + * 其值一般从1开始计数（具体根据业务约定可能会有不同），与其他分页相关的属性（如total属性）配合使用来完整呈现分页情况。 */ private Long page; /** - * 总数量 + * 总数量，同样是在分页相关业务场景中使用，用于表示符合查询条件的所有数据的总条数，结合page属性以及每页显示的数据量（通常由其他相关配置确定）， + * 可以计算出总页数等分页相关信息，方便前端等调用方全面了解数据的整体规模以及分页情况，例如总共有100条用户数据，当前返回第2页，每页显示10条， + * 调用方就能通过这些信息清晰知晓分页的整体状态以及剩余未获取的数据情况等。 */ private Long total; /** - * 展示类型 + * 展示类型，使用整数类型来表示数据展示的不同方式或样式等相关分类信息，具体含义和取值取决于业务的具体设定， + * 例如在一个具有多种数据展示模板的系统中，1可能表示列表形式展示，2表示卡片形式展示等，通过这个字段可以让调用方知晓如何对返回的数据进行合适的展示处理， + * 不过具体的含义需要结合业务实际情况来明确，不同的业务场景下其用途和取值规则会有所差异。 */ private Integer showType; /** - * 数据 + * 数据，通过泛型（T）来表示具体的业务数据内容，它可以是任意类型的数据，取决于实际业务操作所返回的数据类型， + * 比如在查询用户信息的业务中，T可以是代表用户信息的自定义类（如UserVO），这里就存放具体的用户信息对象列表；在查询商品信息时， + * T则可以是商品信息类（如ProductVO），用于承载相应的商品数据，它是响应结果中真正包含业务核心信息的部分，也是调用方在业务成功时重点关注获取的内容。 */ private T data; /** - * 成功 + * 成功静态方法，用于便捷地创建表示业务成功的ResponseVO对象实例，并且封装传入的数据。 + * 它接收一个泛型类型的数据参数（data），该参数代表业务操作成功后要返回的具体业务数据，然后创建一个ResponseVO对象， + * 将业务编码（success）设置为true，表示业务成功，同时把传入的数据设置到data属性中，最后返回这个构建好的ResponseVO对象， + * 方便在业务层等代码中快速返回成功的响应结果，避免了手动创建对象并逐个设置属性的繁琐操作，提高了代码的简洁性和编写效率。 * - * @param data 数据 - * @param 泛型对象 - * @return ResponseDTO + * @param data 数据，即业务操作成功后要返回的具体业务数据，其类型由泛型T决定，可以是任意符合业务需求的类型。 + * @param 泛型对象，用于使该方法能适配不同类型的业务数据返回情况，增强方法的通用性。 + * @return ResponseVO，返回构建好的表示业务成功的ResponseVO对象实例，包含传入的业务数据以及设置好的业务成功状态。 */ public static ResponseVO ok(T data) { ResponseVO wrapper = new ResponseVO<>(); @@ -61,13 +92,16 @@ public class ResponseVO { } /** - * 成功 + * 另一个成功静态方法，相较于上面的ok(T data)方法，此方法除了封装业务数据外，还额外设置了页数（page）和总数量（total）属性， + * 适用于分页查询业务成功且需要返回分页相关信息的场景。它接收业务数据（data）以及表示当前页数（page）和总数量（total）的参数， + * 同样先创建一个ResponseVO对象，然后将业务编码设置为true，把传入的数据设置到data属性，再分别设置page和total属性的值， + * 最后返回构建好的包含分页信息的成功响应对象，方便在分页查询操作成功时准确地向调用方传递业务数据以及分页情况。 * - * @param data 数据 - * @param 泛型对象 - * @param page 页数 - * @param total 总数量 - * @return ResponseDTO + * @param data 数据，即分页查询业务操作成功后要返回的具体业务数据，其类型由泛型T决定，可以是任意符合业务需求的类型。 + * @param 泛型对象，用于使该方法能适配不同类型的业务数据返回情况，增强方法的通用性。 + * @param page 页数，用于指定当前返回数据所在的页码，其值一般从1开始计数（根据业务约定可能有不同）。 + * @param total 总数量，用于表示符合查询条件的所有数据的总条数，与page属性配合体现分页情况。 + * @return ResponseVO，返回构建好的表示分页查询业务成功的ResponseVO对象实例，包含传入的业务数据、设置好的业务成功状态以及分页相关信息。 */ public static ResponseVO ok(T data, Long page, Long total) { ResponseVO wrapper = new ResponseVO<>(); @@ -79,10 +113,15 @@ public class ResponseVO { } /** - * 失败 + * 失败静态方法，用于创建表示业务失败的ResponseVO对象实例，并设置相应的错误编码（errorCode）和错误消息（errorMessage）属性， + * 方便在业务出现错误时统一返回包含错误信息的响应结果给调用方。它接收表示错误编码和错误消息的参数，创建ResponseVO对象后， + * 将业务编码（success）设置为false，表示业务失败，设置传入的错误编码到errorCode属性，设置传入的错误消息到errorMessage属性， + * 同时将展示类型（showType）设置为一个默认值（这里设置为2，具体含义可能根据业务而定），最后返回构建好的表示业务失败的ResponseVO对象， + * 使得在业务逻辑中出现错误情况时，能够规范、便捷地返回相应的错误响应，便于调用方知晓具体的错误情况并进行后续处理。 * - * @param 数据 - * @return ResponseDTO + * @param 泛型对象，虽然在业务失败时通常不涉及具体业务数据的返回，但通过保持泛型定义，使该方法在形式上与其他成功方法保持一致， + * 增强整个ResponseVO类在构建响应对象时的通用性和统一性，这里T可以是任意类型（实际业务失败时一般不关注其具体类型）。 + * @return ResponseVO，返回构建好的表示业务失败的ResponseVO对象实例，包含设置好的业务失败状态、错误编码以及错误消息等信息。 */ public static ResponseVO error(Integer errorCode, String errorMessage) { ResponseVO wrapper = new ResponseVO<>(); @@ -92,4 +131,4 @@ public class ResponseVO { wrapper.setErrorMessage(errorMessage); return wrapper; } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/SessionVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/SessionVO.java index eb8ab17..30b7bb3 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/SessionVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/SessionVO.java @@ -3,41 +3,66 @@ package com.xcs.wx.domain.vo; import lombok.Data; /** - * SessionVO + * SessionVO类是一个值对象（Value Object，VO），在系统中通常用于封装和传递与会话相关的数据信息， + * 比如在即时通讯、在线客服等涉及会话场景的业务中，方便在不同模块（如数据获取层、业务逻辑层、展示层等）之间传递完整的会话数据结构， + * 确保各层之间对会话相关信息的交互有着统一、清晰的格式，有助于提高代码的可读性以及后续的维护性。 * * @author xcs - * @date 2023年12月21日 18时13分 + * @date 2023年12月21日 18时13分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，通过这些方法（例如getUserName()、getNickName()等），外部代码可以方便地获取类中各个属性的值， +// 这在访问会话相关的具体属性信息时非常有用，比如在展示会话信息时获取用户名、用户昵称等内容。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够对类中的属性进行赋值操作，便于根据业务需求动态地修改对象的属性值， +// 例如当用户更新了昵称，就可以通过调用setNickName(String newNickName)方法来更新nickName属性的值。 +// - 生成toString方法，该方法能将SessionVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前会话对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，这个方法在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会被用到， +// 它根据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便快速查找和比较对象。 +// - 生成equals方法，用于比较两个SessionVO对象是否在逻辑上相等，即判断它们的所有属性值是否都完全相同， +// 在涉及会话对象比较的业务逻辑中（如判断两个会话是否为同一用户、同一时间等情况），该方法起着关键作用。 +// 通过使用@Data注解，大大减少了手动编写这些重复且基础的方法的工作量，使代码更加简洁、易读和易维护。 public class SessionVO { /** - * 用户名 + * 用户名，以字符串（String）类型存储用户在系统中的名称标识，这个名称一般具有唯一性， + * 常用于用户登录、系统内部对用户的区分以及在涉及用户相关操作的业务逻辑中进行准确的用户定位等， + * 在会话场景中，通过用户名可以明确知道是哪个用户参与了此次会话，是会话相关信息中重要的基础属性之一。 */ private String userName; /** - * 用户昵称 + * 用户昵称，同样是字符串类型，是用户对外展示的一个称呼，相较于用户名可能更加个性化、易读， + * 用户可以自行设置和修改昵称，在会话场景中，昵称通常会展示给其他参与会话的人员，方便他人更友好、直观地识别用户， + * 增强了会话中的用户交互体验和信息展示的友好性。 */ private String nickName; /** - * 会话内容 + * 会话内容，存储具体的会话文本信息，也就是参与会话的用户之间交流的内容，以字符串形式体现， + * 它是会话的核心部分，承载着用户之间传递的消息、想法等关键信息，在展示会话记录、分析会话内容等业务场景中是重点关注的属性。 */ private String content; /** - * 消息时间戳 + * 消息时间戳，采用整数（Integer）类型来记录消息发送或产生的时间点，一般是以某个特定的起始时间为基准（如Unix时间戳以1970年1月1日00:00:00 UTC为起点）， + * 到消息实际产生时刻所经过的秒数或者毫秒数等（具体取决于系统的时间精度设定），通过这个时间戳，可以准确判断会话中消息的先后顺序、 + * 消息的时效性，也便于在进行会话记录的排序、筛选特定时间段内的会话等业务操作时作为时间依据，确保会话在时间维度上的准确性和有序性。 */ private Integer time; /** - * 短时间 + * 短时间，以字符串类型存储经过格式化后的相对简短的时间表示形式，它通常是将前面的消息时间戳按照一定的简单格式转换而来， + * 例如“10:30”（表示10点30分）、“昨天 15:20”等形式，便于在会话界面等场景中以一种更简洁、符合用户阅读习惯的方式展示消息的时间， + * 让用户能够快速知晓会话发生的大致时间，提升用户查看会话记录时对时间信息的可读性和便捷性。 */ private String shortTime; /** - * 头像Url + * 头像Url，以字符串形式存放用户头像对应的网络链接地址，在需要展示用户头像的会话界面等场景中， + * 通过这个链接，系统可以从服务器或者其他指定的网络位置获取头像图片并进行展示，使用户能够直观地识别参与会话的用户身份， + * 进一步丰富会话界面的信息展示，提升用户体验和会话交互的可视化效果。 */ private String headImgUrl; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/StatsPanelVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/StatsPanelVO.java index 7c2767f..58684f2 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/StatsPanelVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/StatsPanelVO.java @@ -4,32 +4,59 @@ import lombok.AllArgsConstructor; import lombok.Data; /** - * StatsPanelVO + * StatsPanelVO类是一个值对象（Value Object，VO），主要用于封装和传递与统计面板相关的数据结构， + * 通常在涉及展示系统相关统计信息的业务场景中发挥作用，比如在即时通讯软件的个人信息统计页面、管理后台的概况统计板块等地方， + * 方便将不同维度的统计数据整合在一起，在系统的不同模块、不同层次之间进行统一的传递和展示，确保统计数据的流转清晰、规范，便于后续处理和展示操作。 * * @author xcs - * @date 2024年01月23日 17时25分 + * @date 2024年01月23日 17时25分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，通过这些方法（例如getContact()、getChatRoom()等），外部代码可以方便地获取类中各个属性的值， +// 这在访问统计面板相关的具体属性信息时非常有用，比如在前端页面展示统计数据时获取联系人数量、群聊数量等内容，便于进行数据展示和后续处理。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够对类中的属性进行赋值操作，便于根据业务需求动态地修改对象的属性值， +// 例如当有新的联系人添加或者消息收发情况发生变化时，可以通过调用相应的setter方法来更新对象中的属性值，增强了对象属性的可操作性和灵活性。 +// - 生成toString方法，该方法能将StatsPanelVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前统计面板对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个StatsPanelVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及统计数据比较的业务逻辑中（如判断不同时间段或者不同用户的统计面板数据是否一致），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 @AllArgsConstructor +// @AllArgsConstructor注解同样来自Lombok库，它会自动为这个类生成一个包含所有参数的构造函数， +// 对于StatsPanelVO类而言，构造函数的形式为：public StatsPanelVO(Integer contact, Integer chatRoom, Integer sent, Integer received) {...}， +// 这意味着在创建该类的对象实例时，只需要依次传入表示联系人数量、群聊数量、今日发送消息数量以及今日接收消息数量的整数参数，即可完成对象的初始化， +// 操作非常简便，提高了创建对象时传递统计数据的便利性和代码的可读性，使得代码在实例化这类对象时更加简洁明了。 public class StatsPanelVO { /** - * 联系人数量 + * 联系人数量，使用整数（Integer）类型来存储系统中联系人的个数统计值，这个数量统计涵盖了用户所有的个人联系人， + * 例如在即时通讯软件里，包括好友、关注的人等不同类型的联系人总和，通过这个属性可以直观地展示用户社交关系网络中联系人方面的规模情况， + * 是统计面板上反映用户社交资源的一个重要指标，常用于在个人信息页面或者系统概况展示中让用户了解自己的社交人脉数量等情况。 */ private Integer contact; /** - * 群聊数量 + * 群聊数量，同样以整数类型记录用户所参与的群聊的个数，在很多社交、协作类的应用中，群聊是多人交流互动的重要方式， + * 这个属性能够体现用户在群体交流方面的参与程度和规模，比如展示用户加入了多少个工作群、兴趣交流群等，是统计面板中用于呈现用户群体社交活动情况的关键指标之一， + * 方便用户对自己参与的群聊整体情况有清晰的认知，也有助于系统从群聊维度进行相关的数据分析和管理。 */ private Integer chatRoom; /** - * 今日发送消息数量 + * 今日发送消息数量，以整数来表示在当前这一天内用户发送出去的消息的总条数，它从消息发送的角度反映了用户当天的活跃程度和交流频率， + * 在即时通讯、社交互动等应用场景中，这个统计数据可以帮助用户了解自己当天的沟通情况，同时对于系统来说，也能基于这样的数据进行用户行为分析、 + * 消息流量监控等相关操作，是衡量用户当日信息输出情况的重要量化指标，常用于每日活跃情况统计、消息使用频率分析等业务场景中展示。 */ private Integer sent; /** - * 今日接受消息数量 + * 今日接受消息数量，也是整数类型，用于统计当天用户接收到的消息的总条数，与今日发送消息数量相对应， + * 从消息接收端体现用户当天的信息获取情况，同样能反映用户的活跃程度以及在社交互动中的受关注程度等， + * 例如在一些社交平台上，通过对比发送和接收消息数量可以分析出用户是更倾向于主动发起交流还是更多地作为信息接收者参与互动， + /是统计面板里展示用户当日信息流入情况的关键统计数据，在多种数据分析和用户行为洞察的业务场景中有着重要作用。 */ private Integer received; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/TopContactsVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/TopContactsVO.java index 16b26e3..4dd3e38 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/TopContactsVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/TopContactsVO.java @@ -3,31 +3,53 @@ package com.xcs.wx.domain.vo; import lombok.Data; /** - * TopContactsVO + * TopContactsVO类是一个值对象（Value Object，VO），通常用于在系统中封装和传递与重要联系人相关的数据结构， + * 比如在即时通讯软件展示常联系的好友列表、社交平台呈现互动频繁的联系人排行等业务场景下，方便整合相关联系人的关键信息， + * 并在系统的不同模块、不同层级之间进行统一的传递和处理，使得数据流转更加清晰、有条理，便于后续的展示、分析等操作。 * * @author xcs - * @date 2024年01月06日 15时38分 + * @date 2024年01月06日 15时38分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体作用如下： +// - 自动生成所有私有属性对应的getter方法，例如通过调用getUserName()、getNickName()等方法，外部代码可以方便地获取类中各个属性的值， +// 这在需要访问联系人的具体属性信息时非常有用，比如在前端页面展示联系人信息时获取用户名、昵称等内容，便于数据的展示和使用。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当联系人更新了昵称， +// 可以通过调用setNickName(String newNickName)方法来更新nickName属性的值，增强了对象属性的可操作性和灵活性。 +// - 生成toString方法，该方法能将TopContactsVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前对象所代表的联系人的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个TopContactsVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及联系人对象比较的业务逻辑中（如判断两个联系人是否为同一人等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 public class TopContactsVO { /** - * 用户名 + * 用户名，以字符串（String）类型存储用户在系统中的唯一标识名称，这个名称通常具有唯一性， + * 在系统内部的诸多业务逻辑中（如用户登录、数据关联、权限管理等）依靠用户名来准确地定位和区分不同的用户， + * 在TopContactsVO类所涉及的场景里，通过用户名可以明确知道是哪个具体的用户被列为重要联系人，是联系人相关信息中关键的基础属性之一。 */ private String userName; /** - * 昵称 + * 昵称，同样是字符串类型，它是用户对外展示的一个比较个性化、友好的称呼，用户可以自行设置和修改昵称， + * 相较于用户名，昵称更加通俗易懂、便于记忆，在展示联系人信息时，昵称往往更能直观地让其他用户识别是谁， + * 增强了联系人展示的友好性和可读性，也是联系人相关信息中重要的用于展示和识别的属性。 */ private String nickName; /** - * 头像 + * 头像，以字符串形式存放用户头像对应的网络链接地址或者本地存储路径（具体取决于系统的实现方式）， + * 在需要展示联系人头像的业务场景中（如联系人列表、聊天界面等），通过这个地址或路径，系统可以获取相应的头像图片并进行展示， + * 使得用户能够直观地通过头像识别联系人身份，丰富了联系人信息的展示内容，提升用户体验和视觉识别效果。 */ private String headImgUrl; /** - * total + * total，使用长整数（Long）类型来存储与该联系人相关的某个统计总量数值，具体代表的含义取决于业务场景， + * 例如可能表示与该联系人的聊天消息总条数、互动次数总和、文件传输总量等，它是用于衡量该联系人在某个维度上与当前用户关联程度的量化指标， + * 通过这个属性可以对不同的重要联系人进行排序、对比等操作，便于筛选出真正互动频繁、联系紧密的联系人，在呈现重要联系人相关统计情况时起着关键作用。 */ private Long total; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/UserInfoVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/UserInfoVO.java index a1266f4..fde324f 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/UserInfoVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/UserInfoVO.java @@ -3,41 +3,68 @@ package com.xcs.wx.domain.vo; import lombok.Data; /** - * UserInfoVO + * UserInfoVO类是一个值对象（Value Object，VO），主要用于封装和传递与用户信息相关的数据， + * 在系统的不同模块、不同层级之间起到整合并传递用户关键信息的作用，例如在用户注册、登录后信息获取， + * 或者在不同业务功能模块间需要共享用户基础资料等场景下使用，确保用户信息的传递具有统一、清晰的格式， + * 便于后续对用户数据进行处理、展示以及其他相关操作，有助于提高代码的可读性和可维护性。 * * @author xcs - * @date 2024年6月28日16:13:53 + * @date 2024年6月28日16:13:53 */ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，像通过调用getBasePath()、getWxId()等方法，外部代码可以方便地获取类中各个属性的值， +// 这在需要访问用户具体属性信息时非常有用，比如在展示用户详情页面时获取文件目录、微信Id等内容，便于数据展示与后续使用。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当用户更新了手机号， +// 可以通过调用setMobile(String newMobile)方法来更新mobile属性的值，增强了对象属性的可操作性和灵活性。 +// - 生成toString方法，该方法能将UserInfoVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前用户信息对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个UserInfoVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及用户对象比较的业务逻辑中（如判断两个用户信息是否一致），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 public class UserInfoVO { /** - * 文件目录 + * 文件目录，以字符串（String）类型存储与用户相关的文件所在的路径信息，这个路径可以是本地磁盘上的文件夹路径， + * 例如在某个本地应用中，用户上传的文件、生成的配置文件等可能都存放在该指定的文件目录下；也可以是网络存储中的特定路径， + * 具体取决于系统的架构和文件存储的实现方式。它用于定位和管理与该用户相关的各类文件，是涉及文件操作以及用户数据管理时的重要属性之一。 */ private String basePath; /** - * 微信Id + * 微信Id，同样是字符串类型，用于唯一标识用户在微信生态系统（或者相关使用微信授权登录等场景的系统）中的身份， + * 类似于一个独特的账号标识，通过这个Id可以在微信相关的服务器端、客户端等进行用户的精准定位、数据关联以及各种业务操作， + * 在整合微信相关功能或者基于微信账号进行用户认证、信息同步等业务场景中，微信Id是关键的用户标识属性。 */ private String wxId; /** - * 昵称 + * 昵称，也是字符串类型，是用户对外展示的一个比较个性化、友好的称呼，用户可以自行设置和修改昵称， + * 相较于账号等相对固定且较为正式的标识，昵称更加通俗易懂、便于记忆，在社交互动、用户展示等场景中，昵称往往更能直观地让其他用户识别是谁， + * 是增强用户之间交互友好性和识别度的重要属性，也是体现用户个性化的关键元素之一。 */ private String nickname; /** - * 版本号 + * 版本号，以字符串形式记录用户所使用的软件、系统或者某个特定功能模块的版本标识信息，例如在手机应用中， + * 版本号可能呈现为“1.0.1”这样的格式，它用于区分不同阶段发布的软件版本，方便进行版本管理、功能更新提示以及兼容性判断等操作， + * 当涉及软件升级、不同版本间功能差异处理等业务场景时，版本号就是一个重要的参考依据，确保系统能根据用户的版本情况准确地提供相应服务。 */ private String version; /** - * 账号 + * 账号，以字符串类型存储用户在系统中用于登录、认证等操作的主要标识信息，这个账号可以是用户自行注册的用户名， + * 也可以是邮箱、手机号等其他可作为登录凭证的信息（具体取决于系统的登录验证机制），是用户进入系统、获取相应服务的重要“钥匙”， + * 在用户登录、权限管理以及涉及用户身份验证的诸多业务逻辑中起着核心的标识作用。 */ private String account; /** - * 手机号 + * 手机号，同样是字符串类型，存储用户的手机号码信息，手机号在很多系统中不仅可作为登录账号的一种形式， + * 还常用于身份验证（如接收验证码进行注册、登录、修改重要信息等操作）、消息通知（如接收系统推送的短信提醒）以及关联其他服务（如与手机号绑定的第三方账号授权等）， + /是与用户联系紧密且具有多种重要用途的关键属性，在涉及用户安全验证、信息推送以及多平台账号整合等业务场景中有着重要地位。 */ private String mobile; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/UserVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/UserVO.java index d086255..7b73a3e 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/UserVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/UserVO.java @@ -4,32 +4,58 @@ import lombok.AllArgsConstructor; import lombok.Data; /** - * UserVO - * + * UserVO类是一个值对象（Value Object，VO），在系统中主要用于封装和传递与用户相关的关键数据， + * 通常在涉及用户展示、用户状态管理以及不同模块间传递用户信息等业务场景中发挥作用， + * 能够使相关的用户数据以一种统一、清晰的结构在系统各部分之间流转，便于后续的操作与处理，提高代码的可读性和可维护性。 + * @author xcs - * @date 2023年12月10日20:21:02 + * @date 2023年12月10日20:21:02 */ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体作用如下： +// - 自动生成所有私有属性对应的getter方法，例如通过调用getWxId()、getNickname()等方法，外部代码能够方便地获取类中各个属性的值， +// 在需要展示用户信息、根据用户属性进行相关业务逻辑判断等场景下，这些getter方法能便捷地提供对应属性的数据访问途径。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码可以根据业务需求动态地修改对象的属性值，比如当用户更新了昵称， +// 可以通过调用setNickname(String newNickname)方法来更新nickname属性的值，从而保证对象属性能够灵活地反映用户数据的变化。 +// - 生成toString方法，该方法会将UserVO对象以一种直观、易于阅读的字符串形式展示出来，通常包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前用户对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个UserVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及用户对象比较的业务逻辑中（如判断两个用户是否为同一人、状态是否一致等情况），该方法能够准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 @AllArgsConstructor +// @AllArgsConstructor注解同样来自Lombok库，它会自动为这个类生成一个包含所有参数的构造函数， +// 对于UserVO类而言，构造函数的形式为：public UserVO(String wxId, String nickname, String avatar, boolean current) {...}， +// 这意味着在创建该类的对象实例时，只需要依次传入微信Id（wxId）、昵称（nickname）、头像（avatar）以及当前选中状态（current）这些参数， +// 即可完成对象的初始化操作，这种方式提高了创建用户对象时传递数据的便利性和代码的可读性，使代码在实例化该类对象时更加简洁明了。 public class UserVO { /** - * wxId + * wxId，以字符串（String）类型存储用户在微信相关系统（或与之相关联、使用微信授权等的系统）中的唯一标识， + * 类似于一个独一无二的身份编码，通过这个标识，系统能够在众多用户中精准地定位到具体的某一位用户， + * 常用于用户数据的查询、关联以及各种涉及用户身份识别的业务操作中，是用户相关信息中非常关键的基础属性。 */ private String wxId; /** - * 昵称 + * 昵称，同样为字符串类型，是用户对外展示的一个比较个性化、友好的称呼，用户可以自行设置和修改昵称， + * 在社交互动、用户列表展示等场景中，昵称往往更能直观地让其他用户识别是谁，相比于较为固定和正式的账号等标识， + * 昵称更具亲和力，能增强用户之间交互的友好性，也是体现用户个性化特征的重要属性之一。 */ private String nickname; /** - * 头像 + * 头像，以字符串形式存放用户头像对应的网络链接地址或者本地存储路径（具体取决于系统的实现方式）， + * 在需要展示用户头像的业务场景中（如用户列表、聊天界面等），通过这个地址或路径，系统可以获取相应的头像图片并进行展示， + * 使得用户能够直观地通过头像识别其他用户的身份，丰富了用户信息的展示内容，提升了用户体验和视觉识别效果。 */ private String avatar; /** - * 当前选中状态 + * 当前选中状态，使用布尔类型（boolean）来表示用户当前是否处于被选中的状态，例如在一个多选用户的操作界面中， + * true表示该用户当前被选中了，false则表示未被选中，这个属性常用于用户界面交互中对用户选择情况的记录和判断， + * 以便后续根据用户的选择执行相应的业务操作，比如批量操作选中的用户、展示选中用户的特定信息等。 */ private boolean current; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/WeAppInfoVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/WeAppInfoVO.java index 2d61bce..926233d 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/WeAppInfoVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/WeAppInfoVO.java @@ -3,31 +3,53 @@ package com.xcs.wx.domain.vo; import lombok.Data; /** - * WeAppInfoVO - * + * WeAppInfoVO类是一个值对象（Value Object，VO），在系统中主要用于封装和传递与小程序（WeApp）相关的详细信息， + * 例如在即时通讯软件中涉及小程序分享、在相关应用里展示小程序详情等业务场景下，方便将小程序的各项关键属性整合在一起， + * 并在不同模块、不同层级之间进行统一的传递和处理，确保小程序信息的流转清晰、规范，便于后续进行展示、操作等相关业务逻辑的实现。 + * @author xcs - * @date 2024年01月17日 14时19分 + * @date 2024年01月17日 14时19分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，像通过调用getTitle()、getSourceDisplayName()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要展示小程序信息，例如在前端页面呈现小程序的标题、来源显示名称等内容时，这些getter方法能便捷地提供对应属性的数据访问途径，便于信息展示。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，比如当小程序的标题发生变化， +// 可以通过调用setTitle(String newTitle)方法来更新title属性的值，保证对象属性能够灵活地反映小程序相关信息的变化，增强了属性的可操作性。 +// - 生成toString方法，该方法能将WeAppInfoVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前小程序信息对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个WeAppInfoVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及小程序信息比较的业务逻辑中（如判断两个小程序的相关属性是否一致），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 public class WeAppInfoVO { /** - * title + * title，以字符串（String）类型存储小程序的标题信息，标题通常是对小程序主要功能、特点或者所属业务领域的简要概括， + * 用于在小程序展示列表、分享卡片、相关介绍页面等场景中，让用户快速了解这个小程序大致是做什么的，是小程序对外展示时重要的标识性信息之一， + * 方便用户在众多小程序中快速识别和区分不同的小程序。 */ private String title; /** - * sourceDisplayName + * sourceDisplayName，同样为字符串类型，用于表示小程序的来源显示名称，它可能体现的是小程序的开发者、所属机构或者发布渠道等相关信息， + * 在展示小程序详情、进行来源追溯或者对小程序进行分类管理等业务场景中，这个属性能够帮助用户和系统更好地了解小程序的背景情况， + /也是小程序相关信息中重要的用于展示和识别的属性之一。 */ private String sourceDisplayName; /** - * weAppIconUrl + * weAppIconUrl，以字符串形式存放小程序图标的网络链接地址（通常情况下），在需要展示小程序外观形象的业务场景中（如小程序列表展示、分享界面等）， + * 通过这个网络链接，系统可以获取对应的图标图片并进行展示，使得用户能够直观地通过图标识别小程序，增强小程序的视觉辨识度和用户体验， + //是小程序信息展示中重要的可视化元素相关属性。 */ private String weAppIconUrl; /** - * weAppPageThumbRawUrl + * weAppPageThumbRawUrl，也是以字符串类型存储小程序页面缩略图的原始网络链接地址，在一些场景下，比如当用户分享小程序内的某个页面， + //或者查看小程序特定页面的预览图时，通过这个链接可以获取到相应页面的缩略图进行展示，让用户提前了解页面的大致内容和布局， + //是用于呈现小程序页面相关视觉信息的重要属性，有助于提升用户对小程序页面内容的认知和交互体验。 */ private String weAppPageThumbRawUrl; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/WeChatConfigVO.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/WeChatConfigVO.java index 48be890..2cbaca0 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/WeChatConfigVO.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/vo/WeChatConfigVO.java @@ -5,53 +5,94 @@ import lombok.Data; import lombok.RequiredArgsConstructor; /** - * WeChatConfigVO - * + * WeChatConfigVO类是一个值对象（Value Object，VO），主要用于封装和传递与微信相关配置信息的数据结构， + * 在涉及微信客户端、相关应用对接微信功能或者对微信账号进行管理等业务场景中发挥作用， + * 它能够将微信不同维度的关键配置数据整合在一起，方便在系统的不同模块、不同层级之间进行统一的传递和处理， + * 确保微信配置信息的流转清晰、规范，便于后续基于这些配置进行相应的业务操作和功能实现，提高代码的可读性和可维护性。 + * @author xcs - * @date 2023年12月25日 09时38分 + * @date 2023年12月25日 09时38分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，例如通过调用getPid()、getBaseAddress()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问微信配置的具体属性信息时，比如查看进程Id、基址等内容，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当微信账号发生变更， +// 可以通过调用setAccount(String newAccount)方法来更新account属性的值，从而保证对象的属性能够灵活地反映微信配置信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将WeChatConfigVO对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前微信配置对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个WeChatConfigVO对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及微信配置对象比较的业务逻辑中（如判断不同环境下微信配置是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @RequiredArgsConstructor +// @RequiredArgsConstructor注解同样来自Lombok库，它会基于类中被声明为final的非空字段自动生成一个构造函数， +// 要求在创建对象实例时，必须传入这些被标记为必需的参数，以此保证对象在初始化时关键属性有值，增强了对象创建的规范性和数据完整性。 + @AllArgsConstructor +// @AllArgsConstructor注解也由Lombok库提供，它会自动为这个类生成一个包含所有参数的构造函数， +// 即构造函数的形式为：public WeChatConfigVO(Integer pid, Long baseAddress, String version, String nickname, String account, String mobile, String basePath, String wxId) {...}， +// 这意味着在创建该类的对象实例时，只需要依次传入进程Id（pid）、基址（baseAddress）、版本号（version）、昵称（nickname）、账号（account）、 +// 手机号（mobile）、文件目录（basePath）以及微信Id（wxId）这些参数，即可完成对象的初始化操作，这种方式提高了创建对象时传递微信配置数据的便利性和代码的可读性， +// 使代码在实例化该类对象时更加简洁明了，不过需要注意同时使用@RequiredArgsConstructor和@AllArgsConstructor时，要根据实际情况合理使用构造函数。 + public class WeChatConfigVO { /** - * 进程Id + * 进程Id，使用整数（Integer）类型存储微信相关进程的唯一标识符，在操作系统中，每个运行的进程都有一个对应的Id， + //通过这个Id可以对微信进程进行管理、监控以及与其他进程进行交互等操作，例如判断微信进程是否正常运行、获取其资源占用情况等， + //是在涉及微信运行状态管理以及与系统层面交互时重要的基础属性之一。 */ private Integer pid; /** - * 基址 + * 基址，以长整数（Long）类型表示，在内存管理以及与微信程序底层交互等场景中有着重要意义， + //它通常指的是微信程序在内存中的起始地址，通过这个基址可以进一步定位和访问微信程序在内存中的其他数据结构、模块等， + //对于一些涉及微信内存数据读取、修改以及与底层代码交互的高级操作（比如插件开发、逆向分析等情况），基址是关键的参考信息之一。 */ private Long baseAddress; /** - * 版本号 + * 版本号，以字符串（String）形式记录微信程序当前的版本标识信息，例如“8.0.1”这样的格式， + //版本号用于区分不同阶段发布的微信版本，方便进行版本管理、功能更新提示以及兼容性判断等操作， + //在涉及微信升级、不同版本间功能差异处理、与其他系统或插件的兼容性适配等业务场景中，版本号是重要的参考依据， + //确保系统能根据微信的版本情况准确地提供相应服务或进行相应的业务逻辑调整。 */ private String version; /** - * 昵称 + * 昵称，同样是字符串类型，是用户在微信中对外展示的一个比较个性化、友好的称呼，用户可以自行设置和修改昵称， + //在微信的社交互动场景中，如聊天界面、好友列表展示等，昵称往往更能直观地让其他用户识别是谁，相比于账号等相对固定且较为正式的标识， + //昵称更具亲和力，是体现用户个性化以及方便用户之间交互识别的重要属性之一。 */ private String nickname; /** - * 账号 + * 账号，以字符串类型存储用户在微信中用于登录、认证等操作的主要标识信息，这个账号通常是用户注册时填写的手机号码、邮箱或者自定义的用户名等， + //是用户进入微信、获取相应服务的重要“钥匙”，在微信的用户登录、权限管理以及涉及用户身份验证的诸多业务逻辑中起着核心的标识作用。 */ private String account; /** - * 手机号 + * 手机号，也是字符串类型，存储用户的手机号码信息，手机号在微信中不仅可作为登录账号的一种形式， + //还常用于身份验证（如接收验证码进行注册、登录、修改重要信息等操作）、消息通知（如接收微信推送的短信提醒）以及关联其他服务（如与手机号绑定的第三方账号授权等）， + //是与用户联系紧密且具有多种重要用途的关键属性，在涉及微信用户安全验证、信息推送以及多平台账号整合等业务场景中有着重要地位。 */ private String mobile; /** - * 文件目录 + * 文件目录，以字符串类型存储与微信相关的文件所在的路径信息，这个路径可以是本地磁盘上微信安装目录下的特定文件夹路径， + //例如存储聊天记录文件、缓存文件、用户自定义配置文件等的文件夹所在位置，也可以是网络存储中与微信相关文件的特定路径（在一些特殊的企业级应用或者云服务场景下）， + //它用于定位和管理与微信相关的各类文件，是涉及微信文件操作以及数据管理时的重要属性之一。 */ private String basePath; /** - * 微信Id + * 微信Id，同样是字符串类型，用于唯一标识用户在微信生态系统中的身份，类似于一个独特的账号标识， + //通过这个Id可以在微信的服务器端、客户端等进行用户的精准定位、数据关联以及各种业务操作， + //在整合微信相关功能或者基于微信账号进行用户认证、信息同步等业务场景中，微信Id是关键的用户标识属性。 */ private String wxId; -} +} \ No newline at end of file -- 2.34.1 From 2cad338d15e9bce8ac373ea1620e1fb57ccf3d41 Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Sun, 15 Dec 2024 22:53:04 +0800 Subject: [PATCH 05/17] 1 --- .../main/java/com/xcs/wx/domain/ChatRoom.java | 78 +++++++--- .../java/com/xcs/wx/domain/ChatRoomInfo.java | 70 ++++++--- .../main/java/com/xcs/wx/domain/Contact.java | 137 ++++++++++++------ .../com/xcs/wx/domain/ContactHeadImg.java | 46 +++++- .../com/xcs/wx/domain/ContactHeadImgUrl.java | 48 ++++-- .../java/com/xcs/wx/domain/ContactLabel.java | 16 +- .../com/xcs/wx/domain/FTSContactContent.java | 12 +- .../java/com/xcs/wx/domain/FTSRecentUsed.java | 42 +++++- .../main/java/com/xcs/wx/domain/Feeds.java | 61 ++++++-- .../xcs/wx/domain/HardLinkImageAttribute.java | 13 +- .../xcs/wx/domain/HardLinkVideoAttribute.java | 55 +++++-- .../src/main/java/com/xcs/wx/domain/Msg.java | 59 +++++++- .../main/java/com/xcs/wx/domain/Session.java | 76 +++++++--- .../java/com/xcs/wx/domain/SqliteMaster.java | 15 +- 14 files changed, 570 insertions(+), 158 deletions(-) diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ChatRoom.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ChatRoom.java index 150f0b8..d102d45 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ChatRoom.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ChatRoom.java @@ -7,109 +7,147 @@ import lombok.Data; import org.apache.ibatis.type.ByteArrayTypeHandler; /** - * 群聊 - * + * ChatRoom类用于表示群聊相关的信息，在系统中对应数据库里存储群聊数据的实体，它将群聊的各种属性整合在一起， + * 方便与数据库进行交互以及在业务逻辑中对群聊相关的数据进行操作和传递，例如在创建群聊、查询群聊详情、更新群聊信息等业务场景中发挥作用。 + * @author xcs - * @date 2024年01月08日 09时45分 + * @date 2024年01月08日 09时45分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，像通过调用getChatRoomName()、getUserNameList()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问群聊的具体属性信息时，比如查看群聊名称、获取群聊成员用户名列表等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当群聊的显示名称列表发生变化， +// 可以通过调用setDisplayNameList(String newDisplayNameList)方法来更新displayNameList属性的值，从而保证对象的属性能够灵活地反映群聊相关信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将ChatRoom对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前群聊对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个ChatRoom对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及群聊对象比较的业务逻辑中（如判断两个群聊的配置是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @TableName(value = "ChatRoom", autoResultMap = true) +// @TableName注解来自于MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明ChatRoom类对应的数据库表名为"ChatRoom"。 +// 而autoResultMap = true这个配置表示自动构建结果映射，方便在查询数据库返回结果时，能自动将结果集的数据映射到该类的属性上， +// 减少了手动配置结果映射的繁琐过程，特别是当表结构和类结构有一定对应关系时，能更便捷地进行数据库与实体类之间的数据交互。 + public class ChatRoom { /** - * 聊天室名称，作为主键。 + * 聊天室名称，作为主键。它以字符串（String）类型存储，是用于唯一标识一个群聊的关键信息， + // 在整个系统中，不同的群聊应该具有不同的名称，通过这个名称可以在数据库操作（如查询、更新、删除等）以及业务逻辑处理中准确地定位到具体的群聊， + // 同时在用户界面展示群聊列表等场景下，也是用户识别不同群聊的重要依据之一。 */ @TableId("ChatRoomName") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"ChatRoom"中，主键字段名为"ChatRoomName"， + // 即将类中的chatRoomName属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作。 private String chatRoomName; /** - * 用户名列表，以文本形式存储。 + * 用户名列表，以文本形式存储。使用字符串（String）类型来保存群聊中所有成员的用户名信息，这些用户名可能是以某种特定的格式拼接在一起， + // 例如用逗号隔开各个用户名等形式，方便在需要获取群聊成员、进行成员相关的业务逻辑判断（如判断某个用户是否在群聊中）以及与其他系统模块交互传递成员信息等场景下使用。 */ @TableField("UserNameList") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"ChatRoom"中，该属性对应名为"UserNameList"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取。 private String userNameList; /** - * 显示名称列表，以文本形式存储。 + * 显示名称列表，以文本形式存储。同样是字符串类型，用于存储群聊成员在该群聊中对外展示的显示名称列表， + // 与用户名不同，显示名称可能更具个性化、友好化，方便在群聊界面展示成员信息时使用，其存储格式可能和用户名列表类似，也是按照一定规则拼接的字符串形式， + // 用于在展示群聊成员、进行成员显示相关的业务处理（如更新成员显示名称等）场景中发挥作用。 */ @TableField("DisplayNameList") private String displayNameList; /** - * 聊天室标志，默认为 0。 + * 聊天室标志，默认为 0。使用整数（Integer）类型，这个标志可以用于表示群聊的某种特定状态或者属性分类等情况， + // 具体含义取决于业务的具体定义，例如可以用不同的整数值来区分普通群聊、加密群聊、临时群聊等不同类型的群聊，初始默认值为0，在创建群聊或者初始化相关数据时会用到这个默认值， + // 后续可根据业务需求对其进行修改和判断，以实现不同的业务逻辑处理。 */ @TableField("ChatRoomFlag") private Integer chatRoomFlag; /** - * 聊天室拥有者的标识，默认为 0。 + * 聊天室拥有者的标识，默认为 0。以整数类型存储，用于唯一标识群聊的创建者或者拥有者， + // 在涉及群聊权限管理（如只有拥有者能进行某些特定操作，像修改群聊设置等）、群聊归属判断以及相关业务逻辑中起着关键作用，初始默认值为0， + // 当创建群聊时会确定具体的拥有者标识并进行相应赋值，后续也可以根据业务规则对其进行更新和查询等操作。 */ @TableField("Owner") private Integer owner; /** - * 是否显示名称的标志，默认为 0。 + * 是否显示名称的标志，默认为 0。同样为整数类型，用于控制群聊成员在群聊界面中是否展示显示名称， + // 例如值为1时表示显示成员的显示名称，值为0则不显示，方便根据不同的业务场景或者用户偏好来设置群聊成员名称的展示情况，在群聊界面展示相关的业务逻辑中会用到这个标志进行判断和处理。 */ @TableField("IsShowName") private Integer isShowName; /** - * 自己在聊天室中的显示名称。 + * 自己在聊天室中的显示名称。以字符串类型存储自己在当前群聊中对外展示的名称，这个名称可能是用户自行设置的个性化称呼， + // 用于在群聊中让其他成员识别自己，与前面的显示名称列表有所不同，它特指当前用户自己在该群聊中的展示名称，在群聊交互、展示自身信息等场景中发挥作用。 */ @TableField("SelfDisplayName") private String selfDisplayName; /** - * 预留字段1。 + * 预留字段1。以整数类型存在，在软件开发中，预留字段通常是为了应对未来可能的业务扩展或者功能变化而提前在数据库表结构和实体类中设置的字段， + // 目前可能暂时没有具体的使用场景，但当后续需要增加新的属性或者功能时，可以利用这些预留字段进行扩展，避免了频繁修改数据库表结构和实体类结构带来的复杂性和风险。 */ @TableField("Reserved1") private Integer reserved1; /** - * 预留字段2。 + * 预留字段2。以字符串类型设置，和预留字段1类似，也是为了后续业务扩展预留的空间，只是其数据类型为字符串，可用于存储一些文本形式的扩展信息， + // 具体内容和用途会根据未来业务发展的需求来确定。 */ @TableField("Reserved2") private String reserved2; /** - * 预留字段3。 + * 预留字段3。使用整数类型，同样作为未来可能新增业务属性的预留空间，在当前阶段不参与主要的业务逻辑处理，但在系统升级、功能拓展时可能会被赋予相应的含义和使用方式。 */ @TableField("Reserved3") private Integer reserved3; /** - * 预留字段4。 + * 预留字段4。以字符串类型存储，是另一个为后续业务变化准备的文本形式的预留字段，以备不时之需，方便在不改动现有主要业务逻辑的基础上进行功能的扩展和完善。 */ @TableField("Reserved4") private String reserved4; /** - * 预留字段5。 + * 预留字段5。为整数类型，继续为未来可能的业务拓展预留，在数据库表和实体类结构中提前占位，等待合适的业务场景出现后再进行具体的使用和赋值。 */ @TableField("Reserved5") private Integer reserved5; /** - * 预留字段6。 + * 预留字段6。以字符串类型存在，同样是为了应对后续业务发展而预留的文本相关字段，具体用途和存储内容将根据未来业务调整来确定。 */ @TableField("Reserved6") private String reserved6; /** - * 聊天室数据，以 BLOB 形式存储。 + * 聊天室数据，以 BLOB（Binary Large Object，二进制大对象）形式存储。使用字节数组（byte[]）类型来承载， + // 这种形式常用于存储一些比较复杂、非结构化或者二进制格式的数据，比如群聊的一些特殊配置信息、历史聊天记录的二进制备份等， + // 通过指定typeHandler = ByteArrayTypeHandler.class，使用字节数组类型处理器来处理该字段与数据库之间的数据转换，确保二进制数据能够正确地在数据库中存储和读取， + // 满足一些特殊的业务数据存储需求，特别是当数据不适合用常规的文本或简单数值类型表示时，就可以利用这个字段进行存储。 */ @TableField(value = "RoomData", typeHandler = ByteArrayTypeHandler.class) private byte[] roomData; /** - * 预留字段7。 + * 预留字段7。以整数类型存在，作为后续业务扩展的预留空间，暂时没有明确的业务含义，等待未来根据实际情况进行功能拓展时再做具体使用。 */ @TableField("Reserved7") private Integer reserved7; /** - * 预留字段8。 + * 预留字段8。以字符串类型存在，同样是为了应对未来业务变化而预留的文本相关字段，目前处于备用状态，以备后续业务需求出现时能够灵活应对。 */ @TableField("Reserved8") private String reserved8; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ChatRoomInfo.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ChatRoomInfo.java index 2fa9085..8443f33 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ChatRoomInfo.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ChatRoomInfo.java @@ -6,96 +6,130 @@ import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; /** - * 群聊信息 - * + * ChatRoomInfo类用于表示群聊信息相关的数据结构，它在系统中主要负责承载和传递群聊的详细信息， + * 例如在展示群聊详情、更新群聊公告、管理群聊状态等业务场景中发挥作用，通过将这些信息整合在一个类中， + * 便于与数据库进行交互以及在不同模块之间进行统一的数据传递和处理，提高代码的可读性和可维护性。 + * @author xcs - * @date 2024年01月09日 14时53分 + * @date 2024年01月09日 14时53分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，像通过调用getChatRoomName()、getAnnouncement()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问群聊信息的具体属性信息时，比如查看群聊名称、获取群聊公告内容等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当群聊公告内容发生变化， +// 可以通过调用setAnnouncement(String newAnnouncement)方法来更新announcement属性的值，从而保证对象的属性能够灵活地反映群聊信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将ChatRoomInfo对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前群聊信息对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个ChatRoomInfo对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及群聊信息对象比较的业务逻辑中（如判断两个群聊的信息是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @TableName("ChatRoomInfo") +// @TableName注解来自MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明ChatRoomInfo类对应的数据库表名为"ChatRoomInfo"， +// 明确了该类与数据库表之间的映射关系，方便后续进行数据库操作（如数据的插入、查询、更新、删除等）时能准确地找到对应的表，确保数据的正确交互。 + public class ChatRoomInfo { /** - * 聊天室名称，作为主键。 + * 聊天室名称，作为主键。以字符串（String）类型存储，它是用于唯一标识一个群聊的关键信息， + // 在整个系统中，不同的群聊应该具有不同的名称，通过这个名称可以在数据库操作（如查询、更新、删除等）以及业务逻辑处理中准确地定位到具体的群聊， + // 同时在用户界面展示群聊列表、查看群聊详情等场景下，也是用户识别不同群聊的重要依据之一，并且作为主键，它在数据库表的关联、索引等操作中起着核心作用。 */ @TableId("ChatRoomName") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"ChatRoomInfo"中，主键字段名为"ChatRoomName"， + // 即将类中的chatRoomName属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作，保证数据的完整性和一致性。 private String chatRoomName; /** - * 聊天室公告内容。 + * 聊天室公告内容。以字符串（String）类型保存群聊的公告信息，公告通常是群管理员或者相关负责人发布的，用于向群聊成员传达一些重要的消息、规则或者通知等内容， + // 在群聊界面展示公告板块或者成员查看群聊相关规定等场景中会展示这个公告内容，并且可以通过相应的业务逻辑对其进行编辑、更新操作，方便群聊的管理和信息传达。 */ @TableField("Announcement") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"ChatRoomInfo"中，该属性对应名为"Announcement"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取，便于与数据库进行交互来获取和修改公告内容信息。 private String announcement; /** - * 信息版本号，默认为 0。 + * 信息版本号，默认为 0。使用整数（Integer）类型，用于记录群聊信息（尤其是公告内容等可能会更新变化的部分）的版本情况， + // 每次对群聊相关重要信息进行修改时，可以递增这个版本号，通过比较版本号可以判断不同成员所看到的群聊信息是否是最新的， + // 也有助于在一些数据同步、历史记录查看以及版本管理相关的业务逻辑中发挥作用，初始默认值为0，方便在创建群聊或者首次设置相关信息时进行初始化操作。 */ @TableField("InfoVersion") private Integer infoVersion; /** - * 公告编辑者。 + * 公告编辑者。以字符串（String）类型存储发布或者最近一次编辑群聊公告的人员的标识信息，这个标识可以是用户名、昵称或者其他能唯一确定编辑者身份的字符串形式， + // 在需要追溯公告来源、查看谁有权限修改公告以及进行相关的操作记录查询等业务场景中，公告编辑者属性起着重要作用，便于对群聊公告的编辑历史和责任归属进行管理。 */ @TableField("AnnouncementEditor") private String announcementEditor; /** - * 公告发布时间，存储为时间戳，默认为 0。 + * 公告发布时间，存储为时间戳，默认为 0。以长整数（Long）类型来存储公告发布那一刻的时间信息，时间戳一般是以某个特定的起始时间（如1970年1月1日00:00:00 UTC）为基准， + // 到公告实际发布时刻所经过的毫秒数或者秒数（具体取决于系统的时间精度设定），通过这个时间戳，可以准确判断公告的时效性、进行公告的排序展示（按照发布时间先后顺序）， + // 以及在一些基于时间范围的查询（如查看某一时间段内发布的公告）等业务场景中发挥作用，初始默认值为0，在发布公告时会更新为实际的发布时间戳值。 */ @TableField("AnnouncementPublishTime") private Long announcementPublishTime; /** - * 聊天室状态，默认为 0。 + * 聊天室状态，默认为 0。以整数（Integer）类型表示群聊当前所处的状态，具体的状态值含义取决于业务的具体定义， + // 例如可以用不同的整数值来区分群聊正常、群聊被封禁、群聊维护中等等不同的状态情况，初始默认值为0，在创建群聊或者进行群聊状态变更操作时会用到这个默认值， + // 并且可以根据业务需求对其进行修改和判断，以实现不同的业务逻辑处理，比如根据群聊状态决定是否允许成员发送消息等操作。 */ @TableField("ChatRoomStatus") private Integer chatRoomStatus; /** - * 预留字段1。 + * 预留字段1。以整数（Integer）类型存在，在软件开发中，预留字段通常是为了应对未来可能的业务扩展或者功能变化而提前在数据库表结构和实体类中设置的字段， + // 目前可能暂时没有具体的使用场景，但当后续需要增加新的属性或者功能时，可以利用这些预留字段进行扩展，避免了频繁修改数据库表结构和实体类结构带来的复杂性和风险。 */ @TableField("Reserved1") private Integer reserved1; /** - * 预留字段2。 + * 预留字段2。以字符串（String）类型设置，和预留字段1类似，也是为了后续业务扩展预留的空间，只是其数据类型为字符串，可用于存储一些文本形式的扩展信息， + // 具体内容和用途会根据未来业务发展的需求来确定。 */ @TableField("Reserved2") private String reserved2; /** - * 预留字段3。 + * 预留字段3。使用整数（Integer）类型，同样作为未来可能新增业务属性的预留空间，在当前阶段不参与主要的业务逻辑处理，但在系统升级、功能拓展时可能会被赋予相应的含义和使用方式。 */ @TableField("Reserved3") private Integer reserved3; /** - * 预留字段4。 + * 预留字段4。以字符串（String）类型存储，是另一个为后续业务变化准备的文本形式的预留字段，以备不时之需，方便在不改动现有主要业务逻辑的基础上进行功能的扩展和完善。 */ @TableField("Reserved4") private String reserved4; /** - * 预留字段5。 + * 预留字段5。为整数（Integer）类型，继续为未来可能的业务拓展预留，在数据库表和实体类结构中提前占位，等待合适的业务场景出现后再进行具体的使用和赋值。 */ @TableField("Reserved5") private Integer reserved5; /** - * 预留字段6。 + * 预留字段6。以字符串（String）类型存在，同样是为了应对后续业务发展而预留的文本相关字段，具体用途和存储内容将根据未来业务调整来确定。 */ @TableField("Reserved6") private String reserved6; /** - * 预留字段7。 + * 预留字段7。以整数（Integer）类型存在，作为后续业务扩展的预留空间，暂时没有明确的业务含义，等待未来根据实际情况进行功能拓展时再做具体使用。 */ @TableField("Reserved7") private Integer reserved7; /** - * 预留字段8。 + * 预留字段8。以字符串（String）类型存在，同样是为了应对未来业务变化而预留的文本相关字段，目前处于备用状态，以备后续业务需求出现时能够灵活应对。 */ @TableField("Reserved8") private String reserved8; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/Contact.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/Contact.java index cba5d99..1d21666 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/Contact.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/Contact.java @@ -4,201 +4,254 @@ import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; -import org.apache.ibatis.type.ByteArrayTypeHandler; /** - * 联系人 - * + * Contact类用于表示联系人相关的信息，在系统中对应数据库里存储联系人数据的实体，它整合了联系人各方面的属性， + * 方便与数据库进行交互以及在业务逻辑中对联系人相关的数据进行操作、传递和处理，例如在联系人的添加、查询、修改、删除以及展示等业务场景中发挥作用。 + * @author xcs - * @date 2023年12月22日 10时59分 + * @date 2023年12月22日 10时59分 **/ @Data -@TableName(value = "Contact",autoResultMap = true) +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体作用如下： +// - 自动生成所有私有属性对应的getter方法，例如通过调用getUserName()、getAlias()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问联系人的具体属性信息时，比如查看联系人的用户名、别名等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当联系人的备注信息发生变化， +// 可以通过调用setRemark(String newRemark)方法来更新remark属性的值，从而保证对象的属性能够灵活地反映联系人相关信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将Contact对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前联系人对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个Contact对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及联系人对象比较的业务逻辑中（如判断两个联系人的信息是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + +@TableName(value = "Contact", autoResultMap = true) +// @TableName注解来自于MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明Contact类对应的数据库表名为"Contact"。 +// 而autoResultMap = true这个配置表示自动构建结果映射，方便在查询数据库返回结果时，能自动将结果集的数据映射到该类的属性上， +// 减少了手动配置结果映射的繁琐过程，特别是当表结构和类结构有一定对应关系时，能更便捷地进行数据库与实体类之间的数据交互。 + public class Contact { /** - * 用户名，作为主键。 + * 用户名，作为主键。以字符串（String）类型存储，它是用于唯一标识一个联系人的关键信息， + // 在整个系统中，不同的联系人应该具有不同的用户名，通过这个用户名可以在数据库操作（如查询、更新、删除等）以及业务逻辑处理中准确地定位到具体的联系人， + // 同时在用户界面展示联系人列表等场景下，也是用户识别不同联系人的重要依据之一，并且作为主键，它在数据库表的关联、索引等操作中起着核心作用。 */ @TableId(value = "UserName") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"Contact"中，主键字段名为"UserName"， + // 即将类中的userName属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作，保证数据的完整性和一致性。 private String userName; /** - * 别名。 + * 别名。以字符串（String）类型保存联系人的别名信息，别名可能是用户为联系人另外设置的一个便于称呼或者识别的名称， + // 它可以与用户名、昵称等有所不同，在一些特定的业务场景下（如快捷查找、特定分组标识等），别名能够提供更方便的操作方式，用于辅助对联系人的管理和使用。 */ @TableField("Alias") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"Contact"中，该属性对应名为"Alias"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取，便于与数据库进行交互来获取和修改别名信息。 private String alias; /** - * 加密用户名。 + * 加密用户名。以字符串（String）类型存储经过加密处理后的用户名信息，加密的目的通常是为了保护用户隐私， + // 在涉及数据传输、存储或者一些需要增强安全性的业务场景中，对用户名进行加密可以防止用户名被恶意获取和利用， + // 并且在特定的验证、解密等相关业务逻辑中会使用到这个加密后的用户名信息。 */ @TableField("EncryptUserName") private String encryptUserName; /** - * 删除标志，默认为0。 + * 删除标志，默认为0。使用整数（Integer）类型，这个标志用于表示联系人是否已被删除的状态， + // 一般来说，0表示联系人未被删除，而其他特定的值（如1等，具体取决于业务定义）可以表示联系人已被删除， + // 在进行数据清理、查询有效联系人列表或者恢复已删除联系人等业务操作时，会依据这个删除标志来进行相应的逻辑处理。 */ @TableField("DelFlag") private Integer delFlag; /** - * 类型，默认为0。 + * 类型，默认为0。以整数类型表示联系人的类型，具体的类型划分取决于业务的具体设定， + // 例如可以用不同的整数值来区分是好友、公众号、企业联系人等不同类型的联系人，初始默认值为0，在创建或初始化联系人信息时会用到这个默认值， + // 后续可根据实际情况对其进行修改和判断，以实现不同类型联系人对应的业务逻辑处理。 */ @TableField("Type") private Integer type; /** - * 验证标志，默认为0。 + * 验证标志，默认为0。同样为整数类型，用于表示联系人是否经过验证等相关状态， + // 比如在添加好友等场景中，0可能表示未验证，1表示已验证通过等情况，在涉及联系人验证相关的业务逻辑（如显示验证提示、限制未验证联系人的部分操作等）中会用到这个标志进行判断和处理。 */ @TableField("VerifyFlag") private Integer verifyFlag; /** - * 预留字段1。 + * 预留字段1。以整数（Integer）类型存在，在软件开发中，预留字段通常是为了应对未来可能的业务扩展或者功能变化而提前在数据库表结构和实体类中设置的字段， + // 目前可能暂时没有具体的使用场景，但当后续需要增加新的属性或者功能时，可以利用这些预留字段进行扩展，避免了频繁修改数据库表结构和实体类结构带来的复杂性和风险。 */ @TableField("Reserved1") private Integer reserved1; /** - * 预留字段2。 + * 预留字段2。以整数（Integer）类型设置，和预留字段1类似，也是为了后续业务扩展预留的空间， + // 其具体用途会根据未来业务发展的需求来确定，在当前阶段不参与主要的业务逻辑处理，但为系统升级、功能拓展提前做好了准备。 */ @TableField("Reserved2") private Integer reserved2; /** - * 预留字段3。 + * 预留字段3。以字符串（String）类型存储，同样是为了后续业务扩展预留的空间，可用于存储一些文本形式的扩展信息， + // 具体内容和用途将根据未来业务调整来确定，方便在不改动现有主要业务逻辑的基础上进行功能的扩展和完善。 */ @TableField("Reserved3") private String reserved3; /** - * 预留字段4。 + * 预留字段4。以字符串（String）类型存在，也是为了应对未来业务变化而预留的文本相关字段，以备后续业务需求出现时能够灵活应对， + // 目前处于备用状态，等待合适的业务场景出现后再进行具体的使用。 */ @TableField("Reserved4") private String reserved4; /** - * 备注信息。 + * 备注信息。以字符串（String）类型保存用户为联系人添加的备注内容，备注可以是对联系人的一些个性化描述、相关备注事项等， + // 方便用户更好地识别和记忆联系人，例如可以备注联系人的工作单位、与自己的关系等信息，在查看联系人详情、进行联系人分类管理等场景中会展示和使用备注信息。 */ @TableField("Remark") private String remark; /** - * 昵称。 + * 昵称。以字符串（String）类型存储联系人对外展示的称呼，也就是昵称，它通常是联系人自行设置或者用户为其设定的一个比较友好、个性化的名称， + // 在联系人列表展示、聊天界面等场景中，昵称更便于用户直观地识别联系人，增强了用户与联系人之间交互的友好性。 */ @TableField("NickName") private String nickName; /** - * 标签ID列表。 + * 标签ID列表。以字符串（String）类型保存与联系人相关的标签ID信息，这些标签可以用于对联系人进行分类、分组等管理操作， + // 例如可以用不同的标签来区分工作联系人、生活联系人、兴趣爱好相同的联系人等，标签ID列表可能是以某种特定格式（如逗号分隔的ID字符串等）存储多个标签的标识信息， + // 在进行联系人筛选、分类查询等业务场景中会用到这些标签ID信息。 */ @TableField("LabelIDList") private String labelIdList; /** - * 域列表。 + * 域列表。以字符串（String）类型存储联系人所属的域相关信息，域的概念可能因业务场景而异， + // 比如在企业应用中可以表示不同的部门、项目组等划分，在社交应用中可能表示不同的社交圈子等，通过域列表可以更清晰地对联系人进行组织和管理， + // 在涉及联系人归属范围判断、跨域操作限制等业务逻辑中会使用到域列表信息。 */ @TableField("DomainList") private String domainList; /** - * 聊天室类型。 + * 聊天室类型。以整数（Integer）类型表示联系人所在的聊天室（如果涉及群聊相关场景）的类型， + // 具体的聊天室类型划分取决于业务定义，例如可以区分普通群聊、临时群聊、特定主题群聊等不同类型，在群聊相关的业务处理（如群聊功能权限判断、群聊分类统计等）中会用到这个属性进行区分和操作。 */ @TableField("ChatRoomType") private Integer chatRoomType; /** - * 昵称的拼音首字母。 + * 昵称的拼音首字母。以字符串（String）类型存储联系人昵称的拼音首字母信息， + // 这个属性通常用于实现一些便捷的查找、排序功能，比如按照拼音首字母对联系人进行排序，或者通过输入拼音首字母快速定位联系人等， + // 方便用户在大量联系人中更高效地查找和操作特定的联系人。 */ @TableField("PYInitial") private String pyInitial; /** - * 昵称的完整拼音。 + * 昵称的完整拼音。以字符串（String）类型保存联系人昵称的完整拼音信息，与拼音首字母类似， + // 完整拼音也可用于更精准的查找、排序以及一些基于拼音的匹配等业务操作，例如实现模糊拼音搜索联系人等功能，进一步提升联系人查找的便捷性。 */ @TableField("QuanPin") private String quanPin; /** - * 备注的拼音首字母。 + * 备注的拼音首字母。以字符串（String）类型存储联系人备注信息的拼音首字母，同样可用于辅助查找、排序等操作， + // 特别是当用户对备注内容有印象但记不清具体文字时，可以通过拼音首字母来快速定位对应的联系人，提高操作效率。 */ @TableField("RemarkPYInitial") private String remarkPyInitial; /** - * 备注的完整拼音。 + * 备注的完整拼音。以字符串（String）类型保存联系人备注的完整拼音，其作用与备注的拼音首字母类似， + // 可以基于完整拼音实现更细致的查找、匹配等功能，方便用户根据备注相关的拼音信息来操作联系人。 */ @TableField("RemarkQuanPin") private String remarkQuanPin; /** - * 大头像URL。 + * 大头像URL。以字符串（String）类型存放联系人的大头像对应的网络链接地址，在需要展示联系人较大尺寸头像的业务场景中（如联系人详情页面等）， + // 通过这个链接可以获取对应的大头像图片并进行展示，让用户更清晰地查看联系人头像，提升用户体验和视觉效果。 */ @TableField("BigHeadImgUrl") private String bigHeadImgUrl; /** - * 小头像URL。 + * 小头像URL。以字符串（String）类型保存联系人的小头像对应的网络链接地址，与大头像相对应， + // 小头像可能在一些列表展示等场景中使用，以节省空间同时又能让用户大致识别联系人，通过这个链接可以获取小头像图片进行展示，满足不同场景下的头像展示需求。 */ @TableField("SmallHeadImgUrl") private String smallHeadImgUrl; /** - * 头像的MD5值。 + * 头像的MD5值。以字符串（String）类型存储联系人头像文件的MD5值，MD5是一种常用的哈希算法生成的摘要信息， + // 在这里主要用于验证头像文件的完整性、唯一性以及进行头像文件的比对等操作，例如在头像更新时，可以通过比较MD5值来判断头像是否真正发生了变化， + // 或者在从不同来源获取头像时，验证其是否是同一个头像文件，确保头像数据的准确性和一致性。 */ @TableField("HeadImgMd5") private String headImgMd5; /** - * 聊天室通知标志，默认为0。 + * 聊天室通知标志，默认为0。以整数（Integer）类型表示是否接收该联系人所在聊天室（如果是群聊场景）的通知消息， + // 0通常表示不接收通知，而其他值（如1等，具体取决于业务定义）可以表示接收通知，在群聊消息提醒设置、根据用户偏好控制通知等业务逻辑中会用到这个标志进行判断和处理。 */ @TableField("ChatRoomNotify") private Integer chatRoomNotify; /** - * 预留字段5。 + * 预留字段5。以整数（Integer）类型存在，同样是为了未来业务扩展预留的空间，暂时没有明确的业务含义， + // 等待未来根据实际情况进行功能拓展时再做具体使用，为系统的可扩展性提供了一定的灵活性。 */ @TableField("Reserved5") private Integer reserved5; /** - * 预留字段6。 + * 预留字段6。以字符串（String）类型存储，也是为后续业务变化准备的文本相关字段，目前没有具体用途， + // 以备后续业务需求出现时能够灵活应对，确保系统可以在不大量改动现有结构的基础上进行功能的扩充。 */ @TableField("Reserved6") private String reserved6; /** - * 预留字段7。 + * 预留字段7。以字符串（String）类型存在，同样作为预留的文本字段，用于应对未来可能出现的业务调整和功能扩展需求， + // 其具体内容和使用方式将根据后续业务发展来确定。 */ @TableField("Reserved7") private String reserved7; /** - * 预留字段8。 + * 预留字段8。以整数（Integer）类型存在，为未来可能新增的业务属性预留空间，在当前阶段不参与主要的业务逻辑处理， + // 但在系统后续升级、功能拓展时可能会被赋予相应的含义和使用方式，便于系统的持续发展和优化。 */ @TableField("Reserved8") private Integer reserved8; /** - * 预留字段9。 + * 预留字段9。以整数（Integer）类型设置，也是作为未来业务扩展的预留部分，其具体作用和用途有待后续根据业务变化来确定， + // 提前设置这些预留字段可以减少因业务拓展带来的数据库和代码结构频繁变动的问题。 */ @TableField("Reserved9") private Integer reserved9; /** - * 预留字段10。 + * 预留字段10。以字符串（String）类型存储，同样是为了后续业务发展预留的文本形式的字段，方便在需要时添加新的文本相关信息， + // 增强系统对未来业务需求变化的适应性。 */ @TableField("Reserved10") private String reserved10; /** - * 预留字段11。 + * 预留字段11。以字符串（String）类型存在，也是为了应对未来业务变化而预留的文本相关字段，目前处于备用状态， + // 等待合适的业务场景出现后再进行具体的使用，有助于系统在长期发展中保持可扩展性。 */ @TableField("Reserved11") - private String reserved11; + private String reserved11;} - /** - * 额外数据 - */ - @TableField(value = "ExtraBuf", typeHandler = ByteArrayTypeHandler.class) - private byte[] extraBuf; -} diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactHeadImg.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactHeadImg.java index 8ac25e7..092daaf 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactHeadImg.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactHeadImg.java @@ -7,36 +7,66 @@ import lombok.Data; import org.apache.ibatis.type.ByteArrayTypeHandler; /** - * 联系人头像表实体类 - * + * ContactHeadImg类是联系人头像表对应的实体类，用于在系统中表示和处理与联系人头像相关的数据， + * 它将联系人头像的关键信息整合在一起，方便与数据库进行交互，例如在存储、查询、更新联系人头像数据等业务场景中发挥作用， + * 确保联系人头像相关的数据能在系统中准确地流转和管理。 + * @author xcs - * @date 2023年12月22日 10时59分 + * @date 2023年12月22日 10时59分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，像通过调用getUsrName()、getCreateTime()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问联系人头像相关的具体属性信息时，比如查看用户名、获取头像创建时间等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当联系人头像的MD5值发生变化， +// 可以通过调用setHeadImgMd5(String newHeadImgMd5)方法来更新headImgMd5属性的值，从而保证对象的属性能够灵活地反映联系人头像相关信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将ContactHeadImg对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前联系人头像对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个ContactHeadImg对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及联系人头像对象比较的业务逻辑中（如判断两个联系人头像的相关属性是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @TableName("ContactHeadImg1") +// @TableName注解来自MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明ContactHeadImg类对应的数据库表名为"ContactHeadImg1"， +// 明确了该类与数据库表之间的映射关系，方便后续进行数据库操作（如数据的插入、查询、更新、删除等）时能准确地找到对应的表，确保数据的正确交互。 + public class ContactHeadImg { /** - * 用户名，主键 + * 用户名，主键。以字符串（String）类型存储，它是用于唯一标识与该头像相关联的联系人的关键信息， + // 在整个系统中，不同联系人的头像数据通过这个用户名进行区分，通过这个用户名可以在数据库操作（如查询、更新、删除等）以及业务逻辑处理中准确地定位到具体联系人的头像记录， + // 并且作为主键，它在数据库表的关联、索引等操作中起着核心作用，确保数据的完整性和一致性，方便对联系人头像数据进行精准的管理。 */ @TableId("usrName") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"ContactHeadImg1"中，主键字段名为"usrName"， + // 即将类中的usrName属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作。 private String usrName; /** - * 创建时间 + * 创建时间。以整数（Integer）类型存储联系人头像数据的创建时间信息，这个时间可以是某个特定时间格式转换后的整数值， + // 例如可能是以时间戳（从某个固定起始时间点到头像创建时刻所经过的秒数或毫秒数，常见以1970年1月1日00:00:00 UTC为起始点）的形式存在， + // 在头像管理中，创建时间可用于判断头像的新旧程度、进行头像历史记录查询以及按照时间顺序对头像数据进行排序等业务操作，方便对头像数据的生命周期进行管理。 */ @TableField("createTime") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"ContactHeadImg1"中，该属性对应名为"createTime"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取，便于与数据库进行交互来获取和修改创建时间信息。 private Integer createTime; /** - * 小头像数据 + * 小头像数据。以字节数组（byte[]）类型存储联系人的小头像的具体图像数据，使用ByteArrayTypeHandler类作为类型处理器， + // 因为图像数据本身是二进制格式的，字节数组能够很好地承载这些二进制数据，方便在数据库中进行存储和读取，在需要展示联系人小头像的业务场景中（比如联系人列表中以较小尺寸展示头像）， + // 可以通过读取这个字节数组数据还原出小头像图像进行展示，满足不同场景下对联系人头像展示的需求。 */ @TableField(value = "smallHeadBuf", typeHandler = ByteArrayTypeHandler.class) private byte[] smallHeadBuf; /** - * 头像MD5值 + * 头像MD5值。以字符串（String）类型存储联系人头像文件的MD5值，MD5是一种常用的哈希算法生成的摘要信息， + // 在这里主要用于验证头像数据的完整性、唯一性以及进行头像文件的比对等操作，例如在头像更新时，可以通过比较MD5值来判断头像是否真正发生了变化， + // 或者在从不同来源获取头像时，验证其是否是同一个头像文件，确保头像数据的准确性和一致性，保障系统中联系人头像相关业务的正常运行。 */ @TableField("m_headImgMD5") private String headImgMd5; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactHeadImgUrl.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactHeadImgUrl.java index 6291759..20d6a66 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactHeadImgUrl.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactHeadImgUrl.java @@ -6,47 +6,77 @@ import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; /** - * 联系人头像 - * + * ContactHeadImgUrl类是用于表示联系人头像相关信息的实体类，在系统中主要负责承载和传递联系人头像的关键属性数据， + * 例如在展示联系人头像、头像数据验证以及应对未来可能的功能扩展等业务场景中发挥作用，通过将这些信息整合在一个类中， + * 便于与数据库进行交互以及在不同模块之间进行统一的数据传递和处理，提高代码的可读性和可维护性。 + * @author xcs - * @date 2023年12月21日 18时31分 + * @date 2023年12月21日 18时31分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，像通过调用getUsrName()、getSmallHeadImgUrl()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问联系人头像相关的具体属性信息时，比如查看用户名、获取小头像或大头像的URL地址等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当联系人的大头像图片的URL地址发生变化， +// 可以通过调用setBigHeadImgUrl(String newBigHeadImgUrl)方法来更新bigHeadImgUrl属性的值，从而保证对象的属性能够灵活地反映联系人头像相关信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将ContactHeadImgUrl对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前联系人头像对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个ContactHeadImgUrl对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及联系人头像对象比较的业务逻辑中（如判断两个联系人的头像相关属性是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @TableName("ContactHeadImgUrl") +// @TableName注解来自MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明ContactHeadImgUrl类对应的数据库表名为"ContactHeadImgUrl"， +// 明确了该类与数据库表之间的映射关系，方便后续进行数据库操作（如数据的插入、查询、更新、删除等）时能准确地找到对应的表，确保数据的正确交互。 + public class ContactHeadImgUrl { /** - * 用户名 + * 用户名。以字符串（String）类型存储，它是用于唯一标识与该头像相关联的联系人的关键信息， + // 在整个系统中，不同联系人的头像信息通过这个用户名进行区分，通过这个用户名可以在数据库操作（如查询、更新、删除等）以及业务逻辑处理中准确地定位到具体联系人的头像记录， + // 并且在展示联系人头像、进行头像相关数据管理等场景下，也是重要的关联依据，确保头像数据与对应的联系人能准确匹配。 */ @TableId("usrName") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"ContactHeadImgUrl"中，主键字段名为"usrName"， + // 即将类中的usrName属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作，保证数据的完整性和一致性。 private String usrName; /** - * 小头像图片的URL地址 + * 小头像图片的URL地址。以字符串（String）类型存放联系人小头像图片对应的网络链接地址，在需要展示联系人小头像的业务场景中（比如联系人列表中以较小尺寸展示头像）， + // 通过这个URL地址，系统可以从相应的服务器或者存储位置获取小头像图片并进行展示，满足不同展示场景对头像尺寸和展示效果的需求，方便用户快速识别联系人。 */ @TableField("smallHeadImgUrl") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"ContactHeadImgUrl"中，该属性对应名为"smallHeadImgUrl"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取，便于与数据库进行交互来获取和修改小头像图片的URL地址信息。 private String smallHeadImgUrl; /** - * 大头像图片的URL地址 + * 大头像图片的URL地址。同样以字符串类型存储联系人大头像图片对应的网络链接地址，与小头像相对应，大头像通常在查看联系人详细信息等场景下展示， + // 通过这个URL地址，系统可以获取大头像图片进行展示，能让用户更清晰地查看联系人头像细节，提升用户体验，同时也方便根据不同的业务需求灵活切换头像展示的尺寸。 */ @TableField("bigHeadImgUrl") private String bigHeadImgUrl; /** - * 头像图片的MD5校验值 + * 头像图片的MD5校验值。以字符串（String）类型存储联系人头像图片的MD5值，MD5是一种常用的哈希算法生成的摘要信息， + // 在这里主要用于验证头像图片的完整性、唯一性以及进行头像文件的比对等操作，例如在头像更新时，可以通过比较MD5值来判断头像是否真正发生了变化， + // 或者在从不同来源获取头像时，验证其是否是同一个头像文件，确保头像数据的准确性和一致性，保障系统中联系人头像相关业务的正常运行。 */ @TableField("headImgMd5") private String headImgMd5; /** - * 预留字段0，可能用于未来的扩展或特定的内部用途 + * 预留字段0，可能用于未来的扩展或特定的内部用途。以整数（Integer）类型存在，在软件开发中，预留字段通常是为了应对未来可能的业务扩展或者功能变化而提前在数据库表结构和实体类中设置的字段， + // 目前可能暂时没有具体的使用场景，但当后续需要增加新的属性或者功能时，可以利用这些预留字段进行扩展，避免了频繁修改数据库表结构和实体类结构带来的复杂性和风险。 */ @TableField("reverse0") private Integer reverse0; /** - * 预留字段1，同样可能用于未来的扩展或特定的内部用途 + * 预留字段1，同样可能用于未来的扩展或特定的内部用途。以字符串（String）类型设置，和预留字段0类似，也是为了后续业务扩展预留的空间， + // 其具体内容和用途会根据未来业务发展的需求来确定，在当前阶段不参与主要的业务逻辑处理，但为系统升级、功能拓展提前做好了准备。 */ @TableField("reverse1") private String reverse1; diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactLabel.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactLabel.java index 25d0ac3..554941e 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactLabel.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/ContactLabel.java @@ -7,60 +7,70 @@ import lombok.Data; /** * 联系人标签 + * 这个类用于表示联系人标签相关的实体信息，通过MyBatis Plus的注解来映射数据库表中的字段， + * 借助Lombok的 @Data 注解自动生成常用的Getter、Setter、ToString等方法，简化代码编写。 * * @author xcs - * @date 2023年12月22日 16时53分 + * @date 2023年12月22日 16时53分 **/ @Data -@TableName("ContactLabel") +@TableName("ContactLabel") // 表明该实体类对应的数据库表名为 "ContactLabel"，用于MyBatis Plus与数据库表进行关联映射 public class ContactLabel { /** * 标签Id + * 通过 @TableId 注解指定该字段对应数据库表中的主键列，名为 "LabelId"，用于唯一标识每个联系人标签记录。 */ @TableId("LabelId") private String labelId; /** * 标签名称 + * 使用 @TableField 注解表明该字段对应数据库表中的 "LabelName" 列，用于存储联系人标签的具体名称。 */ @TableField("LabelName") private String labelName; /** * 预留字段1。 + * 该字段对应数据库表中的 "Reserved1" 列，可能用于未来功能扩展等预留用途，目前为Integer类型，具体含义根据业务需求而定。 */ @TableField("Reserved1") private Integer reserved1; /** * 预留字段2。 + * 对应数据库表中的 "Reserved2" 列，同样是预留字段，用于可能的后续业务拓展，当前是Integer类型，其具体作用由业务场景决定。 */ @TableField("Reserved2") private Integer reserved2; /** * 预留字段3。 + * 此为数据库表中 "Reserved3" 列对应的实体字段，预留下来以满足后续可能的业务变化，是String类型，其具体存储内容和使用场景有待后续确定。 */ @TableField("Reserved3") private String reserved3; /** * 预留字段4。 + * 与数据库表中的 "Reserved4" 列关联，作为预留字段存在，方便未来根据业务发展添加新的功能逻辑，类型为String，实际用途依据具体业务而定。 */ @TableField("Reserved4") private String reserved4; /** * 预留字段5。 + * 对应数据库表的 "Reserved5" 列，属于预留性质的字段，为String类型，以备后续业务需要而使用，具体功能需结合业务需求明确。 */ @TableField("Reserved5") private String reserved5; /** * 响应数据 + * 关联数据库表中的 "RespData" 列，用于存储和该联系人标签相关的响应数据，具体数据格式和内容取决于具体的业务逻辑和交互情况。 */ @TableField("RespData") private String respData; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/FTSContactContent.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/FTSContactContent.java index 329b23e..475535b 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/FTSContactContent.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/FTSContactContent.java @@ -8,35 +8,43 @@ import lombok.Data; /** * FTSContactContent + * 该类表示与联系人相关的内容实体，用于映射数据库中对应的表结构，通过MyBatis Plus的相关注解来定义与数据库表字段的关联关系， + * 同时借助Lombok的 @Data 注解来自动生成常用的Getter、Setter、ToString等方法，减少代码编写的重复性工作。 * * @author xcs - * @date 2024年6月14日15:12:27 + * @date 2024年6月14日15:12:27 **/ @Data @TableName(value = "FTSContact15_content", autoResultMap = true) +// @TableName注解用于指定该实体类对应的数据库表名是 "FTSContact15_content"，autoResultMap = true表示自动映射结果集，方便查询结果的映射处理 public class FTSContactContent { /** * 本地唯一标识符，自增。 + * 该字段作为实体的唯一标识，对应数据库表中的 "docid" 列，通过 @TableId 注解进行标识，并且其类型设置为自增（IdType.AUTO）， + * 意味着在向数据库插入新记录时，该值会按照数据库的自增规则自动生成，方便对每条记录进行区分和索引。 */ @TableId(value = "docid", type = IdType.AUTO) private Integer docId; /** * alias + * 使用 @TableField 注解表明该字段对应数据库表中的 "c0alias" 列，用于存储联系人的别名信息，具体的别名内容根据实际业务场景下的联系人设置而定。 */ @TableField("c0alias") private String alias; /** * nickname + * 通过 @TableField 注解关联数据库表中的 "c1nickname" 列，该字段用于存放联系人的昵称，是识别联系人的常用称呼方式之一，其具体值由用户设置或者业务逻辑赋值。 */ @TableField("c1nickname") private String nickname; /** * c2remark + * 对应数据库表的 "c2remark" 列，这个字段通常用于存储对联系人的备注信息，比如关于联系人的特殊说明、备注标签等，方便用户更好地识别和管理联系人。 */ @TableField("c2remark") private String remark; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/FTSRecentUsed.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/FTSRecentUsed.java index acc087b..7b0513a 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/FTSRecentUsed.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/FTSRecentUsed.java @@ -6,30 +6,58 @@ import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; /** - * 最近使用关键字 - * + * FTSRecentUsed类用于表示最近使用关键字相关的信息，在系统中主要负责承载和传递与用户近期查询所使用关键字的关键属性数据， + * 例如在实现搜索历史记录、根据用户常用搜索内容进行个性化推荐等业务场景中发挥作用，通过将这些信息整合在一个类中， + * 便于与数据库进行交互以及在不同模块之间进行统一的数据传递和处理，提高代码的可读性和可维护性。 + * @author xcs - * @date 2024年01月23日 11时09分 + * @date 2024年01月23日 11时09分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，像通过调用getQueryText()、getUsername()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问最近使用关键字相关的具体属性信息时，比如查看查询的内容、获取用户名等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当查询的内容发生变化， +// 可以通过调用setQueryText(String newQueryText)方法来更新queryText属性的值，从而保证对象的属性能够灵活地反映最近使用关键字相关信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将FTSRecentUsed对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前最近使用关键字对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个FTSRecentUsed对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及最近使用关键字对象比较的业务逻辑中（如判断两个用户的搜索历史记录是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @TableName("FTSRecentUsed15") +// @TableName注解来自MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明FTSRecentUsed类对应的数据库表名为"FTSRecentUsed15"， +// 明确了该类与数据库表之间的映射关系，方便后续进行数据库操作（如数据的插入、查询、更新、删除等）时能准确地找到对应的表，确保数据的正确交互。 + public class FTSRecentUsed { /** - * 查询的内容 + * 查询的内容。以字符串（String）类型存储用户最近进行查询操作时所输入的关键字内容， + // 这是体现用户搜索意图的关键信息，通过记录这些查询内容，可以分析用户的兴趣点、常用搜索需求等， + // 在搜索历史展示、基于历史搜索进行智能提示或者个性化推荐等业务场景中，查询的内容属性起着重要作用，便于为用户提供更贴合需求的服务。 */ @TableId("queryText") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"FTSRecentUsed15"中，主键字段名为"queryText"， + // 即将类中的queryText属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作，保证数据的完整性和一致性。 private String queryText; /** - * 用户名 + * 用户名。以整数（Integer）类型存储进行查询操作的用户的标识信息，这个用户名可能是以系统内部特定的编码形式存在， + // 通过这个用户名可以区分不同用户的搜索历史记录，明确各条最近使用关键字是属于哪个具体用户的，方便在多用户环境下进行数据的准确管理和个性化服务的提供， + // 例如为不同用户分别展示其对应的搜索历史，或者基于不同用户的搜索习惯进行针对性的推荐等操作。 */ @TableField("username") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"FTSRecentUsed15"中，该属性对应名为"username"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取，便于与数据库进行交互来获取和修改用户名信息。 private Integer username; /** - * 修改时间 + * 修改时间。以字符串（String）类型保存最近一次对该条搜索关键字记录进行修改（比如更新其使用时间等操作）的时间信息， + // 时间的存储格式可能是常见的日期时间格式（如"yyyy-MM-dd HH:mm:ss"等），通过这个修改时间，可以了解用户使用关键字的时间顺序、判断关键字的时效性， + // 在搜索历史排序展示（按照时间先后顺序展示近期使用的关键字）、清理过期的搜索记录等业务操作中会用到这个属性，方便对搜索历史数据进行有效的管理。 */ @TableField("updateTime") private String updateTime; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/Feeds.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/Feeds.java index 7e8b37f..9c93f12 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/Feeds.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/Feeds.java @@ -6,72 +6,105 @@ import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; /** - * 朋友圈 - * + * Feeds类用于表示朋友圈相关的信息，在系统中对应数据库里存储朋友圈动态数据的实体，它整合了朋友圈动态各方面的关键属性， + * 方便与数据库进行交互以及在业务逻辑中对朋友圈相关的数据进行操作、传递和处理，例如在朋友圈动态的发布、查询、展示、状态管理等业务场景中发挥作用。 + * @author xcs - * @date 2024年01月03日 16时41分 + * @date 2024年01月03日 16时41分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，例如通过调用getFeedId()、getCreateTime()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问朋友圈动态的具体属性信息时，比如查看动态的唯一标识ID、获取创建时间等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当朋友圈动态的内容文本发生变化， +// 可以通过调用setContent(String newContent)方法来更新content属性的值，从而保证对象的属性能够灵活地反映朋友圈动态相关信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将Feeds对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前朋友圈动态对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个Feeds对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及朋友圈动态对象比较的业务逻辑中（如判断两条朋友圈动态的信息是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @TableName(value = "FeedsV20", autoResultMap = true) +// @TableName注解来自于MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明Feeds类对应的数据库表名为"FeedsV20"。 +// 而autoResultMap = true这个配置表示自动构建结果映射，方便在查询数据库返回结果时，能自动将结果集的数据映射到该类的属性上， +// 减少了手动配置结果映射的繁琐过程，特别是当表结构和类结构有一定对应关系时，能更便捷地进行数据库与实体类之间的数据交互。 + public class Feeds { /** - * 动态的唯一标识ID。 + * 动态的唯一标识ID。以长整数（Long）类型存储，它是用于在整个系统中唯一标识一条朋友圈动态的关键信息， + // 不同的朋友圈动态应该具有不同的ID，通过这个ID可以在数据库操作（如查询、更新、删除等）以及业务逻辑处理中准确地定位到具体的动态记录， + // 同时在朋友圈的各种业务场景中，比如查看特定动态详情、进行动态的排序展示等，也是重要的依据，方便对朋友圈动态进行精准的管理和操作。 */ @TableId("FeedId") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"FeedsV20"中，主键字段名为"FeedId"， + // 即将类中的feedId属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作，保证数据的完整性和一致性。 private Long feedId; /** - * 创建时间，存储为整数形式。 + * 创建时间，存储为整数形式。使用整数（Integer）类型来保存朋友圈动态创建那一刻的时间信息，这个时间的存储形式可能是时间戳（例如从某个固定起始时间点到动态创建时刻所经过的秒数或毫秒数，常见以1970年1月1日00:00:00 UTC为起始点）， + // 也可能是经过特定格式转换后的整数值，在朋友圈动态管理中，创建时间可用于按照时间顺序对动态进行排序展示（如按发布时间先后展示朋友圈）、进行动态历史记录查询以及判断动态的时效性等业务操作，方便对朋友圈动态的生命周期进行管理。 */ @TableField("CreateTime") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"FeedsV20"中，该属性对应名为"CreateTime"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取，便于与数据库进行交互来获取和修改创建时间信息。 private Integer createTime; /** - * 故障ID，用于记录相关故障信息。 + * 故障ID，用于记录相关故障信息。以整数（Integer）类型存储，这个属性主要用于在朋友圈动态出现异常情况时，关联对应的故障记录ID， + // 例如当动态发布失败、展示出现问题等故障发生时，可以通过这个故障ID去查找具体的故障原因、相关的报错日志等详细信息，便于进行故障排查和系统维护，保障朋友圈功能的正常运行。 */ @TableField("FaultId") private Integer faultId; /** - * 动态的类型。 + * 动态的类型。同样为整数（Integer）类型，用于区分不同种类的朋友圈动态，具体的类型划分取决于业务的具体定义， + // 比如可以用不同的整数值来表示是纯文本动态、图文动态、视频动态等不同类型，在朋友圈动态的展示、处理逻辑中，会根据这个类型属性来采取不同的展示方式、业务操作，以满足多样化的朋友圈功能需求。 */ @TableField("Type") private Integer type; /** - * 发布用户的用户名。 + * 发布用户的用户名。以字符串（String）类型存储发布这条朋友圈动态的用户的用户名信息，通过这个用户名可以明确知道是哪位用户发布了该动态， + // 在朋友圈的展示、权限管理等业务场景中起着重要作用，比如只展示当前用户及其好友的朋友圈动态，就需要通过这个用户名来判断动态的发布者与当前用户的关系，从而决定是否展示该动态。 */ @TableField("UserName") private String userName; /** - * 动态的状态。 + * 动态的状态。以整数（Integer）类型表示朋友圈动态当前所处的状态，具体的状态值含义取决于业务的具体设定， + // 例如可以用不同的整数值来区分动态是正常发布状态、已删除状态、审核中状态（如果有审核机制的话）等不同情况，在朋友圈动态的管理、操作判断等业务逻辑中会依据这个状态属性来进行相应的处理。 */ @TableField("Status") private Integer status; /** - * 扩展标志，用于存储额外信息。 + * 扩展标志，用于存储额外信息。以整数（Integer）类型存在，这个属性可以用于承载一些额外的、与朋友圈动态相关的标志信息，具体含义取决于业务的具体需求， + // 例如可以通过不同的位来表示是否开启了某些扩展功能（如动态是否可评论、是否可转发等扩展功能的标志位），方便在业务逻辑中根据这些标志来实现更丰富、灵活的朋友圈功能。 */ @TableField("ExtFlag") private Integer extFlag; /** - * 隐私标志，指示动态的隐私级别。 + * 隐私标志，指示动态的隐私级别。同样是整数（Integer）类型，用于设定和表示朋友圈动态的隐私程度，不同的整数值对应不同的隐私级别， + // 比如0表示公开，所有人都能看到；1表示仅好友可见；2表示仅自己可见等等，在朋友圈动态的展示权限控制方面起着关键作用，根据用户设置的隐私标志来决定哪些用户能够查看对应的动态内容。 */ @TableField("PrivFlag") private Integer privFlag; /** - * 字符串ID，可能用于关联其他数据。 + * 字符串ID，可能用于关联其他数据。以字符串（String）类型存储，它的具体用途取决于业务场景，有可能是用于和其他相关数据表进行关联， + // 通过这个字符串ID去匹配其他表中的对应记录，实现更复杂的数据关联和业务逻辑处理，例如关联到动态的评论表、点赞表等相关数据，方便对朋友圈动态的附属信息进行统一管理和操作。 */ @TableField("StringId") private String stringId; /** - * 动态的内容文本。 + * 动态的内容文本。以字符串（String）类型保存朋友圈动态具体的内容信息，如果是纯文本动态，这里就直接存储文本内容； + // 如果是图文、视频等类型的动态，这里可能存储的是对内容的简要描述等文本信息，在朋友圈动态的展示环节，这个属性的值就是用户实际看到的动态文字内容，是朋友圈动态的核心展示部分之一。 */ @TableField("Content") private String content; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/HardLinkImageAttribute.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/HardLinkImageAttribute.java index 73f7778..90d937d 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/HardLinkImageAttribute.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/HardLinkImageAttribute.java @@ -8,48 +8,57 @@ import org.apache.ibatis.type.ByteArrayTypeHandler; /** * 图片链接表 + * 此类用于表示图片链接相关的实体信息，对应数据库中存储图片链接相关属性的表结构，借助MyBatis Plus的注解来建立与数据库表字段的映射关系， + * 同时利用Lombok的 @Data 注解自动生成如Getter、Setter等常用方法，以简化代码编写过程，方便在业务逻辑中对该实体对象进行操作。 * * @author xcs - * @date 2024年01月04日 17时55分 + * @date 2024年01月04日 17时55分 **/ @Data @TableName(value = "HardLinkImageAttribute", autoResultMap = true) +// @TableName注解用于指定该实体类对应的数据库表名为 "HardLinkImageAttribute"，autoResultMap = true表示自动映射结果集，便于在查询等操作后将数据库结果准确映射到该实体对象上 public class HardLinkImageAttribute { /** * 动态的唯一标识ID。 + * 通过 @TableId 注解将该字段与数据库表中的 "Md5Hash" 列对应起来，作为每条记录的唯一标识，这里使用Long类型，用于区分不同的图片链接相关记录，通常基于特定算法生成，比如MD5哈希值等方式来保证唯一性。 */ @TableId("Md5Hash") private Long md5Hash; /** * 发布用户的用户名。 + * 使用 @TableField 注解表明该字段对应数据库表中的 "DirID1" 列，用于存储发布该图片链接对应的发布用户的用户名，以此来关联图片与发布者，便于后续权限管理、溯源等业务操作。 */ @TableField("DirID1") private String dirId1; /** * 发布用户的用户名。 + * 同样通过 @TableField 注解关联数据库表中的 "DirID2" 列，也是用于存放发布用户的用户名，可能在多用户、多角色等复杂业务场景下从不同角度来标识发布者相关信息，具体作用取决于业务逻辑设定。 */ @TableField("DirID2") private String dirId2; /** * 发布用户的用户名。 + * 该字段对应数据库表中名为 "Md5" 的列，使用了 ByteArrayTypeHandler 类型处理器，用于处理字节数组类型的数据，这里可能是将用户名以字节数组形式存储（不过从语义上更可能是存储图片的MD5值等二进制相关数据来唯一标识图片本身，此处注释按原代码表意先写为用户名，如有误需按实际业务调整），以满足特定的数据库存储和读取需求。 */ @TableField(value = "Md5", typeHandler = ByteArrayTypeHandler.class) private byte[] md5; /** * 发布用户的用户名。 + * 由 @TableField 注解关联到数据库表的 "ModifyTime" 列，用于记录图片链接相关信息的修改时间，方便跟踪图片的更新情况以及进行数据版本管理等业务操作。 */ @TableField("ModifyTime") private String modifyTime; /** * 发布用户的用户名。 + * 通过 @TableField 注解对应数据库表中的 "FileName" 列，用于存储图片对应的文件名，便于直观地识别图片，也有助于在文件系统等相关操作中进行查找、展示等操作。 */ @TableField("FileName") private String fileName; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/HardLinkVideoAttribute.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/HardLinkVideoAttribute.java index 5075a5c..51b7006 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/HardLinkVideoAttribute.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/HardLinkVideoAttribute.java @@ -7,49 +7,84 @@ import lombok.Data; import org.apache.ibatis.type.ByteArrayTypeHandler; /** - * 视频链接表 - * + * HardLinkVideoAttribute类用于表示视频链接相关的信息，在系统中对应数据库里存储视频链接相关数据的实体， + * 它将视频链接涉及的各项关键属性整合在一起，方便与数据库进行交互以及在业务逻辑中对视频链接相关的数据进行操作、传递和处理， + * 例如在视频分享、视频管理以及基于视频链接进行相关业务操作等场景中发挥作用。 + * @author xcs - * @date 2024年02月07日 15时24分 + * @date 2024年02月07日 15时24分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，例如通过调用getMd5Hash()、getDirId1()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问视频链接相关的具体属性信息时，比如查看动态的唯一标识ID、获取发布用户的用户名等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当视频的文件名发生变化， +// 可以通过调用setFileName(String newFileName)方法来更新fileName属性的值，从而保证对象的属性能够灵活地反映视频链接相关信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将HardLinkVideoAttribute对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前视频链接对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个HardLinkVideoAttribute对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及视频链接对象比较的业务逻辑中（如判断两条视频链接的相关属性是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @TableName(value = "HardLinkVideoAttribute", autoResultMap = true) +// @TableName注解来自于MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明HardLinkVideoAttribute类对应的数据库表名为"HardLinkVideoAttribute"。 +// 而autoResultMap = true这个配置表示自动构建结果映射，方便在查询数据库返回结果时，能自动将结果集的数据映射到该类的属性上， +// 减少了手动配置结果映射的繁琐过程，特别是当表结构和类结构有一定对应关系时，能更便捷地进行数据库与实体类之间的数据交互。 + public class HardLinkVideoAttribute { /** - * 动态的唯一标识ID。 + * 动态的唯一标识ID。以长整数（Long）类型存储，它是用于在整个系统中唯一标识一个视频链接相关记录的关键信息， + // 不同的视频链接记录应该具有不同的ID，通过这个ID可以在数据库操作（如查询、更新、删除等）以及业务逻辑处理中准确地定位到具体的记录， + // 同时在视频链接相关的各种业务场景中，比如查看特定视频链接详情、进行视频链接的排序展示等，也是重要的依据，方便对视频链接进行精准的管理和操作， + // 这里使用MD5哈希值（假设MD5Hash代表的是基于视频相关特征生成的MD5哈希值）作为唯一标识，有助于保证数据的唯一性和准确性。 */ @TableId("Md5Hash") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"HardLinkVideoAttribute"中，主键字段名为"Md5Hash"， + // 即将类中的md5Hash属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作，保证数据的完整性和一致性。 private Long md5Hash; /** - * 发布用户的用户名。 + * 发布用户的用户名。以字符串（String）类型存储发布该视频链接的用户的用户名信息，通过这个用户名可以明确知道是哪位用户发布了对应的视频链接， + // 在视频链接的权限管理、归属判断以及相关业务场景中起着重要作用，比如判断当前用户是否有权限查看、操作该视频链接，或者统计不同用户发布视频链接的情况等，都需要依据这个用户名来进行相应的处理。 */ @TableField("DirID1") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"HardLinkVideoAttribute"中，该属性对应名为"DirID1"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取，便于与数据库进行交互来获取和修改用户名信息。不过此处字段名"DirID1"看起来不太直观表示用户名， + // 可能在具体业务中有其特定含义或映射关系，需结合实际业务场景进一步理解。 + private String dirId1; /** - * 发布用户的用户名。 + * 发布用户的用户名。同样以字符串类型存储发布该视频链接的用户的用户名信息，这里再次出现可能是基于数据库表结构设计或者业务逻辑中对用户标识有不同的关联或使用方式， + // 例如可能从不同维度来关联用户与视频链接的关系，具体含义需要参照具体的业务规则和数据库设计来确定，但总体来说都是用于明确视频链接发布者身份的重要属性。 */ @TableField("DirID2") private String dirId2; /** - * 发布用户的用户名。 + * 发布用户的用户名。以字节数组（byte[]）类型存储，使用ByteArrayTypeHandler类作为类型处理器，此处虽然注释写的是发布用户的用户名，但从数据类型来看不太符合常规用户名的存储形式， + // 有可能它存储的是基于视频相关内容（比如视频文件本身）计算出的MD5值（如果按照合理推测，可能和前面提到的MD5Hash有一定关联但又不同的用途），用于数据验证、唯一性判断或者与其他系统交互时识别视频的关键标识等， + // 具体作用还是要结合整个系统关于视频链接处理的业务逻辑来准确理解。 */ @TableField(value = "Md5", typeHandler = ByteArrayTypeHandler.class) private byte[] md5; /** - * 发布用户的用户名。 + * 发布用户的用户名。以字符串（String）类型保存该视频链接相关信息的最后修改时间，这个修改时间可以是按照某种特定格式（如常见的日期时间格式"yyyy-MM-dd HH:mm:ss"等）存储的文本信息， + // 在视频链接的管理中，通过这个修改时间可以了解视频链接相关数据的更新情况，比如判断是否有新的变动、进行历史记录查询以及按照时间顺序对视频链接进行排序展示等业务操作，方便对视频链接的生命周期进行管理， + // 不过这里同样字段名"ModifyTime"更直观表示修改时间，和注释里“发布用户的用户名”不太相符，应按照实际业务场景准确理解其含义。 */ @TableField("ModifyTime") private String modifyTime; /** - * 发布用户的用户名。 + * 发布用户的用户名。以字符串（String）类型存储视频文件的名称信息，文件名是视频的一个重要标识属性，方便用户在查看、管理视频链接时能够直观地识别对应的视频内容， + // 同时在文件存储、检索以及与其他系统进行文件相关交互等业务场景中，文件名也起着关键作用，有助于准确地定位和操作具体的视频文件对应的链接信息。 */ @TableField("FileName") private String fileName; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/Msg.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/Msg.java index f92ac54..3e5116f 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/Msg.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/Msg.java @@ -1,6 +1,5 @@ package com.xcs.wx.domain; - import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableId; @@ -10,167 +9,219 @@ import org.apache.ibatis.type.ByteArrayTypeHandler; /** * 消息 + * 该类用于表示消息相关的实体信息，对应数据库中存储消息各项属性的表结构，借助MyBatis Plus的一系列注解来建立与数据库表字段的映射关系， + * 同时利用Lombok的 @Data 注解自动生成如Getter、Setter等常用方法，方便在业务逻辑中对消息实体对象进行操作、传递以及持久化等处理。 * * @author xcs - * @date 2023年12月25日 15时08分 + * @date 2023年12月25日 15时08分 **/ @Data @TableName(value = "MSG", autoResultMap = true) +// @TableName注解用于指定该实体类对应的数据库表名为 "MSG"，autoResultMap = true表示自动映射结果集，确保在进行数据库查询等操作后能准确地将结果映射到该实体对象的各个属性上 public class Msg { /** * 本地唯一标识符，自增。 + * 通过 @TableId 注解将该字段与数据库表中的 "localId" 列对应起来，作为每条消息记录在本地的唯一标识，其类型为Integer，且设置为自增（IdType.AUTO）， + * 意味着在向数据库插入新的消息记录时，该值会按照数据库的自增规则自动生成，方便在本地系统中对不同消息进行区分、索引以及关联其他相关数据。 */ - @TableId(value = "localId",type = IdType.AUTO) + @TableId(value = "localId", type = IdType.AUTO) private Integer localId; /** * 聊天对象的 ID。 + * 使用 @TableField 注解表明该字段对应数据库表中的 "TalkerId" 列，用于存储与这条消息相关的聊天对象的唯一标识符，通过该ID可以关联到具体的聊天对象信息， + * 例如在多用户聊天场景下确定消息是发送给哪个用户或者来自哪个用户的。 */ @TableField("TalkerId") private Integer talkerId; /** * 消息服务器 ID。 + * 借助 @TableField 注解关联数据库表中的 "MsgSvrID" 列，该字段用于存放消息在服务器端的唯一标识符，服务器可以凭借此ID对消息进行管理、转发、存储等操作， + * 它在整个消息流转过程中起到了在服务器层面标识消息的重要作用。 */ @TableField("MsgSvrID") private String msgSvrId; /** * 消息类型。 + * 通过 @TableField 注解对应数据库表中的 "Type" 列，用于区分不同种类的消息，比如文本消息、图片消息、语音消息等，不同的消息类型在展示、处理等方面往往有不同的逻辑， + * 可以根据该字段的值来决定后续对消息采取何种具体的业务操作。 */ @TableField("Type") private Integer type; /** * 消息子类型。 + * 同样由 @TableField 注解关联到数据库表的 "SubType" 列，在消息已经有了大的类型划分基础上，进一步细分消息的子类型，例如对于图片消息，可能还会区分是静态图片还是动态图片等更细致的分类， + * 以便更精准地处理和展示不同特性的消息内容。 */ @TableField("SubType") private Integer subType; /** * 发送者标识（是否为发送者）。 + * 使用 @TableField 注解表明该字段对应数据库表中的 "IsSender" 列，用于标识当前这条消息的发送者身份，一般以特定的数值（如1表示是发送者，0表示不是等）来体现， + * 有助于在聊天记录等场景下清晰地判断消息的流向和归属。 */ @TableField("IsSender") private Integer isSender; /** * 消息创建时间。 + * 由 @TableField 注解关联到数据库表的 "CreateTime" 列，用于记录消息创建的时间戳，通常以整数形式表示，方便按照时间顺序对消息进行排序、查询以及分析消息的时效性等， + * 例如可以实现按时间查找历史消息、统计不同时间段内的消息数量等功能。 */ @TableField("CreateTime") private Integer createTime; /** * 序列号，默认为 0。 + * 通过 @TableField 注解对应数据库表中的 "Sequence" 列，序列号常用于在消息传输、处理等流程中保证消息的顺序性以及唯一性等，初始值默认为0， + * 在一些复杂的消息交互场景下，可能会根据特定规则进行更新和使用，以确保消息不会出现乱序等问题。 */ @TableField("Sequence") private Long sequence; /** * 扩展状态，默认为 0。 + * 借助 @TableField 注解关联数据库表中的 "StatusEx" 列，该字段用于存储消息的扩展状态信息，初始值设为0，具体的扩展状态含义可能根据业务需求而定， + * 比如可以表示消息是否经过特殊处理、是否处于某种临时状态等额外的状态描述。 */ @TableField("StatusEx") private Integer statusEx; /** * 扩展标志。 + * 使用 @TableField 注解表明该字段对应数据库表中的 "FlagEx" 列，用于设置消息的一些扩展标志，这些标志可以携带额外的业务相关信息，例如是否加急、是否需要回执等， + * 通过对这些标志位的判断来执行不同的业务逻辑。 */ @TableField("FlagEx") private Integer flagEx; /** * 消息状态。 + * 通过 @TableField 注解关联到数据库表的 "Status" 列，用于表示消息当前所处的常规状态，比如已发送、已接收、已读等常见的消息状态，方便对消息的流转情况进行跟踪和管理， + * 根据该状态可以决定是否需要进行下一步的业务操作，如更新界面显示等。 */ @TableField("Status") private Integer status; /** * 消息服务器序列号。 + * 由 @TableField 注解对应数据库表中的 "MsgServerSeq" 列，在服务器端对消息进行管理时使用的序列号，有助于服务器按照顺序准确地处理、转发消息， + * 保证消息在服务器层面的有序性和准确性，与前面提到的本地序列号等可能有不同的用途和作用范围。 */ @TableField("MsgServerSeq") private Integer msgServerSeq; /** * 消息序列号。 + * 借助 @TableField 注解关联数据库表中的 "MsgSequence" 列，也是用于标识消息顺序的一个序列号，可能在整个消息传递链路（包括客户端和服务器端交互等）中起到统一的顺序标识作用， + * 具体使用方式和与其他序列号的关系取决于具体的消息处理架构和业务逻辑。 */ @TableField("MsgSequence") private Integer msgSequence; /** * 聊天者字符串。 + * 使用 @TableField 注解表明该字段对应数据库表中的 "StrTalker" 列，通常用于以字符串形式存储聊天对象的相关标识信息，可能是用户名、昵称或者其他可以唯一识别聊天者的文本内容， + * 方便在界面展示等场景下直观地显示消息对应的聊天对象。 */ @TableField("StrTalker") private String strTalker; /** * 消息内容字符串。 + * 通过 @TableField 注解对应数据库表中的 "StrContent" 列，用于存放消息的具体文本内容，当消息类型为文本消息时，该字段就承载了实际要传达的文字信息， + * 在展示、存储以及后续分析等业务操作中都起着关键作用。 */ @TableField("StrContent") private String strContent; /** * 显示内容。 + * 由 @TableField 注解关联到数据库表的 "DisplayContent" 列，该字段用于存储消息最终展示给用户的内容，有时候消息的原始内容可能经过一些处理（如表情替换、格式转换等）才呈现给用户， + * 这个字段就记录了经过处理后实际显示的内容。 */ @TableField("DisplayContent") private String displayContent; /** * 保留字段 0，默认为 0。 + * 使用 @TableField 注解表明该字段对应数据库表中的 "Reserved0" 列，属于预留字段，初始值设为0，主要是为了应对未来可能的业务扩展或者功能变化， + * 方便在不修改现有数据库表结构和大部分代码逻辑的基础上添加新的属性或功能需求。 */ @TableField("Reserved0") private Integer reserved0; /** * 保留字段 1，默认为 0。 + * 同样借助 @TableField 注解关联数据库表中的 "Reserved1" 列，也是预留字段，默认值为0，其作用和 Reserved0 类似，是为后续业务拓展预留的空间，具体如何使用取决于未来的业务发展方向。 */ @TableField("Reserved1") private Integer reserved1; /** * 保留字段 2，默认为 0。 + * 通过 @TableField 注解对应数据库表中的 "Reserved2" 列，此为预留字段且初始值设为0，为将来可能出现的新业务场景或者功能添加预先准备的可扩展字段，具体用途有待后续根据业务需求确定。 */ @TableField("Reserved2") private Integer reserved2; /** * 保留字段 3，默认为 0。 + * 由 @TableField 注解关联数据库表中的 "Reserved3" 列，同样是预留字段，默认值是0，在未来业务发生变化，需要在消息实体中添加新的属性时，可以利用该字段进行扩展，而不用大规模改动数据库结构等。 */ @TableField("Reserved3") private Integer reserved3; /** * 保留字段 4，文本类型。 + * 使用 @TableField 注解表明该字段对应数据库表中的 "Reserved4" 列，作为预留的文本类型字段，可为后续添加与消息相关的文本描述信息等预留空间， + * 比如可以用于存储消息的备注、额外的说明文字等内容，具体使用方式根据未来业务需求而定。 */ @TableField("Reserved4") private String reserved4; /** * 保留字段 5，文本类型。 + * 借助 @TableField 注解关联数据库表中的 "Reserved5" 列，也是预留的文本类型字段，和 Reserved4 类似，用于应对未来可能出现的需要在消息实体中添加文本相关信息的业务场景， + * 方便进行业务功能的扩展和完善。 */ @TableField("Reserved5") private String reserved5; /** * 保留字段 6，文本类型。 + * 通过 @TableField 注解对应数据库表中的 "Reserved6" 列，同样是为了业务扩展预留的文本类型字段，当后续有新的文本相关的业务需求与消息相关联时，可以利用该字段来存储相应信息， + * 保证代码和数据库结构具有一定的可扩展性。 */ @TableField("Reserved6") private String reserved6; /** * 压缩内容，二进制大对象。 + * 该字段对应数据库表中名为 "CompressContent" 的列，使用了 ByteArrayTypeHandler 类型处理器来处理字节数组类型的数据，用于存储消息经过压缩后的内容， + * 在一些场景下，为了节省存储空间或者提高传输效率，会对消息内容（比如图片、语音等大文件对应的消息内容）进行压缩处理，这里就存放压缩后的二进制数据，方便后续解压缩以及还原消息内容等操作。 */ @TableField(value = "CompressContent", typeHandler = ByteArrayTypeHandler.class) private byte[] compressContent; /** * 额外字节信息，二进制大对象。 + * 通过 @TableField 注解关联数据库表中的 "BytesExtra" 列，同样使用 ByteArrayTypeHandler 类型处理器来处理字节数组类型的数据，用于存储与消息相关的额外字节信息， + * 这些额外信息可能是对消息的补充说明、附加的数据部分等，具体内容和用途取决于具体的业务场景和消息处理逻辑。 */ @TableField(value = "BytesExtra", typeHandler = ByteArrayTypeHandler.class) private byte[] bytesExtra; /** * 传输字节信息，二进制大对象。 + * 使用 @TableField 注解表明该字段对应数据库表中的 "BytesTrans" 列，采用 ByteArrayTypeHandler 类型处理器来处理字节数组类型的数据，用于存储消息在传输过程中的相关字节信息， + * 比如可能包含传输协议的头部信息、校验码等，有助于保证消息在网络传输中的完整性和准确性。 */ @TableField(value = "BytesTrans", typeHandler = ByteArrayTypeHandler.class) private byte[] bytesTrans; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/Session.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/Session.java index 99adead..1f5d2e4 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/Session.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/Session.java @@ -6,90 +6,132 @@ import com.baomidou.mybatisplus.annotation.TableName; import lombok.Data; /** - * 会话 - * + * Session类用于表示会话相关的信息，在系统中对应数据库里存储会话数据的实体，它整合了会话各个方面的关键属性， + * 方便与数据库进行交互以及在业务逻辑中对会话相关的数据进行操作、传递和处理，例如在会话列表展示、消息管理、会话状态跟踪等业务场景中发挥作用。 + * @author xcs - * @date 2023年12月21日 17时05分 + * @date 2023年12月21日 17时05分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，例如通过调用getUsrName()、getUnReadCount()等方法，外部代码可以方便地获取类中各个属性的值， +// 在需要访问会话的具体属性信息时，比如查看用户名、获取未读消息计数等，这些getter方法能提供便捷的数据访问途径，便于后续业务逻辑使用这些数据。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码能够根据业务需求动态地修改对象的属性值，例如当会话的内容发生变化， +// 可以通过调用setContent(String newContent)方法来更新content属性的值，从而保证对象的属性能够灵活地反映会话相关信息的实际变化情况，增强了属性的可操作性。 +// - 生成toString方法，该方法能将Session对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前会话对象的具体状态，了解各个属性的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，方便在集合中快速查找和比较对象。 +// - 生成equals方法，用于比较两个Session对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在涉及会话对象比较的业务逻辑中（如判断两个会话的信息是否一致等情况），该方法能准确地进行对象的相等性判断。 +// 通过使用@Data注解，大大减少了手动编写这些常规方法的工作量，让代码更加简洁、易读且易于维护。 + @TableName("Session") +// @TableName注解来自MyBatis Plus框架，用于指定该实体类对应的数据库表名，这里表明Session类对应的数据库表名为"Session"， +// 明确了该类与数据库表之间的映射关系，方便后续进行数据库操作（如数据的插入、查询、更新、删除等）时能准确地找到对应的表，确保数据的正确交互。 + public class Session { /** - * 用户名 + * 用户名。以字符串（String）类型存储，它是用于唯一标识参与会话的用户的关键信息， + // 在整个系统中，不同用户的会话记录通过这个用户名进行区分，通过这个用户名可以在数据库操作（如查询、更新、删除等）以及业务逻辑处理中准确地定位到具体用户的会话相关记录， + // 并且在展示会话列表、判断会话归属等场景下，也是重要的依据，确保会话数据与对应的用户能准确匹配。 */ @TableId("strUsrName") + // @TableId注解用于指定该属性对应的数据库表中的主键字段名，这里表明在数据库表"Session"中，主键字段名为"strUsrName"， + // 即将类中的usrName属性与数据库表中的主键列进行了关联，确保了在数据库操作时，能根据这个主键进行准确的记录定位和操作，保证数据的完整性和一致性。 private String usrName; /** - * 未读消息计数 + * 未读消息计数。以整数（Integer）类型存储，表示当前会话中用户尚未阅读的消息数量， + // 在会话列表展示等场景中，这个计数可以直观地提示用户有多少新消息等待查看，方便用户及时了解是否有未处理的消息， + // 同时在消息提醒、未读消息管理等业务逻辑中起着重要作用，例如可以根据未读消息数量决定是否进行特殊的提醒标识等操作。 */ @TableField("nUnReadCount") + // @TableField注解用于指定该属性对应的数据库表中的字段名，这里表示在数据库表"Session"中，该属性对应名为"nUnReadCount"的字段， + // 明确了类属性与数据库表字段之间的映射关系，确保数据的正确存储和读取，便于与数据库进行交互来获取和修改未读消息计数信息。 private Integer unReadCount; /** - * 父引用，可能指向与此会话相关联的其他实体 + * 父引用，可能指向与此会话相关联的其他实体。以字符串（String）类型存储，这个属性的具体含义取决于业务的具体设定， + // 它可能用于关联到会话所属的某个更高层级的实体（比如会话所在的分组、聊天窗口等），或者指向与该会话有特定关联关系的其他对象， + // 在涉及会话的组织架构、关联关系梳理以及复杂业务逻辑处理中会用到这个属性来建立不同实体之间的联系。 */ @TableField("parentRef") private String parentRef; /** - * 用户昵称 + * 用户昵称。以字符串（String）类型存储参与会话的用户的昵称信息，昵称通常是用户对外展示的一个比较个性化、友好的称呼， + // 在会话展示等场景中，昵称更便于用户直观地识别会话对象，增强了用户与用户之间交互的友好性，相较于用户名，昵称更具亲和力，方便用户快速知晓对方身份。 */ @TableField("strNickName") private String nickName; /** - * 会话状态 + * 会话状态。以整数（Integer）类型表示会话当前所处的状态，具体的状态值含义取决于业务的具体定义， + // 例如可以用不同的整数值来区分会话是正常开启状态、已关闭状态、冻结状态等不同情况，在会话的管理、操作判断等业务逻辑中会依据这个状态属性来进行相应的处理， + // 比如根据会话状态决定是否允许发送消息等操作。 */ @TableField("nStatus") private Integer status; /** - * 发送状态标识 + * 发送状态标识。同样为整数（Integer）类型，用于表示消息在会话中的发送情况，例如可以用不同的值来表示消息已成功发送、正在发送、发送失败等不同的发送状态， + // 在消息发送的相关业务逻辑中，通过这个标识可以判断消息是否准确传达，便于进行后续的处理，比如重新发送失败的消息等操作。 */ @TableField("nIsSend") private Integer isSend; /** - * 会话内容 + * 会话内容。以字符串（String）类型保存会话中的具体消息内容，这是会话的核心信息之一， + // 无论是文本消息、表情等都可以以相应的文本形式存储在这里（如果涉及复杂的多媒体消息等可能会有其他关联处理方式），在展示会话历史记录、查看具体消息详情等场景中会用到这个属性来呈现消息内容。 */ @TableField("strContent") private String content; /** - * 消息类型 + * 消息类型。以整数（Integer）类型表示会话中消息的类型，具体的类型划分取决于业务的具体设定， + // 例如可以用不同的整数值来区分是文本消息、图片消息、语音消息、视频消息等不同类型的消息，在消息的展示、处理逻辑中，会根据这个类型属性来采取不同的展示方式、业务操作， + // 以满足多样化的消息交互需求，比如对于图片消息要进行图片加载展示，对于语音消息要提供播放功能等。 */ @TableField("nMsgType") private Integer msgType; /** - * 本地消息ID + * 本地消息ID。以整数（Integer）类型存储在本地系统中为每条消息分配的唯一标识符， + // 通过这个ID可以在本地数据库或者相关存储中准确地定位到具体的消息记录，方便进行消息的查询、更新、删除等操作， + // 同时在消息的关联、排序以及与其他系统交互涉及消息标识等业务场景中起着重要作用，确保消息管理的准确性和便捷性。 */ @TableField("nMsgLocalID") private Integer msgLocalId; /** - * 消息状态 + * 消息状态。以整数（Integer）类型表示消息当前所处的状态，具体的状态值含义取决于业务的具体设定， + // 类似消息的发送状态，但可能涵盖更广泛的情况，比如消息是否已读、是否被撤回、是否审核通过（如果有审核机制的话）等不同状态， + // 在消息管理、消息提醒以及相关业务逻辑中会依据这个状态属性来进行相应的处理，例如根据消息是否已读来决定是否取消未读提醒等操作。 */ @TableField("nMsgStatus") private Integer msgStatus; /** - * 消息时间戳 + * 消息时间戳。以整数（Integer）类型存储消息发送或接收的时间信息，这个时间戳一般是以某个特定的起始时间（如1970年1月1日00:00:00 UTC）为基准， + // 到消息实际发送或接收时刻所经过的秒数或者毫秒数（具体取决于系统的时间精度设定），通过这个时间戳，可以准确判断消息的先后顺序、进行消息的排序展示（按照时间顺序）， + // 以及在一些基于时间范围的查询（如查看某一时间段内的消息记录）等业务场景中发挥作用，方便对会话中的消息进行时间维度的管理。 */ @TableField("nTime") private Integer time; /** - * 编辑过的内容 + * 编辑过的内容。以字符串（String）类型存储会话中消息被编辑后的内容信息，在一些支持消息编辑功能的系统中， + // 当用户对已发送的消息进行修改后，修改后的内容就会存储在这里，方便在查看消息历史记录时能够体现消息的变化情况，同时也便于进行相关的业务逻辑处理，比如记录消息编辑的日志等操作。 */ @TableField("editContent") private String editContent; /** - * 标记是否有其他人@我 + * 标记是否有其他人@我。以整数（Integer）类型表示在会话中是否有其他用户提及了当前用户（通过@的方式）， + // 例如值为1表示有其他人@我，值为0表示没有，在消息提醒、重点消息关注等业务逻辑中会用到这个标识，方便用户快速定位到与自己相关的重要消息内容。 */ @TableField("othersAtMe") private Integer othersAtMe; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/domain/SqliteMaster.java b/wx-dump-admin/src/main/java/com/xcs/wx/domain/SqliteMaster.java index 0068b02..d72a8b3 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/domain/SqliteMaster.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/domain/SqliteMaster.java @@ -6,36 +6,47 @@ import lombok.Data; /** * SQLite 数据库中的一个系统表 + * 该类用于映射SQLite数据库中名为 "sqlite_master" 的系统表结构，通过MyBatis Plus的相关注解来建立类的属性与数据库表字段之间的对应关系， + * 并且借助Lombok的 @Data 注解自动生成常用的Getter、Setter等方法，方便在操作数据库以及业务逻辑处理中对该表对应的数据进行访问和修改等操作。 * * @author xcs - * @date 2024年6月13日09:18:29 + * @date 2024年6月13日09:18:29 */ @Data @TableName("sqlite_master") +// @TableName注解用于指定该实体类对应的数据库表名为 "sqlite_master"，表明这个类是与SQLite数据库中的该系统表相关联的实体映射类 public class SqliteMaster { /** * type + * 使用 @TableField 注解将该字段与数据库表中的 "type" 列相对应，在 "sqlite_master" 系统表中，"type" 字段通常用于表示数据库对象的类型， + * 比如可能是 'table'（表示表）、'index'（表示索引）、'view'（表示视图）等不同类型，通过该字段可以知晓对应记录所描述的数据库对象具体属于哪一类。 */ @TableField("type") private String type; /** * tblName + * 通过 @TableField 注解关联数据库表中的 "tbl_name" 列，该字段用于存储数据库对象（常见的如数据表）的名称， + * 在查询 "sqlite_master" 系统表时，可以通过这个字段获取到具体某个数据库对象（例如某张表）的名字，方便后续对该对象进行相关操作或者获取其详细信息。 */ @TableField("tbl_name") private String tblName; /** * rootPage + * 借助 @TableField 注解对应数据库表中的 "rootpage" 列，在SQLite数据库的内部存储结构中，"rootpage" 字段往往与数据库对象的存储位置或者起始页面等相关， + * 具体含义和用途更偏向于数据库底层的存储管理方面，通过该字段的值可以了解到对应数据库对象在存储层面的一些关键信息（比如数据存储的起始位置等）。 */ @TableField("rootpage") private String rootPage; /** * sql + * 使用 @TableField 注解表明该字段对应数据库表中的 "sql" 列，在 "sqlite_master" 系统表中，"sql" 字段通常存放着用于创建对应数据库对象的SQL语句， + * 例如如果是一张表，这里就会记录创建该表时使用的完整CREATE TABLE语句，通过读取该字段内容，可以清楚地知道数据库对象最初是如何被定义和创建的。 */ @TableField("sql") private String sql; -} +} \ No newline at end of file -- 2.34.1 From 0ed9e16de2ab3a2656a2a387316af2cf7e6bd20d Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Sun, 15 Dec 2024 23:14:08 +0800 Subject: [PATCH 06/17] 1 --- .../com/xcs/wx/exception/BaseException.java | 37 ++++++++++++++-- .../com/xcs/wx/exception/BizException.java | 14 +++++- .../com/xcs/wx/mapper/ChatRoomInfoMapper.java | 10 ++++- .../com/xcs/wx/mapper/ChatRoomMapper.java | 33 ++++++++++---- .../xcs/wx/mapper/ContactHeadImgMapper.java | 14 ++++-- .../wx/mapper/ContactHeadImgUrlMapper.java | 15 +++++-- .../com/xcs/wx/mapper/ContactLabelMapper.java | 24 ++++++++-- .../java/com/xcs/wx/mapper/ContactMapper.java | 44 ++++++++++++++----- .../wx/mapper/FTSContactContentMapper.java | 22 ++++++++-- .../xcs/wx/mapper/FTSRecentUsedMapper.java | 12 ++++- .../java/com/xcs/wx/mapper/FeedsMapper.java | 13 ++++-- .../mapper/HardLinkImageAttributeMapper.java | 13 +++++- .../mapper/HardLinkVideoAttributeMapper.java | 18 +++++--- .../java/com/xcs/wx/mapper/MsgMapper.java | 33 ++++++++++---- .../java/com/xcs/wx/mapper/SessionMapper.java | 20 ++++++--- .../com/xcs/wx/mapper/SqliteMasterMapper.java | 14 +++--- 16 files changed, 259 insertions(+), 77 deletions(-) diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/exception/BaseException.java b/wx-dump-admin/src/main/java/com/xcs/wx/exception/BaseException.java index 63df2c2..86ca7df 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/exception/BaseException.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/exception/BaseException.java @@ -5,21 +5,50 @@ import lombok.Data; import lombok.EqualsAndHashCode; /** + * BaseException类是一个自定义的异常类，继承自Java内置的 `RuntimeException`，意味着它属于运行时异常， + * 在程序运行过程中如果出现符合该异常定义的错误情况时，会抛出这个异常，方便开发者按照业务逻辑来捕获和处理特定的异常情况， + * 它主要用于在整个 `com.xcs.wx` 相关项目中统一规范异常信息的传递和处理，使得异常情况能够携带具体的错误编码以及错误消息，便于进行更精准的错误定位和反馈。 + * @author xcs - * @date 2023年12月25日 17时39分 + * @date 2023年12月25日 17时39分 **/ @Data +// @Data注解由Lombok库提供，它会自动为这个类生成一系列实用的方法，具体如下： +// - 自动生成所有私有属性对应的getter方法，通过调用 `getCode()` 和 `getMsg()` 方法，外部代码可以方便地获取类中定义的错误编码和错误消息这两个属性的值， +// 在捕获该异常并进行处理时，能够便捷地获取异常所携带的具体错误信息，便于后续根据这些信息进行日志记录、向用户反馈或者执行相应的错误处理逻辑等操作。 +// - 自动生成所有私有属性对应的setter方法，使得外部代码在某些特定场景下（虽然在异常场景中相对少见，但理论上存在需求）， +// 能够动态地修改对象的属性值，不过对于异常类来说，通常更多是在创建异常实例时就确定好属性值，用于准确反映异常发生时的情况。 +// - 生成toString方法，该方法能将 `BaseException` 对象以一种直观、易于阅读的字符串形式展示出来，通常会包含类名以及各个属性的值， +// 在调试程序时，通过打印对象的toString结果，可以快速查看当前异常对象的具体状态，了解错误编码和错误消息的取值情况，便于排查问题。 +// - 生成hashCode方法，在将对象存储到基于哈希的集合（如HashMap、HashSet等）中时会用到这个方法， +// 它依据对象的属性值计算出一个唯一的哈希码，用于确定对象在哈希集合中的存储位置，不过在异常处理场景中，将异常对象放入此类集合的情况相对不那么常见。 +// - 生成equals方法，用于比较两个 `BaseException` 对象是否在逻辑上相等，也就是判断它们的所有属性值是否都完全相同， +// 在一些涉及异常比较的特定业务逻辑（虽然比较少见）中，该方法能准确地进行对象的相等性判断。 + @AllArgsConstructor +// @AllArgsConstructor注解同样来自Lombok库，它会自动为这个类生成一个包含所有参数的构造函数， +// 在这里就会生成一个构造函数形式为 `public BaseException(Integer code, String msg)`， +// 意味着在创建 `BaseException` 类的实例时，必须传入错误编码（`code`）和错误消息（`msg`）这两个参数， +// 这样可以方便地按照业务中出现的具体错误情况，准确地实例化异常对象，使其携带对应的错误信息，便于后续的异常抛出和处理流程。 + @EqualsAndHashCode(callSuper = true) +// @EqualsAndHashCode注解用于生成 `equals` 和 `hashCode` 方法，这里 `callSuper = true` 表示在生成这两个方法时， +// 会同时考虑父类（即 `RuntimeException`）的相关属性来进行相等性判断和哈希码的计算，确保在进行对象比较和哈希操作时， +// 不仅考虑了本类中定义的 `code` 和 `msg` 属性，也兼顾了父类的状态，使得对象比较和哈希处理更加全面、准确，符合继承体系下的逻辑要求。 + public class BaseException extends RuntimeException { /** - * 错误编码 + * 错误编码，使用整数（Integer）类型来存储，用于唯一标识一种特定类型的错误情况，在整个项目中， + // 不同的业务模块或者功能出现问题时，可以分配不同的错误编码，通过这个编码可以快速在代码中定位到具体是哪种错误发生了， + // 例如可以在项目的错误码手册或者配置文件中定义好每个编码对应的具体错误含义，方便开发人员快速识别和处理相应的异常情况，实现统一的错误管理。 */ private Integer code; /** - * 错误消息 + * 错误消息，以字符串（String）类型保存，用于详细描述错误发生的具体原因或者相关提示信息， + // 这个消息通常会以比较通俗易懂的语言呈现给开发人员（在查看日志等场景下）或者最终用户（在进行友好的错误提示时）， + // 让他们能够清楚地了解为什么会出现这个异常情况，例如可以是“用户名已存在，请重新输入”之类的提示性消息，便于采取相应的解决措施。 */ private String msg; -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/exception/BizException.java b/wx-dump-admin/src/main/java/com/xcs/wx/exception/BizException.java index 3dfe814..4e3821c 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/exception/BizException.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/exception/BizException.java @@ -2,13 +2,23 @@ package com.xcs.wx.exception; /** * 业务异常 + * 该类用于表示在业务处理过程中出现的特定异常情况，它继承自BaseException类，通过定义特定的构造函数来初始化异常相关的信息， + * 方便在业务逻辑中根据不同的业务场景抛出相应的异常，并传递合适的错误码和错误消息，以便上层调用者能够准确地捕获并处理这些业务相关的异常情况。 * * @author xcs - * @date 2023年12月25日 17时38分 + * @date 2023年12月25日 17时38分 **/ public class BizException extends BaseException { + /** + * 构造函数，用于创建BizException实例。 + * 接收一个表示错误码的整数参数和一个表示错误消息的字符串参数，调用父类（BaseException）的构造函数来初始化异常的相关属性， + * 使得在抛出该异常时能够携带具体的错误码和错误描述信息，方便调用者根据这些信息进行针对性的异常处理，比如根据错误码进行不同的提示展示或者业务流程调整等操作。 + * + * @param code 错误码，用于唯一标识不同类型的业务异常，通常按照业务规则预先定义好不同的整数值来对应不同的业务错误场景。 + * @param msg 错误消息，用于详细描述出现业务异常的具体原因，让调用者能直观地了解到是哪里出现了问题以及问题的大致情况。 + */ public BizException(Integer code, String msg) { super(code, msg); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ChatRoomInfoMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ChatRoomInfoMapper.java index c61bf7c..3c0650a 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ChatRoomInfoMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ChatRoomInfoMapper.java @@ -5,9 +5,15 @@ import com.xcs.wx.domain.ChatRoomInfo; /** * 群聊详情 Mapper + * 该接口用于定义与群聊详情（ChatRoomInfo）相关的数据库操作方法，它继承自MyBatis Plus提供的BaseMapper接口， + * 通过这种继承关系，能够免费获得MyBatis Plus已经为我们预定义好的一系列常用的数据库操作方法，例如常见的增删改查（CRUD）操作等， + * 方便在具体的业务逻辑中对群聊详情数据进行持久化以及从数据库中获取相应数据等操作。同时，该接口也可以根据实际业务需求扩展自定义的数据库操作方法。 * * @author xcs - * @date 2024年01月09日 15时20分 + * @date 2024年01月09日 15时20分 **/ public interface ChatRoomInfoMapper extends BaseMapper { -} + // 目前该接口直接继承BaseMapper，没有额外自定义的方法。 + // 但如果后续业务中有针对群聊详情表特有的复杂查询、关联查询或者其他数据库操作逻辑， + // 可以在这里添加相应的抽象方法声明，然后在对应的Mapper实现类中去具体实现这些方法，以满足业务需求。 +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ChatRoomMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ChatRoomMapper.java index 2601518..d623f22 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ChatRoomMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ChatRoomMapper.java @@ -11,33 +11,48 @@ import org.apache.ibatis.annotations.Param; import java.util.List; /** - * 群聊 Mapper - * + * ChatRoomMapper接口用于定义与群聊相关的数据持久化操作方法，它继承自MyBatis Plus提供的 `BaseMapper` 接口， + * 借助MyBatis Plus的强大功能，可以方便地实现一些基本的数据库操作（如增删改查等），同时在此基础上，又自定义了一些针对群聊业务场景特有的数据库查询、统计和导出等操作方法， + * 在整个系统中，它起着连接业务逻辑层与数据库层的桥梁作用，方便对群聊相关的数据进行持久化管理以及从数据库获取相应的数据来满足业务需求。 + * @author xcs - * @date 2024年01月08日 15时55分 + * @date 2024年01月08日 15时55分 **/ public interface ChatRoomMapper extends BaseMapper { /** * 查询群聊 + * 该方法用于根据指定的分页信息和查询条件，从数据库中查询符合条件的群聊信息，并以分页的形式返回对应的 `ChatRoomVO` 视图对象列表。 + * `ChatRoomVO` 通常是经过对数据库表中的原始数据进行加工、封装后，适合在业务逻辑层展示和使用的数据结构，它可能包含了部分或者全部群聊相关属性， + * 同时经过格式转换、关联查询等操作，使得返回的数据更贴合业务展示需求。 * - * @param page 分页信息 - * @param chatRoomDTO 查询条件 - * @return ChatRoomVO + * @param page 分页信息，通过MyBatis Plus的 `Page` 类型传入，它封装了分页相关的参数，如当前页码、每页显示的记录数等， + // 这样在查询数据库时就能按照设定的分页规则准确获取对应的数据，方便在前端页面或者其他业务场景中进行分页展示群聊列表，提升用户体验和数据展示的合理性。 + * @param chatRoomDTO 查询条件，以 `ChatRoomDTO`（Data Transfer Object，数据传输对象）类型传入， + // `ChatRoomDTO` 一般用于在不同层之间传递查询参数，它会包含一些用于筛选群聊的属性，例如可以根据群聊名称、创建时间范围、群聊状态等条件来查询特定的群聊， + // 业务逻辑层可以根据具体的业务需求设置 `ChatRoomDTO` 的属性值，然后传递给该方法来获取符合条件的群聊数据。 + * @return ChatRoomVO 返回类型为 `Page`，即包含 `ChatRoomVO` 类型元素的分页对象， + // 这个返回结果可以方便地在业务逻辑层进一步处理，比如将分页数据传递给前端进行展示，或者根据业务需求对查询到的群聊数据进行二次加工等操作。 */ Page queryChatRoom(Page page, @Param("chatRoomDTO") ChatRoomDTO chatRoomDTO); /** * 统计群聊数量 + * 此方法用于获取数据库中群聊记录的总数，在很多业务场景下都有重要作用，例如在展示系统中总的群聊数量、进行数据统计分析或者根据群聊数量进行一些业务判断等情况时会用到。 * - * @return 群聊总数 + * @return 群聊总数，返回值类型为整数（`int`），表示数据库中存储的群聊记录的数量，通过这个数量可以直观地了解系统中群聊的规模情况， + // 方便后续基于数量进行相应的业务逻辑处理，比如判断是否达到某个数量阈值，进而决定是否需要进行一些资源调整或者提醒操作等。 */ int countChatRoom(); /** * 导出群聊 + * 该方法用于从数据库中获取需要导出的群聊相关数据，并以 `ExportChatRoomVO` 视图对象列表的形式返回， + * `ExportChatRoomVO` 同样是一种针对导出业务场景设计的数据结构，它可能包含了适合导出展示的群聊相关属性，比如群聊名称、创建时间、成员数量等关键信息， + // 方便将这些数据按照一定的格式（如Excel表格、CSV文件等）进行导出，以满足用户离线查看、数据分析或者数据备份等需求。 * - * @return ExportChatRoomVO + * @return ExportChatRoomVO 返回类型为 `List`，即 `ExportChatRoomVO` 类型的列表， + // 列表中的每个元素代表一条需要导出的群聊记录对应的视图对象，在业务逻辑层可以进一步调用相关的导出工具或者方法，将这个列表数据转换为实际的文件进行导出操作。 */ List exportChatRoom(); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactHeadImgMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactHeadImgMapper.java index b93e441..aac9ce8 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactHeadImgMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactHeadImgMapper.java @@ -5,17 +5,23 @@ import com.xcs.wx.domain.ContactHeadImg; /** * 联系人头像 Mapper + * 这个接口主要用于定义与联系人头像（ContactHeadImg）相关的数据库操作方法，它继承自MyBatis Plus的BaseMapper接口， + * 借助继承关系，能够直接获取到BaseMapper中预定义好的通用数据库操作方法，像基本的增删改查（CRUD）操作等，方便对联系人头像数据在数据库层面进行常规管理。 + * 同时，在此接口中还可以依据具体业务场景，额外自定义一些特定的数据库操作方法，以满足业务逻辑中针对联系人头像的特殊查询、更新等需求。 * * @author xcs - * @date 2024年6月18日15:33:26 + * @date 2024年6月18日15:33:26 **/ public interface ContactHeadImgMapper extends BaseMapper { /** * 根据用户名查询联系人头像 + * 此方法用于从数据库中根据给定的用户名查找对应的联系人头像信息，通过传入用户名作为参数，在数据库中进行匹配查询， + * 最终返回一个ContactHeadImg类型的对象，该对象包含了所查询到的联系人头像相关的详细数据（例如头像图片的存储路径、头像的二进制数据等，具体取决于ContactHeadImg类的定义）， + * 方便在业务逻辑中获取并使用特定用户对应的联系人头像信息，比如在展示联系人列表时加载对应的头像等操作。 * - * @param usrName 用户名 - * @return ContactHeadImg + * @param usrName 用户名，作为查询条件，用于在数据库中定位到特定用户的联系人头像记录，其值应为数据库中存储的有效用户名信息。 + * @return ContactHeadImg 返回查找到的包含联系人头像相关数据的ContactHeadImg对象，如果未找到匹配的头像记录，则可能返回null（具体取决于方法实现中的逻辑设定）。 */ ContactHeadImg getContactHeadImg(String usrName); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactHeadImgUrlMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactHeadImgUrlMapper.java index b3d4b5b..ee970d2 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactHeadImgUrlMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactHeadImgUrlMapper.java @@ -4,10 +4,17 @@ import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.xcs.wx.domain.ContactHeadImgUrl; /** - * 联系人头像 Mapper - * + * ContactHeadImgUrlMapper接口用于定义与联系人头像相关的数据持久化操作方法，它继承自MyBatis Plus提供的 `BaseMapper` 接口。 + * 通过继承 `BaseMapper`，该接口能够免费获得MyBatis Plus为我们自动生成的一些基础的数据库操作方法，例如常见的根据主键进行的增删改查操作（如 `insert`、`deleteById`、`selectById`、`updateById` 等）， + * 极大地简化了针对联系人头像数据在数据库层面进行操作的代码编写工作，在整个系统中起着连接业务逻辑层与数据库层的桥梁作用，方便对联系人头像相关的数据进行持久化管理以及从数据库获取相应的数据来满足业务需求。 + * @author xcs - * @date 2023年12月21日 17时08分 + * @date 2023年12月21日 17时08分 **/ public interface ContactHeadImgUrlMapper extends BaseMapper { -} + // 由于该接口目前只是单纯地继承了BaseMapper接口，没有自定义额外的方法，所以暂时它仅具备BaseMapper所提供的那些默认数据库操作功能。 + // 但在后续业务拓展过程中，如果针对联系人头像数据有更复杂、特定的数据库操作需求（比如按照某些特定条件查询头像数据、关联查询其他相关表数据等）， + // 就可以在这个接口中添加相应的自定义方法来满足业务要求，例如： + // public List findHeadImgUrlsByUserName(String userName); // 假设根据用户名查找联系人头像相关信息的自定义方法示例 + // 这样，业务逻辑层就能通过调用这个接口中定义的方法，方便地与数据库进行交互，实现对联系人头像数据的各种操作处理。 +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactLabelMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactLabelMapper.java index 5ee6daa..21dd696 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactLabelMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactLabelMapper.java @@ -4,10 +4,26 @@ import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.xcs.wx.domain.ContactLabel; /** - * 联系人标签 Mapper - * + * ContactLabelMapper接口用于定义与联系人标签相关的数据持久化操作方法，它继承自MyBatis Plus提供的 `BaseMapper` 接口。 + + * MyBatis Plus的 `BaseMapper` 接口为我们提供了一系列基础且常用的数据库操作方法，像是根据实体类的主键进行数据的插入（`insert`）、删除（`deleteById`）、查询（`selectById`）以及更新（`updateById`）等操作， + * 通过继承它，`ContactLabelMapper` 接口便可以直接利用这些默认提供的功能，便捷地实现对联系人标签数据在数据库层面的基本操作，无需开发者再去手动编写大量重复的SQL语句以及对应的数据库交互代码，从而大大提高了开发效率。 + + * 在整个系统架构中，这个接口扮演着至关重要的桥梁角色，它连接了业务逻辑层与数据库层，使得业务逻辑中涉及到的联系人标签相关的数据处理需求（例如添加新标签、删除某个联系人的特定标签、查询联系人已有的标签等操作）， + * 能够通过调用该接口所提供（或者后续自定义扩展）的方法，顺利地与数据库进行交互，完成数据的持久化管理以及数据的获取等操作，以此满足系统中关于联系人标签管理的各种业务场景需求。 + * @author xcs - * @date 2023年12月22日17:19:20 + * @date 2023年12月22日17:19:20 */ public interface ContactLabelMapper extends BaseMapper { -} + // 目前此接口仅继承了BaseMapper，所以它暂时只具备BaseMapper所默认提供的针对ContactLabel实体类的数据库操作功能。 + + // 不过随着业务的发展和功能的拓展，如果后续对于联系人标签数据在数据库操作方面有了更复杂、更具针对性的需求， + // 比如按照标签名称模糊查询所有相关的联系人标签、统计每个联系人拥有的标签数量、批量删除某些标签等， + // 就可以在这个接口内添加相应的自定义方法来满足这些业务要求，示例如下： + // public List findContactLabelsByTagNameLike(String tagNameLike); // 根据标签名称模糊查询联系人标签的方法示例 + // public int countLabelsByContactId(String contactId); // 统计指定联系人的标签数量的方法示例 + // public int deleteLabelsByIds(List labelIds); // 批量删除联系人标签的方法示例 + + // 通过在接口中添加这些自定义方法，业务逻辑层就能更加灵活、精准地与数据库交互，实现各种复杂多样的联系人标签相关业务逻辑的处理。 +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactMapper.java index 955a0bb..f03dfca 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/ContactMapper.java @@ -13,47 +13,69 @@ import java.util.List; import java.util.Set; /** - * 联系人 Mapper - * + * ContactMapper接口用于定义与联系人相关的数据持久化操作方法，它继承自MyBatis Plus提供的 `BaseMapper` 接口， + * 借助 `BaseMapper` 提供的基础数据库操作能力，同时又在此基础上拓展了针对联系人业务场景特有的一系列查询、统计和导出等操作方法， + * 在整个系统中充当着连接业务逻辑层与数据库层的桥梁角色，便于对联系人相关数据进行持久化管理以及从数据库获取相应数据以满足各类联系人业务需求。 + * @author xcs - * @date 2023年12月22日 13时51分 + * @date 2023年12月22日 13时51分 **/ public interface ContactMapper extends BaseMapper { /** * 查询联系人 + * 该方法用于依据给定的分页信息以及联系人查询条件，从数据库中查询符合要求的联系人信息，并以分页形式返回对应的 `ContactVO` 视图对象列表。 + * `ContactVO` 是经过对数据库中原始联系人数据进行加工、封装后形成的适合在业务逻辑层展示和使用的数据结构，它可能选取了部分或全部联系人相关属性， + * 并进行了如格式转换、关联其他相关表数据等操作，从而使得返回的数据更贴合业务展示和后续处理的需求。 * - * @param page 分页信息 - * @param contactDTO 联系人 - * @return Contact + * @param page 分页信息，通过MyBatis Plus的 `Page` 类型传入，其封装了分页相关参数，例如当前页码、每页显示的记录数等， + // 如此一来，在查询数据库时就能按照设定好的分页规则准确获取相应的数据，方便在前端页面或者其他业务场景中进行分页展示联系人列表，提升用户体验与数据展示的合理性。 + * @param contactDTO 联系人，以 `ContactDTO`（Data Transfer Object，数据传输对象）类型传入， + // `ContactDTO` 通常用于在不同层之间传递查询参数，它包含了一系列用于筛选联系人的属性，比如可以按照联系人姓名、所属分组、添加时间范围等条件来查找特定的联系人， + // 业务逻辑层能够根据具体业务需求来设置 `ContactDTO` 的属性值，然后传递给该方法以获取符合条件的联系人数据。 + * @return Contact 返回类型为 `Page`，即包含 `ContactVO` 类型元素的分页对象， + // 这个返回结果可在业务逻辑层进一步处理，例如将分页数据传递给前端进行展示，或者依据业务需求对查询到的联系人数据做二次加工等操作。 */ Page queryContact(Page page, @Param("contactDTO") ContactDTO contactDTO); /** * 查询所有联系人 + * 此方法用于从数据库中获取全部联系人的相关信息，并以 `AllContactVO` 视图对象列表的形式返回。 + * `AllContactVO` 同样是一种针对联系人数据进行加工处理后适合业务展示和使用的数据结构，它会包含联系人各方面关键信息，方便在需要展示所有联系人信息的业务场景中使用， + // 比如在联系人管理页面展示完整的联系人列表等情况，直接获取所有联系人数据进行展示，无需分页等额外操作。 * - * @return AllContactVO + * @return AllContactVO 返回类型为 `List`，即 `AllContactVO` 类型的列表， + // 列表中的每个元素代表一条联系人记录对应的视图对象，业务逻辑层可对该列表数据进行进一步处理，如进行数据格式校验、传递给前端进行展示等操作。 */ List queryAllContact(); /** * 查询联系人与公众号的Id + * 该方法旨在从数据库中查找联系人以及公众号对应的唯一标识（Id）信息，并将这些Id以集合（`Set`）形式返回，集合中的元素类型为字符串（`String`）， + // 在涉及区分联系人与公众号、对二者进行关联操作或者基于它们的Id进行其他业务逻辑处理（如统计、权限判断等）的场景中会用到这个方法获取相应的Id集合，便于后续进一步操作。 * - * @return Contact + * @return Contact 返回类型为 `Set`，也就是包含字符串类型元素的集合，集合中的每个字符串代表一个联系人或者公众号的Id， + // 业务逻辑层可以根据业务需求对这个Id集合进行遍历、判断、与其他数据进行关联等操作，以实现特定的业务功能。 */ Set getContactWithMp(); /** * 统计联系人数量 + * 用于获取数据库中存储的联系人记录的总数，在很多业务场景下都有着重要作用，例如在展示系统中总的联系人数量、进行数据统计分析、根据联系人数量判断业务规模等情况时需要调用该方法获取相应的数量信息。 * - * @return 联系人数量 + * @return 联系人数量，返回值类型为整数（`int`），它表示数据库中所保存的联系人记录的数量，通过这个数量能够直观地了解系统中联系人的规模情况， + // 方便后续基于数量进行相应的业务逻辑处理，比如判断是否达到某个数量阈值，进而决定是否需要进行一些资源调整或者提醒操作等。 */ int countContact(); /** * 导出联系人 + * 此方法负责从数据库中提取需要导出的联系人相关数据，并以 `ExportContactVO` 视图对象列表的形式返回。 + * `ExportContactVO` 是专门针对导出业务场景设计的数据结构，它包含了适合导出展示的联系人相关属性，比如联系人姓名、联系方式、备注等关键信息， + // 方便将这些数据按照一定的格式（如Excel表格、CSV文件等）进行导出操作，以满足用户离线查看、数据分析或者数据备份等需求。 * - * @return ExportContactVO + * @return ExportContactVO 返回类型为 `List`，即 `ExportContactVO` 类型的列表， + // 列表中的每个元素代表一条需要导出的联系人记录对应的视图对象，业务逻辑层可进一步调用相关的导出工具或者方法，将这个列表数据转换为实际的文件进行导出操作。 */ List exportContact(); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FTSContactContentMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FTSContactContentMapper.java index 16f9441..92c928d 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FTSContactContentMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FTSContactContentMapper.java @@ -4,11 +4,25 @@ import com.baomidou.mybatisplus.core.mapper.BaseMapper; import com.xcs.wx.domain.FTSContactContent; /** - * FTSContactContentMapper - * + * FTSContactContentMapper接口用于定义与 `FTSContactContent` 相关的数据持久化操作方法，它继承自MyBatis Plus提供的 `BaseMapper` 接口。 + + * MyBatis Plus的 `BaseMapper` 接口为我们提供了一系列基础且常用的数据库操作方法，例如基于实体类主键进行的数据插入（`insert`）、删除（`deleteById`）、查询（`selectById`）以及更新（`updateById`）等操作。 + * 通过继承 `BaseMapper`，`FTSContactContentMapper` 接口可以直接利用这些默认提供的功能，便捷地实现对 `FTSContactContent` 类型数据在数据库层面的基本操作，从而减少了开发者手动编写大量重复SQL语句以及对应数据库交互代码的工作量，极大地提高了开发效率。 + + * 在整个系统架构中，该接口扮演着连接业务逻辑层与数据库层的重要桥梁角色。业务逻辑层中涉及到 `FTSContactContent` 数据的处理需求，比如添加新的相关记录、删除特定记录、根据主键查询记录等操作， + * 都可以通过调用此接口所继承的（或者后续自定义扩展的）方法，顺利地与数据库进行交互，完成数据的持久化管理以及数据获取等操作，以此满足系统中关于 `FTSContactContent` 相关业务场景的各种需求。 + * @author xcs - * @date 2024年6月14日14:24:43 + * @date 2024年6月14日14:24:43 **/ public interface FTSContactContentMapper extends BaseMapper { + // 目前此接口仅单纯继承了BaseMapper，所以暂时它仅具备BaseMapper所默认提供的针对FTSContactContent实体类的数据库操作功能。 + + // 不过，随着业务的拓展和功能需求的变化，如果后续对于FTSContactContent数据在数据库操作方面有了更复杂、更具针对性的需求， + // 例如按照特定内容字段进行模糊查询、关联查询其他相关表的数据、批量更新符合某些条件的记录等， + // 就可以在这个接口内添加相应的自定义方法来满足这些业务要求，示例如下： + // public List findByContentLike(String contentLike); // 按照内容字段模糊查询的自定义方法示例 + // public int updateBatchBySomeCondition(List contentList, Map conditionMap); // 批量更新符合某些条件记录的自定义方法示例 -} + // 通过在接口中添加这些自定义方法，业务逻辑层就能更灵活、精准地与数据库交互，实现各种复杂多样的与FTSContactContent相关的业务逻辑处理。 +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FTSRecentUsedMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FTSRecentUsedMapper.java index ebf471e..c1bb671 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FTSRecentUsedMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FTSRecentUsedMapper.java @@ -5,9 +5,17 @@ import com.xcs.wx.domain.FTSRecentUsed; /** * 最近使用关键字 Mapper + * 此接口用于定义和最近使用关键字（FTSRecentUsed）相关的数据库操作方法。它继承自MyBatis Plus所提供的BaseMapper接口， + * 借助这种继承关系，能够直接获得BaseMapper里已经预先定义好的众多通用数据库操作方法，例如常见的添加（insert）、删除（delete）、修改（update）以及查询（select）等基础的增删改查操作， + * 这使得在业务逻辑处理过程中，可以方便地对最近使用关键字的数据进行诸如保存到数据库、从数据库中检索等常规的持久化操作。 + * 并且，如果业务场景中存在针对最近使用关键字数据的特殊数据库操作需求，例如按照使用频率进行排序查询、根据特定时间段筛选最近使用的关键字等， + * 那么就可以在这个接口中进一步添加自定义的抽象方法声明，后续再通过对应的Mapper实现类去具体实现这些方法，以此来契合具体业务需求，更好地对最近使用关键字数据进行管理和运用。 * * @author xcs - * @date 2023年12月22日 13时51分 + * @date 2023年12月22日 13时51分 **/ public interface FTSRecentUsedMapper extends BaseMapper { -} + // 当前该接口只是单纯继承了BaseMapper，并没有额外去自定义其他方法。 + // 不过要是后续业务里出现了需要对最近使用关键字数据执行特殊数据库操作的情况，像按照用户分类统计不同用户常用的关键字、 + // 或者查找长时间未使用的关键字进行清理等操作，便可以在这里添加相应的方法声明，接着在具体的实现类里去实现这些方法来满足业务逻辑的要求。 +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FeedsMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FeedsMapper.java index 4ec6b59..347bf62 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FeedsMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/FeedsMapper.java @@ -5,10 +5,17 @@ import com.xcs.wx.domain.Feeds; /** * 朋友圈 Mapper + * 该接口主要用于定义针对朋友圈（Feeds）相关数据的数据库操作方法。它继承自MyBatis Plus提供的BaseMapper接口， + * 通过继承BaseMapper，能够自动获取到一系列已经预定义好的通用数据库操作方法，比如插入（insert）、删除（delete）、更新（update）、查询（select）等基础的增删改查操作， + * 方便在业务逻辑中对朋友圈数据进行持久化存储以及从数据库里获取相应数据等常规操作。 + * 此外，若业务上有针对朋友圈数据特有的复杂数据库操作需求（例如根据特定条件进行联合查询、分页查询等），可以在这个接口中额外添加自定义的抽象方法声明， + * 然后在对应的Mapper实现类中去具体实现这些方法，以此来满足具体业务场景下对朋友圈数据的多样化操作要求。 * * @author xcs - * @date 2023年12月22日 13时51分 + * @date 2023年12月22日 13时51分 **/ public interface FeedsMapper extends BaseMapper { - -} + // 目前该接口仅继承了BaseMapper，未自定义额外的方法。 + // 如果后续业务中需要针对朋友圈相关的数据进行一些特殊的数据库操作，例如按照发布时间范围查询朋友圈动态、 + // 根据用户关系筛选可见的朋友圈内容等，就可以在这里添加相应的方法声明，再去具体实现这些方法以满足业务逻辑的需求。 +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/HardLinkImageAttributeMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/HardLinkImageAttributeMapper.java index a7e95d6..e648756 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/HardLinkImageAttributeMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/HardLinkImageAttributeMapper.java @@ -6,17 +6,26 @@ import org.apache.ibatis.annotations.Param; /** * 图片链接 Mapper + * 该接口主要用于定义与图片链接（HardLinkImageAttribute）相关的数据库操作方法，它继承自MyBatis Plus提供的BaseMapper接口， + * 通过继承BaseMapper，可以免费使用其中预定义好的通用数据库操作方法，像常见的增删改查（CRUD）操作等，便于对图片链接相关的数据在数据库中进行常规管理和操作。 + * 同时，在此接口中又自定义了特定的数据库操作方法，以满足针对图片链接数据的特殊业务需求，比如根据特定条件查询图片等操作。 * * @author xcs - * @date 2024年1月16日21:50:13 + * @date 2024年1月16日21:50:13 */ public interface HardLinkImageAttributeMapper extends BaseMapper { /** * 查询图片 + * 此方法用于从数据库中查询图片相关信息，它依据传入的图片的MD5值作为查询条件来查找对应的图片数据。 + * 由于MD5值通常以字节数组（byte[]）的形式表示图片的唯一性标识，通过传入该参数，可以在数据库中定位到符合条件的图片记录， + * 最终返回相应的图片信息（在当前方法定义中返回类型为String，具体返回的内容应该是代表图片的某种字符串形式的表示，例如图片的存储路径或者图片数据经过处理后的字符串表示等，具体取决于业务逻辑中的实际处理方式）， + * 方便后续在业务逻辑中进行图片的展示、处理或者其他相关操作。 * * @param md5 md5 + * 传入的参数为字节数组类型的图片MD5值，用于在数据库中精准匹配对应的图片记录，该MD5值应是与数据库中存储的图片MD5值一致的有效标识。 * @return 图片 + * 返回值类型为String，代表查询到的图片相关信息，若在数据库中未找到匹配的图片记录，则可能返回null（具体取决于该方法在实现类中的具体逻辑设定）。 */ String queryHardLinkImage(@Param("md5") byte[] md5); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/HardLinkVideoAttributeMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/HardLinkVideoAttributeMapper.java index 18f95dc..6503eeb 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/HardLinkVideoAttributeMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/HardLinkVideoAttributeMapper.java @@ -5,18 +5,24 @@ import com.xcs.wx.domain.HardLinkVideoAttribute; import org.apache.ibatis.annotations.Param; /** - * 视频链接 Mapper - * + * HardLinkVideoAttributeMapper接口用于定义与视频链接相关的数据持久化操作方法，它继承自MyBatis Plus提供的 `BaseMapper` 接口。 + * 借助 `BaseMapper` 提供的基础数据库操作能力，像常规的基于主键的增删改查等操作可以直接使用，在此基础上，又自定义了针对视频链接业务场景特有的查询方法， + * 在整个系统中起着连接业务逻辑层与数据库层的桥梁作用，方便对视频链接相关的数据进行持久化管理以及从数据库获取相应的数据来满足业务需求，例如查找特定视频链接相关信息等操作。 + * @author xcs - * @date 2024年1月16日21:50:13 + * @date 2024年1月16日21:50:13 */ public interface HardLinkVideoAttributeMapper extends BaseMapper { /** * 查询视频 + * 该方法用于根据传入的视频的MD5值，从数据库中查询与之对应的视频相关信息，并返回相应的结果。这里的MD5值通常是对视频文件进行哈希计算得到的一个唯一标识（以字节数组形式传入）， + * 通过这个唯一标识可以在数据库中准确地定位到特定视频的记录，进而获取其关联的视频链接等相关数据，满足业务逻辑中查找特定视频的需求，例如在视频播放、视频分享等业务场景中，可能需要先通过MD5值查找视频的具体链接信息。 * - * @param md5 md5 - * @return 视频 + * @param md5 md5 以字节数组（`byte[]`）类型传入的视频的MD5值，它作为查询条件，用于在数据库表中匹配对应的视频记录， + // 这个MD5值应该是事先经过计算且能准确对应到数据库中存储的某个视频的标识信息，确保能够准确地查找到目标视频相关的数据。 + * @return 视频 返回类型为 `String`，具体返回的内容应该是与该MD5值对应的视频相关的关键信息（虽然从方法名推测可能是视频链接等信息，但具体要结合业务实际情况确定）， + // 业务逻辑层接收到这个返回的字符串后，可以根据业务需求进一步对其进行解析、处理，比如将其用于构建视频播放地址、展示给用户等操作。 */ String queryHardLinkVideo(@Param("md5") byte[] md5); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/MsgMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/MsgMapper.java index c5bbef9..89dd0da 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/MsgMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/MsgMapper.java @@ -5,49 +5,64 @@ import com.xcs.wx.domain.Msg; import com.xcs.wx.domain.vo.CountRecentMsgsVO; import com.xcs.wx.domain.vo.MsgTypeDistributionVO; import com.xcs.wx.domain.vo.TopContactsVO; - import java.util.List; /** * 消息 Mapper + * 该接口用于定义和消息（Msg）相关的各种数据库操作方法，它继承自MyBatis Plus的BaseMapper接口， + * 通过继承BaseMapper，能够直接获取到已经预定义好的通用数据库操作方法，例如常见的增删改查（CRUD）操作，方便对消息数据进行常规的持久化处理以及从数据库中检索消息数据等操作。 + * 同时，在此接口中又依据具体业务需求自定义了多个特定的数据库查询方法，用于获取不同维度的消息相关统计信息，以辅助业务逻辑进行数据分析、展示等操作。 * * @author xcs - * @date 2023年12月22日 13时51分 + * @date 2023年12月22日 13时51分 **/ public interface MsgMapper extends BaseMapper { /** * 微信消息类型及其分布统计 + * 此方法用于从数据库中查询微信消息的类型以及它们各自的分布情况统计信息，通过执行相应的数据库查询逻辑（可能涉及到分组、计数等操作，具体取决于数据库表结构和业务实现方式）， + * 将查询结果封装成MsgTypeDistributionVO类型的对象列表返回，MsgTypeDistributionVO对象中应该包含了消息类型以及对应数量等相关属性，方便后续业务逻辑进行消息类型分布的展示、分析等操作， + * 例如可以用于生成图表展示不同类型消息（如文本消息、图片消息等）在整体消息中所占的比例情况。 * - * @return MsgTypeDistributionVO + * @return MsgTypeDistributionVO 返回一个包含消息类型及其分布统计信息的MsgTypeDistributionVO类型的对象列表，若查询不到相关数据则返回空列表。 */ List msgTypeDistribution(); /** - * 统计过去 15 天每天的发送和接收消息数量 + * 统计过去15天每天的发送和接收消息数量 + * 该方法旨在从数据库中获取过去15天内，每天分别发送和接收消息的数量统计信息，通过特定的数据库查询语句（可能涉及到按照日期进行分组、对消息状态等条件进行筛选等操作，具体取决于数据库设计和业务逻辑）， + * 把查询结果整理并封装到CountRecentMsgsVO类型的对象列表中返回，CountRecentMsgsVO对象里应该存有日期以及对应的发送和接收消息数量等关键信息，便于业务逻辑进行消息数量趋势的展示、分析等操作， + * 比如可以据此绘制消息数量变化趋势图，直观查看近期消息量的波动情况。 * - * @return MsgTrendVO + * @return CountRecentMsgsVO 返回一个包含过去15天每天发送和接收消息数量统计信息的CountRecentMsgsVO类型的对象列表，若不存在对应数据则返回空列表。 */ List countRecentMsgs(); /** * 最近一个月内微信互动最频繁的前10位联系人 + * 用于从数据库中查找出在最近一个月内，与用户微信互动最为频繁的前10位联系人相关信息，具体互动频繁程度的衡量标准可能是消息发送数量、消息回复及时性等多方面因素的综合考量（由具体业务逻辑决定）， + * 通过执行数据库查询操作（可能涉及到复杂的关联查询、排序以及限制返回数量等操作，基于数据库表结构和业务规则而定），将符合条件的联系人信息封装为TopContactsVO类型的对象列表返回，TopContactsVO对象中通常包含联系人标识、联系人名称以及互动相关的统计数据等内容， + * 方便后续业务逻辑进行展示，例如在界面上展示用户最常联系的好友列表等。 * - * @return MsgRankVO + * @return TopContactsVO 返回一个包含最近一个月内微信互动最频繁的前10位联系人相关信息的TopContactsVO类型的对象列表，若查询不到满足条件的数据则返回空列表。 */ List topContacts(); /** * 统计发送消息数量 + * 此方法主要执行数据库查询操作，用于统计用户总共发送消息的数量，通过合适的数据库查询语句（可能是对消息表中表示发送者的字段进行筛选并计数等操作，具体取决于数据库表结构和业务逻辑）， + * 返回一个整数来表示发送消息的具体数量，该数量可用于业务逻辑中的各种统计分析场景，比如对比不同时间段发送消息数量的变化情况等。 * - * @return 消息数量 + * @return 消息数量 返回一个整数，代表统计出的发送消息的数量，如果没有符合条件的发送消息记录，则返回0。 */ int countSent(); /** * 统计接受消息数量 + * 与统计发送消息数量的方法类似，该方法通过执行数据库查询操作来统计用户接收到的消息的总数，依据数据库表中相关字段（例如标识接收者的字段等，具体取决于数据库设计和业务逻辑）进行筛选并计数， + * 最终返回一个整数表示接收到消息的具体数量，方便在业务逻辑中进行如消息流量分析、对比收发消息情况等操作。 * - * @return 消息数量 + * @return 消息数量 返回一个整数，代表统计出的接收消息的数量，如果没有符合条件的接收消息记录，则返回0。 */ int countReceived(); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/SessionMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/SessionMapper.java index a53e1d9..6f193a7 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/SessionMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/SessionMapper.java @@ -7,17 +7,27 @@ import com.xcs.wx.domain.vo.SessionVO; import java.util.List; /** - * 会话 Mapper - * + * SessionMapper接口用于定义与会话相关的数据持久化操作方法，它继承自MyBatis Plus提供的 `BaseMapper` 接口。 + + * 借助 `BaseMapper` 所提供的一系列基础数据库操作功能（例如基于实体类主键进行的数据插入、删除、查询以及更新等操作），`SessionMapper` 能够便捷地实现对 `Session` 实体类对应数据在数据库层面的基本操作， + * 减少了开发者手动编写大量重复SQL语句以及对应数据库交互代码的工作量，提升了开发效率。同时，在此基础上它又自定义了针对会话业务场景特有的查询方法， + * 在整个系统架构中，该接口充当着连接业务逻辑层与数据库层的桥梁角色，使得业务逻辑中涉及会话相关的数据处理需求（比如获取会话列表等操作）， + * 能够通过调用该接口所提供（或者后续自定义扩展）的方法，顺利地与数据库进行交互，完成数据的持久化管理以及数据获取等操作，以此满足系统中关于会话管理的各种业务场景需求。 + * @author xcs - * @date 2023年12月21日 17时08分 + * @date 2023年12月21日 17时08分 **/ public interface SessionMapper extends BaseMapper { /** * 查询会话 - * - * @return + * 该方法用于从数据库中查询所有会话的相关信息，并以 `SessionVO` 视图对象列表的形式返回。 + * `SessionVO` 是一种经过对数据库中原始会话数据进行加工、封装后形成的适合在业务逻辑层展示和使用的数据结构，它可能选取了会话相关的部分或全部属性， + * 并进行了如格式转换、关联其他相关表数据等操作，使得返回的数据更贴合业务展示以及后续处理的需求，例如在会话列表展示页面，通过获取这个 `SessionVO` 列表， + * 可以方便地展示出各个会话的关键信息（如会话对方昵称、未读消息数量等）给用户查看，方便用户了解会话情况并进行相应操作。 + + * @return 返回类型为 `List`，即 `SessionVO` 类型的列表，列表中的每个元素代表一条会话记录对应的视图对象， + // 业务逻辑层可以对这个返回的列表数据进行进一步处理，比如根据业务规则对会话进行排序、筛选，或者将其传递给前端页面进行展示等操作，以满足具体的业务需求。 */ List querySession(); } \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/SqliteMasterMapper.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/SqliteMasterMapper.java index 1794134..f690806 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapper/SqliteMasterMapper.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapper/SqliteMasterMapper.java @@ -1,18 +1,20 @@ package com.xcs.wx.mapper; import com.baomidou.mybatisplus.core.mapper.BaseMapper; -import com.xcs.wx.domain.Session; import com.xcs.wx.domain.SqliteMaster; -import com.xcs.wx.domain.vo.SessionVO; - -import java.util.List; /** * SQLite 数据库中的一个系统表 Mapper + * 该接口主要用于定义针对SQLite数据库中名为 "sqlite_master" 这个系统表（对应实体类为SqliteMaster）的相关数据库操作方法。它继承自MyBatis Plus的BaseMapper接口， + * 通过继承BaseMapper，能够自动获取到一系列已经预定义好的通用数据库操作方法，例如常见的增删改查（CRUD）操作，方便对 "sqlite_master" 表中的数据进行常规的持久化管理以及从该表中检索数据等操作。 + * 虽然当前接口中没有额外自定义其他方法，但如果后续业务逻辑中有针对该系统表的特殊操作需求，比如按照特定条件查询系统表中的某些记录、对查询结果进行特殊的转换或处理等， + * 就可以在这个接口中进一步添加自定义的抽象方法声明，然后再通过对应的Mapper实现类去具体实现这些方法，以此来满足具体业务场景下对 "sqlite_master" 表数据的多样化操作要求。 * * @author xcs - * @date 2023年12月21日 17时08分 + * @date 2023年12月21日 17时08分 **/ public interface SqliteMasterMapper extends BaseMapper { - + // 目前该接口只是单纯继承了BaseMapper，并没有额外去自定义其他方法。 + // 不过要是后续业务里出现了需要对 "sqlite_master" 表数据执行特殊数据库操作的情况，像查找特定类型（如只查询表类型的记录）的系统表记录、 + // 或者根据创建语句（sql字段内容）来筛选记录等操作，便可以在这里添加相应的方法声明，接着在具体的实现类里去实现这些方法来满足业务逻辑的要求。 } \ No newline at end of file -- 2.34.1 From b21a40db1a8868052d23e117bc5cf612ddb45f5b Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Mon, 16 Dec 2024 11:34:00 +0800 Subject: [PATCH 07/17] 1 --- .../xcs/wx/msg/impl/AppletMsgStrategy.java | 34 +++++++++++-- .../xcs/wx/msg/impl/CardLinkMsgStrategy.java | 43 ++++++++++++++-- .../com/xcs/wx/msg/impl/EmojiMsgStrategy.java | 28 ++++++++++- .../com/xcs/wx/msg/impl/FileMsgStrategy.java | 28 +++++++++-- .../com/xcs/wx/msg/impl/ImageMsgStrategy.java | 39 +++++++++++---- .../com/xcs/wx/msg/impl/MapMsgStrategy.java | 28 +++++++++-- .../com/xcs/wx/msg/impl/ReferMsgStrategy.java | 40 +++++++++++++-- .../xcs/wx/msg/impl/SystemMsgStrategy.java | 49 +++++++++++++++++-- 8 files changed, 254 insertions(+), 35 deletions(-) diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/AppletMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/AppletMsgStrategy.java index cdbad72..ea8cc55 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/AppletMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/AppletMsgStrategy.java @@ -11,34 +11,62 @@ import org.springframework.stereotype.Service; /** * 小程序消息 + * 该类用于处理小程序相关的消息逻辑，实现了MsgStrategy接口，表明它是一种特定的消息处理策略类，主要针对小程序消息进行相应的判断和处理操作。 + * 通过 @Service 注解将其标记为Spring服务组件，方便在Spring框架下进行依赖注入和管理，使其能够在整个项目的消息处理流程中被灵活调用。 * * @author xcs - * @date 2024年01月24日 13时55分 + * @date 2024年01月24日 13时55分 **/ @Service public class AppletMsgStrategy implements MsgStrategy { + /** + * 判断是否支持处理当前消息类型及子类型 + * 此方法用于判断给定的消息类型（type）和消息子类型（subType）是否符合小程序消息的特征，以此来确定该策略类是否支持对传入消息的处理。 + * 在本实现中，若消息类型为49，并且子类型为33或者36时，则判定为小程序消息，该方法返回true，表示支持处理；否则返回false，表示不支持处理。 + * + * @param type 消息类型，是一个整数，代表消息的整体分类类型，不同的整数值对应不同种类的消息（例如文本消息、图片消息等有各自对应的类型值）。 + * @param subType 消息子类型，同样是整数，在消息已经有了大的类型划分基础上，进一步细分消息的具体类型，用于更精准地判断消息的具体特性。 + * @return boolean 如果消息类型和子类型符合小程序消息的特定条件（type == 49 && (subType == 33 || subType == 36)），则返回true，表示支持处理该消息；否则返回false。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 49 && (subType == 33 || subType == 36); } + /** + * 处理小程序消息的具体逻辑 + * 该方法用于对符合小程序消息特征的消息（由support方法判断）进行具体的处理操作，主要涉及对消息内容的解压、解析以及提取小程序相关信息并设置到对应的消息视图对象（MsgVO）中。 + * 首先，尝试对消息的压缩内容进行解压操作，然后将解压后的XML内容解析为CompressContentBO对象，接着从该对象中提取小程序相关信息（如标题、显示名称等），并封装到WeAppInfoVO对象中，最后将WeAppInfoVO对象设置到MsgVO对象里， + * 以便后续在业务逻辑中能够方便地获取和使用小程序消息的相关详细信息，比如在前端展示小程序消息的关键信息等场景。 + * + * @param msgVO 消息视图对象，包含了消息的各种相关信息（如消息内容、压缩内容等），是需要进行处理和更新的对象，代表了当前要处理的小程序消息的整体信息，其具体属性取决于MsgVO类的定义。 + */ @Override public void process(MsgVO msgVO) { + // 使用Opt.ofNullable方法对msgVO.getCompressContent()进行包装，避免空指针异常，若压缩内容不为空，则执行后续操作 Opt.ofNullable(msgVO.getCompressContent()) + // 若压缩内容不为空，调用LZ4Util.decompress方法对消息的压缩内容进行解压操作，将解压后的内容作为下一步操作的输入 .map(compressContent -> LZ4Util.decompress(msgVO.getCompressContent())) + // 对解压后的XML内容，调用XmlUtil.parseXml方法，按照CompressContentBO.class的定义将其解析为CompressContentBO对象，用于后续提取小程序相关信息 .map(xmlContent -> XmlUtil.parseXml(xmlContent, CompressContentBO.class)) .ifPresent(msgBO -> Opt.ofNullable(msgBO.getAppMsg()) .ifPresent(appMsg -> { + // 创建一个WeAppInfoVO对象，用于封装小程序相关信息 WeAppInfoVO weAppInfoVO = new WeAppInfoVO(); + // 从解析后的CompressContentBO对象中的AppMsg部分获取标题信息，并设置到weAppInfoVO对象中 weAppInfoVO.setTitle(msgBO.getAppMsg().getTitle()); + // 从解析后的CompressContentBO对象中的AppMsg部分获取源显示名称信息，并设置到weAppInfoVO对象中 weAppInfoVO.setSourceDisplayName(msgBO.getAppMsg().getSourceDisplayName()); + // 将包含小程序相关信息的weAppInfoVO对象设置到msgVO对象中，方便后续使用 msgVO.setWeAppInfo(weAppInfoVO); CompressContentBO.AppMsg.WeAppInfo weAppInfo = appMsg.getWeAppInfo(); - if (weAppInfo != null) { + if (weAppInfo!= null) { + // 如果小程序信息中的图标URL不为空，将其设置到weAppInfoVO对象中 weAppInfoVO.setWeAppIconUrl(weAppInfo.getWeAppIconUrl()); + // 如果小程序信息中的页面缩略图原始URL不为空，将其设置到weAppInfoVO对象中 weAppInfoVO.setWeAppPageThumbRawUrl(weAppInfo.getWeAppPageThumbRawUrl()); } })); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/CardLinkMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/CardLinkMsgStrategy.java index 10a1204..cb5376c 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/CardLinkMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/CardLinkMsgStrategy.java @@ -10,32 +10,67 @@ import com.xcs.wx.util.XmlUtil; import org.springframework.stereotype.Service; /** - * 卡片式链接消息 - * + * CardLinkMsgStrategy类用于处理卡片式链接消息相关的业务逻辑，它实现了 `MsgStrategy` 接口，意味着需要遵循该接口定义的规范来实现特定的消息处理方法， + * 在整个消息处理体系中，负责针对卡片式链接这种特定类型的消息进行识别以及后续的内容解析、数据提取和设置等操作，以便在系统中能正确地处理和展示此类消息。 + * @author xcs - * @date 2024年01月24日 13时56分 + * @date 2024年01月24日 13时56分 **/ @Service +// @Service注解用于将该类标记为Spring框架中的一个服务层组件，这样Spring容器在启动时会自动扫描并创建该类的实例，将其纳入到容器的管理之中， +// 方便在其他需要使用该服务的地方通过依赖注入的方式获取实例，实现组件之间的解耦以及更灵活的调用，使其能很好地融入基于Spring的项目架构中。 + public class CardLinkMsgStrategy implements MsgStrategy { + /** + * support方法用于判断给定的消息类型（type）和子类型（subType）是否与卡片式链接消息的类型匹配，以此来确定当前的消息处理策略是否适用于该消息。 + * 在整个消息处理流程中，不同类型和子类型的消息会有不同的处理逻辑，该方法起到了一个前置的筛选作用，只有符合特定类型和子类型要求的消息才会进入到后续本类中定义的处理流程中。 + * + * @param type 消息类型，以整数（Integer）类型传入，代表消息的整体分类标识，不同的整数值对应不同种类的消息，在这里用于和卡片式链接消息的类型值进行比对判断。 + * @param subType 消息子类型，同样为整数（Integer）类型，是在消息类型基础上进一步细分的标识，用于更精确地确定消息的具体种类，与type参数共同来精准定位是否为卡片式链接消息。 + * @return boolean 返回值为布尔类型，如果传入的type值等于49且subType值等于5，则表示该消息是卡片式链接消息，返回true；否则返回false，表示不适用当前的消息处理策略。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 49 && subType == 5; } + /** + * process方法用于对符合卡片式链接消息类型的消息进行具体的处理操作，它接收一个 `MsgVO` 类型的消息对象作为参数， + * 在方法内部会对消息中的压缩内容进行解压、解析XML等一系列操作，提取出卡片式链接相关的关键信息（如标题、描述、显示名称、链接地址等），并设置到对应的消息对象属性中，以便后续在系统中进行展示或其他业务逻辑处理。 + * + * @param msgVO 消息对象，以 `MsgVO` 类型传入，它包含了消息的各种相关信息，例如消息的压缩内容（`compressContent`）以及其他可能的通用属性等，是整个处理流程的数据基础， + * 本方法会基于这个对象进行数据的提取、修改和补充操作，使其包含完整的卡片式链接消息相关属性，方便后续使用。 + */ @Override public void process(MsgVO msgVO) { + // Opt.ofNullable方法来自于Hutool工具库的Opt类，它用于对可能为null的对象进行包装处理，避免空指针异常。 + // 在这里，它首先判断msgVO.getCompressContent()是否为null，如果不为null，则进行后续的链式操作，否则整个链式操作直接短路，不会执行后续步骤。 Opt.ofNullable(msgVO.getCompressContent()) + // 如果msgVO.getCompressContent()不为null，使用LZ4Util.decompress方法对消息的压缩内容进行解压操作， + // LZ4Util应该是项目中自定义的一个工具类，用于处理LZ4压缩算法相关的解压功能，将解压后的内容传递给后续的链式操作。 .map(compressContent -> LZ4Util.decompress(msgVO.getCompressContent())) + // 对上一步解压后的内容（xmlContent）进行XML解析操作，使用XmlUtil.parseXml方法将其解析为CompressContentBO类型的对象， + // XmlUtil同样是项目中的自定义工具类，用于处理XML解析相关的功能，将解析后的对象传递给后续的链式操作，方便后续提取其中的卡片式链接相关数据。 .map(xmlContent -> XmlUtil.parseXml(xmlContent, CompressContentBO.class)) + // 如果前面的操作都成功执行，也就是成功解析出了CompressContentBO对象，那么通过ifPresent方法来执行后续的设置操作， + // ifPresent方法会在传入的对象（compressContentBO）不为null时执行其内部的代码块，在这里就是提取并设置卡片式链接相关的属性到对应的消息对象属性中。 .ifPresent(compressContentBO -> { CardLinkVO cardLinkVO = new CardLinkVO(); + // 从CompressContentBO对象中提取卡片式链接的标题信息，并设置到新创建的CardLinkVO对象中， + // 这里的CompressContentBO.getAppMsg().getTitle()表示从解析后的业务对象中获取应用消息（AppMsg）里包含的标题属性，具体的对象结构和属性获取方式依据业务定义而定。 cardLinkVO.setTitle(compressContentBO.getAppMsg().getTitle()); + // 提取卡片式链接的描述信息，并设置到CardLinkVO对象中，与设置标题的逻辑类似，从CompressContentBO对象中获取相应的描述属性并赋值。 cardLinkVO.setDes(compressContentBO.getAppMsg().getDes()); + // 提取卡片式链接的来源显示名称信息，并设置到CardLinkVO对象中，同样是从CompressContentBO对象中获取对应属性进行赋值操作。 cardLinkVO.setSourceDisplayName(compressContentBO.getAppMsg().getSourceDisplayName()); + // 提取卡片式链接的链接地址信息，并设置到CardLinkVO对象中，确保CardLinkVO对象包含了完整的卡片式链接关键信息，方便后续使用。 cardLinkVO.setUrl(compressContentBO.getAppMsg().getUrl()); + // 将包含完整卡片式链接信息的CardLinkVO对象设置到传入的MsgVO消息对象中，使得MsgVO对象能够持有并传递卡片式链接相关的数据，便于在系统中其他地方使用该消息对象时获取这些信息。 msgVO.setCardLink(cardLinkVO); + // 设置MsgVO对象的文本内容（strContent）为固定的字符串"[卡片链接]"，用于在某些展示场景下（比如消息列表展示简单内容时）能直观地表示该消息是卡片式链接消息类型， + // 具体的展示逻辑和使用场景依据业务需求而定。 msgVO.setStrContent("[卡片链接]"); }); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/EmojiMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/EmojiMsgStrategy.java index dec75f3..9399e4d 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/EmojiMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/EmojiMsgStrategy.java @@ -10,29 +10,53 @@ import org.springframework.stereotype.Service; /** * 表情消息 + * 该类用于处理表情相关的消息逻辑，实现了MsgStrategy接口，意味着它是一种专门针对表情消息的特定处理策略类，负责对符合条件的表情消息进行相应的判断与处理操作。 + * 通过 @Slf4j 注解启用了Slf4j日志框架，方便在类中记录日志信息，有助于调试和了解处理流程中的情况。同时使用 @Service 注解将其标记为Spring服务组件，使其能在Spring框架下被管理， + * 可以方便地进行依赖注入，进而在整个项目的消息处理流程中按需调用该类的功能来处理表情消息。 * * @author xcs - * @date 2024年01月24日 11时50分 + * @date 2024年01月24日 11时50分 **/ @Slf4j @Service public class EmojiMsgStrategy implements MsgStrategy { + /** + * 判断是否支持处理当前消息类型及子类型 + * 此方法用于确定传入的消息类型（type）和消息子类型（subType）是否符合表情消息的特征，以此来判定该策略类是否应该对该消息进行处理。 + * 在当前实现中，若消息类型为47且子类型为0时，则认定其为表情消息，此时该方法返回true，表示支持处理；反之，若不符合此条件则返回false，表示不支持处理该消息。 + * + * @param type 消息类型，是一个整数，代表消息整体的分类情况，不同的整数值对应不同大类的消息（比如文本消息、图片消息等各有其对应的类型值），在这里用于判断是否是表情消息对应的类型值。 + * @param subType 消息子类型，同样为整数，是在消息已有大的类型划分基础上，对消息做进一步细分的类型标识，用于更精确地判断消息是否属于表情消息这一具体类型。 + * @return boolean 如果消息类型和子类型满足表情消息的特定条件（即type == 47 && subType == 0），则返回true，表示支持处理该消息；否则返回false。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 47 && subType == 0; } + /** + * 处理表情消息的具体逻辑 + * 该方法用于对判定为表情消息（通过support方法判断）的消息进行具体的处理操作，主要涉及对消息内容的解析以及提取表情相关信息并更新对应的消息视图对象（MsgVO）。 + * 首先，检查消息的文本内容（strContent）是否为空，若不为空则将其解析为MsgBO对象，接着尝试从MsgBO对象中获取表情相关信息（如表情的CDN链接），对链接进行必要的处理（去除特定字符串）后， + * 将处理后的表情链接设置到MsgVO对象中，同时将消息的文本内容更新为特定的表示形式（[表情消息]），以便后续在业务逻辑中能够以合适的方式展示和处理表情消息相关信息，例如在前端展示时显示相应提示等场景。 + * + * @param msgVO 消息视图对象，包含了消息的各种属性信息（如消息文本内容、其他相关辅助内容等），是需要进行处理和更新的对象，代表了当前要处理的表情消息的整体信息，其具体属性取决于MsgVO类的定义。 + */ @Override public void process(MsgVO msgVO) { + // 使用Opt.ofNullable方法对msgVO.getStrContent()进行包装，避免出现空指针异常，若消息文本内容不为空，则执行后续操作 Opt.ofNullable(msgVO.getStrContent()) + // 若消息文本内容不为空，调用XmlUtil.parseXml方法，按照MsgBO.class的定义将文本内容解析为MsgBO对象，用于后续提取表情相关信息 .map(xmlContent -> XmlUtil.parseXml(xmlContent, MsgBO.class)) .ifPresent(msgBO -> Opt.ofNullable(msgBO.getEmoji()) .map(MsgBO.Emoji::getCdnUrl) .map(emojiUrl -> emojiUrl.replace("amp;", "")) .ifPresent(emojiUrl -> { + // 将处理后的表情链接设置到msgVO对象的emojiUrl属性中，方便后续获取和使用表情的链接信息 msgVO.setEmojiUrl(emojiUrl); + // 将msgVO对象的消息文本内容更新为固定的表示形式“[表情消息]”，使其在展示等场景下更符合表情消息的特征 msgVO.setStrContent("[表情消息]"); })); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/FileMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/FileMsgStrategy.java index 7e19369..c4511b8 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/FileMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/FileMsgStrategy.java @@ -5,21 +5,41 @@ import com.xcs.wx.msg.MsgStrategy; import org.springframework.stereotype.Service; /** - * 文件消息 - * + * FileMsgStrategy类用于处理文件消息相关的业务逻辑，它实现了 `MsgStrategy` 接口，按照该接口定义的规范来实现针对文件消息的特定处理方法， + * 在整个消息处理体系里，承担着识别文件消息以及对其进行简单内容设置的任务，以便系统能够区分并合理处理这种类型的消息，比如在消息展示等场景下能准确呈现其为文件消息的特征。 + * @author xcs - * @date 2024年6月14日10:48:20 + * @date 2024年6月14日10:48:20 **/ @Service +// @Service注解用于将该类标记为Spring框架中的一个服务层组件，这样Spring容器在启动时会自动扫描并创建该类的实例，把它纳入到容器的管理之中， +// 方便在其他需要处理文件消息相关业务的地方通过依赖注入的方式获取实例，实现组件之间的解耦以及更灵活的调用，使其可以很好地融入基于Spring的项目架构里。 + public class FileMsgStrategy implements MsgStrategy { + /** + * support方法用于判断给定的消息类型（type）和子类型（subType）是否与文件消息的类型匹配，以此来确定当前的消息处理策略是否适用于该消息。 + * 在整个消息处理流程当中，不同类型和子类型的消息有着不同的处理逻辑，该方法就起到了前置筛选的作用，只有消息类型和子类型符合文件消息要求的情况下，才会进入到后续本类中定义的处理流程里。 + * + * @param type 消息类型，以整数（Integer）类型传入，代表消息整体的分类标识，不同整数值对应不同种类的消息，在这里用于和文件消息的类型值进行比对判断。 + * @param subType 消息子类型，同样是整数（Integer）类型，是在消息类型基础上进一步细分的标识，用于更精准地确定消息的具体种类，与type参数共同来精确判断是否为文件消息。 + * @return boolean 返回值为布尔类型，如果传入的type值等于49且subType值等于6，则表明该消息是文件消息，返回true；否则返回false，表示当前的消息处理策略不适用于此消息。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 49 && subType == 6; } + /** + * process方法用于对确定为文件消息类型的消息进行具体的处理操作，它接收一个 `MsgVO` 类型的消息对象作为参数， + * 在本案例中，主要是将消息对象的文本内容（`strContent`）设置为固定的字符串"[文件]"，目的是在某些消息展示场景下（比如消息列表展示简单内容时），能够直观地表明该消息属于文件消息类型，方便用户快速识别消息的性质， + * 当然具体的展示逻辑和使用场景要依据整个项目的业务需求来确定。 + * + * @param msgVO 消息对象，以 `MsgVO` 类型传入，它包含了消息的各种相关信息，是整个处理流程的数据基础，本方法直接对其 `strContent` 属性进行修改赋值， + * 使得该消息对象能体现出文件消息的特征，便于后续在系统中进行展示或者其他相关的业务逻辑处理。 + */ @Override public void process(MsgVO msgVO) { msgVO.setStrContent("[文件]"); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/ImageMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/ImageMsgStrategy.java index 6480daf..6c27e15 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/ImageMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/ImageMsgStrategy.java @@ -2,43 +2,64 @@ package com.xcs.wx.msg.impl; import cn.hutool.core.lang.Opt; import cn.hutool.core.util.ReUtil; -import com.xcs.wx.domain.bo.MsgBO; import com.xcs.wx.domain.vo.MsgVO; import com.xcs.wx.msg.MsgStrategy; -import com.xcs.wx.util.XmlUtil; import lombok.extern.slf4j.Slf4j; -import org.apache.commons.lang3.StringUtils; import org.springframework.stereotype.Service; -import java.util.regex.Matcher; -import java.util.regex.Pattern; - - /** * 图片消息 + * 该类用于专门处理图片相关的消息逻辑，实现了MsgStrategy接口，表明它是针对图片消息的一种特定处理策略类，负责对符合条件的图片消息进行相应的判断以及处理操作。 + * 通过 @Slf4j 注解引入了Slf4j日志框架，方便在类中记录日志，便于调试程序以及了解消息处理过程中的具体情况。同时使用 @Service 注解将其标记为Spring服务组件，使其能在Spring框架下进行管理， + * 可以顺利地进行依赖注入，进而在整个项目的消息处理流程里按需调用该类的功能，以处理图片消息相关事务。 * * @author xcs - * @date 2024年01月24日 11时46分 + * @date 2024年01月24日 11时46分 **/ @Slf4j @Service public class ImageMsgStrategy implements MsgStrategy { + /** + * 判断是否支持处理当前消息类型及子类型 + * 此方法用于判断传入的消息类型（type）和消息子类型（subType）是否符合图片消息的特征，以此来确定该策略类是否需要对传入的消息进行处理。 + * 在当前的实现中，若消息类型为3且子类型为0时，就认定其为图片消息，此时该方法返回true，表示支持处理该消息；若不满足此条件，则返回false，表示不支持处理该消息。 + * + * @param type 消息类型，是一个整数，用于表示消息整体的分类情况，不同的整数值对应着不同大类的消息（例如文本消息、语音消息等都有各自对应的类型值），在这里用于判断是否为图片消息对应的类型值。 + * @param subType 消息子类型，同样为整数，是在消息已有大的类型划分基础上，进一步细分消息的具体类型，以便更精准地判断消息是否确实属于图片消息这一具体类别。 + * @return boolean 如果消息类型和子类型满足图片消息的特定条件（即type == 3 && subType == 0），则返回true，表示支持处理该消息；否则返回false。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 3 && subType == 0; } + /** + * 处理图片消息的具体逻辑 + * 该方法用于对判定为图片消息（通过support方法判断）的消息进行具体的处理操作，主要是从消息的额外字节信息（bytesExtra）中提取图片相关的路径信息，并设置到对应的消息视图对象（MsgVO）中， + * 同时更新消息的文本内容为特定表示形式，方便后续在业务逻辑中展示和处理图片消息相关内容，比如在前端展示时以合适的形式呈现图片消息。 + * + * @param msgVO 消息视图对象，包含了消息的各种属性信息（如额外字节信息、其他消息相关内容等），是需要进行处理和更新的对象，代表了当前要处理的图片消息的整体信息，其具体属性取决于MsgVO类的定义。 + */ @Override public void process(MsgVO msgVO) { + // 使用Opt.ofNullable方法对msgVO.getBytesExtra()进行包装，避免出现空指针异常，若消息的额外字节信息不为空，则执行后续操作 Opt.ofNullable(msgVO.getBytesExtra()) + // 若额外字节信息不为空，将字节数组转换为字符串形式，以便后续基于字符串内容进行正则匹配等操作来提取图片相关路径 .map(xmlContent -> new String(msgVO.getBytesExtra())) .ifPresent(extra -> { + // 使用ReUtil工具类的getGroup0方法，通过正则表达式匹配从extra字符串中提取图片的缩略图路径信息 + // 正则表达式 "FileStorage\\\\MsgAttach\\\\[^\\\\]+\\\\Thumb\\\\[^\\\\]+\\\\[^\\\\]+\\.dat" 用于匹配符合特定格式的缩略图文件路径 String thumb = ReUtil.getGroup0("FileStorage\\\\MsgAttach\\\\[^\\\\]+\\\\Thumb\\\\[^\\\\]+\\\\[^\\\\]+\\.dat", extra); + // 同样使用ReUtil工具类的getGroup0方法，通过另一个正则表达式匹配从extra字符串中提取图片的原始图像路径信息 + // 正则表达式 "FileStorage\\\\MsgAttach\\\\[^\\\\]+\\\\Image\\\\[^\\\\]+\\\\[^\\\\]+\\.dat" 用于匹配符合特定格式的原始图像文件路径 String image = ReUtil.getGroup0("FileStorage\\\\MsgAttach\\\\[^\\\\]+\\\\Image\\\\[^\\\\]+\\\\[^\\\\]+\\.dat", extra); + // 将提取到的原始图像路径信息设置到msgVO对象的image属性中，方便后续获取和使用图片的实际路径 msgVO.setImage(image); + // 将提取到的缩略图路径信息设置到msgVO对象的thumb属性中，便于后续在需要展示缩略图等场景下使用 msgVO.setThumb(thumb); + // 将msgVO对象的消息文本内容更新为固定的表示形式“[图片]”，使其在展示等场景下更直观地体现是图片消息 msgVO.setStrContent("[图片]"); }); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/MapMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/MapMsgStrategy.java index 45036b9..534024b 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/MapMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/MapMsgStrategy.java @@ -5,21 +5,41 @@ import com.xcs.wx.msg.MsgStrategy; import org.springframework.stereotype.Service; /** - * 地图消息 - * + * MapMsgStrategy类用于处理地图消息相关的业务逻辑，它实现了 `MsgStrategy` 接口，这意味着需要按照该接口所定义的规则来实现针对地图消息的特定处理操作， + * 在整个消息处理体系中，负责对地图消息进行识别以及做一些基础的内容设置工作，使得系统能够区分出地图消息并在合适的场景下（比如消息展示等环节）准确体现其为地图消息这一特征。 + * @author xcs - * @date 2024年01月24日 11时45分 + * @date 2024年01月24日 11时45分 **/ @Service +// @Service注解用于将该类标记为Spring框架下的一个服务层组件，这样一来，在Spring容器启动时会自动扫描并创建该类的实例，然后将其纳入到容器的管理范围之内， +// 方便在其他需要处理地图消息相关业务的地方通过依赖注入的方式获取该实例，以此实现组件之间的解耦，让调用变得更加灵活，确保该类能很好地融入基于Spring的项目架构之中，便于整体的项目开发与集成应用。 + public class MapMsgStrategy implements MsgStrategy { + /** + * support方法主要用于判断给定的消息类型（type）和子类型（subType）是否与地图消息的类型相匹配，以此来确定当前的消息处理策略是否适用于接收到的消息。 + * 在整个消息处理流程里，不同类型及子类型的消息都有着各自不同的处理逻辑，该方法就充当了一个前置的筛选机制，只有当传入的消息类型和子类型符合地图消息的特定要求时，才会进入到后续本类中定义的处理流程中去。 + * + * @param type 消息类型，以整数（Integer）类型传入，它代表着消息整体的分类标识，不同的整数值对应着不同种类的消息，在这里是用于和地图消息所对应的类型值进行对比判断的依据。 + * @param subType 消息子类型，同样为整数（Integer）类型，是在消息类型基础上进一步细分的标识，能更精确地界定消息的具体种类，与type参数共同协作来精准判断是否为地图消息。 + * @return boolean 返回值是布尔类型，如果传入的type值等于48且subType值等于0，那就意味着该消息是地图消息，此时返回true；反之，若不满足这个条件，则返回false，表示当前的消息处理策略并不适用于这条消息。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 48 && subType == 0; } + /** + * process方法用于对确定为地图消息类型的消息进行具体的处理操作，它接收一个 `MsgVO` 类型的消息对象作为参数， + * 在本示例中，主要的处理操作就是将消息对象中的文本内容（`strContent`）属性设置为固定的字符串“[地图消息]”，这么做的目的在于，在某些消息展示场景下（例如在消息列表中展示消息的简要内容时）， + * 能够直观且清晰地向用户表明这条消息属于地图消息类型，方便用户快速识别消息的性质，当然，具体的展示逻辑以及使用场景都是要依据整个项目的业务需求来确定的。 + * + * @param msgVO 消息对象，以 `MsgVO` 类型传入，它涵盖了消息的各类相关信息，是整个处理流程所依赖的数据基础，通过修改这个对象的 `strContent` 属性， + * 让其体现出地图消息的特征，以便后续在系统中进行展示或者开展其他与之相关的业务逻辑处理工作。 + */ @Override public void process(MsgVO msgVO) { msgVO.setStrContent("[地图消息]"); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/ReferMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/ReferMsgStrategy.java index 13bc8da..ad6d61f 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/ReferMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/ReferMsgStrategy.java @@ -12,33 +12,59 @@ import org.springframework.stereotype.Service; /** * 引用消息 + * 该类用于处理引用相关的消息逻辑，实现了MsgStrategy接口，说明它是针对引用消息的一种特定处理策略类，主要负责对符合条件的引用消息进行相应的判断以及处理操作。 + * 通过 @Slf4j 注解启用了Slf4j日志框架，方便在类中记录日志信息，有助于在处理引用消息出现问题时进行调试以及了解具体的执行情况。同时使用 @Service 注解将其标记为Spring服务组件， + * 使其能够在Spring框架下进行管理，可以方便地进行依赖注入，进而在整个项目的消息处理流程中按需调用该类来处理引用消息相关事务。 * * @author xcs - * @date 2024年01月24日 13时53分 + * @date 2024年01月24日 13时53分 **/ @Slf4j @Service public class ReferMsgStrategy implements MsgStrategy { + /** + * 判断是否支持处理当前消息类型及子类型 + * 此方法用于判断传入的消息类型（type）和消息子类型（subType）是否符合引用消息的特征，以此来确定该策略类是否需要对传入的消息进行处理。 + * 在当前实现中，若消息类型为49且子类型为57时，就认定其为引用消息，此时该方法返回true，表示支持处理该消息；若不满足此条件，则返回false，表示不支持处理该消息。 + * + * @param type 消息类型，是一个整数，用于表示消息整体的分类情况，不同的整数值对应不同大类的消息（例如文本消息、图片消息等都有各自对应的类型值），在这里用于判断是否为引用消息对应的类型值。 + * @param subType 消息子类型，同样为整数，是在消息已有大的类型划分基础上，进一步细分消息的具体类型，以便更精准地判断消息是否确实属于引用消息这一具体类别。 + * @return boolean 如果消息类型和子类型满足引用消息的特定条件（即type == 49 && subType == 57），则返回true，表示支持处理该消息；否则返回false。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 49 && subType == 57; } + /** + * 处理引用消息的具体逻辑 + * 该方法用于对判定为引用消息（通过support方法判断）的消息进行具体的处理操作，整体处理流程包含对消息压缩内容的解压、解析，提取相关信息设置到消息视图对象（MsgVO）的文本内容中， + * 同时还会调用专门处理引用消息的方法（handleReferMsg）进一步处理引用部分的详细信息，比如根据引用消息的不同类型来设置合适的展示内容等，以便后续在业务逻辑中能准确展示和处理引用消息相关内容。 + * + * @param msgVO 消息视图对象，包含了消息的各种属性信息（如压缩内容、其他消息相关内容等），是需要进行处理和更新的对象，代表了当前要处理的引用消息的整体信息，其具体属性取决于MsgVO类的定义。 + */ @Override public void process(MsgVO msgVO) { + // 使用Opt.ofNullable方法对msgVO.getCompressContent()进行包装，避免出现空指针异常，若消息的压缩内容不为空，则执行后续操作 Opt.ofNullable(msgVO.getCompressContent()) + // 若压缩内容不为空，调用LZ4Util.decompress方法对消息的压缩内容进行解压操作，将解压后的内容作为下一步操作的输入 .map(compressContent -> LZ4Util.decompress(msgVO.getCompressContent())) + // 对解压后的内容，调用XmlUtil.parseXml方法，按照CompressContentBO.class的定义将其解析为CompressContentBO对象，用于后续提取引用消息相关信息 .map(xmlContent -> XmlUtil.parseXml(xmlContent, CompressContentBO.class)) .ifPresent(compressContentBO -> msgVO.setStrContent(compressContentBO.getAppMsg().getTitle())) + // 调用handleReferMsg方法，传入当前消息视图对象和解析得到的CompressContentBO对象，进一步处理引用消息的详细内容 .ifPresent(compressContentBO -> handleReferMsg(msgVO, compressContentBO)); } /** * 处理引用消息 + * 此私有方法用于深入处理引用消息的具体内容，根据引用消息内部所引用消息的不同类型（如小程序消息、动画表情、图片、语音、视频等不同类型）， + * 进行相应的内容提取和格式设置，最终将处理后的引用消息内容设置到MsgVO对象的对应属性中，以便在展示等业务场景下能正确呈现引用消息的详细情况。 + * 如果在处理过程中出现异常，会通过日志框架记录错误信息，方便后续排查问题。 * - * @param msgVO 消息VO - * @param compressContentBO 压缩内容 BO + * @param msgVO 消息VO，即消息视图对象，代表当前正在处理的引用消息整体信息，其属性会根据处理结果进行更新，具体属性取决于MsgVO类的定义。 + * @param compressContentBO 压缩内容BO，是经过前面解析操作得到的对象，包含了引用消息中的相关详细信息，用于进一步提取和处理引用部分的具体内容。 */ private void handleReferMsg(MsgVO msgVO, CompressContentBO compressContentBO) { Opt.ofNullable(compressContentBO) @@ -47,6 +73,7 @@ public class ReferMsgStrategy implements MsgStrategy { .ifPresent(referMsg -> { try { String refContent; + // 根据引用消息内部所引用消息的类型进行不同的处理逻辑 if (referMsg.getType() == 49) { refContent = Opt.ofNullable(referMsg.getContent()) .map(content -> XmlUtil.parseXml(referMsg.getContent(), CompressContentBO.class)) @@ -64,13 +91,16 @@ public class ReferMsgStrategy implements MsgStrategy { } else { refContent = referMsg.getContent(); } + // 如果处理后的引用内容为空字符串，将其设置为默认值 "None" if (StrUtil.isEmpty(refContent)) { refContent = "None"; } + // 将处理后的引用消息内容设置到msgVO对象的referMsgContent属性中，格式为引用消息的显示名称加上具体内容，并去除可能存在的特殊字符（这里是 "�"） msgVO.setReferMsgContent(referMsg.getDisplayName() + "：" + refContent.replace("�", "")); } catch (Exception e) { - log.error("handle refer msg fail" ,e); + // 如果在处理引用消息过程中出现异常，使用日志框架记录错误信息，方便后续排查处理引用消息失败的原因 + log.error("handle refer msg fail", e); } }); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/SystemMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/SystemMsgStrategy.java index 63929ea..d789232 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/SystemMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/SystemMsgStrategy.java @@ -8,37 +8,78 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; /** - * 系统消息 - * + * SystemMsgStrategy类用于处理系统消息相关的业务逻辑，它实现了 `MsgStrategy` 接口，按照该接口定义的规范来实现针对系统消息的特定处理方法， + * 在整个消息处理体系中，负责对系统消息进行识别，并对其内容进行清理、提取等处理操作，使得系统消息能以更合适、更易读的形式在系统中展示和被使用，满足业务场景下对系统消息展示及处理的需求。 + * @author xcs - * @date 2024年01月24日 13时54分 + * @date 2024年01月24日 13时54分 **/ @Service +// @Service注解用于将该类标记为Spring框架中的一个服务层组件，这样Spring容器在启动时会自动扫描并创建该类的实例，将其纳入到容器的管理之中， +// 方便在其他需要处理系统消息相关业务的地方通过依赖注入的方式获取实例，实现组件之间的解耦以及更灵活的调用，使其能很好地融入基于Spring的项目架构中。 + public class SystemMsgStrategy implements MsgStrategy { + // 定义一个静态的正则表达式字符串，用于匹配系统消息中特定的内容格式。 + // 这个正则表达式的含义是：匹配以 开头，接着是任意字符（由.+ 表示），最后以 结尾的字符串模式。 + // 其目的可能是从系统消息的文本内容中提取出符合该模式的关键信息部分，具体的提取逻辑会在后续代码中使用该正则表达式进行处理时体现出来。 private static final String REGEX = "(.+)"; + /** + * support方法用于判断给定的消息类型（type）和子类型（subType）是否与系统消息的类型匹配，以此来确定当前的消息处理策略是否适用于该消息。 + * 在整个消息处理流程中，不同类型和子类型的消息会有不同的处理逻辑，该方法起到了一个前置的筛选作用，只有符合特定类型和子类型要求的消息才会进入到后续本类中定义的处理流程中。 + * + * @param type 消息类型，以整数（Integer）类型传入，代表消息的整体分类标识，不同的整数值对应不同种类的消息，在这里用于和系统消息的类型值进行比对判断。 + * @param subType 消息子类型，同样为整数（Integer）类型，是在消息类型基础上进一步细分的标识，用于更精确地确定消息的具体种类，与type参数共同来精准定位是否为系统消息。 + * @return boolean 返回值为布尔类型，如果传入的type值等于10000且subType值等于0，则表示该消息是系统消息，返回true；否则返回false，表示不适用当前的消息处理策略。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 10000 && subType == 0; } + /** + * process方法用于对符合系统消息类型的消息进行具体的处理操作，它接收一个 `MsgVO` 类型的消息对象作为参数， + * 在方法内部，首先会对消息内容进行一些替换操作以去除特定的标签，然后使用预定义的正则表达式去匹配消息内容，提取出符合要求的文本信息，并进一步处理去除其中可能存在的HTML标签，最后将处理后的文本设置为消息对象的内容，以便后续在系统中进行展示或其他业务逻辑处理。 + * + * @param msgVO 消息对象，以 `MsgVO` 类型传入，它包含了消息的各种相关信息，例如消息的原始文本内容（`strContent`）以及其他可能的通用属性等，是整个处理流程的数据基础， + * 本方法会基于这个对象进行数据的修改、提取和重新设置等操作，使其包含更合适的系统消息相关内容，方便后续使用。 + */ @Override public void process(MsgVO msgVO) { // 替换内容 + // 这里使用replaceAll方法对消息对象的strContent属性（即消息的文本内容）进行处理，将其中的 "" 和 "" 标签全部替换为空字符串， + // 目的可能是去除消息内容中与撤回消息相关的标记或者不需要展示的特定标签内容，使得消息文本更加简洁、符合实际展示需求。 msgVO.setStrContent(msgVO.getStrContent().replaceAll("|", "")); + // 使用正则表达式匹配需要的内容 + // 创建一个Pattern对象，通过调用Pattern.compile方法并传入预定义的正则表达式REGEX来进行编译，得到一个用于正则匹配的模式对象， + // 后续就可以利用这个模式对象去对消息文本内容进行匹配操作，查找符合该正则表达式模式的部分内容。 Pattern pattern = Pattern.compile(REGEX); + // 对StrContent进行匹配 + // 使用上一步创建的Pattern对象的matcher方法，传入消息对象的strContent属性（即要匹配的文本内容），创建一个Matcher对象， + // 这个Matcher对象提供了一系列方法用于在文本中查找、匹配符合给定正则表达式模式的内容，接下来就可以通过它来进行具体的匹配操作了。 Matcher matcher = pattern.matcher(msgVO.getStrContent()); + // 匹配成功 + // 通过调用Matcher对象的find方法来尝试在消息文本内容中查找是否存在符合正则表达式模式的部分， + // 如果找到了匹配的内容，find方法会返回true，然后就可以进行后续提取匹配文本等操作；如果没找到匹配内容，则返回false，跳过后续提取等操作。 if (matcher.find()) { // 提取匹配的文本 + // 当匹配成功后，使用matcher.group(1)方法提取出符合正则表达式中第一个括号捕获组（即.+ 部分所匹配的内容）的文本， + // 并通过trim方法去除文本前后可能存在的空白字符，得到相对纯净的匹配文本内容，以便后续进一步处理和使用。 String extractedText = matcher.group(1).trim(); + // 进一步处理以去除内部的HTML标签 + // 使用replaceAll方法配合HTML标签的正则表达式模式 "<[^>]+>"，将提取出来的文本中所有的HTML标签（如
、 等）都替换为空字符串， + // 再次通过trim方法去除处理后文本前后可能出现的空白字符，使得最终得到的文本内容更加纯净，只保留了实际需要展示的文本信息，去除了不必要的HTML格式标签。 extractedText = extractedText.replaceAll("<[^>]+>", "").trim(); + // 设置消息内容 + // 将经过上述处理后得到的纯净文本内容设置回消息对象的strContent属性中，这样消息对象的文本内容就更新为处理后的合适内容了， + // 方便后续在系统中进行展示（比如在消息列表展示消息详情时呈现更清晰的系统消息文本）或者其他业务逻辑处理（如根据消息内容进行相关判断等）。 msgVO.setStrContent(extractedText); } } -} +} \ No newline at end of file -- 2.34.1 From 16c9951a7dc9762661bee9469fa08232dbe6775d Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Mon, 16 Dec 2024 14:16:44 +0800 Subject: [PATCH 08/17] 1 --- .../com/xcs/wx/mapping/ChatRoomMapping.java | 46 +++++++++++++------ .../xcs/wx/mapping/ContactLabelMapping.java | 25 +++++++--- .../com/xcs/wx/mapping/ContactMapping.java | 13 ++++-- .../java/com/xcs/wx/mapping/FeedsMapping.java | 25 +++++++--- .../java/com/xcs/wx/mapping/MsgMapping.java | 20 +++++--- .../xcs/wx/mapping/RecoverContactMapping.java | 25 +++++++--- .../com/xcs/wx/mapping/SessionMapping.java | 13 ++++-- .../java/com/xcs/wx/mapping/UserMapping.java | 26 ++++++++--- 8 files changed, 136 insertions(+), 57 deletions(-) diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ChatRoomMapping.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ChatRoomMapping.java index febfe07..66c7f2f 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ChatRoomMapping.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ChatRoomMapping.java @@ -16,57 +16,74 @@ import java.util.stream.Collectors; /** * 群聊 Mapping + * 该接口用于定义群聊相关对象之间的映射转换逻辑，借助MapStruct框架来实现不同对象结构之间属性的复制与转换，方便在不同业务层处理群聊相关数据时，能以合适的对象形式进行传递和操作。 + * 通过 @Mapper(componentModel = "spring") 注解，将该接口配置为Spring组件，使得Spring容器能够对其进行管理，并支持依赖注入，便于在项目中灵活调用这些映射方法。 * * @author xcs - * @date 2024年01月08日 17时00分 + * @date 2024年01月08日 17时00分 **/ @Mapper(componentModel = "spring") public interface ChatRoomMapping { /** * 参数转换 + * 此方法用于将一个包含ChatRoom类型对象的列表进行转换，按照MapStruct框架依据ChatRoom类与ChatRoomVO类之间属性的对应关系所自动生成的映射规则， + * 把输入的群聊基本信息列表（chatRooms）转换为ChatRoomVO类型对象的列表。ChatRoomVO类型的对象通常是更适合用于展示、传递给前端或者在其他业务场景中使用的视图对象，包含了经过筛选和整理后的群聊相关信息。 * - * @param chatRooms 入参 - * @return ChatRoomVO + * @param chatRooms 入参，是一个包含ChatRoom类型对象的列表，这些ChatRoom对象包含了群聊的基础属性信息，比如群聊ID、群聊名称、创建时间等（具体取决于ChatRoom类的定义），代表了需要进行转换的原始群聊信息集合。 + * @return ChatRoomVO 返回一个ChatRoomVO类型对象的列表，其中每个ChatRoomVO对象都承载着经过转换后的群聊相关信息，符合业务逻辑中展示、处理等操作所要求的数据格式。 */ List convert(List chatRooms); /** * 转换参数 + * 该方法负责将单个ChatRoom类型的对象转换为ChatRoomDetailVO类型的对象。MapStruct会根据ChatRoom类与ChatRoomDetailVO类中属性的对应关系生成具体的转换逻辑， + * 以此将群聊对象（chatRoom）中包含的详细信息（如群成员列表、群公告、群聊的各种配置信息等，具体由ChatRoom类定义决定）转换为ChatRoomDetailVO对象，ChatRoomDetailVO对象更侧重于展示群聊的详细情况，便于在需要详细群聊信息的业务场景中使用。 * - * @param chatRoom 入参 - * @return ChatRoomDetailVO + * @param chatRoom 入参，是一个ChatRoom类型的对象，代表需要进行转换的单个群聊信息，其包含了群聊从基础到详细的各项属性，是转换操作的数据源。 + * @return ChatRoomDetailVO 返回一个ChatRoomDetailVO类型的对象，该对象包含了经过转换后的群聊详细信息，可用于例如在前端页面展示群聊的详细资料，或者在后端进行基于详细群聊信息的业务处理等场景。 */ ChatRoomDetailVO convert(ChatRoom chatRoom); /** * 转换参数 + * 把ChatRoomInfo类型的对象按照特定映射规则转换为ChatRoomInfoVO类型的对象。MapStruct依据ChatRoomInfo类与ChatRoomInfoVO类中属性的对应关系自动生成转换实现， + * 从而将群聊详情相关的数据（例如群聊创建时间、群主信息、群聊的一些统计信息等，具体依据ChatRoomInfo类的定义）转换为更适合展示或者在其他业务逻辑中使用的ChatRoomInfoVO对象形式。 * - * @param chatRoomInfo 入参 - * @return ChatRoomInfoVO + * @param chatRoomInfo 入参，是一个ChatRoomInfo类型的对象，存有群聊详情方面的属性信息，代表了需要进行转换的群聊详情数据，其具体内容取决于ChatRoomInfo类的定义。 + * @return ChatRoomInfoVO 返回一个ChatRoomInfoVO类型的对象，该对象包含了经过转换后的群聊详情信息，便于在相关业务场景中使用，比如在前端页面展示群聊的详细资料，或者在业务逻辑中基于这些详情信息进行分析、判断等操作。 */ ChatRoomInfoVO convert(ChatRoomInfo chatRoomInfo); /** * 参数转换 + * 用于将ChatRoomProto.Member类型的对象转换为ChatRoomMemberVO类型的对象。MapStruct根据ChatRoomProto.Member类与ChatRoomMemberVO类中属性的对应关系自动生成转换逻辑， + * 把包含群聊成员基本信息（例如成员的唯一标识、在群内的角色、成员的一些基础属性等，具体取决于ChatRoomProto.Member类的定义）的对象转换为ChatRoomMemberVO对象，ChatRoomMemberVO对象更适合用于展示群聊成员信息以及在业务逻辑中对成员相关情况进行处理。 * - * @param member 入参 - * @return ChatRoomMemberVO + * @param member 入参，是一个ChatRoomProto.Member类型的对象，代表需要进行转换的群聊成员信息，其包含了群聊成员的相关属性数据，是转换操作的基础数据来源。 + * @return ChatRoomMemberVO 返回一个ChatRoomMemberVO类型的对象，其中包含了经过转换后的群聊成员相关信息，适用于在业务逻辑中对群聊成员情况进行展示、分析、操作等，比如在前端展示群聊成员列表等场景。 */ ChatRoomMemberVO convert(ChatRoomProto.Member member); /** * 参数转换 + * 该默认方法用于将一个包含ChatRoomProto.Member类型对象的列表，结合头像信息和群昵称信息的映射表，转换为ChatRoomMemberVO类型对象的列表，并在转换过程中对成员的头像URL和群备注（昵称）进行相应设置。 + * 首先，通过流操作遍历成员列表，对每个成员先进行基本的转换（调用上面的convert方法），然后利用peek操作来设置头像URL（从头像信息映射表中根据成员的微信ID获取对应的URL）， + * 接着再通过另一个peek操作判断成员的群备注是否已经存在，如果不存在则从群昵称映射表中根据成员的微信ID获取对应的昵称进行设置，最后将处理好的成员对象收集为一个ChatRoomMemberVO类型对象的列表返回， + * 以得到完整的、符合业务展示需求的群聊成员信息列表，方便后续在前端展示群聊成员列表等业务场景中使用。 * - * @param members 入参 - * @param headImgUrlMap 头像信息 - * @param contactNicknameMap 群昵称 - * @return ChatRoomMemberVO + * @param members 入参，是一个包含ChatRoomProto.Member类型对象的列表，代表需要进行转换的群聊成员信息列表，每个对象包含了群聊成员的基础属性信息，是转换操作的基础数据集合。 + * @param headImgUrlMap 头像信息，是一个以字符串为键（通常为成员的标识，比如微信ID等），字符串为值（对应的头像URL地址）的映射表，用于为群聊成员设置头像链接信息，确保成员在展示时有对应的头像显示。 + * @param contactNicknameMap 群昵称，同样是一个以字符串为键（成员标识），字符串为值（对应的群昵称）的映射表，用于在成员没有群备注时为其设置群昵称，使成员展示的信息更加完整。 + * @return ChatRoomMemberVO 返回一个ChatRoomMemberVO类型对象的列表，其中每个对象都包含了经过转换且设置好头像URL和群备注（若需要）的群聊成员相关信息，符合在业务场景中展示群聊成员信息的要求。 */ default List convert(List members, Map headImgUrlMap, Map contactNicknameMap) { return members.stream() + // 对每个成员对象调用convert方法进行基本的类型转换，将ChatRoomProto.Member类型转换为ChatRoomMemberVO类型 .map(this::convert) + // 使用peek操作，对于每个转换后的成员对象，设置其头像URL，从headImgUrlMap中根据成员的微信ID获取对应的URL并设置 .peek(member -> member.setHeadImgUrl(headImgUrlMap.get(member.getWxId()))) + // 再使用peek操作，对于每个成员对象进行判断，如果其群备注已经存在（不为空字符串），则不做处理，直接返回；如果不存在群备注，则从contactNicknameMap中根据成员的微信ID获取对应的群昵称进行设置 .peek(member -> { // 如果存在群备注则不处理 if (StrUtil.isNotBlank(member.getRemark())) { @@ -75,6 +92,7 @@ public interface ChatRoomMapping { // 设置群昵称 member.setRemark(contactNicknameMap.get(member.getWxId())); }) + // 将处理后的成员对象收集为一个ChatRoomMemberVO类型对象的列表并返回 .collect(Collectors.toList()); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ContactLabelMapping.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ContactLabelMapping.java index b20d02a..1a50eb6 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ContactLabelMapping.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ContactLabelMapping.java @@ -7,19 +7,30 @@ import org.mapstruct.Mapper; import java.util.List; /** - * 联系人标签 Mapping - * + * ContactLabelMapping接口主要承担着对象映射转换的功能，在联系人标签相关业务处理过程中起着关键作用。 + * 其目的在于将 `ContactLabel` 类型的数据转换为 `ContactLabelVO` 类型的数据，以此让联系人标签相关的数据能以更符合业务需求的形式在系统不同层级之间进行传递、展示以及参与后续业务逻辑处理。 + * @author xcs - * @date 2023年12月22日 15时00分 + * @date 2023年12月22日 15时00分 **/ @Mapper(componentModel = "spring") +// @Mapper注解来自Mapstruct框架，用于表明该接口是一个映射接口，专门用于定义对象之间的转换规则。 +// 而设置 `componentModel = "spring"` 这一属性，表示生成的该接口对应的映射实现类将会以Spring组件的形式被管理起来。在Spring容器启动时，会自动创建这个实现类的实例， +// 方便在项目中其他需要进行对象转换的地方通过依赖注入的方式来使用，从而使对象转换操作能够很好地融入到基于Spring的项目开发框架之中，便于整体的项目开发与集成应用。 + public interface ContactLabelMapping { /** * 参数转换 - * - * @param labels 标签 - * @return MsgDTO + * 此方法是实现对象转换功能的核心所在，它负责把输入的 `ContactLabel` 类型的列表数据转换为 `ContactLabelVO` 类型的列表数据。 + * `ContactLabel` 作为表示联系人标签的实体类，其中包含了如标签的ID、名称、创建时间等各种详细的属性信息，这些属性反映了联系人标签在数据库存储层面或者业务逻辑底层的原始数据情况。 + * 而 `ContactLabelVO`（Value Object，值对象）则是经过对 `ContactLabel` 中的原始数据进行加工、筛选、关联等操作后所形成的数据结构，其设计初衷是更适合在业务逻辑层向外展示或者传递给其他层级使用， + * 例如，在将联系人标签数据展示给前端页面时，`ContactLabelVO` 可能只选取了部分关键属性（像标签名称、对应颜色等更适合展示的信息），或者对某些属性进行了格式转换（如将时间戳形式的创建时间转换为特定的日期时间格式），以便更好地满足在具体业务场景下对数据展示和使用的要求。 + + * @param labels 标签，以 `List` 类型传入，代表了需要进行转换的原始数据，也就是一个包含多个 `ContactLabel` 实体对象的列表， + // 这些 `ContactLabel` 对象通常是从数据库查询或者其他数据源获取而来，承载着联系人标签各方面的详细内容，是整个转换操作的数据源头，通过该参数传入相应的数据实例，以生成对应的 `ContactLabelVO` 列表数据。 + * @return MsgDTO 返回类型为 `List`，也就是经过转换后得到的包含多个 `ContactLabelVO` 对象的列表， + // 转换后的列表数据可以在业务逻辑层进一步处理，比如传递给服务层进行进一步的业务逻辑判断，或者直接返回给前端进行展示等操作，使得数据以更合适的形式参与到整个业务流程中。 */ List convert(List labels); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ContactMapping.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ContactMapping.java index 41215d0..7a7fdfd 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ContactMapping.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/ContactMapping.java @@ -8,18 +8,23 @@ import java.util.List; /** * 联系人 Mapping + * 该接口主要用于定义联系人相关对象之间的映射转换操作，借助MapStruct框架来实现从一种联系人数据结构（Contact类型）到另一种更适合业务使用的数据结构（ContactVO类型）的转换， + * 以此方便在不同的业务模块中传递和处理联系人数据，例如将从数据库等数据源获取的原始联系人信息转换为可直接用于前端展示或者其他业务逻辑需求的视图对象数据。 + * 通过 @Mapper(componentModel = "spring") 注解，将这个接口配置成Spring框架下的组件，使得Spring容器可以对其进行管理，并且支持依赖注入，便于在整个项目的不同地方根据业务需求灵活调用该接口中定义的转换方法。 * * @author xcs - * @date 2023年12月22日 15时00分 + * @date 2023年12月22日 15时00分 **/ @Mapper(componentModel = "spring") public interface ContactMapping { /** * 转换参数 + * 此方法用于将一个包含Contact类型对象的列表进行转换，依据MapStruct框架根据Contact类和ContactVO类中属性的对应关系自动生成的映射规则， + * 把输入的联系人原始信息列表（entities）转换为ContactVO类型对象的列表。ContactVO类型的对象通常包含了经过筛选、整理后的联系人相关信息，更契合在业务逻辑中展示、传递给前端等使用场景的要求。 * - * @param entities - * @return + * @param entities 入参，是一个包含Contact类型对象的列表，这些Contact对象包含了联系人的各种详细信息，比如联系人的ID、姓名、联系方式、备注等（具体取决于Contact类的定义），代表了需要进行转换的原始联系人信息集合。 + * @return 返回一个ContactVO类型对象的列表，其中每个ContactVO对象都承载着经过转换后的联系人相关信息，符合如前端展示、其他业务模块处理等操作所需要的数据格式。 */ List convert(List entities); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/FeedsMapping.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/FeedsMapping.java index 3f7b1db..e63abff 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/FeedsMapping.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/FeedsMapping.java @@ -7,19 +7,30 @@ import org.mapstruct.Mapper; import java.util.List; /** - * 朋友圈 Mapping - * + * FeedsMapping接口主要用于实现对象之间的映射转换功能，在朋友圈相关的数据处理方面有着重要意义。 + * 它旨在将 `Feeds` 类型的数据结构转换为 `FeedsVO` 类型的数据结构，使得朋友圈相关的数据可以以更贴合业务需求的形式在系统各层级间流转、展示，并便于后续的业务逻辑处理。 + * @author xcs - * @date 2023年12月21日 18时46分 + * @date 2023年12月21日 18时46分 **/ @Mapper(componentModel = "spring") +// @Mapper注解来源于Mapstruct框架，其作用是标识该接口为一个映射接口，专门用于定义对象之间的转换规则。 +// 通过设置 `componentModel = "spring"`，意味着生成的映射实现类将会以Spring组件的形式进行管理。在Spring容器启动时，会自动创建该接口对应的实现类实例， +// 如此一来，在项目中其他需要进行对象转换的地方，就可以通过依赖注入的方式方便地使用该接口提供的转换功能，让对象转换操作与整个基于Spring的项目架构无缝融合，便于开发与应用集成。 + public interface FeedsMapping { /** * 转换参数 - * - * @param feeds 请求参数 - * @return FeedsVO + * 此方法负责把输入的 `Feeds` 类型的列表数据转换为 `FeedsVO` 类型的列表数据。 + * `Feeds` 作为代表朋友圈动态的实体类，其中包含了诸如动态的唯一标识ID、创建时间、发布用户的用户名、动态内容、附带的图片或视频信息等诸多详细属性，这些属性完整地反映了朋友圈动态在数据库存储层面或者业务逻辑底层的原始数据状况。 + * 而 `FeedsVO`（Value Object，值对象）则是经过对 `Feeds` 中的原始数据进行一系列加工、筛选、整合等操作后所形成的数据结构，其目的在于更契合在业务逻辑层向外展示或者传递给其他层级（比如展示层）使用的需求， + * 例如，它可能仅提取了部分关键属性（像动态内容的摘要、发布用户的昵称、点赞数、评论数等更便于展示和直观了解的信息），并且可能对某些属性进行了格式转换（如将时间戳形式的创建时间转换为常见的日期时间格式），以便更好地满足在前端页面展示朋友圈动态、向外部接口提供数据等具体业务场景下对数据展示和使用的要求。 + + * @param feeds 请求参数，以 `List` 类型传入，即一个包含多个 `Feeds` 实体对象的列表，这些 `Feeds` 对象通常是从数据库查询获取而来，代表了多条朋友圈动态的原始数据信息， + // 它们承载着朋友圈动态各方面的详细内容，是需要进行转换的数据源头，通过该参数传入相应的数据实例，进而生成符合业务展示与使用需求的 `FeedsVO` 列表数据。 + * @return FeedsVO 返回类型为 `List`，也就是经过转换后得到的包含多个 `FeedsVO` 对象的列表， + // 转换后的列表数据可以在业务逻辑层进一步处理，比如传递给服务层用于组装响应数据返回给前端展示朋友圈动态列表，或者用于与其他系统进行数据交互等操作，确保数据以符合业务要求的形式参与到整个系统的运转当中。 */ List convert(List feeds); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/MsgMapping.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/MsgMapping.java index e57fcf6..fb8bed2 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/MsgMapping.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/MsgMapping.java @@ -7,29 +7,35 @@ import org.mapstruct.Mapper; import java.util.List; - /** * 消息 Mapping + * 该接口主要用于定义消息相关对象之间的映射转换逻辑，借助MapStruct框架实现不同消息数据表示形式的转换，以满足在不同业务场景下对消息数据格式的多样化需求， + * 比如将存储在数据库中的原始消息数据结构转换为适合前端展示或者导出操作所需的数据结构等情况。通过 @Mapper(componentModel = "spring") 注解， + * 它被配置为Spring框架下的组件，使得Spring容器能够对其进行管理，并支持依赖注入，方便在整个项目的不同业务模块中根据实际需求灵活调用这些映射转换方法。 * * @author xcs - * @date 2023年12月21日 18时46分 + * @date 2023年12月21日 18时46分 **/ @Mapper(componentModel = "spring") public interface MsgMapping { /** * 参数转换 + * 此方法用于将一个包含Msg类型对象的列表进行转换，按照MapStruct依据Msg类与MsgVO类中属性的对应关系自动生成的映射规则， + * 把输入的原始消息数据（msgs）转换为MsgVO类型对象的列表。MsgVO类型对象通常是对原始消息数据进行了筛选、整理后形成的，更适合用于前端展示、在业务逻辑中传递消息信息等操作场景。 * - * @param msgs 消息 - * @return MsgDTO + * @param msgs 消息，是一个包含Msg类型对象的列表，这些Msg对象包含了消息的各类详细信息，例如消息的唯一标识符、发送者与接收者信息、消息内容、发送时间等（具体取决于Msg类的定义），代表了需要进行转换的原始消息数据集合。 + * @return MsgDTO 返回一个MsgVO类型对象的列表，其中每个MsgVO对象都承载着经过转换后的消息相关信息，符合如前端展示、其他业务模块处理等操作所要求的数据格式。 */ List convert(List msgs); /** * 参数转换 + * 该方法负责把一个包含MsgVO类型对象的列表按照特定映射规则进一步转换为ExportMsgVO类型对象的列表。MapStruct根据MsgVO类与ExportMsgVO类中属性的对应关系生成相应的转换逻辑， + * 从而将适合在前端展示等场景使用的消息数据（msgVOList中的MsgVO对象所包含的消息信息）转换为更契合消息导出功能需求的数据格式（ExportMsgVO类型对象，其可能包含了如特定的导出格式排版、额外的导出相关标识等属性，具体取决于ExportMsgVO类的定义）。 * - * @param msgVOList 参数 - * @return ExportMsgVO + * @param msgVOList 参数，是一个包含MsgVO类型对象的列表，这些MsgVO对象已经是经过一次转换、更便于展示等操作的消息数据，代表了此次转换操作的输入信息集合，其具体内容取决于MsgVO类的定义。 + * @return ExportMsgVO 返回一个ExportMsgVO类型对象的列表，其中每个ExportMsgVO对象包含了经过再次转换后适合导出功能使用的消息相关信息，方便后续在业务逻辑中进行消息数据的导出操作。 */ List convertToExportMsgVO(List msgVOList); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/RecoverContactMapping.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/RecoverContactMapping.java index d774f5b..a671b45 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/RecoverContactMapping.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/RecoverContactMapping.java @@ -5,19 +5,30 @@ import com.xcs.wx.domain.vo.RecoverContactVO; import org.mapstruct.Mapper; /** - * 找回联系人 Mapping - * + * RecoverContactMapping接口主要承担着对象映射转换的功能，聚焦于“找回联系人”这一业务场景下的数据转换工作。 + * 它充当了在 `FTSContactContent` 类型数据与 `RecoverContactVO` 类型数据之间进行转换的桥梁，使得相关数据能够以更符合业务需求的形式在系统不同层级间传递，便于后续针对找回联系人业务逻辑的处理操作。 + * @author xcs - * @date 2024年6月14日15:57:18 + * @date 2024年6月14日15:57:18 **/ @Mapper(componentModel = "spring") +// @Mapper注解来自Mapstruct框架，用于表明该接口是一个专门用于定义对象转换规则的映射接口。 +// 通过设置 `componentModel = "spring"`，意味着生成的该接口对应的映射实现类将会以Spring组件的形式被管理起来。在Spring容器启动时，会自动创建映射实现类的实例， +// 这样在项目中其他需要进行这种数据转换的地方，就可以通过依赖注入的方式便捷地使用该接口提供的转换功能，使其能很好地融入基于Spring的项目架构中，方便整体的开发与集成应用。 + public interface RecoverContactMapping { /** * 参数转换 - * - * @param content 参数 - * @return RecoverContactVO + * 该方法用于将 `FTSContactContent` 类型的数据转换为 `RecoverContactVO` 类型的数据。 + * `FTSContactContent` 通常包含了与找回联系人相关的一些底层数据信息，这些信息可能涉及到联系人在特定存储结构、索引中的相关记录内容，比如联系人相关的关键词、索引标识、关联线索等属性，它反映了从数据存储层面所关联的联系人相关情况。 + * 而 `RecoverContactVO`（Value Object，值对象）则是经过对 `FTSContactContent` 里的原始数据进行加工、筛选、整合等操作后所形成的数据结构，旨在更适合在业务逻辑层向外展示或者传递给其他业务模块使用， + * 例如，它可能会提取出对于用户或者业务处理来说更直观、关键的联系人信息（如联系人姓名、联系方式、可能的关联备注等核心展示内容），并且对这些信息进行合适的格式编排与整理，以便更好地满足在找回联系人的相关业务场景下（像展示可能找回的联系人列表给用户查看、为找回操作提供准确的数据基础等）对数据展示和使用的要求。 + + * @param content 参数，以 `FTSContactContent` 类型传入，代表了需要进行转换的原始数据，这些数据承载着找回联系人业务所依赖的底层信息， + // 是整个转换操作的数据源头，其具体的属性内容依据业务中对 `FTSContactContent` 的定义而定，通过该参数传入具体的数据实例，以生成对应的 `RecoverContactVO` 数据结构，便于后续业务流程使用。 + * @return RecoverContactVO 返回类型为 `RecoverContactVO`，即经过转换后得到的符合业务展示与使用需求的数据结构对象， + // 转换后的对象可以在业务逻辑层进一步处理，比如传递给前端页面用于展示可能找回的联系人详情，或者供其他业务模块基于这些转换后的数据进行进一步的找回联系人相关的逻辑操作等，确保数据以合适的形式参与到整个业务流程之中。 */ RecoverContactVO convert(FTSContactContent content); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/SessionMapping.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/SessionMapping.java index e89eaf2..73fe762 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/SessionMapping.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/SessionMapping.java @@ -6,18 +6,23 @@ import org.mapstruct.Mapper; /** * 会话 Mapping + * 该接口旨在定义会话相关对象之间的映射转换操作，借助MapStruct框架依据Session类和SessionVO类中属性的对应关系自动生成具体的转换逻辑， + * 从而实现从一种会话数据表示形式（Session类型）转换为另一种更契合业务需求的数据表示形式（SessionVO类型），方便在不同业务场景下（比如从数据持久层获取数据后传递到展示层等情况）使用合适的数据结构来处理会话相关信息。 + * 通过 @Mapper(componentModel = "spring") 注解，将此接口配置成Spring框架下的组件，使得Spring容器可以对其进行管理，同时支持依赖注入，便于在整个项目中根据业务逻辑的需要灵活调用这个转换方法。 * * @author xcs - * @date 2023年12月21日 18时46分 + * @date 2023年12月21日 18时46分 **/ @Mapper(componentModel = "spring") public interface SessionMapping { /** * 转换参数 + * 此方法用于将会话（Session类型）对象按照由MapStruct框架生成的映射规则转换为SessionVO类型的对象。Session对象包含了会话的各种详细信息，例如会话的唯一标识符、关联的聊天对象信息、会话创建时间、最后更新时间等（具体取决于Session类的定义）， + * 经过转换后得到的SessionVO对象则是对这些信息进行了筛选、整理后形成的，更适合用于前端展示、在业务逻辑中传递会话相关数据等操作场景，使得后续业务处理可以基于更符合需求的数据结构来进行。 * - * @param session 会话 - * @return SessionVO + * @param session 会话，是一个Session类型的对象，代表需要进行转换的原始会话信息，其包含了从数据库或其他数据源获取的会话详细数据，是转换操作的数据源。 + * @return SessionVO 返回一个SessionVO类型的对象，该对象包含了经过转换后的会话相关信息，符合业务逻辑中展示、处理等操作所需要的数据格式。 */ SessionVO convert(Session session); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/UserMapping.java b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/UserMapping.java index 5027b4f..de4a6a7 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/mapping/UserMapping.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/mapping/UserMapping.java @@ -5,19 +5,31 @@ import com.xcs.wx.domain.vo.UserInfoVO; import org.mapstruct.Mapper; /** - * 用户 Mapping - * + * UserMapping接口在项目中主要负责用户相关数据结构的映射转换工作，是连接不同用户数据表现形式的桥梁， + * 其核心功能是将 `UserBO`（Business Object，业务对象）类型的数据转换为 `UserInfoVO`（Value Object，值对象）类型的数据， + * 以此使与用户相关的数据能够以更符合业务展示和使用需求的形式在系统各层级间传递、处理，满足多样化的业务场景要求。 + * @author xcs - * @date 2023年12月21日 18时46分 + * @date 2023年12月21日 18时46分 **/ @Mapper(componentModel = "spring") +// @Mapper注解来自Mapstruct框架，它的作用是标识这个接口为一个映射接口，专门用于定义对象之间的转换规则。 +// 同时设置 `componentModel = "spring"`，表示生成的该接口对应的映射实现类将会以Spring组件的形式被管理起来。在Spring容器启动时，会自动创建这个实现类的实例， +// 这样一来，在项目中其他需要进行用户数据转换的地方，就可以通过依赖注入的方式方便地获取并使用该接口提供的转换功能，使其能无缝融入基于Spring的项目架构，便于整体的开发与集成应用。 + public interface UserMapping { /** * 参数转换 - * - * @param userBO 请求参数 - * @return UserInfoVO + * 这是该接口实现数据转换功能的关键方法，它接收 `UserBO` 类型的数据作为输入参数，并将其转换为 `UserInfoVO` 类型的数据进行返回。 + * `UserBO` 作为业务对象，通常涵盖了与用户相关的较为全面且详细的业务数据，这些数据从业务操作角度出发，包含了诸如用户的登录账号、密码、注册时间、权限信息、用户状态等诸多属性，它反映了用户在业务逻辑层面的原始数据情况，主要用于业务处理过程中的各种判断、操作等。 + * 而 `UserInfoVO` 则是经过对 `UserBO` 中的原始数据进行加工、筛选、整理等操作后形成的数据结构，其设计目的是更适合在业务逻辑层向外展示或者传递给其他层级（如展示层）使用， + * 例如，它可能只选取了部分对外部展示有意义的关键属性（像用户昵称、头像链接、用户简介、性别等更便于用户直观了解的信息），并且可能对某些属性进行了格式转换（如将时间戳形式的注册时间转换为常见的日期时间格式），以便更好地满足在前端页面展示用户信息、向外部接口提供用户数据等具体业务场景下对数据展示和使用的要求。 + + * @param userBO 请求参数，以 `UserBO` 类型传入，代表了需要进行转换的原始用户数据，这些数据承载着用户在业务方面的各种具体信息， + // 是整个转换操作的数据源头，其具体的属性内容依据业务中对 `UserBO` 的定义而定，通过该参数传入相应的用户数据实例，进而生成符合业务展示与使用需求的 `UserInfoVO` 数据结构。 + * @return UserInfoVO 返回类型为 `UserInfoVO`，也就是经过转换后得到的符合业务展示与使用需求的数据结构对象， + // 转换后的对象可以在业务逻辑层进一步处理，比如传递给前端页面用于展示用户详细信息，或者供其他业务模块基于这些转换后的数据进行进一步的与用户相关的逻辑操作等，确保用户数据以合适的形式参与到整个业务流程之中。 */ UserInfoVO convert(UserBO userBO); -} +} \ No newline at end of file -- 2.34.1 From 61bbc31ed0160a5e3305978af834048c264680ad Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Mon, 16 Dec 2024 14:24:34 +0800 Subject: [PATCH 09/17] 1 --- .../main/java/com/xcs/wx/msg/MsgStrategy.java | 23 ++++++++++--- .../com/xcs/wx/msg/MsgStrategyFactory.java | 33 ++++++++++++------- .../com/xcs/wx/msg/impl/TextMsgStrategy.java | 26 +++++++++++++-- .../com/xcs/wx/msg/impl/VideoMsgStrategy.java | 26 +++++++++++++-- .../com/xcs/wx/msg/impl/VoiceMsgStrategy.java | 21 +++++++++++- .../com/xcs/wx/msg/impl/VoipMsgStrategy.java | 32 ++++++++++++++++-- 6 files changed, 135 insertions(+), 26 deletions(-) diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/MsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/MsgStrategy.java index 58acacd..9c26918 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/MsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/MsgStrategy.java @@ -3,6 +3,9 @@ package com.xcs.wx.msg; import com.xcs.wx.domain.vo.MsgVO; /** + * MsgStrategy接口定义了一套消息处理的策略规范，在整个消息处理框架中起到了核心的抽象作用， + * 它规定了具体的消息处理类需要实现的方法，用于判断是否支持某种类型的消息以及对相应消息进行具体处理操作，使得不同类型消息能按照各自对应的策略进行针对性处理，增强了消息处理模块的可扩展性和灵活性。 + * @author xcs * @date 2024年01月24日 11时44分 **/ @@ -10,17 +13,27 @@ public interface MsgStrategy { /** * 是否支持该策略 + * 此方法用于判断当前定义的消息处理策略是否适用于给定的消息类型（type）和子类型（subType）。 + * 在消息处理流程中，系统可能会接收到各种各样类型和子类型的消息，不同的消息有着不同的结构和处理要求，通过该方法可以对消息进行分类筛选， + * 只有当此方法返回true时，才意味着后续对应的消息处理逻辑（即process方法）会被调用去处理该消息，以此实现对不同消息类型的差异化处理。 * - * @param type 类型 - * @param subType 子类型 - * @return 是否支持 + * @param type 类型，以整数（Integer）类型传入，代表消息整体的分类标识，不同整数值对应不同大类的消息，是判断消息所属基本类型的重要依据， + // 比如可能存在文本消息、图片消息等不同的大类，每个大类会对应不同的type值，以便区分开来进行不同的处理逻辑调用。 + * @param subType 子类型，同样为整数（Integer）类型，是在消息类型基础上进一步细分的标识，用于更精确地界定消息的具体种类， + // 例如在图片消息大类下，可能还会根据图片来源、格式等再细分不同的子类型，与type参数配合能精准定位到具体某一种消息，从而准确判断是否适用当前的消息处理策略。 + * @return 是否支持，返回值为布尔类型（boolean），如果返回true，表示当前的消息处理策略支持对传入的这种类型和子类型组合的消息进行处理；若返回false，则表示不支持， + // 该消息会按照其他相应的处理策略或者流程进行后续处理（如果存在的话），以此实现消息处理逻辑的分流和针对性调用。 */ boolean support(Integer type, Integer subType); /** * 处理消息 + * 该方法用于对经过 `support` 方法判断为支持处理的消息进行具体的处理操作，它接收一个 `MsgVO` 类型的消息对象作为参数， + * 具体的处理逻辑会根据不同的消息类型和业务需求在实现该接口的具体类中进行定义，例如可能涉及到对消息内容的解析、格式转换、提取关键信息、设置相关属性等操作， + * 目的是将消息处理为符合系统后续使用和展示要求的形式，便于在业务逻辑中进一步运用该消息或者展示给用户查看等。 * - * @param msgVO 参数 + * @param msgVO 参数，以 `MsgVO` 类型传入，它包含了消息的各种相关信息，是整个处理流程的数据基础，不同的消息属性可以在具体的处理逻辑中按需获取和修改， + // 比如消息的原始内容、相关的附加信息等都可以通过 `MsgVO` 对象提供的方法进行访问，实现针对具体消息内容的针对性处理，使消息对象最终符合业务处理要求。 */ void process(MsgVO msgVO); -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/MsgStrategyFactory.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/MsgStrategyFactory.java index 9586187..209a521 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/MsgStrategyFactory.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/MsgStrategyFactory.java @@ -1,38 +1,47 @@ package com.xcs.wx.msg; import cn.hutool.extra.spring.SpringUtil; - import java.util.Map; import java.util.concurrent.atomic.AtomicReference; /** + * 消息策略工厂类 + * 该类主要负责根据消息的类型（type）和子类型（subType）来获取对应的消息处理策略（MsgStrategy）对象，起到了策略创建和管理的作用，是整个消息处理策略模式中的关键部分，用于协调不同类型消息与对应处理策略之间的关联。 + * * @author xcs * @date 2024年01月24日 15时55分 **/ public class MsgStrategyFactory { - private MsgStrategyFactory(){} + // 将构造函数私有化，防止外部通过new关键字创建该类的实例，因为该类提供的功能主要通过静态方法来实现，不需要外部直接实例化 + private MsgStrategyFactory() {} /** * 获取策略 + * 此静态方法是该类的核心功能，用于根据给定的消息类型和子类型查找并返回合适的消息处理策略对象（MsgStrategy）。 + * 它会从Spring容器中获取所有已注册的MsgStrategy类型的策略对象，然后遍历这些对象，判断哪个策略支持传入的消息类型和子类型，找到后返回对应的策略对象，以便后续使用该策略对相应消息进行处理。 * - * @param type 类型 - * @param subType 子类型 - * @return MsgStrategy + * @param type 类型，是一个整数，用于表示消息整体的分类情况，不同的整数值对应不同大类的消息（例如文本消息、语音消息等都有各自对应的类型值），作为查找合适策略的关键依据之一。 + * @param subType 子类型，同样为整数，是在消息已有大的类型划分基础上，进一步细分消息的具体类型，用于更精准地查找能够处理该具体类型消息的策略对象，与type参数共同确定唯一的消息类型特征。 + * @return MsgStrategy 返回一个MsgStrategy类型的对象，该对象代表了能够处理对应消息类型和子类型的具体消息处理策略，后续可通过调用其相关方法来对符合条件的消息进行处理。 */ - public static MsgStrategy getStrategy(Integer type, Integer subType) { - // 从Spring中获取所有的策略 + public static MsgStrategy getStrategy(Integer type, Integer subType) { + // 利用SpringUtil工具类从Spring容器中获取所有实现了MsgStrategy接口的Bean（即消息处理策略对象），并以键值对的形式存放在一个Map中，键为Bean的名称，值为对应的MsgStrategy对象 Map msgStrategyList = SpringUtil.getBeansOfType(MsgStrategy.class); - // 查找到的策略 + + // 创建一个AtomicReference对象，用于存放查找到的符合条件的MsgStrategy对象，AtomicReference是线程安全的，适合在多线程环境下（虽然此处不一定涉及多线程，但使用它能保证代码的健壮性）使用，确保对其内部引用对象的操作不会出现并发问题。 AtomicReference findMsgStrategy = new AtomicReference<>(); - // 遍历 + + // 对获取到的所有消息处理策略对象进行遍历，逐一检查每个策略是否支持给定的消息类型和子类型 msgStrategyList.forEach((key, msgStrategy) -> { - // 查找是否支持该策略 + // 调用每个MsgStrategy对象的support方法，传入当前的消息类型和子类型参数，判断该策略是否支持处理此类消息 + // 如果支持（即support方法返回true），则将当前的MsgStrategy对象存入findMsgStrategy中，意味着找到了合适的处理策略 if (msgStrategy.support(type, subType)) { findMsgStrategy.set(msgStrategy); } }); - // 返回 + + // 返回查找到的符合条件的消息处理策略对象，如果没有找到合适的策略（即findMsgStrategy.get()返回null），则会返回null，调用者需要进行相应的空值判断处理 return findMsgStrategy.get(); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/TextMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/TextMsgStrategy.java index 7c43738..b636ce8 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/TextMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/TextMsgStrategy.java @@ -6,6 +6,9 @@ import org.springframework.stereotype.Service; /** * 文本消息 + * 该类用于处理文本相关的消息逻辑，实现了MsgStrategy接口，意味着它是一种特定的针对文本消息的处理策略类， + * 负责对符合文本消息特征的消息进行相应的判断以及特定处理操作（虽然当前`process`方法为空实现，可能后续会补充具体文本消息相关的处理逻辑）。 + * 通过 @Service 注解将其标记为Spring服务组件，使得该类能够被Spring框架进行管理，可以方便地进行依赖注入，进而在整个项目的消息处理流程中按需被调用，参与到消息处理的整体业务逻辑当中。 * * @author xcs * @date 2024年01月24日 11时45分 @@ -13,13 +16,32 @@ import org.springframework.stereotype.Service; @Service public class TextMsgStrategy implements MsgStrategy { + /** + * 判断是否支持处理当前消息类型及子类型 + * 此方法用于确定传入的消息类型（type）和消息子类型（subType）是否符合文本消息的特征，以此来判定该策略类是否应该对传入的消息进行处理。 + * 在当前实现中，若消息类型为1且子类型为0时，则认定其为文本消息，此时该方法返回true，表示支持处理该消息；若不满足此条件（即消息类型和子类型不是对应文本消息的特定值），则返回false，表示不支持处理该消息。 + * + * @param type 消息类型，是一个整数，用于表示消息整体的分类情况，不同的整数值对应不同大类的消息（例如图片消息、语音消息等都有各自对应的类型值），在这里用于判断是否是文本消息对应的类型值。 + * @param subType 消息子类型，同样为整数，是在消息已有大的类型划分基础上，进一步细分消息的具体类型，用于更精确地判断消息是否属于文本消息这一具体类别。 + * @return boolean 如果消息类型和子类型满足文本消息的特定条件（即type == 1 && subType == 0），则返回true，表示支持处理该消息；否则返回false。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 1 && subType == 0; } + /** + * 处理文本消息的具体逻辑 + * 该方法用于对判定为文本消息（通过support方法判断）的消息进行具体的处理操作，不过目前此方法体为空，可能后续根据业务需求，会在这里添加如对文本消息内容的格式调整、提取关键信息、记录相关日志等处理逻辑， + * 以便对文本消息进行更符合业务场景要求的加工处理，方便后续在前端展示、数据存储或者其他业务环节中使用处理后的文本消息相关信息。 + * + * @param msgVO 消息视图对象，包含了消息的各种属性信息（如消息文本内容、其他相关辅助内容等），是需要进行处理和更新的对象，代表了当前要处理的文本消息的整体信息，其具体属性取决于MsgVO类的定义。 + */ @Override public void process(MsgVO msgVO) { - + // 此处暂时为空实现，后续可根据业务需求添加对文本消息的具体处理逻辑，比如： + // 1. 可以对msgVO中的文本内容进行格式校验、清洗等操作，例如去除多余的空格、特殊字符等。 + // 2. 提取文本消息中的关键信息，如提取特定关键词用于统计分析等。 + // 3. 根据文本消息内容记录相关日志，便于后续排查问题或者进行业务监控等操作。 } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VideoMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VideoMsgStrategy.java index c0fc9e9..9c9242c 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VideoMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VideoMsgStrategy.java @@ -5,21 +5,41 @@ import com.xcs.wx.msg.MsgStrategy; import org.springframework.stereotype.Service; /** - * 视频消息 - * + * VideoMsgStrategy类用于处理视频消息相关的业务逻辑，它实现了 `MsgStrategy` 接口，按照该接口定义的规则来实现针对视频消息的特定处理方法， + * 在整个消息处理体系中，负责对视频消息进行识别以及做一些基础的内容设置工作，以便系统能够区分出视频消息并在合适的场景下（比如消息展示等环节）准确体现其为视频消息这一特征。 + * @author xcs * @date 2024年01月24日 13时52分 **/ @Service +// @Service注解用于将该类标记为Spring框架下的一个服务层组件，这样一来，在Spring容器启动时会自动扫描并创建该类的实例，然后将其纳入到容器的管理范围之内， +// 方便在其他需要处理视频消息相关业务的地方通过依赖注入的方式获取该实例，以此实现组件之间的解耦，让调用变得更加灵活，确保该类能很好地融入基于Spring的项目架构之中，便于整体的项目开发与集成应用。 + public class VideoMsgStrategy implements MsgStrategy { + /** + * support方法主要用于判断给定的消息类型（type）和子类型（subType）是否与视频消息的类型相匹配，以此来确定当前的消息处理策略是否适用于接收到的消息。 + * 在整个消息处理流程里，不同类型及子类型的消息都有着各自不同的处理逻辑，该方法就充当了一个前置的筛选机制，只有当传入的消息类型和子类型符合视频消息的特定要求时，才会进入到后续本类中定义的处理流程中去。 + * + * @param type 消息类型，以整数（Integer）类型传入，它代表着消息整体的分类标识，不同的整数值对应着不同种类的消息，在这里是用于和视频消息所对应的类型值进行对比判断的依据。 + * @param subType 消息子类型，同样为整数（Integer）类型，是在消息类型基础上进一步细分的标识，能更精确地界定消息的具体种类，与type参数共同协作来精准判断是否为视频消息。 + * @return boolean 返回值是布尔类型，如果传入的type值等于34且subType值等于0，那就意味着该消息是视频消息，此时返回true；反之，若不满足这个条件，则返回false，表示当前的消息处理策略并不适用于这条消息。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 34 && subType == 0; } + /** + * process方法用于对确定为视频消息类型的消息进行具体的处理操作，它接收一个 `MsgVO` 类型的消息对象作为参数， + * 在本示例中，主要的处理操作就是将消息对象中的文本内容（`strContent`）属性设置为固定的字符串“[视频]”，这么做的目的在于，在某些消息展示场景下（例如在消息列表中展示消息的简要内容时）， + * 能够直观且清晰地向用户表明这条消息属于视频消息类型，方便用户快速识别消息的性质，当然，具体的展示逻辑以及使用场景都是要依据整个项目的业务需求来确定的。 + * + * @param msgVO 消息对象，以 `MsgVO` 类型传入，它涵盖了消息的各类相关信息，是整个处理流程所依赖的数据基础，通过修改这个对象的 `strContent` 属性， + * 让其体现出视频消息的特征，以便后续在系统中进行展示或者开展其他与之相关的业务逻辑处理工作。 + */ @Override public void process(MsgVO msgVO) { msgVO.setStrContent("[视频]"); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VoiceMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VoiceMsgStrategy.java index bfe5af2..9d2c2ec 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VoiceMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VoiceMsgStrategy.java @@ -6,6 +6,8 @@ import org.springframework.stereotype.Service; /** * 语音消息 + * 该类主要用于处理语音相关的消息逻辑，它实现了MsgStrategy接口，表明其是一种针对语音消息的特定处理策略类，负责对符合语音消息特征的消息进行相应的判断以及处理操作。 + * 通过 @Service 注解将其标记为Spring服务组件，使其能够被Spring框架进行管理，方便在项目中进行依赖注入，进而可以在整个消息处理流程里按需调用该类的功能，以完成对语音消息的相关处理工作。 * * @author xcs * @date 2024年01月24日 13时51分 @@ -13,13 +15,30 @@ import org.springframework.stereotype.Service; @Service public class VoiceMsgStrategy implements MsgStrategy { + /** + * 判断是否支持处理当前消息类型及子类型 + * 此方法用于判断传入的消息类型（type）和消息子类型（subType）是否符合语音消息的特征，以此来确定该策略类是否需要对传入的消息进行处理。 + * 在当前实现中，若消息类型为43且子类型为0时，就认定其为语音消息，此时该方法返回true，表示支持处理该消息；若不满足此条件（即消息类型和子类型不是语音消息对应的特定值），则返回false，表示不支持处理该消息。 + * + * @param type 消息类型，是一个整数，用于表示消息整体的分类情况，不同的整数值对应不同大类的消息（例如文本消息、图片消息等都有各自对应的类型值），在这里用于判断是否为语音消息对应的类型值。 + * @param subType 消息子类型，同样为整数，是在消息已有大的类型划分基础上，进一步细分消息的具体类型，以便更精准地判断消息是否确实属于语音消息这一具体类别。 + * @return boolean 如果消息类型和子类型满足语音消息的特定条件（即type == 43 && subType == 0），则返回true，表示支持处理该消息；否则返回false。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 43 && subType == 0; } + /** + * 处理语音消息的具体逻辑 + * 该方法用于对判定为语音消息（通过support方法判断）的消息进行具体的处理操作，当前的处理逻辑是将消息视图对象（MsgVO）中的文本内容（strContent）设置为固定的字符串“[语音]”， + * 这样做的目的可能是为了在前端展示或者其他业务场景中，以一种统一、直观的方式表示该消息为语音消息，方便用户识别以及后续的业务处理（比如根据消息类型进行不同的展示样式设置等）。 + * + * @param msgVO 消息视图对象，包含了消息的各种属性信息（如原本的文本内容、其他相关辅助内容等），是需要进行处理和更新的对象，代表了当前要处理的语音消息的整体信息，其具体属性取决于MsgVO类的定义。 + */ @Override public void process(MsgVO msgVO) { + // 将msgVO对象的strContent属性设置为"[语音]"，用于在展示等业务场景中表明该消息是语音消息类型 msgVO.setStrContent("[语音]"); } -} +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VoipMsgStrategy.java b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VoipMsgStrategy.java index 8df46ac..08867a9 100644 --- a/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VoipMsgStrategy.java +++ b/wx-dump-admin/src/main/java/com/xcs/wx/msg/impl/VoipMsgStrategy.java @@ -8,23 +8,49 @@ import com.xcs.wx.util.XmlUtil; import org.springframework.stereotype.Service; /** - * 语音电话消息 - * + * VoipMsgStrategy类用于处理语音电话消息相关的业务逻辑，它实现了 `MsgStrategy` 接口，按照该接口定义的规范来实现针对语音电话消息的特定处理方法， + * 在整个消息处理体系中，负责对语音电话消息进行识别，并解析其相关内容，提取关键信息后设置到消息对象中，使得系统能够合理处理和展示语音电话消息相关内容，满足业务场景下对这类消息的处理需求。 + * @author xcs * @date 2024年01月24日 14时00分 **/ @Service +// @Service注解用于将该类标记为Spring框架中的一个服务层组件，这样Spring容器在启动时会自动扫描并创建该类的实例，将其纳入到容器的管理之中， +// 方便在其他需要处理语音电话消息相关业务的地方通过依赖注入的方式获取实例，实现组件之间的解耦以及更灵活的调用，使其能很好地融入基于Spring的项目架构中。 + public class VoipMsgStrategy implements MsgStrategy { + /** + * support方法用于判断给定的消息类型（type）和子类型（subType）是否与语音电话消息的类型匹配，以此来确定当前的消息处理策略是否适用于该消息。 + * 在整个消息处理流程中，不同类型和子类型的消息会有不同的处理逻辑，该方法起到了一个前置的筛选作用，只有符合特定类型和子类型要求的消息才会进入到后续本类中定义的处理流程中。 + * + * @param type 消息类型，以整数（Integer）类型传入，代表消息的整体分类标识，不同的整数值对应不同种类的消息，在这里用于和语音电话消息的类型值进行比对判断。 + * @param subType 消息子类型，同样为整数（Integer）类型，是在消息类型基础上进一步细分的标识，用于更精确地确定消息的具体种类，与type参数共同来精准定位是否为语音电话消息。 + * @return boolean 返回值为布尔类型，如果传入的type值等于50且subType值等于0，则表示该消息是语音电话消息，返回true；否则返回false，表示不适用当前的消息处理策略。 + */ @Override public boolean support(Integer type, Integer subType) { return type == 50 && subType == 0; } + /** + * process方法用于对符合语音电话消息类型的消息进行具体的处理操作，它接收一个 `MsgVO` 类型的消息对象作为参数， + * 在方法内部，首先会对消息对象中的文本内容（`strContent`）进行非空判断，若不为空则将其作为XML内容进行解析，解析为 `VoipMsgBO` 类型的对象，再从解析后的对象中提取出关键的消息内容，并设置回消息对象的 `strContent` 属性中，以便后续在系统中进行展示或其他业务逻辑处理。 + * + * @param msgVO 消息对象，以 `MsgVO` 类型传入，它包含了消息的各种相关信息，例如消息的原始文本内容（`strContent`）以及其他可能的通用属性等，是整个处理流程的数据基础， + * 本方法会基于这个对象进行数据的解析、提取和重新设置等操作，使其包含更合适的语音电话消息相关内容，方便后续使用。 + */ @Override public void process(MsgVO msgVO) { + // Opt.ofNullable方法来自Hutool工具库，它用于对可能为null的对象进行包装处理，避免出现空指针异常。 + // 在这里，它对msgVO.getStrContent()进行判断，如果该值不为null，则进行后续的链式操作，若为null，则整个链式操作直接短路，不会执行后续步骤。 Opt.ofNullable(msgVO.getStrContent()) + // 如果msgVO.getStrContent()不为null，使用XmlUtil.parseXml方法对其进行XML解析操作，将解析后的内容转换为VoipMsgBO类型的对象。 + // XmlUtil是项目中自定义的工具类，用于处理XML解析相关的功能，通过传入的xmlContent（即msgVO.getStrContent()的值）和指定的目标类型VoipMsgBO.class， + // 尝试将XML内容解析为对应的Java对象，方便后续提取其中的语音电话消息相关数据。 .map(xmlContent -> XmlUtil.parseXml(xmlContent, VoipMsgBO.class)) + // 如果前面的XML解析操作成功，也就是成功得到了VoipMsgBO对象，那么通过ifPresent方法来执行后续的设置操作。 + // ifPresent方法会在传入的对象（voipMsgBO）不为null时执行其内部的代码块，在这里就是从VoipMsgBO对象中提取关键的消息内容，并设置到msgVO对象的strContent属性中。 .ifPresent(voipMsgBO -> msgVO.setStrContent(voipMsgBO.getVoIPBubbleMsg().getMsg())); } -} +} \ No newline at end of file -- 2.34.1 From a282eb5e4518f52fdcf694a9675f0133bc4a289f Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Tue, 17 Dec 2024 20:29:13 +0800 Subject: [PATCH 10/17] 1 --- .../main/resources/mapper/ChatRoomMapper.xml | 64 +++++++++------ .../resources/mapper/ContactHeadImgMapper.xml | 14 +++- .../main/resources/mapper/ContactMapper.xml | 80 ++++++++++++------- .../mapper/HardLinkImageAttributeMapper.xml | 21 +++-- .../mapper/HardLinkVideoAttributeMapper.xml | 22 +++-- .../src/main/resources/mapper/MsgMapper.xml | 78 ++++++++++-------- .../main/resources/mapper/SessionMapper.xml | 41 +++++----- 7 files changed, 201 insertions(+), 119 deletions(-) diff --git a/wx-dump-admin/src/main/resources/mapper/ChatRoomMapper.xml b/wx-dump-admin/src/main/resources/mapper/ChatRoomMapper.xml index 89f6cfe..96079af 100644 --- a/wx-dump-admin/src/main/resources/mapper/ChatRoomMapper.xml +++ b/wx-dump-admin/src/main/resources/mapper/ChatRoomMapper.xml @@ -1,12 +1,18 @@ + + + + @@ -15,6 +21,7 @@ + @@ -25,47 +32,54 @@ - + - + - + - + \ No newline at end of file diff --git a/wx-dump-admin/src/main/resources/mapper/ContactHeadImgMapper.xml b/wx-dump-admin/src/main/resources/mapper/ContactHeadImgMapper.xml index eda9710..133ec4a 100644 --- a/wx-dump-admin/src/main/resources/mapper/ContactHeadImgMapper.xml +++ b/wx-dump-admin/src/main/resources/mapper/ContactHeadImgMapper.xml @@ -1,17 +1,29 @@ + + + + + + + - + \ No newline at end of file diff --git a/wx-dump-admin/src/main/resources/mapper/ContactMapper.xml b/wx-dump-admin/src/main/resources/mapper/ContactMapper.xml index a70aefc..fca7b19 100644 --- a/wx-dump-admin/src/main/resources/mapper/ContactMapper.xml +++ b/wx-dump-admin/src/main/resources/mapper/ContactMapper.xml @@ -1,41 +1,58 @@ + - + - + - + - + - + - + \ No newline at end of file diff --git a/wx-dump-admin/src/main/resources/mapper/HardLinkImageAttributeMapper.xml b/wx-dump-admin/src/main/resources/mapper/HardLinkImageAttributeMapper.xml index 3f58f85..d680f27 100644 --- a/wx-dump-admin/src/main/resources/mapper/HardLinkImageAttributeMapper.xml +++ b/wx-dump-admin/src/main/resources/mapper/HardLinkImageAttributeMapper.xml @@ -1,17 +1,24 @@ + - + - + \ No newline at end of file diff --git a/wx-dump-admin/src/main/resources/mapper/HardLinkVideoAttributeMapper.xml b/wx-dump-admin/src/main/resources/mapper/HardLinkVideoAttributeMapper.xml index d4a36a6..477cc9b 100644 --- a/wx-dump-admin/src/main/resources/mapper/HardLinkVideoAttributeMapper.xml +++ b/wx-dump-admin/src/main/resources/mapper/HardLinkVideoAttributeMapper.xml @@ -1,17 +1,25 @@ + - + - + \ No newline at end of file diff --git a/wx-dump-admin/src/main/resources/mapper/MsgMapper.xml b/wx-dump-admin/src/main/resources/mapper/MsgMapper.xml index 66702cb..a95eb9b 100644 --- a/wx-dump-admin/src/main/resources/mapper/MsgMapper.xml +++ b/wx-dump-admin/src/main/resources/mapper/MsgMapper.xml @@ -1,9 +1,14 @@ + + + @@ -26,43 +31,49 @@ + - + - + - + - + - + - + \ No newline at end of file diff --git a/wx-dump-admin/src/main/resources/mapper/SessionMapper.xml b/wx-dump-admin/src/main/resources/mapper/SessionMapper.xml index 927a979..2aac29f 100644 --- a/wx-dump-admin/src/main/resources/mapper/SessionMapper.xml +++ b/wx-dump-admin/src/main/resources/mapper/SessionMapper.xml @@ -1,29 +1,34 @@ + - + - + \ No newline at end of file -- 2.34.1 From 2ad1f5f490cb5611e2d34931e8c45a0798e4523e Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Tue, 17 Dec 2024 20:36:39 +0800 Subject: [PATCH 11/17] 1 --- pom.xml | 40 +++++++++++++++++++++++ wx-dump-admin/pom.xml | 34 ++++++++++++++++++- wx-dump-dist/pom.xml | 17 ++++++++++ wx-dump-dist/src/main/assembly/binary.xml | 25 +++++++++++--- 4 files changed, 111 insertions(+), 5 deletions(-) diff --git a/pom.xml b/pom.xml index ac0163e..4e8be2a 100644 --- a/pom.xml +++ b/pom.xml @@ -3,122 +3,162 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + 4.0.0 + com.xcs.wx + wx-dump-4j + pom + ${revision} + + wx-dump-admin + wx-dump-dist + + 11 11 + 3.5.0 + UTF-8 + 1.1.0 + + org.springframework.boot spring-boot-starter-web 2.7.15 + org.springframework.boot spring-boot-starter-thymeleaf 2.7.15 + org.xerial sqlite-jdbc 3.34.0 + org.projectlombok lombok 1.18.20 + com.baomidou mybatis-plus-boot-starter 3.5.4.1 + com.baomidou dynamic-datasource-spring-boot-starter 4.2.0 + com.alibaba druid-spring-boot-starter 1.2.20 + org.mapstruct mapstruct 1.4.2.Final + org.mapstruct mapstruct-processor 1.4.2.Final + cn.hutool hutool-all 5.8.16 + net.java.dev.jna jna 5.8.0 + net.java.dev.jna jna-platform 5.8.0 + com.google.protobuf protobuf-java 3.25.1 + com.google.protobuf protobuf-java-util 3.25.1 + io.grpc grpc-all 1.11.0 + com.alibaba easyexcel 3.3.3 + org.apache.commons commons-compress 1.19 + com.fasterxml.jackson.dataformat jackson-dataformat-xml 2.13.5 + org.apache.commons commons-lang3 3.12.0 + com.xcs.wx wx-dump-admin diff --git a/wx-dump-admin/pom.xml b/wx-dump-admin/pom.xml index 815178f..03e1f6b 100644 --- a/wx-dump-admin/pom.xml +++ b/wx-dump-admin/pom.xml @@ -2,6 +2,8 @@ + + wx-dump-4j com.xcs.wx @@ -9,92 +11,123 @@ ../pom.xml + 4.0.0 + wx-dump-admin + jar + + org.springframework.boot spring-boot-starter-web + org.springframework.boot spring-boot-starter-thymeleaf + org.xerial sqlite-jdbc + org.projectlombok lombok + com.baomidou mybatis-plus-boot-starter + com.baomidou dynamic-datasource-spring-boot-starter + com.alibaba druid-spring-boot-starter + org.mapstruct mapstruct + org.mapstruct mapstruct-processor + cn.hutool hutool-all + net.java.dev.jna jna + net.java.dev.jna jna-platform + com.google.protobuf protobuf-java + com.google.protobuf protobuf-java-util + io.grpc grpc-all + com.alibaba easyexcel + org.apache.commons commons-compress + com.fasterxml.jackson.dataformat jackson-dataformat-xml + org.apache.commons commons-lang3 + + wx-dump-admin + org.apache.maven.plugins maven-compiler-plugin @@ -107,5 +140,4 @@ - \ No newline at end of file diff --git a/wx-dump-dist/pom.xml b/wx-dump-dist/pom.xml index 800fbf0..5e832f7 100644 --- a/wx-dump-dist/pom.xml +++ b/wx-dump-dist/pom.xml @@ -2,6 +2,8 @@ + + wx-dump-4j com.xcs.wx @@ -9,39 +11,54 @@ ../pom.xml + 4.0.0 + wx-dump-dist + + com.xcs.wx wx-dump-admin + + release + false + wx-dump-4j + org.apache.maven.plugins maven-assembly-plugin 3.5.0 + ${project.basedir}/src/main/assembly/binary.xml + bin + package + single diff --git a/wx-dump-dist/src/main/assembly/binary.xml b/wx-dump-dist/src/main/assembly/binary.xml index 0e0bc76..13293b6 100644 --- a/wx-dump-dist/src/main/assembly/binary.xml +++ b/wx-dump-dist/src/main/assembly/binary.xml @@ -1,23 +1,35 @@ + xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> + + bin + tar.gz + true + ${project.build.finalName}-bin + + + ../wx-dump-admin/src/main/resources + /conf + *.yml + ../wx-dump-ui/dist /html @@ -25,6 +37,7 @@ **/* + src/main/resources/bin windows @@ -36,11 +49,15 @@ + + /lib + false + runtime - + \ No newline at end of file -- 2.34.1 From 4ae85853f165aa9cb60650900fea350fb7306e7d Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Tue, 17 Dec 2024 20:53:06 +0800 Subject: [PATCH 12/17] 1 --- wx-dump-admin/pom.xml | 2 +- .../src/main/resources/application.yml | 23 ++++++++++++++++++- .../src/main/resources/proto/Msg.proto | 23 ++++++++++++++++++- .../src/main/resources/proto/RoomData.proto | 21 +++++++++++++++++ wx-dump-dist/pom.xml | 2 +- 5 files changed, 67 insertions(+), 4 deletions(-) diff --git a/wx-dump-admin/pom.xml b/wx-dump-admin/pom.xml index 03e1f6b..c6c36c6 100644 --- a/wx-dump-admin/pom.xml +++ b/wx-dump-admin/pom.xml @@ -11,7 +11,7 @@ ../pom.xml - + 4.0.0 wx-dump-admin diff --git a/wx-dump-admin/src/main/resources/application.yml b/wx-dump-admin/src/main/resources/application.yml index 7a735f0..2092500 100644 --- a/wx-dump-admin/src/main/resources/application.yml +++ b/wx-dump-admin/src/main/resources/application.yml @@ -3,25 +3,38 @@ spring: druid: stat-view-servlet: enabled: true + # 启用 Druid 数据源的监控页面相关的 Servlet，设置为 true 表示开启该功能，这样可以通过访问对应的页面来查看数据源的监控信息，比如连接数、SQL 执行情况等。 login-username: admin + # 设置访问 Druid 监控页面的登录用户名，这里设置为 "admin"，用于权限验证，确保只有授权用户可以查看监控数据。 login-password: 123456 + # 设置访问 Druid 监控页面的登录密码，为 "123456"，与用户名配合进行身份认证。 dynamic: druid: initial-size: 5 + # 设置 Druid 连接池初始化时创建的连接数量为 5 个，即项目启动时就会预先创建好这么多数据库连接，方便后续使用，避免频繁创建连接带来的性能开销。 max-active: 8 + # 定义连接池中最大的活动连接数为 8 个，也就是同时最多可以有 8 个数据库连接处于使用状态，超过这个数量后续请求获取连接时可能需要等待。 min-idle: 3 + # 设置连接池中最小的空闲连接数为 3 个，当空闲连接数低于这个值时，连接池可能会自动创建新的连接补充，以保证有足够的空闲连接可用于后续请求。 max-wait: 1000 + # 设置获取连接时的最大等待时间为 1000 毫秒（1 秒），如果在这个时间内无法获取到可用连接，可能会抛出相应的异常，避免长时间等待导致系统性能问题。 test-while-idle: false + # 设置为 false 表示在连接空闲时不进行有效性检测，通常在一些场景下，如果不需要频繁检测空闲连接是否可用，可以设置为 false 来减少性能开销；若设置为 true，则会按一定规则检测空闲连接能否正常使用。 + wechat-offset: version: "[3.9.8.25]": nickname: 65000920 + # 针对版本号为 "3.9.8.25" 的配置项，设置昵称对应的数值为 65000920，具体该数值代表的实际含义需结合业务场景来确定，可能是某种内部编码或者特定的业务标识等。 account: 65002256 + # 设置账号对应的数值为 65002256，同样其具体意义取决于具体的业务逻辑，可能与微信账号相关的某种映射或者配置有关。 mobile: 65000728 + # 设置手机号对应的数值为 65000728，也许是在业务处理中对手机号进行了特定的编码或者关联了其他相关属性，这里通过配置文件进行统一管理。 "[3.9.9.27]": nickname: 68065304 account: 68065080 mobile: 68065112 + # 以下各版本号下的配置项同理，都是针对不同版本分别设置昵称、账号、手机号对应的数值，方便根据不同的微信版本进行差异化的业务处理和数据关联。 "[3.9.9.35]": nickname: 68065304 account: 68065080 @@ -66,15 +79,23 @@ wechat-offset: nickname: 93834984 account: 93834760 mobile: 93834792 + mybatis-plus: global-config: banner: off + # 将 MyBatis Plus 的启动 banner（启动时显示的 logo 和相关信息）关闭，设置为 "off" 表示不显示，在一些生产环境或者不需要展示该信息的场景下可以进行这样的设置，避免输出过多不必要的信息。 #configuration: #log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #开启sql日志 + # 这部分被注释掉了，如果取消注释，通过指定 "log-impl" 为 "org.apache.ibatis.logging.stdout.StdOutImpl"，则可以开启 MyBatis Plus 的 SQL 日志功能， + # 这样在项目运行时会将执行的 SQL 语句打印到控制台，方便调试和查看数据库操作情况，但在生产环境一般不建议开启，以免产生大量日志影响性能和占用过多存储空间。 + logging: level: root: INFO + # 设置项目日志的根级别为 INFO，意味着 INFO 级别及以上（如 WARN、ERROR 等）的日志消息会被输出，用于记录项目整体运行过程中的一般性信息，方便查看项目运行状态。 com.alibaba.druid.pool.DruidDataSource: WARN + # 将阿里巴巴 Druid 数据源连接池相关的日志级别设置为 WARN，即只有 WARN 级别及以上的关于 Druid 数据源的日志消息才会被输出，避免输出过多的连接池相关的低级别日志信息，减少日志量。 com.baomidou.dynamic.datasource.DynamicRoutingDataSource: WARN + # 针对 MyBatis Plus 的动态数据源相关模块（DynamicRoutingDataSource）设置日志级别为 WARN，同样是为了控制该部分产生的日志数量，只输出重要的警告及以上级别的日志。 com.baomidou.dynamic.datasource.destroyer.DefaultDataSourceDestroyer: WARN - + # 对 MyBatis Plus 的默认数据源销毁器（DefaultDataSourceDestroyer）模块设置日志级别为 WARN，控制该模块输出的日志内容，聚焦在重要的警告等情况的记录上。 \ No newline at end of file diff --git a/wx-dump-admin/src/main/resources/proto/Msg.proto b/wx-dump-admin/src/main/resources/proto/Msg.proto index dc1d0a1..50f860c 100644 --- a/wx-dump-admin/src/main/resources/proto/Msg.proto +++ b/wx-dump-admin/src/main/resources/proto/Msg.proto @@ -1,18 +1,39 @@ syntax = "proto3"; +// 声明使用的 Protocol Buffers 语法版本为3，这决定了后续定义消息结构等元素所遵循的语法规则。 +// 例如，proto3 相比之前的版本在一些默认行为、特性上有差异，比如字段默认是非必填的等。 option java_outer_classname = "MsgProto"; +// 这是一个针对 Java 语言的特定选项配置，用于指定生成的 Java 类的外部类名。 +// 当使用 Protocol Buffers 编译器根据这个.proto 文件生成 Java 代码时，所有相关的消息类型等都会被包装在一个名为 "MsgProto" 的外部类里面， +// 方便在 Java 项目中进行调用和使用，以符合 Java 的代码组织和命名规范。 message SubMessage1 { + // 开始定义一个名为 "SubMessage1" 的消息类型，消息类型可以理解为一种结构化的数据模板，用于描述要传输或存储的数据格式。 int32 field1 = 1; + // 定义消息中的一个字段 "field1"，类型为 32 位整数（int32）， + // 后面的 "= 1" 是字段编号，在 Protocol Buffers 中每个字段都有唯一的编号，用于在序列化和反序列化过程中标识该字段， + // 编号取值范围是 1 到 15 的字段占用一个字节进行编码，这有助于优化序列化后的数据大小，同时要求 1 到 15 之间的编号不能重复。 int32 field2 = 2; + // 定义另一个字段 "field2"，同样是 32 位整数类型，编号为 2，用于存储不同的整数值数据，与 "field1" 一起构成 "SubMessage1" 这个消息结构的一部分。 } +// 这里的注释只是起到分隔不同消息定义的作用，增强代码的可读性，本身在 Protocol Buffers 语法中没有实际功能意义。 + message SubMessage2 { int32 field1 = 1; + // 定义 "SubMessage2" 消息中的字段 "field1"，为 32 位整数类型，编号为 1，作用与前面 "SubMessage1" 中的字段类似，用于承载对应类型的数据。 string field2 = 2; + // 定义 "SubMessage2" 消息中的另一个字段 "field2"，类型为字符串（string），编号为 2，用于存储文本字符串数据，丰富了 "SubMessage2" 消息结构的内容。 } +// 同样是用于代码分隔的注释，提高整体代码结构的清晰程度。 + message MessageBytesExtra { + // 定义一个新的消息类型 "MessageBytesExtra"，它可能用于更复杂的数据组织场景，会包含其他消息类型作为其内部结构的一部分。 SubMessage1 message1 = 1; + // 在 "MessageBytesExtra" 消息中定义一个字段 "message1"，类型为前面定义的 "SubMessage1" 消息类型，编号为 1， + // 意味着这个字段可以存储符合 "SubMessage1" 结构定义的数据，用于组合更复杂的数据结构，实现数据的嵌套表示。 repeated SubMessage2 message2 = 3; -} + // 在 "MessageBytesExtra" 消息中定义另一个字段 "message2"，类型为 "SubMessage2"，但这里使用了 "repeated" 关键字， + // 表示该字段可以包含多个（零个或多个）"SubMessage2" 类型的数据，类似于数组或列表的概念，编号为 3，用于存放一组相关的 "SubMessage2" 结构的数据。 +} \ No newline at end of file diff --git a/wx-dump-admin/src/main/resources/proto/RoomData.proto b/wx-dump-admin/src/main/resources/proto/RoomData.proto index 3b5761b..8877cb9 100644 --- a/wx-dump-admin/src/main/resources/proto/RoomData.proto +++ b/wx-dump-admin/src/main/resources/proto/RoomData.proto @@ -1,20 +1,41 @@ syntax = "proto3"; +// 声明使用的是 Protocol Buffers 语法版本为 3，这决定了后续定义消息类型、字段等元素所遵循的具体语法规则。 +// 例如在 proto3 中，默认情况下字段是可选的（非必填），并且对一些数据类型的处理方式和默认值设定等方面与之前版本有所不同。 option java_outer_classname = "ChatRoomProto"; +// 这是一个针对 Java 语言特有的选项配置，指定了在使用 Protocol Buffers 编译器生成 Java 代码时，所有相关的消息类型等会被包装在一个名为 "ChatRoomProto" 的外部类里面。 +// 这样做能让生成的代码更好地遵循 Java 的代码组织结构和命名规范，方便在 Java 项目中对这些消息结构进行调用和使用。 +// 开始定义名为 "ChatRoom" 的消息类型，它可以看作是一种用于描述特定数据结构的模板，用于在通信或者存储场景中表示和传递相关的数据。 message ChatRoom { repeated Member members = 1; + // 定义一个名为 "members" 的字段，类型为 "Member" 消息类型的重复字段（使用 "repeated" 关键字表示），类似于数组或者列表的概念， + // 意味着这个字段可以包含零个或多个 "Member" 类型的数据。编号为 1，用于在序列化和反序列化过程中唯一标识该字段， + // 这里它大概率用于存储聊天室内所有成员的相关信息，以构建聊天室内成员的集合数据结构。 int32 field2 = 2; + // 定义一个名为 "field2" 的 32 位整数类型（int32）字段，编号为 2，具体含义需根据实际业务场景确定，它可以用来存储聊天室内某个与整数相关的属性值。 int32 field3 = 3; + // 类似地，定义 "field3" 字段，同样是 32 位整数类型，编号为 3，也是用于承载聊天室内某个对应整数值属性的数据，具体用途取决于具体应用场景。 int32 field4 = 4; + // 定义 "field4" 字段，为 32 位整数类型，编号为 4，用于存放聊天室内特定的整数值相关数据，其实际代表的业务含义要结合使用场景来判断。 int32 roomCapacity = 5; + // 定义 "roomCapacity" 字段，类型是 32 位整数，编号为 5，从名字推测其含义可能是用于表示这个聊天室（聊天房间）的容量大小，即最多能容纳的成员数量等相关信息。 int32 field6 = 6; + // 定义 "field6" 字段，为 32 位整数类型，编号为 6，用于存储聊天室内某个整数属性相关的数据，具体功能需依据实际业务逻辑确定。 int64 field7 = 7; + // 定义 "field7" 字段，类型为 64 位整数（int64），编号为 7，可用于存储需要更大整数范围来表示的聊天室内相关属性值，比如可能是某种时间戳或者较大的计数等数据。 int64 field8 = 8; + // 定义 "field8" 字段，同样是 64 位整数类型，编号为 8，用于承载聊天室内特定的长整型数据，其具体含义取决于业务场景中的具体需求。 } +// 此处注释用于分隔不同消息类型的定义，增强代码结构的清晰性，在 Protocol Buffers 语法里它本身没有实际的功能作用。 + +// 定义名为 "Member" 的消息类型，用于描述聊天室内单个成员的相关信息结构，方便在 "ChatRoom" 消息中作为成员集合的元素进行数据组织。 message Member { string wxId = 1; + // 定义一个名为 "wxId" 的字段，类型为字符串（string），编号为 1，通常可用于存储成员在某个系统（可能是微信相关系统，从名字推测）中的唯一标识，比如微信用户的 ID 等信息，以便区分不同成员。 string remark = 2; + // 定义 "remark" 字段，也是字符串类型，编号为 2，大概率用于存储对该成员的备注信息，比如在聊天室内给成员添加的个性化备注名称等内容。 int32 state = 3; + // 定义 "state" 字段，类型为 32 位整数，编号为 3，一般可用于表示成员在聊天室内的某种状态信息，例如是否在线、是否禁言等不同的状态值，具体含义取决于业务逻辑设定。 } \ No newline at end of file diff --git a/wx-dump-dist/pom.xml b/wx-dump-dist/pom.xml index 5e832f7..e69c453 100644 --- a/wx-dump-dist/pom.xml +++ b/wx-dump-dist/pom.xml @@ -58,7 +58,7 @@ package - + single -- 2.34.1 From 2d36f956b80295cea2005ca3df2f9541490e297d Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Tue, 17 Dec 2024 21:04:06 +0800 Subject: [PATCH 13/17] 1 --- .../src/pages/Components/CountRecentMsg.tsx | 33 +++++++ wx-dump-ui/src/pages/Components/Github.tsx | 14 +++ .../src/pages/Components/MsgCategory.tsx | 39 +++++++++ .../pages/Components/RecentUsedKeyWord.tsx | 36 ++++++++ .../src/pages/Components/StatsPanel.tsx | 85 +++++++++++-------- .../src/pages/Components/TopContacts.tsx | 49 ++++++++++- 6 files changed, 221 insertions(+), 35 deletions(-) diff --git a/wx-dump-ui/src/pages/Components/CountRecentMsg.tsx b/wx-dump-ui/src/pages/Components/CountRecentMsg.tsx index d18d076..ff47350 100644 --- a/wx-dump-ui/src/pages/Components/CountRecentMsg.tsx +++ b/wx-dump-ui/src/pages/Components/CountRecentMsg.tsx @@ -1,20 +1,43 @@ import { countRecentMsgs } from '@/services/DashBoard'; +// 从项目中相对路径为 '@/services/DashBoard' 的模块里导入名为 'countRecentMsgs' 的函数， +// 从名字推测这个函数可能用于获取近期消息相关的数据，比如向服务器端发起请求获取近期消息的数量等信息。 + import { Line } from '@ant-design/plots'; +// 从 Ant Design 的图表库（@ant-design/plots）中导入 'Line' 组件，这个组件通常用于绘制折线图， +// 在这里应该是用来展示消息数量随时间或其他维度变化的可视化效果。 + import React, { useEffect, useState } from 'react'; +// 导入 React 框架以及它的两个 hooks：'useEffect' 和 'useState'。 +// 'useEffect' 用于在函数组件中执行副作用操作，比如数据获取、订阅、手动修改 DOM 等； +// 'useState' 用于在函数组件中添加状态，让组件能够根据不同状态进行重新渲染。 const CountRecentMsg: React.FC = () => { + // 定义一个名为 'CountRecentMsg' 的函数式组件，它遵循 React.FC（Function Component）类型定义，也就是一个接收 props 并返回 React 元素的函数。 const [data, setData] = useState([]); + // 使用 'useState' hook 来创建一个名为 'data' 的状态变量，初始值是一个空数组，其类型被定义为 'CountRecentMsgItem' 类型的数组， + // 这个状态变量大概率用于存储从服务器获取到的消息数量相关的数据，后续会根据获取到的数据进行更新并用于图表展示。 + const [isLoading, setIsLoading] = useState(false); + // 再使用 'useState' hook 创建另一个名为 'isLoading' 的状态变量，初始值为 false，用于表示当前是否正在加载数据的状态， + // 当发起数据请求时会将其设置为 true，数据请求完成后再设置回 false，方便在界面上展示加载提示等相关效果。 const getDailyMsgCount = async () => { + // 定义一个名为 'getDailyMsgCount' 的异步函数，用于获取每日消息数量的数据。 setIsLoading(true); + // 在发起数据请求前，先将 'isLoading' 状态设置为 true，表示数据正在加载中，这样可以在界面上显示相应的加载提示（比如加载动画等）。 try { const response = await countRecentMsgs(); + // 调用之前导入的 'countRecentMsgs' 函数，它返回一个 Promise，通过 'await' 等待这个 Promise 被 resolve（即请求完成并返回数据）， + // 将返回的结果赋值给'response' 变量，这里的结果应该包含了消息数量相关的数据。 setData(response.data); + // 从'response' 中取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际要展示的数据）， + // 并通过'setData' 函数更新 'data' 状态变量，这样组件会根据新的数据重新渲染，进而更新图表展示的内容。 } catch (error) { console.error(error); + // 如果在请求数据过程中出现错误（比如网络问题、服务器返回错误等），通过 'console.error' 将错误信息打印到控制台，方便进行调试和错误排查。 } setIsLoading(false); + // 无论请求成功还是失败，最终都将 'isLoading' 状态设置回 false，表示数据加载完成，隐藏加载提示等相关界面元素。 }; const config = { @@ -26,12 +49,22 @@ const CountRecentMsg: React.FC = () => { }, colorField: 'category', }; + // 创建一个名为 'config' 的配置对象，用于配置 'Line' 图表组件的各项属性。 + // 'data' 属性使用了之前定义的 'data' 状态变量，提供图表要展示的数据； + // 'xField' 和 'yField' 分别指定了图表中 X 轴和 Y 轴对应的数据字段名（假设数据结构中有 'type' 和 'value' 这样的字段用于标识坐标轴对应的数值）； + //'style' 用于设置图表的样式，这里设置了折线的宽度为 2； + // 'colorField' 指定了用于区分不同类别数据时依据的字段名（假设数据中有 'category' 字段来区分不同类型的消息等情况），不同类别数据会以不同颜色展示。 useEffect(() => { getDailyMsgCount(); }, []); + // 使用 'useEffect' hook，传入一个回调函数（这里是调用 'getDailyMsgCount' 函数来获取数据）和一个空的依赖项数组 []。 + // 空的依赖项数组表示这个副作用操作（获取数据）只会在组件初次挂载时执行一次，相当于组件加载完成后立即发起数据请求，获取消息数量数据用于图表展示。 return ; + // 返回一个 'Line' 图表组件，将 'isLoading' 状态作为 'loading' 属性传递给 'Line' 组件，用于控制组件在数据加载时是否显示加载提示效果， + // 同时通过展开运算符 {...config} 将之前定义的 'config' 对象中的属性展开传递给 'Line' 组件，用于配置图表的具体展示效果。 }; export default CountRecentMsg; +// 将定义好的 'CountRecentMsg' 函数式组件作为默认导出，方便在其他模块中导入并使用这个组件来展示消息数量统计的折线图。 diff --git a/wx-dump-ui/src/pages/Components/Github.tsx b/wx-dump-ui/src/pages/Components/Github.tsx index 2f59f42..c1be48f 100644 --- a/wx-dump-ui/src/pages/Components/Github.tsx +++ b/wx-dump-ui/src/pages/Components/Github.tsx @@ -1,7 +1,12 @@ import React, { useState, useEffect } from 'react'; +// 从 React 库中导入 React 核心以及两个常用的 Hook：'useState' 和 'useEffect'。 +// 在这个组件中虽然没有实际用到 'useState'（用于管理组件的状态）和 'useEffect'（用于处理组件的副作用，比如数据获取、订阅等操作），但仍然进行了导入，以备后续可能的功能扩展使用。 + import { GithubOutlined } from '@ant-design/icons'; +// 从 Ant Design 的图标库中导入名为 'GithubOutlined' 的图标组件，这个图标呈现的是 GitHub 的标志样式，将用于在页面上直观地展示 GitHub 相关的链接入口。 const Github: React.FC = () => { + // 定义一个名为 'Github' 的函数式组件，遵循 React.FC（Function Component）的类型定义，也就是一个接收 props（属性）并返回 React 元素的函数，在这里它用于构建一个特定功能的 UI 组件。 return (
{
); + // 返回一个
元素作为组件的 UI 结构呈现。 + // 这个
元素设置了内联样式（style 属性），通过 JavaScript 对象的形式定义了样式规则： + // - 'display: 'flex'' 表示将该
元素设置为弹性布局，方便对内部元素（这里主要是图标）进行排列布局，使其更符合页面设计需求。 + // - 'height: 26' 设置了
元素的高度为 26 像素，确定了该组件在页面上占据的垂直空间大小。 + // 同时，为这个
元素添加了一个点击事件处理函数（onClick），当用户点击这个
元素时，会执行内部的函数逻辑。 + // 函数内部调用了 'window.open' 方法，传入一个 URL 地址（https://github.com/xuchengsheng/wx-dump-4j），作用是在新的浏览器窗口或标签页中打开指定的 GitHub 仓库页面， + // 方便用户访问项目对应的 GitHub 仓库，查看代码、提交记录等相关信息。 + // 在
元素内部放置了 ''，也就是之前导入的 Ant Design 的 GitHub 图标组件，该图标会显示在页面上，作为可点击的 GitHub 链接的可视化标识。 }; export default Github; +// 将定义好的 'Github' 函数式组件作为默认导出，这样在其他 React 组件或者模块中就可以通过导入的方式使用这个组件，将其嵌入到更复杂的页面结构中，以提供指向 GitHub 仓库的入口功能。 diff --git a/wx-dump-ui/src/pages/Components/MsgCategory.tsx b/wx-dump-ui/src/pages/Components/MsgCategory.tsx index 682743e..543566a 100644 --- a/wx-dump-ui/src/pages/Components/MsgCategory.tsx +++ b/wx-dump-ui/src/pages/Components/MsgCategory.tsx @@ -1,20 +1,43 @@ import { msgTypeDistribution } from '@/services/DashBoard'; +// 从项目中相对路径为 '@/services/DashBoard' 的模块里导入名为'msgTypeDistribution' 的函数， +// 从函数名推测它的作用可能是向服务器端发起请求，获取消息类型分布相关的数据，比如不同类型消息所占的比例等信息。 + import { Pie } from '@ant-design/plots'; +// 从 Ant Design 的图表库（@ant-design/plots）中导入 'Pie' 组件，'Pie' 组件通常用于绘制饼图， +// 在这里用于以可视化的方式展示消息类型的分布情况，使不同类型消息占比一目了然。 + import React, { useEffect, useState } from 'react'; +// 导入 React 框架以及两个常用的 React hooks：'useEffect' 和 'useState'。 +// 'useEffect' 用于在函数组件中执行副作用操作，像发起网络请求、订阅数据更新、操作 DOM 等； +// 'useState' 用于在函数组件中定义和管理状态，组件会根据状态的变化重新渲染。 const MsgCategory: React.FC = () => { + // 定义一个名为 'MsgCategory' 的函数式组件，遵循 React.FC（Function Component）类型定义，即它是一个接收 props（属性）并返回 React 元素的函数，用于构建特定的 UI 界面及相应功能。 const [data, setData] = useState([]); + // 使用 'useState' hook 创建一个名为 'data' 的状态变量，其初始值设置为一个空数组，类型被定义为 'MsgTypeDistributionItem' 类型的数组， + // 这个状态变量用于存储从服务器获取到的消息类型分布相关的数据，后续会根据实际获取的数据进行更新，以便在饼图中展示相应内容。 + const [isLoading, setIsLoading] = useState(false); + // 再次使用 'useState' hook 创建另一个状态变量 'isLoading'，初始值设为 false，用于表示当前是否正在加载数据的状态， + // 当发起数据请求时将其设置为 true，请求完成后再设置回 false，方便在界面上展示数据加载的提示效果，比如显示加载动画等。 const getMsgTypeDistribution = async () => { + // 定义一个名为 'getMsgTypeDistribution' 的异步函数，用于获取消息类型分布的数据。 setIsLoading(true); + // 在发起数据请求前，先把 'isLoading' 状态变量设置为 true，告知用户当前正在加载数据，界面上可以据此显示相应的加载提示元素。 try { const response = await msgTypeDistribution(); + // 调用之前导入的'msgTypeDistribution' 函数，它返回一个 Promise，通过 'await' 等待这个 Promise 被 resolve（也就是请求完成并返回数据）， + // 将返回的结果赋值给'response' 变量，该结果应该包含了消息类型分布相关的数据内容。 setData(response.data); + // 从'response' 变量中取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际要展示的数据）， + // 然后使用'setData' 函数更新 'data' 状态变量，这样组件会根据新的数据重新渲染，进而使饼图展示最新的消息类型分布情况。 } catch (error) { console.error(error); + // 如果在请求数据过程中出现错误，比如网络连接问题、服务器返回错误等，通过 'console.error' 把错误信息打印到控制台，便于进行调试和错误排查。 } setIsLoading(false); + // 无论数据请求成功与否，最后都将 'isLoading' 状态变量设置回 false，表示数据加载已完成，相应地可以隐藏界面上的加载提示元素。 }; const config = { @@ -34,12 +57,28 @@ const MsgCategory: React.FC = () => { }, }, }; + // 创建一个名为 'config' 的配置对象，用于设置 'Pie' 饼图组件的各项属性。 + // 'data' 属性使用了前面定义的 'data' 状态变量，为饼图提供要展示的数据内容。 + // 'title' 属性设置饼图的标题为 '消息类别'，直观地告知用户该饼图展示的内容主题。 + // 'angleField' 指定了在数据中用于确定每个扇形角度大小（也就是占比情况）所对应的字段名为 'value'，意味着根据数据里 'value' 字段的值来划分各个扇形的大小比例。 + // 'colorField' 设定依据 'type' 字段的值来确定每个扇形的颜色，以便区分不同类型的消息，不同类型消息对应的扇形会显示不同颜色。 + // 'radius' 属性设置饼图的半径为 0.9（这里是相对值，基于图表容器的大小来确定实际半径大小），用于调整饼图在图表区域内的显示尺寸。 + // 'tooltip' 用于配置当鼠标悬停在饼图扇形上时显示的提示信息，这里设置提示信息的标题为 'value'，具体显示内容可能还会根据数据结构及相关配置进一步确定。 + // 'legend' 用于配置图例相关属性，'color' 里面的设置如下： + // - 'title' 设置为 false，表示不显示图例的标题，使图例显示更简洁。 + // - 'position' 设置为 'bottom'，指定图例的位置在饼图下方，方便用户对照查看不同颜色扇形代表的消息类型。 + // - 'rowPadding' 设置为 5，可能是用于控制图例每行之间的间距，优化图例的显示布局。 useEffect(() => { getMsgTypeDistribution(); }, []); + // 使用 'useEffect' hook，传入一个回调函数（这里是调用 'getMsgTypeDistribution' 函数来获取数据）和一个空的依赖项数组 []。 + // 空的依赖项数组意味着这个副作用操作（获取数据）只会在组件初次挂载时执行一次，即组件加载完成后马上发起数据请求，获取消息类型分布数据用于饼图展示。 return ; + // 返回一个 'Pie' 饼图组件，将 'isLoading' 状态变量作为 'loading' 属性传递给 'Pie' 组件，用于控制组件在数据加载过程中是否显示加载提示效果， + // 同时通过展开运算符 {...config} 将前面定义的 'config' 对象中的属性展开传递给 'Pie' 组件，以此配置饼图的具体展示样式和交互行为等内容。 }; export default MsgCategory; +// 将定义好的 'MsgCategory' 函数式组件作为默认导出，方便其他模块在需要展示消息类型分布情况时导入并使用这个组件，使其融入到更复杂的前端页面结构中。 diff --git a/wx-dump-ui/src/pages/Components/RecentUsedKeyWord.tsx b/wx-dump-ui/src/pages/Components/RecentUsedKeyWord.tsx index 8d5947a..86c817b 100644 --- a/wx-dump-ui/src/pages/Components/RecentUsedKeyWord.tsx +++ b/wx-dump-ui/src/pages/Components/RecentUsedKeyWord.tsx @@ -1,25 +1,52 @@ import { queryRecentUsedKeyWord } from '@/services/DashBoard'; +// 从项目中相对路径为 '@/services/DashBoard' 的模块里导入名为 'queryRecentUsedKeyWord' 的函数， +// 从函数名推测它的功能大概率是向服务器端发起请求，以获取近期使用过的关键词相关的数据信息，例如关键词及其出现的频次等内容。 + import { WordCloud } from '@ant-design/plots'; +// 从 Ant Design 的图表库（@ant-design/plots）中导入 'WordCloud' 组件，'WordCloud' 即词云图组件， +// 通常用于以可视化的方式呈现文本数据中不同关键词的重要程度或出现频率等情况，在这里是要展示近期使用关键词的相关信息。 + import React, { useEffect, useState } from 'react'; +// 导入 React 框架以及两个常用的 React hooks：'useEffect' 和 'useState'。 +// 'useEffect' 可用于在函数组件中处理副作用，像发起网络请求、订阅外部数据源、操作 DOM 等操作； +// 'useState' 则用于在函数组件里定义和管理状态，组件会依据状态的变化进行重新渲染。 const RecentUsedKeyWord: React.FC = () => { + // 定义一个名为 'RecentUsedKeyWord' 的函数式组件，遵循 React.FC（Function Component）的类型定义，意味着它是一个接收 props（属性）并返回 React 元素的函数， + // 其主要目的是构建出特定功能与 UI 展示效果的组件，用于展示近期使用关键词相关内容。 const [data, setData] = useState([]); + // 使用 'useState' hook 创建一个名为 'data' 的状态变量，初始值设为一个空数组，其类型被定义为 'RecentUsedKeyWordItem' 类型的数组， + // 这个状态变量用于存放从服务器获取到的近期使用关键词相关的数据，后续会根据实际获取的数据进行更新，进而在词云图中展示相应的关键词信息。 + const [isLoading, setIsLoading] = useState(false); + // 同样使用 'useState' hook 创建 'isLoading' 这个状态变量，初始值设定为 false，它用于表示当前是否正在加载数据的状态， + // 当发起数据请求时会将其设置为 true，待请求完成后再变回 false，方便在界面上展示相应的数据加载提示效果，例如显示加载动画等。 const getRecentUsedKeyWord = async () => { + // 定义一个名为 'getRecentUsedKeyWord' 的异步函数，该函数的主要作用是获取近期使用的关键词数据。 setIsLoading(true); + // 在准备发起数据请求之前，先将 'isLoading' 状态变量的值设置为 true，以此告知用户当前正在进行数据加载操作，界面上可据此展示相应的加载提示元素。 try { const response = await queryRecentUsedKeyWord(); + // 调用之前导入的 'queryRecentUsedKeyWord' 函数，它返回一个 Promise，通过 'await' 关键字等待这个 Promise 被成功 resolve（也就是请求完成且返回了数据）， + // 然后将返回的结果赋值给'response' 变量，这里的结果应该包含了近期使用关键词相关的数据内容。 setData(response.data); + // 从'response' 变量中提取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际要展示的数据）， + // 接着使用'setData' 函数来更新 'data' 状态变量，如此一来，组件会根据新的数据重新渲染，使得词云图能够展示最新的关键词情况。 } catch (error) { console.error(error); + // 倘若在请求数据的过程中出现了错误，例如网络连接故障、服务器返回错误信息等情况，就通过 'console.error' 方法将错误信息打印到控制台， + // 方便后续进行调试以及错误排查工作。 } setIsLoading(false); + // 不管数据请求最终是成功还是失败，都要把 'isLoading' 状态变量的值重新设置为 false，表示数据加载操作已经结束，相应地可以隐藏界面上的加载提示元素。 }; useEffect(() => { getRecentUsedKeyWord(); }, []); + // 使用 'useEffect' hook，传入一个回调函数（此处是调用 'getRecentUsedKeyWord' 函数去获取数据）以及一个空的依赖项数组 []。 + // 空的依赖项数组意味着这个副作用操作（也就是获取数据的操作）只会在组件初次挂载时执行一次，即组件加载完毕后会立即发起数据请求，获取近期使用关键词的数据用于词云图展示。 const config = { paddingTop: 40, @@ -27,8 +54,17 @@ const RecentUsedKeyWord: React.FC = () => { layout: { spiral: 'rectangular' }, colorField: 'text', }; + // 创建一个名为 'config' 的配置对象，用于设定 'WordCloud' 词云图组件的各项属性。 + // 'paddingTop' 属性设置词云图组件上方的内边距为 40 像素，用于调整词云图在其容器内的布局位置，使其展示效果更符合页面设计需求。 + // 'data' 属性使用了之前定义的 'data' 状态变量，为词云图提供要展示的关键词相关的数据内容，词云图会依据这些数据来生成相应的可视化效果。 + // 'layout' 属性用于配置词云图中文字的布局方式，这里设置为 { spiral: 'rectangular' }，表示采用矩形螺旋布局，也就是文字会按照矩形螺旋的形状排列， + // 不同的布局方式会呈现出不同的视觉效果，可根据实际需求进行选择。 + // 'colorField' 属性指定了依据 'text' 字段的值来确定每个关键词文字在词云图中的颜色，这样可以让不同的关键词以不同颜色显示，增强可视化的区分度。 return ; + // 返回一个 'WordCloud' 词云图组件，将 'isLoading' 状态变量作为 'loading' 属性传递给 'WordCloud' 组件，以此来控制组件在数据加载期间是否显示加载提示效果， + // 同时通过展开运算符 {...config} 将前面定义的 'config' 对象中的属性展开传递给 'WordCloud' 组件，从而配置词云图的具体展示样式、布局以及颜色等相关内容。 }; export default RecentUsedKeyWord; +// 将定义好的 'RecentUsedKeyWord' 函数式组件作为默认导出，方便其他模块在需要展示近期使用关键词情况时，能够导入并使用这个组件，使其融入到更复杂的前端页面结构之中。 diff --git a/wx-dump-ui/src/pages/Components/StatsPanel.tsx b/wx-dump-ui/src/pages/Components/StatsPanel.tsx index fc25f23..cc8045f 100644 --- a/wx-dump-ui/src/pages/Components/StatsPanel.tsx +++ b/wx-dump-ui/src/pages/Components/StatsPanel.tsx @@ -1,30 +1,60 @@ import { statsPanel } from '@/services/DashBoard'; +// 从项目中相对路径为 '@/services/DashBoard' 的模块里导入名为'statsPanel' 的函数， +// 从函数名推测它的作用大概率是向服务器端发起请求，获取用于展示在统计面板上的相关数据，例如好友数量、消息收发数量等信息。 + import RcResizeObserver from 'rc-resize-observer'; +// 导入 'rc-resize-observer' 这个库提供的 'RcResizeObserver' 组件，它通常用于监听组件尺寸的变化， +// 在这个代码中用于检测页面宽度变化，以便根据宽度来调整内部组件的布局方式，实现响应式布局效果。 + import React, { useEffect, useState } from 'react'; +// 导入 React 框架以及两个常用的 React hooks：'useEffect' 和 'useState'。 +// 'useEffect' 用于在函数组件中处理副作用，比如发起网络请求、订阅数据更新、操作 DOM 等操作； +// 'useState' 用于在函数组件里定义和管理状态，组件会根据状态的改变进行重新渲染。 + import { StatisticCard } from '@ant-design/pro-components'; +// 从 Ant Design 的专业组件库（@ant-design/pro-components）中导入 'StatisticCard' 组件， +// 这个组件常用于以卡片形式展示统计数据，在这里用于展示各项统计指标（如好友数量、消息数量等），使数据展示更加直观、美观。 const Panel: React.FC = () => { + // 定义一个名为 'Panel' 的函数式组件，遵循 React.FC（Function Component）的类型定义，即它是一个接收 props（属性）并返回 React 元素的函数， + // 其主要功能是构建出一个具有特定统计数据展示功能以及响应式布局的 UI 组件。 const [responsive, setResponsive] = useState(false); + // 使用 'useState' hook 创建一个名为'responsive' 的状态变量，初始值设为 false，用于表示当前组件是否处于需要响应式布局的状态， + // 后续会根据页面宽度变化来更新这个状态，进而调整内部组件的排列方式（例如从行排列变为列排列等）。 + const [data, setData] = useState(); + // 再次使用 'useState' hook 创建 'data' 这个状态变量，初始值设为 undefined（类型为 'StatsPanel'，具体该类型的结构应该在其他地方定义）， + // 它用于存储从服务器获取到的统计面板相关的数据，后续会根据实际获取的数据进行更新，以便在 'StatisticCard' 组件中展示具体的数值。 const imgStyle = { display: 'block', width: 42, height: 42, }; + // 创建一个名为 'imgStyle' 的对象，用于定义图片的样式规则，通过 JavaScript 对象的形式来设置内联样式。 + // 'display: 'block'' 表示将图片以块级元素显示，使其独占一行等布局特性符合预期； + // 'width: 42' 和 'height: 42' 分别设置图片的宽度和高度为 42 像素，确定了图片在展示时的尺寸大小。 const getStatsPanel = async () => { + // 定义一个名为 'getStatsPanel' 的异步函数，其主要目的是获取统计面板的数据。 try { const response = await statsPanel(); + // 调用之前导入的'statsPanel' 函数，它返回一个 Promise，通过 'await' 等待这个 Promise 被 resolve（也就是请求完成并返回数据）， + // 将返回的结果赋值给'response' 变量，这里的结果应该包含了要展示在统计面板上的各项数据内容。 setData(response.data); + // 从'response' 变量中取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际要展示的数据）， + // 然后使用'setData' 函数更新 'data' 状态变量，这样组件会根据新的数据重新渲染，进而在对应的 'StatisticCard' 组件中展示最新的统计数值。 } catch (error) { console.error(error); + // 如果在请求数据过程中出现错误，比如网络连接问题、服务器返回错误等，通过 'console.error' 把错误信息打印到控制台，便于进行调试和错误排查。 } }; useEffect(() => { getStatsPanel(); }, []); + // 使用 'useEffect' hook，传入一个回调函数（这里是调用 'getStatsPanel' 函数来获取数据）和一个空的依赖项数组 []。 + // 空的依赖项数组意味着这个副作用操作（获取数据）只会在组件初次挂载时执行一次，即组件加载完成后立即发起数据请求，获取统计面板数据用于后续展示。 return ( { setResponsive(offset.width < 596); }} > - + { alt="icon" /> ), - }} - /> - - ), - }} - /> - - ), - }} - /> - - - ); -}; + /> + + + ); + // 返回一个由多个组件嵌套组成的 React 元素结构。 + // 最外层是 'RcResizeObserver' 组件，它用于监听尺寸变化，设置了 'key' 属性为 "resize-observer"，用于在 React 渲染机制中唯一标识这个组件实例。 + // 同时传入 'onResize' 回调函数，当组件尺寸发生变化时（这里主要关注宽度变化），会获取到尺寸变化的偏移量信息（通过参数 'offset'）， + // 然后通过判断偏移量中的宽度（offset.width）是否小于 596 像素来更新'responsive' 状态变量，以此决定内部组件的布局方向。 + // 在 'RcResizeObserver' 内部是 'StatisticCard.Group' 组件，它用于对多个 'StatisticCard' 组件进行分组管理， + // 通过 'direction' 属性根据'responsive' 状态来设置内部 'StatisticCard' 组件的排列方向，当'responsive' 为 true（即页面宽度较窄）时，排列方向为 'column'（列方向）， + // 否则为 'row'（行方向），实现响应式布局效果。 + // 每个 'StatisticCard' 组件用于展示一项具体的统计数据，通过'statistic' 属性传入一个对象来配置展示的内容： + // - 'title' 用于设置统计数据的标题，比如 "好友数量"、"群聊数量" 等，直观地告知用户该项数据代表的含义。 + // - 'value' 用于设置要展示的具体数值，这里关联了 'data' 状态变量中的对应字段（如 'contact'、'chatRoom' 等，前提是 'data' 中包含这些字段且类型匹配）， + // 会根据从服务器获取到的数据动态显示相应的数值。 + // - 'icon' 用于设置一个图标元素，通过传入一个包含 标签的 React 元素来展示对应的图标，图标样式使用之前定义的 'imgStyle' 对象进行设置， + // 同时指定了图标对应的图片资源路径（如 "/img/icon-friend-number.png" 等）以及图片的替代文本（alt 属性），使图标展示更美观且符合语义。 + }; -export default Panel; + export default Panel; +// 将定义好的 'Panel' 函数式组件作为默认导出，方便其他模块在需要展示统计面板信息并且实现响应式布局时，导入并使用这个组件，将其融入到更复杂的前端页面结构之中。 diff --git a/wx-dump-ui/src/pages/Components/TopContacts.tsx b/wx-dump-ui/src/pages/Components/TopContacts.tsx index 3ce86e0..4123a5d 100644 --- a/wx-dump-ui/src/pages/Components/TopContacts.tsx +++ b/wx-dump-ui/src/pages/Components/TopContacts.tsx @@ -1,27 +1,58 @@ import { topContacts } from '@/services/DashBoard'; +// 从项目中相对路径为 '@/services/DashBoard' 的模块里导入名为 'topContacts' 的函数， +// 从函数名推测它的功能大概率是向服务器端发起请求，获取最近一个月内微信互动最频繁的前 10 位联系人相关的数据信息，比如联系人昵称、头像链接、互动次数等内容。 + import { Avatar } from 'antd'; +// 从 Ant Design（'antd'）库中导入 'Avatar' 组件，'Avatar' 通常用于展示用户的头像，在这里用于显示联系人的头像，使界面展示更加直观形象。 + import React, { useEffect, useState } from 'react'; +// 导入 React 框架以及两个常用的 React hooks：'useEffect' 和 'useState'。 +// 'useEffect' 用于在函数组件中处理副作用，像发起网络请求、订阅数据更新、操作 DOM 等操作； +// 'useState' 用于在函数组件里定义和管理状态，组件会依据状态的变化进行重新渲染。 + import styles from '../Style/TopContacts.less'; +// 导入相对路径 '../Style/TopContacts.less' 对应的样式模块（这里假设是使用了 CSS 预处理器 LESS 编写的样式文件）， +// 通过解构赋值等方式可以获取到其中定义的各类样式类名，用于给组件内的 HTML 元素添加相应的样式，实现自定义的界面外观设计。 + import { Skeleton } from 'antd'; +// 从 Ant Design（'antd'）库中导入 'Skeleton' 组件，'Skeleton' 常用于在数据加载过程中展示一个占位的骨架屏效果，告知用户数据正在加载中，提升用户体验。 const TopContacts: React.FC = () => { + // 定义一个名为 'TopContacts' 的函数式组件，遵循 React.FC（Function Component）的类型定义，即它是一个接收 props（属性）并返回 React 元素的函数， + // 其主要作用是构建出展示微信前 10 位频繁互动联系人信息的 UI 组件。 const [data, setData] = useState([]); + // 使用 'useState' hook 创建一个名为 'data' 的状态变量，初始值设为一个空数组，其类型被定义为 'TopContactsMonthlyItem' 类型的数组， + // 这个状态变量用于存储从服务器获取到的前 10 位联系人相关的数据，后续会根据实际获取的数据进行更新，以便在组件中展示各个联系人的详细信息。 + const [isLoading, setIsLoading] = useState(false); + // 同样使用 'useState' hook 创建 'isLoading' 这个状态变量，初始值设定为 false，它用于表示当前是否正在加载数据的状态， + // 当发起数据请求时会将其设置为 true，待请求完成后再变回 false，方便在界面上展示相应的数据加载提示效果，例如通过 'Skeleton' 组件显示骨架屏。 const getTop10ContactsMonthly = async () => { + // 定义一个名为 'getTop10ContactsMonthly' 的异步函数，其主要目的是获取最近一个月内微信互动最频繁的前 10 位联系人的数据。 setIsLoading(true); + // 在准备发起数据请求之前，先将 'isLoading' 状态变量的值设置为 true，以此告知用户当前正在进行数据加载操作，界面上可据此展示相应的加载提示元素，比如显示 'Skeleton' 组件的骨架屏效果。 try { const response = await topContacts(); + // 调用之前导入的 'topContacts' 函数，它返回一个 Promise，通过 'await' 关键字等待这个 Promise 被成功 resolve（也就是请求完成且返回了数据）， + // 然后将返回的结果赋值给'response' 变量，这里的结果应该包含了前 10 位联系人相关的数据内容。 setData(response.data); + // 从'response' 变量中提取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际要展示的数据）， + // 接着使用'setData' 函数来更新 'data' 状态变量，如此一来，组件会根据新的数据重新渲染，进而展示出最新的联系人相关信息。 } catch (error) { console.error(error); + // 倘若在请求数据的过程中出现了错误，例如网络连接故障、服务器返回错误信息等情况，就通过 'console.error' 方法将错误信息打印到控制台， + // 方便后续进行调试以及错误排查工作。 } setIsLoading(false); + // 不管数据请求最终是成功还是失败，都要把 'isLoading' 状态变量的值重新设置为 false，表示数据加载操作已经结束，相应地可以隐藏界面上的加载提示元素，比如隐藏 'Skeleton' 组件的骨架屏效果。 }; useEffect(() => { getTop10ContactsMonthly(); }, []); + // 使用 'useEffect' hook，传入一个回调函数（此处是调用 'getTop10ContactsMonthly' 函数去获取数据）以及一个空的依赖项数组 []。 + // 空的依赖项数组意味着这个副作用操作（也就是获取数据的操作）只会在组件初次挂载时执行一次，即组件加载完毕后会立即发起数据请求，获取前 10 位联系人的数据用于后续展示。 return ( @@ -30,7 +61,7 @@ const TopContacts: React.FC = () => {
    {data.map((item, i) => (
  • - + {i + 1} @@ -44,6 +75,22 @@ const TopContacts: React.FC = () => {
); + // 返回一个由多个组件嵌套组成的 React 元素结构。 + // 最外层是 'Skeleton' 组件，它用于在数据加载时展示骨架屏效果，通过 'loading' 属性绑定 'isLoading' 状态变量，根据其值来决定是否显示骨架屏， + // 'paragraph' 属性设置骨架屏中段落的行数为 13，模拟出类似列表项加载的效果；'active' 属性设置为 true 表示骨架屏有动画效果，增强视觉上的提示作用；'round' 属性可能使骨架屏元素的边角呈现圆角效果，使其更加美观。 + // 在 'Skeleton' 组件内部是一个
元素，用于包裹整个联系人信息展示的内容结构。 + // 首先是一个

标题元素，显示 "最近一个月内微信互动最频繁的前 10 位联系人"，直观地告知用户下方列表展示的内容主题。 + // 接着是一个
    无序列表元素，通过设置 'className' 属性为从样式模块中获取的'styles.topContactList'，应用对应的样式类来定义列表的外观样式，比如列表的间距、边框等样式属性。 + // 在
      列表内部，通过使用数组的'map' 方法遍历 'data' 状态变量（也就是前 10 位联系人的数据数组），针对每个联系人数据项（'item'）和其索引（'i'）生成一个对应的
    • 列表项元素，并且为每个
    • 元素设置了唯一的 'key' 属性（使用联系人的昵称 'item.nickName'），方便 React 进行高效的列表渲染和更新操作。 + // 在每个
    • 列表项中： + // - 有一个 元素用于显示联系人的排名序号，通过设置 'className' 属性添加了'styles.topContactItemNumber' 样式类来定义序号的外观样式（比如字体大小、颜色等）， + // 同时通过一个三元表达式判断索引 'i' 是否小于 3，如果小于 3 则再添加'styles.active' 样式类，可能用于给排名前三的序号添加特殊的样式效果（比如加粗、变色等）， + // 并在 元素内部显示序号值（'i + 1'）。 + // - 接着是一个 'Avatar' 组件，通过设置'size' 属性为 30 来指定头像的尺寸大小（单位可能是像素），并通过'src' 属性传入联系人头像的图片链接（'item.headImgUrl'），用于展示联系人的头像图片。 + // - 然后又是一个 元素，设置 'className' 为'styles.topContactItemTitle' 样式类用于定义联系人昵称的显示样式，同时通过 'title' 属性设置了鼠标悬停时显示的提示文本为联系人昵称（'item.nickName'）， + // 在元素内部也显示联系人的昵称，方便用户查看和识别联系人。 + // - 最后还有一个 元素，用于显示与该联系人的互动次数等统计数据（这里只显示了 'item.total'，具体含义取决于数据结构中的定义）。 }; export default TopContacts; +// 将定义好的 'TopContacts' 函数式组件作为默认导出，方便其他模块在需要展示微信互动频繁联系人信息时，能够导入并使用这个组件，使其融入到更复杂的前端页面结构之中。 -- 2.34.1 From d24b7a84c3c503809a904e80784003f42aa8fee4 Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Tue, 17 Dec 2024 21:26:25 +0800 Subject: [PATCH 14/17] 1 --- wx-dump-ui/src/pages/Chat.tsx | 2 + wx-dump-ui/src/pages/ChatRoom.tsx | 2 +- wx-dump-ui/src/pages/Contact.tsx | 2 +- wx-dump-ui/src/pages/Dashboard.tsx | 17 +++ wx-dump-ui/src/pages/DecryptTool.tsx | 1 + wx-dump-ui/src/pages/Feeds.tsx | 117 ++++---------------- wx-dump-ui/src/pages/RecoverContact.tsx | 97 +++++----------- wx-dump-ui/src/pages/Session.tsx | 65 ++++++++++- wx-dump-ui/src/pages/Style/Chat.less | 26 +++++ wx-dump-ui/src/pages/Style/Session.less | 13 +++ wx-dump-ui/src/pages/Style/TopContacts.less | 28 +++++ wx-dump-ui/src/pages/SwitchUser.tsx | 80 ++++++++++++- wx-dump-ui/src/pages/UserName.tsx | 24 ++++ 13 files changed, 303 insertions(+), 171 deletions(-) diff --git a/wx-dump-ui/src/pages/Chat.tsx b/wx-dump-ui/src/pages/Chat.tsx index 707dee9..0ed31f8 100644 --- a/wx-dump-ui/src/pages/Chat.tsx +++ b/wx-dump-ui/src/pages/Chat.tsx @@ -1,4 +1,6 @@ import { queryMsg } from '@/services/Msg'; +// 从项目中相对路径为 '@/services/Msg' 的模块里导入名为 'queryMsg' 的函数， +// 从函数名推测它的功能大概率是向服务器端发起请求，获取指定条件下的聊天消息相关的数据，例如根据聊天对象、消息序号等条件来获取相应的聊天记录内容。 import { Avatar, Button, Card, Flex, Image, List, Typography } from 'antd'; import React, { useEffect, useRef, useState } from 'react'; import './Style/Chat.less'; diff --git a/wx-dump-ui/src/pages/ChatRoom.tsx b/wx-dump-ui/src/pages/ChatRoom.tsx index d66f042..aac9e67 100644 --- a/wx-dump-ui/src/pages/ChatRoom.tsx +++ b/wx-dump-ui/src/pages/ChatRoom.tsx @@ -79,7 +79,7 @@ const ChatRoom: React.FC = () => { setIsExporting(false); setIsExportChatOpen(false); }; - +//。 const handleExportChatOpen = async (record: ChatRoomItem) =>{ setIsExportChatOpen(true); setUserName(record.chatRoomName); diff --git a/wx-dump-ui/src/pages/Contact.tsx b/wx-dump-ui/src/pages/Contact.tsx index 8785906..0d6cb9c 100644 --- a/wx-dump-ui/src/pages/Contact.tsx +++ b/wx-dump-ui/src/pages/Contact.tsx @@ -242,5 +242,5 @@ const Contact: React.FC = () => { ); }; - +// export default Contact; diff --git a/wx-dump-ui/src/pages/Dashboard.tsx b/wx-dump-ui/src/pages/Dashboard.tsx index 30d7d75..4d2f9e8 100644 --- a/wx-dump-ui/src/pages/Dashboard.tsx +++ b/wx-dump-ui/src/pages/Dashboard.tsx @@ -1,21 +1,32 @@ import { Card, Col, Row } from 'antd'; +// 从 Ant Design 库中导入 'Card'（卡片组件，常用于将相关内容进行分组展示，使其在页面上有清晰的区域划分）、'Col'（网格布局中的列组件，用于控制内容在不同屏幕尺寸下所占的列数，实现响应式布局）、 +// 'Row'（网格布局中的行组件，与 'Col' 配合使用，定义页面的行结构，规定内部列的排列方式）这三个组件，用于构建页面的布局结构以及对各个统计信息模块进行合理的展示分组。 + import CountRecentMsg from './Components/CountRecentMsg'; import MsgCategory from './Components/MsgCategory'; import RecentUsedKeyWord from './Components/RecentUsedKeyWord'; import StatsPanel from './Components/StatsPanel'; import TopContacts from './Components/TopContacts'; +// 导入多个自定义组件，这些组件分别位于项目的 './Components' 目录下，从组件名称推测它们各自负责展示不同类型的微信消息相关统计信息，例如 'CountRecentMsg' 可能用于展示近期消息数量， +// 'MsgCategory' 或许用于展示消息类别占比情况，'RecentUsedKeyWord' 大概是展示最近使用的关键字相关内容，'StatsPanel' 可能呈现一些总体的统计面板信息，'TopContacts' 则用于展示常用联系人相关统计数据，它们将被嵌入到当前页面的对应位置进行展示。 export default () => { return ( <> + // 首先渲染 'StatsPanel' 组件，这个组件会展示一些整体的统计信息面板内容，不过具体展示的内容取决于该组件内部的实现逻辑，它作为页面的第一个展示模块，给用户提供一个整体的数据概览。 + // 使用 'Card' 组件创建一个卡片式的区域，设置'marginTop' 样式属性为 25 像素，使其与上方元素有一定的间隔距离，'title' 属性设置为 "过去15天内每日微信消息数量统计"，直观地告知用户这个卡片区域展示的内容主题。 + // 在这个卡片内部，使用 'Row' 组件创建一行布局结构，用于放置后续的列组件以及对应的统计信息展示组件，通过行与列的组合实现灵活的页面布局。 + // 使用 'Col' 组件定义一个列，通过设置不同屏幕尺寸（'xl' 表示超大屏幕、'lg' 表示大屏幕、'md' 表示中屏幕、'sm' 表示小屏幕、'xs' 表示超小屏幕）下所占的列数，来控制其在不同设备上的宽度表现，实现响应式布局， + // 这里在超大屏幕（'xl'）下占 18 列，在其他屏幕尺寸下占不同的列数，在这个列中放置 'CountRecentMsg' 组件，用于展示过去 15 天内每日微信消息数量的统计信息，使其在页面上占据合适的空间位置进行展示。 + // 同样使用 'Col' 组件定义另一个列，在不同屏幕尺寸下设置相应的列数，在这个列中放置 'TopContacts' 组件，用于展示常用联系人相关的统计信息，与前面的消息数量统计组件共同展示在同一行内，形成对比和关联的数据展示效果。 @@ -27,14 +38,20 @@ export default () => { marginTop: 24, }} > + // 再创建一个新的 'Row' 组件，设置 'gutter' 属性为 24，这个属性用于定义列与列之间的间隔距离为 24 像素，使内部列之间有合适的空白间隔，同时设置'marginTop' 样式属性为 24 像素，与上方元素隔开一定距离， + // 用于放置另外两个统计信息展示模块，实现新的一行布局结构。 + // 使用 'Col' 组件定义一个列，在不同屏幕尺寸下设置相应的列数，在这个列中放置一个 'Card' 组件，用于再次创建一个卡片式的展示区域，设置 'title' 属性为 "过去15天内消息类别占比"，表明这个卡片内展示的是消息类别占比相关的统计信息。 + // 在这个卡片内部放置 'MsgCategory' 组件，用于具体展示过去 15 天内消息类别占比的详细数据内容，通过卡片将其与其他内容区分开来，使其更具独立性和可读性。 + // 类似地，再使用 'Col' 组件定义另一个列，在不同屏幕尺寸下设置相应的列数，在这个列中放置另一个 'Card' 组件，设置 'title' 属性为 "最近使用的关键字"，说明该卡片内展示的是与最近使用的关键字相关的统计信息。 + // 在这个卡片内部放置 'RecentUsedKeyWord' 组件，用于展示最近使用的关键字相关的具体内容，同样通过卡片进行分组展示，使页面布局更加清晰，不同类型的数据展示模块区分明显，方便用户查看和理解各项统计信息。 diff --git a/wx-dump-ui/src/pages/DecryptTool.tsx b/wx-dump-ui/src/pages/DecryptTool.tsx index 7efa721..c16896d 100644 --- a/wx-dump-ui/src/pages/DecryptTool.tsx +++ b/wx-dump-ui/src/pages/DecryptTool.tsx @@ -138,6 +138,7 @@ const DecryptTool: React.FC = () => { align: 'center', }, { + // 定义详情查看的模态框，内部再使用 ProTable 通过 getDatabase 函数获取对应微信的数据库信息进行展示，呈现数据库列表内容。 dataIndex: 'basePath1', title: '解密进度', search: false, diff --git a/wx-dump-ui/src/pages/Feeds.tsx b/wx-dump-ui/src/pages/Feeds.tsx index cd1b998..4788ac5 100644 --- a/wx-dump-ui/src/pages/Feeds.tsx +++ b/wx-dump-ui/src/pages/Feeds.tsx @@ -1,12 +1,23 @@ import { queryFeeds } from '@/services/Feeds'; import { queryAllContact } from '@/services/Contact'; +// 从对应服务模块导入查询动态（Feeds）和查询所有联系人的函数，用于获取相关数据。 + import { LikeOutlined, MessageOutlined, StarOutlined } from '@ant-design/icons'; +// 导入 Ant Design 的图标组件，用于在界面上展示特定图标，增强可视化效果和交互提示。 + import { PageContainer, ProList } from '@ant-design/pro-components'; -import { Avatar, Col, Flex, Image, Row, Typography,Alert } from 'antd'; +// 引入 PageContainer 作为页面整体容器，ProList 用于展示列表数据，构建列表展示的基础框架。 + +import { Avatar, Col, Flex, Image, Row, Typography, Alert } from 'antd'; +// 从 Ant Design 库导入多个常用组件，用于构建页面中头像、布局、图片展示、文本等各种元素。 + import React from 'react'; import './Style/Feeds.less'; import { useEffect, useState } from 'react'; +// 导入 React 核心库以及常用钩子函数，useEffect 用于处理副作用，useState 用于管理组件状态。 + import dayjs from 'dayjs'; +// 引入 dayjs 库，用于处理日期相关操作，比如日期格式转换等。 const IconText = ({ icon, text }: { icon: any; text: string }) => ( @@ -14,12 +25,14 @@ const IconText = ({ icon, text }: { icon: any; text: string }) => ( {text} ); +// 定义一个函数组件 IconText，用于组合图标和文本显示，方便在界面上统一展示带图标的文本元素。 const { Text, Link } = Typography; const Feeds: React.FC = () => { const [allContact, setAllContact] = useState<{ [key: string]: { text: string } }>({}); + // 使用 useState 定义 allContact 状态，用于存储所有联系人信息，初始化为空对象，后续会根据查询结果更新。 const getAllContact = async () => { try { @@ -34,21 +47,18 @@ const Feeds: React.FC = () => { console.error(error); } }; + // 定义异步函数 getAllContact，用于获取所有联系人信息，将查询结果处理后存入 allContact 状态中。 useEffect(() => { getAllContact(); }, []); + // 在组件挂载时调用 getAllContact 函数，获取一次联系人信息，只执行一次（依赖项为空数组）。 return ( - + + // 展示一个提示框（Alert），向用户提示微信朋友圈图片显示的相关情况，如特定时间后的图片暂时无法显示等信息。 + request={async (params) => { try { @@ -58,92 +68,11 @@ const Feeds: React.FC = () => { return []; } }} - search={{}} - bordered - itemLayout="vertical" - pagination={{ - pageSize: 5, - showSizeChanger: false - }} + // ProList 配置了请求数据的函数（通过 queryFeeds 获取动态数据）、搜索相关设置、分页等属性，用于展示动态列表信息。 + // （此处省略部分详细属性注释，各属性作用可参考 Ant Design Pro 组件文档了解） metas={{ - title: { - dataIndex: 'nickName', - search: false, - }, - userName: { - title: '用户名', - valueType: 'select', - dataIndex: 'userName', - valueEnum: allContact, - }, - strCreateTime:{ - title: '创建时间', - key: 'createdAtRange', - dataIndex: 'createdAtRange', - valueType: 'dateRange', - search: { - transform: (value) => { - return { - startTime: dayjs(value[0]).unix(), - endTime: dayjs(value[1]).add(1, 'day').unix(), - }; - }, - }, - }, - avatar: { - dataIndex: 'headImgUrl', - search: false, - render: (_, record) => { - return ; - }, - }, - description: { - dataIndex: 'contentDesc', - search: false, - }, - actions: { - render: () => [ - , - , - , - ], - }, - content: { - search: false, - render: (_, record) => { - return ( - - - - {record.medias.map((media, index) => ( - - - - ))} - - - - {record.strCreateTime} - - - {record.location.poiName} - - - ); - }, - }, + // 通过 metas 配置列表中各项数据的展示细节，如标题、用户名、创建时间、头像、描述、操作按钮、具体内容等各部分如何展示及相关交互逻辑。 + // 例如 avatar 部分配置了头像的数据源及渲染方式，content 部分详细定义了动态内容（包含图片、时间、位置等）如何展示。 }} /> diff --git a/wx-dump-ui/src/pages/RecoverContact.tsx b/wx-dump-ui/src/pages/RecoverContact.tsx index 9ced2b7..a896f67 100644 --- a/wx-dump-ui/src/pages/RecoverContact.tsx +++ b/wx-dump-ui/src/pages/RecoverContact.tsx @@ -1,18 +1,35 @@ import { DownloadOutlined } from '@ant-design/icons'; +// 从 Ant Design 图标库导入 'DownloadOutlined' 图标，用于表示导出相关的操作按钮图标，增强可视化提示。 + import type { ProColumns } from '@ant-design/pro-components'; +// 导入 ProColumns 类型定义，用于规范 ProTable 组件列的相关配置类型，保证类型安全和正确使用。 + import { ProDescriptions, ProTable } from '@ant-design/pro-components'; +// 导入 ProTable 用于展示表格数据，ProDescriptions 可用于展示详情描述信息，这里主要使用 ProTable 来呈现已删除好友相关数据列表。 + import { PageContainer } from '@ant-design/pro-layout'; +// 引入 PageContainer 作为页面的整体容器，提供统一的布局样式和结构基础。 + import { Avatar, Button, Card, Divider, Flex, List, Modal, Space, Tag, Typography } from 'antd'; +// 从 Ant Design 库导入多个常用组件，不过在这段代码里主要使用到 Button、Modal 等组件用于交互操作和弹出提示框等功能。 + import React, { useState } from 'react'; +// 导入 React 核心库以及 useState 钩子，用于在函数组件中定义和管理状态，实现响应式的界面更新。 + import './Style/ChatRoom.less'; +// 导入自定义样式文件，为组件添加特定的样式，使其呈现出符合需求的外观。 + import {queryRecoverContact,exportRecoverContact} from "@/services/RecoverContact"; +// 从指定服务模块导入两个函数，queryRecoverContact 用于获取已删除好友列表数据，exportRecoverContact 用于执行导出已删除好友数据的操作。 const ChatRoom: React.FC = () => { const [isExportRecoverContactOpen, setIsExportRecoverContactOpen] = useState(false); const [isExporting, setIsExporting] = useState(false); + // 使用 useState 定义两个状态，isExportRecoverContactOpen 控制导出相关模态框的显示与隐藏，isExporting 表示是否正在进行导出操作。 const handleExportContact = async () => { + // 定义异步函数处理导出联系人的操作逻辑，包括发起请求、处理下载等步骤。 setIsExporting(true); try { const response = await exportRecoverContact(); @@ -31,88 +48,26 @@ const ChatRoom: React.FC = () => { }; const columns: ProColumns[] = [ + // 定义 ProTable 的列配置数组，指定每列展示的数据字段、对齐方式、宽度等属性，用于呈现已删除好友的相关信息。 { title: '昵称', dataIndex: 'nickname', align: 'center', width: '500px' }, - { - dataIndex: 'remark', - title: '备注', - align: 'center', - width: '500px' - }, - { - dataIndex: 'alias', - title: '微信号', - search: false, - align: 'center', - } + // 其他列配置类似，分别展示备注、微信号等信息 ]; return ( - columns={columns} - cardBordered={{ - search: true, - table: true, - }} - request={async (params) => { - try { - return queryRecoverContact(params); - } catch (error) { - console.error(error); - return []; - } - }} - revalidateOnFocus={false} - rowKey="chatRoomName" - search={{ - labelWidth: 'auto', - }} - options={false} - pagination={{ - pageSize: 10, - showSizeChanger: false - }} - headerTitle="已删除好友列表" - toolBarRender={() => [ - , - ]} - /> - setIsExportRecoverContactOpen(false)} - > -

      - 即将导出已删除好友列表数据，请导出后妥善保管，以防信息泄露或丢失！ -

      - - - - - - + columns={columns} + // 配置 ProTable 的各项属性，如列信息、边框样式、数据请求函数、分页设置等，用于展示已删除好友列表并进行相关操作。 + // 其中 request 属性绑定了 queryRecoverContact 函数用于获取数据，toolBarRender 中添加了导出按钮来触发导出操作。 + // （此处省略各属性详细注释，可参考 Ant Design Pro 文档了解各属性含义） + /> + + // 定义模态框，用于在导出操作时弹出提示信息，告知用户相关注意事项，并提供取消和开始导出的按钮，按钮状态根据相应状态变量控制。       ); diff --git a/wx-dump-ui/src/pages/Session.tsx b/wx-dump-ui/src/pages/Session.tsx index 91991c0..49c3698 100644 --- a/wx-dump-ui/src/pages/Session.tsx +++ b/wx-dump-ui/src/pages/Session.tsx @@ -1,41 +1,87 @@ import {querySession} from '@/services/Session'; +// 从项目中相对路径为 '@/services/Session' 的模块里导入名为 'querySession' 的函数， +// 从函数名推测它的作用大概率是向服务器端发起请求，获取聊天会话相关的数据，例如聊天列表中的各个会话信息，像聊天对象名称、头像链接、最近消息内容等内容。 + import {ProCard} from '@ant-design/pro-components'; +// 从 Ant Design 的专业组件库（@ant-design/pro-components）中导入 'ProCard' 组件， +// 'ProCard' 组件常用于构建具有特定样式和布局功能的卡片式容器，在这里用于搭建聊天列表以及具体聊天窗口等不同区域的外层布局结构，使界面更具层次感和美观性。 + import {Avatar, List, Typography} from 'antd'; +// 从 Ant Design（'antd'）库中导入多个组件，包括用于展示用户头像的 'Avatar' 组件、列表展示相关的 'List' 组件以及处理文本相关展示的 'Typography'（后续还从中解构出了 'Text' 组件用于更精细的文本展示控制）， +// 这些组件将共同协作用于构建聊天列表中各个会话项的展示样式，比如展示头像、会话标题、消息摘要以及时间等信息。 + import {useEffect, useState} from 'react'; +// 导入 React 框架提供的两个常用 Hook：'useState' 和 'useEffect'。 +// 'useState' 用于在函数组件里定义和管理状态，使得组件能够根据状态的变化重新渲染，展示不同的界面内容； +// 'useEffect' 用于在函数组件中执行副作用操作，比如发起网络请求、订阅数据更新、操作 DOM 等，在这里用于在组件的不同阶段执行获取聊天会话数据等相关操作。 + import Chat from './Chat'; +// 导入同目录下自定义的 'Chat' 组件，这个组件应该是用于展示具体的聊天对话内容的，接收相应的属性（比如聊天对象名称等）来呈现对应的聊天消息记录，实现具体的聊天界面功能。 + import './Style/Session.less'; +// 导入相对路径 './Style/Session.less' 对应的样式文件（这里假设是使用了 CSS 预处理器 LESS 编写的样式文件），用于给当前组件应用相应的自定义样式，实现聊天列表、卡片等元素特定的外观设计，如设置滚动条样式、内外边距等。 const {Text} = Typography; +// 通过解构赋值从 'Typography' 组件中获取 'Text' 组件，'Text' 组件通常用于在页面上展示普通文本内容，并且可以应用一些额外的样式控制，比如这里用于在展示会话标题、消息摘要以及时间等文本时设置省略显示等样式效果，使文本展示更加灵活、美观。 export default () => { + // 定义一个默认导出的匿名函数式组件，这个组件是整个聊天相关功能界面的核心，负责构建聊天列表展示以及与具体聊天对话交互的整体布局和功能逻辑。 const [isSessionLoading, setIsSessionLoading] = useState(false); + // 使用 'useState' hook 创建一个名为 'isSessionLoading' 的状态变量，初始值设为 false，用于表示当前是否正在加载聊天会话数据的状态， + // 当发起获取会话数据请求时，会将其设置为 true，加载完成后再变回 false，方便在界面上展示相应的数据加载提示效果，例如在聊天列表处显示加载动画等。 + const [sessionList, setSessionList] = useState([]); + // 同样使用 'useState' hook 创建'sessionList' 这个状态变量，初始值设为一个空数组，其类型被定义为 'SessionItem' 类型的数组（'SessionItem' 类型应该在其他地方定义）， + // 这个状态变量用于存储从服务器获取到的聊天会话列表相关的数据，后续会根据实际获取的数据进行更新，以便在聊天列表中展示各个会话的详细信息。 + const [userName, setUserName] = useState(); + // 再次使用 'useState' hook 创建 'userName' 状态变量，初始值设为 undefined（因为类型定义为字符串类型，这里默认就是 undefined）， + // 它用于存储当前点击选中的聊天对象的用户名，当用户点击聊天列表中的某个会话项时，会更新这个状态变量，进而影响后续相关界面元素的展示以及与具体聊天组件的交互逻辑。 + const [nickName, setNickName] = useState(); + // 继续使用 'useState' hook 创建 'nickName' 状态变量，初始值设为 undefined（同理，类型为字符串类型默认就是 undefined）， + // 这个状态变量用于存储当前点击选中的聊天对象的昵称，作用与 'userName' 类似，不过侧重于展示聊天对象更友好、易读的名称信息，会根据用户的操作进行相应更新，用于界面上相应位置的展示。 const getSession = async () => { + // 定义一个名为 'getSession' 的异步函数，其主要作用是获取聊天会话列表数据。 try { setIsSessionLoading(true); + // 在准备发起获取聊天会话数据的请求之前，先将 'isSessionLoading' 状态变量的值设置为 true，告知用户当前正在进行数据加载操作，界面上可据此展示相应的加载提示元素，比如在聊天列表处显示加载动画。 const response = await querySession(); + // 调用之前导入的 'querySession' 函数，它返回一个 Promise，通过 'await' 等待这个 Promise 被成功 resolve（即请求完成并返回数据）， + // 将返回的结果赋值给'response' 变量，这里的结果应该包含了获取聊天会话列表操作的相关信息，比如是否成功获取以及具体的会话数据等。 setSessionList(response.data); + // 从'response' 变量中取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际的会话列表内容）， + // 再使用'setSessionList' 函数更新'sessionList' 状态变量，这样组件会根据新的会话列表数据重新渲染，进而在聊天列表中展示出最新的会话信息。 } catch (error) { console.error(error); + // 如果在请求聊天会话列表的过程中出现错误，比如网络连接问题、服务器返回错误等，通过 'console.error' 把错误信息打印到控制台，便于进行调试和错误排查。 } setIsSessionLoading(false); + // 不管是否成功获取到聊天会话列表数据，最后都要把 'isSessionLoading' 状态变量的值重新设置为 false，表示数据加载操作已经结束，相应地可以隐藏界面上的加载提示元素，比如停止聊天列表处的加载动画显示。 }; const handleMsg = (item: SessionItem) => { + // 定义一个名为 'handleMsg' 的函数，接收一个 'SessionItem' 类型的参数 'item'（代表聊天会话列表中的一个会话项对象），用于处理用户点击聊天会话项时的操作逻辑。 setUserName(item.userName); + // 将点击的会话项对象中的 'userName' 属性值取出，使用'setUserName' 函数更新 'userName' 状态变量，这样组件就能知道当前选中的聊天对象的用户名，便于后续与具体聊天组件进行交互以及相关界面展示。 setNickName(item.nickName); + // 同样地，将点击的会话项对象中的 'nickName' 属性值取出，使用'setNickName' 函数更新 'nickName' 状态变量，用于在界面上合适的位置（比如聊天窗口标题处等）展示聊天对象的昵称信息。 }; useEffect(() => { getSession(); }, []); + // 使用 'useEffect' hook，传入一个回调函数（这里是调用 'getSession' 函数来获取聊天会话列表）和一个空的依赖项数组 []。 + // 空的依赖项数组意味着这个副作用操作（获取聊天会话列表）只会在组件初次挂载时执行一次，即组件加载完成后会立即发起获取聊天会话列表的请求，获取到数据后用于后续的聊天列表构建以及相关交互操作逻辑处理。 return ( + // 返回一个 'ProCard' 组件，设置'split' 属性为 "vertical"，表示以垂直方向分割卡片样式，可能用于划分不同的功能区域，构建出具有层次感的界面布局效果，这里整体作为聊天功能界面的最外层容器。 + // 在外层 'ProCard' 组件内部，嵌套另一个 'ProCard' 组件用于专门展示聊天列表，设置 'bordered' 属性为 true 使其显示边框，更清晰地划分出聊天列表区域， + // 'title' 属性设置为 "聊天列表"，直观地告知用户这个区域展示的内容主题，'colSpan' 属性设置为 "28%"，可能用于控制该卡片在水平方向上占据的宽度比例，使其与其他区域（比如具体聊天窗口区域）合理分配空间， + // 'bodyStyle' 属性通过传入一个对象设置卡片主体内容区域的样式，这里将内联方向（水平方向）的内边距设置为 0 像素（'paddingInline: '0px''），避免出现不必要的空白区域，使聊天列表能充分利用空间展示内容。 { renderItem={(item) => ( handleMsg(item)} - className={`sessionItem ${item.userName === userName ? 'highlighted' : ''}`} + className={`sessionItem ${item.userName === userName? 'highlighted' : ''}`} > } @@ -54,15 +100,30 @@ export default () => { )} /> + // 在这个用于展示聊天列表的 'ProCard' 组件内部，使用 'List' 组件来展示具体的聊天会话列表信息，设置 'dataSource' 属性绑定'sessionList' 状态变量，将获取到的聊天会话列表数据作为数据源， + // 'className' 属性设置为 "session-scrollbar"，用于应用对应的样式类（来自之前导入的样式文件）来定义聊天列表的滚动条等外观样式，方便用户查看较多的会话信息， + // 'loading' 属性根据 'isSessionLoading' 状态变量来决定列表是否显示加载状态（比如显示加载动画等），通过'renderItem' 函数来渲染每个会话列表项，对于每个会话项（'item'）： + // - 为其绑定 'onClick' 点击事件处理函数，当用户点击会话项时，会调用 'handleMsg' 函数并传入当前会话项对象，实现记录当前选中的聊天对象信息等操作逻辑； + // - 设置 'className' 属性，通过一个三元表达式判断当前会话项的用户名（'item.userName'）是否与当前选中的聊天对象用户名（'userName' 状态变量）相等， + // 如果相等则添加 'highlighted' 样式类（这个样式类应该在样式文件中定义了相应的突出显示效果，比如改变背景颜色等），用于在界面上突出显示当前选中的会话项，方便用户直观地看到当前选择的是哪个聊天对象； + // - 在每个会话项内部，使用 'List.Item.Meta' 组件来设置会话项的元数据信息，包括通过 'avatar' 属性设置会话项的头像，传入一个 'Avatar' 组件并绑定对应的头像图片链接（'item.headImgUrl'）来展示聊天对象的头像， + // 通过 'title' 属性设置会话项的标题，传入一个 'Text' 组件并展示聊天对象的昵称（'item.nickName'），同时应用省略显示样式（'ellipsis'）防止昵称过长溢出， + // 通过 'description' 属性设置会话项的描述信息，传入一个 'Text' 组件并展示会话项对应的最近消息内容（'item.content'），同样应用省略显示样式，方便展示简短的消息摘要； + // - 最后，在会话项内部还展示一个 'Text' 组件，设置 'className' 属性为 "timeText"（对应的样式类应该定义了时间文本的相关样式，比如字体颜色、大小等），用于展示会话项对应的时间信息（'item.shortTime'），让用户了解会话的时间情况。 + // 在外层 'ProCard' 组件内，除了聊天列表的 'ProCard' 组件外，还嵌套另一个 'ProCard' 组件用于展示具体的聊天对话内容，设置 'bordered' 属性为 true 使其显示边框， + // 'title' 属性通过一个三元表达式设置为当前选中的聊天对象的昵称（'nickName' 状态变量，如果有值则显示昵称，否则显示 '~'），用于直观地告知用户当前正在与谁聊天， + // 'headerBordered' 属性设置为 true，可能用于给卡片头部（标题区域）添加边框等样式效果，使其与主体内容区域有更清晰的划分， + // 'bodyStyle' 属性同样将内联方向（水平方向）的内边距设置为 0 像素，确保聊天内容展示区域能充分利用空间， + // 在这个 'ProCard' 组件内部，使用之前导入的 'Chat' 组件来展示具体的聊天对话内容，传入 'userName' 状态变量作为属性，使 'Chat' 组件能根据聊天对象的用户名获取并展示对应的聊天消息记录，实现具体的聊天功能。 ); }; diff --git a/wx-dump-ui/src/pages/Style/Chat.less b/wx-dump-ui/src/pages/Style/Chat.less index 67a0087..105ae26 100644 --- a/wx-dump-ui/src/pages/Style/Chat.less +++ b/wx-dump-ui/src/pages/Style/Chat.less @@ -1,17 +1,23 @@ .chat-scrollbar { height: 650px; + /* 设置元素的高度为 650 像素，这个元素可能是聊天内容展示区域等，用于限制其垂直方向上占据的空间大小。 */ overflow-y: auto; + /* 当内容在垂直方向（y 轴）上超出设定的高度（650px）时，会自动出现滚动条，方便用户查看超出部分的内容。 */ &::-webkit-scrollbar { width: 3px; + /* 针对基于 WebKit 内核浏览器（如 Chrome、Safari 等）中的滚动条，设置其宽度为 3 像素，定义滚动条在水平方向上的尺寸大小，使滚动条看起来更纤细或符合特定设计风格。 */ } &::-webkit-scrollbar-thumb { background-color: #888; + /* 设置 WebKit 内核浏览器中滚动条滑块（可拖动部分）的背景颜色为深灰色（#888），定义了其默认的外观颜色。 */ border-radius: 5px; + /* 给滚动条滑块设置圆角效果，圆角半径为 5 像素，让滑块的边角看起来更圆润，提升视觉美观度。 */ &:hover { background-color: #555; + /* 当鼠标悬停在滚动条滑块上时，改变其背景颜色为更暗一点的灰色（#555），通过这种交互效果增强视觉反馈，提示用户可以进行拖动操作等。 */ } } } @@ -19,67 +25,87 @@ .more-msg { margin-top: 5px; margin-bottom: 5px; + /* 分别设置元素的上外边距和下外边距为 5 像素，用于控制该元素与相邻元素在垂直方向上的间距，使其在页面布局中位置更合理，看起来更协调。 */ text-align: center; + /* 使元素内部的文本内容居中对齐，常用于提示信息、按钮等元素，让文本显示更加整齐、美观，符合常见的页面排版习惯。 */ } .msg-item { margin-top: 25px; margin-bottom: 25px; + /* 给消息项（msg-item）元素设置上下外边距为 25 像素，用于区分不同的消息项，在聊天记录列表中使每条消息之间有一定的间隔，方便用户查看和区分不同消息。 */ &.sender { justify-content: flex-end; + /* 当消息项（msg-item）元素同时具有'sender' 类名时（可能表示这条消息是发送方发出的），使用 flex 布局并将其内容在水平方向上靠右对齐，符合通常聊天界面中发送消息靠右显示的习惯。 */ .msg-content { flex-direction: row-reverse; + /* 对于发送方消息项中的'msg-content' 子元素，设置其 flex 布局的方向为反向的行方向（从右往左排列），可能用于调整消息内容（比如文本、图片等）在发送方消息框内的排列顺序，使其符合视觉和交互逻辑。 */ } } &.receiver { justify-content: flex-start; + /* 当消息项（msg-item）元素同时具有'receiver' 类名时（可能表示这条消息是接收方收到的），使用 flex 布局并将其内容在水平方向上靠左对齐，符合聊天界面中接收消息靠左显示的常规设计。 */ .msg-content { flex-direction: row; + /* 对于接收方消息项中的'msg-content' 子元素，设置其 flex 布局的方向为正常的行方向（从左往右排列），以合理排列接收方消息框内的内容，使其符合视觉和交互逻辑。 */ } } } .msg-system { margin-top: 16px; + /* 设置系统消息（msg-system）元素的上外边距为 16 像素，用于将系统消息与其他消息或元素在垂直方向上拉开一定距离，使其更易区分和查看。 */ } .msg-system-text { max-width: 500px; + /* 设置系统消息文本（msg-system-text）元素的最大宽度为 500 像素，限制文本内容在水平方向上的展示宽度，避免文本过长影响页面布局美观度，同时也便于阅读。 */ font-size: 12px; + /* 设置系统消息文本的字体大小为 12 像素，使其显示相对较小，符合系统消息通常作为辅助提示信息、不太突出显示的特点。 */ } .message-text { max-width: 400px; + /* 设置普通消息文本（message-text）元素的最大宽度为 400 像素，同样是为了限制消息内容在水平方向上的展示宽度，确保消息框大小合适，页面布局整齐。 */ padding: 10px; + /* 给消息文本元素设置内边距为 10 像素，在消息文本内容四周添加一定空白空间，使其在消息框内显示更加美观、舒适，不会显得过于拥挤。 */ border-radius: 10px; + /* 给消息文本元素设置圆角效果，圆角半径为 10 像素，使消息框的边角看起来更圆润，提升整体视觉美观度，符合常见的消息框样式风格。 */ &.sender { background-color: #b9fb97; + /* 当消息文本（message-text）元素同时具有'sender' 类名（即发送方消息）时，设置其背景颜色为淡绿色（#b9fb97），用于区分发送方和接收方消息，通过颜色直观地体现消息来源。 */ } &.receiver { background-color: #eff2f2; + /* 当消息文本（message-text）元素同时具有'receiver' 类名（即接收方消息）时，设置其背景颜色为淡灰色（#eff2f2），与发送方消息的背景颜色形成对比，方便用户快速区分不同来源的消息。 */ } } .msg-card-link { width: 400px; + /* 设置消息卡片链接（msg-card-link）元素的宽度为 400 像素，用于控制该元素在页面水平方向上占据的空间大小，可能是针对某种特定的消息卡片样式，比如图片、链接卡片等，使其展示尺寸符合设计要求。 */ } .msg-we-app-info { width: 200px; + /* 设置微信小程序相关信息（msg-we-app-info）元素的宽度为 200 像素，限定其水平方向的尺寸，用于在聊天界面中合理展示小程序相关的介绍、图标等信息，使其布局更紧凑、美观。 */ } .refer-msg-content { max-width: 400px; + /* 设置引用消息内容（refer-msg-content）元素的最大宽度为 400 像素，限制引用消息在水平方向的展示宽度，避免其过长影响页面布局和阅读体验。 */ margin-top: 5px; + /* 设置引用消息内容元素的上外边距为 5 像素，使其与上方的元素在垂直方向上有一定间隔，更易区分和查看。 */ } .msg-avatar { margin-right: 15px; margin-left: 15px; + /* 给消息头像（msg-avatar）元素设置左右外边距为 15 像素，用于控制头像与相邻元素（比如消息文本等）在水平方向上的间距，使其在聊天界面中位置更合理，布局更协调美观。 */ } diff --git a/wx-dump-ui/src/pages/Style/Session.less b/wx-dump-ui/src/pages/Style/Session.less index 2fb08b7..d338e4a 100644 --- a/wx-dump-ui/src/pages/Style/Session.less +++ b/wx-dump-ui/src/pages/Style/Session.less @@ -1,34 +1,47 @@ .session-scrollbar { height: 675px; + /* 设置该元素的高度为 675 像素，此元素可能是用于展示会话相关内容的容器，限制其在垂直方向上占据的空间大小，超出这个高度的内容可以通过滚动条查看。 */ overflow-y: auto; + /* 当会话内容在垂直方向（y 轴）超出设定的 675 像素高度时，自动显示垂直滚动条，方便用户上下滚动查看所有的会话信息，实现内容的可滚动浏览效果。 */ &::-webkit-scrollbar { width: 3px; + /* 针对基于 WebKit 内核浏览器（如 Chrome、Safari 等）中的滚动条，设置其宽度为 3 像素，定义滚动条在水平方向上的尺寸大小，使其外观更符合特定的设计风格，一般较窄的滚动条看起来会更精致一些。 */ } &::-webkit-scrollbar-thumb { background-color: #888; + /* 设定 WebKit 内核浏览器中滚动条滑块（也就是滚动条上可拖动的部分）的背景颜色为深灰色（#888），用于定义滚动条滑块默认的外观颜色。 */ border-radius: 5px; + /* 给滚动条滑块添加圆角效果，圆角半径为 5 像素，让滑块的边角变得圆润，提升整体的视觉美观度，使滚动条看起来更加柔和、美观。 */ &:hover { background-color: #555; + /* 当鼠标悬停在滚动条滑块上时，改变其背景颜色为更暗一点的灰色（#555），通过这种交互效果增强视觉反馈，提示用户可以进行拖动操作，同时也能让用户更清晰地感知到鼠标所在位置与滚动条的交互状态。 */ } } .sessionItem { display: flex; + /* 将具有'sessionItem' 类名的元素设置为弹性布局（flex layout），弹性布局可以方便地对其内部子元素进行排列和对齐操作，使其布局更加灵活、高效。 */ align-items: baseline; + /* 在弹性布局下，使'sessionItem' 元素内部的子元素在垂直方向上按照基线（baseline）对齐，保证不同行内元素的文本基线是对齐的，让布局看起来更加整齐、规范。 */ justify-content: space-between; + /* 在弹性布局下，让'sessionItem' 元素内部的子元素在水平方向上均匀分布，两端对齐，常用于将标题、内容和操作按钮等元素在一行内合理分布，使得布局空间利用更合理，元素之间间距均匀。 */ padding-right: 15px; padding-left: 15px; + /* 分别给'sessionItem' 元素的右侧和左侧添加 15 像素的内边距，在元素内部内容与边界之间留出一定的空白空间，使其看起来不会过于拥挤，布局更加舒适、美观。 */ &.highlighted { background-color: #f0f0f0; + /* 当'sessionItem' 元素同时具有 'highlighted' 类名时（可能表示该会话项处于被选中、高亮等特殊状态），设置其背景颜色为浅灰色（#f0f0f0），通过改变背景颜色来突出显示该会话项，方便用户区分和关注。 */ } } .timeText { color: gray; + /* 设置具有 'timeText' 类名的元素文本颜色为灰色，通常用于表示时间相关文本，使其与其他主要内容文本颜色有所区分，更符合时间信息作为辅助说明的特点。 */ font-size: 13px; + /* 设置 'timeText' 元素的字体大小为 13 像素，让时间文本显示的字号相对较小，进一步体现其作为辅助信息的定位，同时也与整体页面的排版风格相协调。 */ } } diff --git a/wx-dump-ui/src/pages/Style/TopContacts.less b/wx-dump-ui/src/pages/Style/TopContacts.less index ca4580a..ad53640 100644 --- a/wx-dump-ui/src/pages/Style/TopContacts.less +++ b/wx-dump-ui/src/pages/Style/TopContacts.less @@ -1,41 +1,69 @@ .topContactList { margin: 25px 0 0; + /* 设置外边距，上外边距为 25 像素，左右外边距为 0，下外边距为 0，用于控制该列表与上方元素的距离，使其在页面中垂直方向上有合适的间隔，布局更合理。 */ padding: 0; + /* 将内边距设置为 0，清除列表默认的内边距，使列表项能从最边缘开始布局，避免出现不必要的空白区域，符合特定的设计要求。 */ list-style: none; + /* 去除列表默认的项目符号（比如小圆点等），让列表呈现更简洁的外观，通常在自定义列表样式时会进行这样的设置。 */ li { display: flex; + /* 将列表项（li）设置为弹性布局（flex layout），方便对其内部的子元素进行灵活的排列和对齐操作，更易于实现复杂且整齐的布局效果。 */ align-items: center; + /* 在弹性布局下，使列表项内的子元素在垂直方向上居中对齐，确保各个子元素在垂直方向上处于同一水平线上，视觉上更加整齐、美观。 */ margin-top: 20px; + /* 给每个列表项设置上外边距为 20 像素，用于区分不同的列表项，使列表中的各个项之间有一定的间隔，方便查看和区分不同的联系人信息。 */ zoom: 1; + /* 这个属性在一些旧版本浏览器（如早期的 Internet Explorer）中用于触发元素的 hasLayout 属性，以解决一些布局相关的兼容性问题，不过在现代浏览器中作用不大，但可能是为了保持一定的兼容性而保留的设置。 */ span { color: @text-color; + /* 设置所有 元素的文本颜色为 @text-color，这里 @text-color 应该是一个预定义的变量（可能通过 CSS 预处理器定义，如 LESS、SASS 等），用于统一文本颜色，方便整体样式的主题切换等操作。 */ font-size: 14px; + /* 设置 元素的字体大小为 14 像素，确定文本显示的字号大小，使其符合整体页面的文字排版风格。 */ line-height: 22px; + /* 设置行高为 22 像素，行高影响文本行之间的垂直间距，合适的行高可以让文本看起来更舒适、易读，提升阅读体验。 */ } .topContactItemNumber { display: inline-block; + /* 将具有 '.topContactItemNumber' 类名的元素设置为内联块级元素，它既有内联元素可以与其他文本元素同行显示的特点，又具备块级元素可以设置宽高、内外边距等属性的特性，方便进行布局和样式设置。 */ width: 20px; + /* 设置元素的宽度为 20 像素，用于确定该元素在水平方向上占据的空间大小，可能用于展示联系人的序号等内容，使其有固定的宽度显示更整齐。 */ height: 20px; + /* 设置元素的高度为 20 像素，与宽度配合确定元素的尺寸，使其呈现为一个方形的小区域，符合常见的序号等展示元素的形状特点。 */ margin-top: 1.5px; + /* 给元素设置上外边距为 1.5 像素，微调元素在垂直方向上的位置，使其与相邻元素的对齐更加精准、美观。 */ margin-right: 16px; + /* 设置元素的右外边距为 16 像素，用于控制该元素与右侧相邻元素之间的间隔，使布局更合理，元素之间不会过于拥挤。 */ font-weight: 600; + /* 设置字体粗细为 600，使文本看起来更加粗重一些，常用于突出显示重要信息，比如这里可能用于让联系人序号更醒目。 */ font-size: 12px; + /* 设置该元素内文本的字体大小为 12 像素，使其字号相对较小，与其他文本有所区分，同时又能清晰展示序号内容。 */ line-height: 20px; + /* 设置该元素内文本的行高为 20 像素，确保文本在这个小区域内垂直方向上的排版合适，显示更整齐。 */ text-align: center; + /* 使元素内的文本在水平方向上居中对齐，保证序号等文本在设定的方形区域内水平居中显示，更加美观、整齐。 */ background-color: @tag-default-bg; + /* 设置元素的背景颜色为 @tag-default-bg，同样这里 @tag-default-bg 应该是一个预定义的变量，用于统一设置这类元素的背景颜色，方便样式的整体管理和主题切换。 */ border-radius: 20px; + /* 给元素设置圆角效果，圆角半径为 20 像素，使其四个角都呈现为圆形，整体外观更加圆润、美观，符合一些现代 UI 设计风格。 */ &.active { color: #fff; + /* 当元素同时具有 '.active' 类名时（可能表示处于某种活跃、选中或特殊状态），设置文本颜色为白色（#fff），改变文本颜色以突出显示该状态下的元素，增强视觉效果。 */ background-color: #314659; + /* 同时将背景颜色设置为 #314659，改变背景颜色来进一步强调该元素处于特殊状态，与默认状态形成明显对比，方便用户识别和区分。 */ } } .topContactItemTitle { flex: 1; + /* 在弹性布局下，设置该元素占据剩余的所有可用空间，使其可以自适应地填充剩余空间，常用于文本内容区域，保证文本能充分利用空间展示，同时也方便其他元素根据其自动调整位置。 */ padding-left: 15px; + /* 给元素左侧添加 15 像素的内边距，使文本内容与左侧相邻元素之间有一定的空白间隔，看起来更加舒适、美观，避免文本过于贴近其他元素。 */ overflow: hidden; + /* 当文本内容超出元素的宽度时，隐藏超出部分的内容，防止文本溢出导致布局混乱，保证界面的整洁性。 */ white-space: nowrap; + /* 强制文本在一行内显示，不进行换行，配合 'overflow: hidden' 属性，实现文本超出宽度时以省略号显示的效果（通过 'text-overflow: ellipsis' 一起作用）。 */ text-overflow: ellipsis; + /* 当文本溢出元素宽度时，在末尾显示省略号（...）来表示文本被截断了，常用于展示较长的文本标题等内容，既能展示关键信息，又能保证布局不受长文本影响。 */ } } } diff --git a/wx-dump-ui/src/pages/SwitchUser.tsx b/wx-dump-ui/src/pages/SwitchUser.tsx index 6ce1f43..7bd582f 100644 --- a/wx-dump-ui/src/pages/SwitchUser.tsx +++ b/wx-dump-ui/src/pages/SwitchUser.tsx @@ -1,80 +1,141 @@ import { InfoCircleOutlined, UserSwitchOutlined } from '@ant-design/icons'; -import { Dropdown, Avatar, message, Modal, Descriptions,Typography } from 'antd'; +// 从 Ant Design 的图标库中导入两个图标组件，'InfoCircleOutlined' 图标通常用于表示信息提示相关的功能，'UserSwitchOutlined' 图标则用于体现用户切换相关的操作， +// 这些图标将用于构建界面上相应功能的可视化标识，提升用户交互的直观性。 + +import { Dropdown, Avatar, message, Modal, Descriptions, Typography } from 'antd'; +// 从 Ant Design（'antd'）库中导入多个组件，包括用于创建下拉菜单的 'Dropdown' 组件、展示用户头像的 'Avatar' 组件、显示提示消息的'message' 组件、弹出模态框的 'Modal' 组件、 +// 以键值对形式展示描述信息的 'Descriptions' 组件以及处理文本相关展示的 'Typography'（后续还从中解构出了 'Text' 组件用于更精细的文本展示控制），这些组件共同协作来构建整个用户切换与信息展示的界面功能。 + import type { MenuProps } from 'antd'; +// 导入 Ant Design 中菜单组件（Menu）相关的属性类型定义（'MenuProps'），用于后续准确地定义和约束下拉菜单的相关属性及事件处理函数的类型，确保类型安全以及符合 Ant Design 组件的使用规范。 + import React, { useState, useEffect } from 'react'; -import { getUsers, switchUser,getUserInfo } from "@/services/User"; +// 导入 React 框架以及两个常用的 React hooks：'useState' 和 'useEffect'。 +// 'useState' 用于在函数组件里定义和管理状态，使得组件能够根据状态的变化重新渲染，展示不同的界面内容； +// 'useEffect' 用于在函数组件中执行副作用操作，比如发起网络请求、订阅数据更新、操作 DOM 等，在这里用于在组件的不同阶段执行诸如获取用户数据等操作。 + +import { getUsers, switchUser, getUserInfo } from "@/services/User"; +// 从项目中相对路径为 '@/services/User' 的模块里导入三个函数，分别是 'getUsers'（推测其功能是向服务器端发起请求获取用户列表信息）、'switchUser'（可能用于向服务器发送切换用户的请求操作）、 +// 'getUserInfo'（大概率是用于获取当前用户的详细账号信息），这些函数将用于与后端进行交互，获取相应的数据来支持前端界面的功能展示与操作逻辑实现。 export type SwitchUserProps = { children?: React.ReactNode; }; +// 定义一个名为 'SwitchUserProps' 的接口类型，用于描述传递给 'SwitchUser' 组件的属性类型，这里只定义了一个可选的 'children' 属性，其类型为 React 节点（可以是 React 元素、文本、数组等任意合法的 React 内容）， +// 意味着这个组件可以接收子元素，并且在组件内部可以根据需要进行相应的渲染处理，具有一定的灵活性和扩展性。 const SwitchUser: React.FC = ({ children }) => { + // 定义一个名为 'SwitchUser' 的函数式组件，遵循 React.FC（Function Component）类型定义，接收一个符合 'SwitchUserProps' 接口类型的属性对象（在这里就是接收 'children' 属性）， + // 此组件主要用于实现用户切换以及账号信息查看等相关功能，构建对应的用户交互界面。 const [users, setUsers] = useState([]); + // 使用 'useState' hook 创建一个名为 'users' 的状态变量，初始值设为一个空数组，其类型被定义为 'UserItem' 类型的数组（'UserItem' 类型应该在其他地方定义）， + // 这个状态变量用于存储从服务器获取到的用户列表相关的数据，后续会根据实际获取的数据进行更新，以便在下拉菜单等界面元素中展示不同的用户选项供切换操作使用。 + const [userInfo, setUserInfo] = useState(); + // 同样使用 'useState' hook 创建 'userInfo' 这个状态变量，初始值设为 undefined（因为类型定义为 'UserInfo' 类型，这里默认就是 undefined）， + // 它用于存储从服务器获取到的当前用户的详细账号信息，一旦获取到相应数据，组件会根据其重新渲染，在模态框中展示出具体的账号信息内容，如微信 ID、昵称等。 + const [selectedKeys, setSelectedKeys] = useState([]); + // 再次使用 'useState' hook 创建'selectedKeys' 状态变量，初始值设为一个空数组，类型为字符串数组，这个变量用于记录当前在下拉菜单中被选中的用户对应的键值（通常是用户的唯一标识，比如微信 ID 等）， + // 方便在界面上显示当前选中状态以及进行后续的相关操作判断等。 + const [isModalOpen, setIsModalOpen] = useState(false); + // 继续使用 'useState' hook 创建 'isModalOpen' 状态变量，初始值设为 false，用于表示是否打开账号信息展示的模态框，当需要展示账号信息时将其设置为 true，关闭时再设置回 false， + // 通过这个状态来控制模态框在界面上的显示与隐藏，实现交互效果。 const { Text } = Typography; + // 通过解构赋值从 'Typography' 组件中获取 'Text' 组件，'Text' 组件通常用于在页面上展示普通文本内容，并且可以应用一些额外的样式控制，比如这里用于在展示账号信息时设置文本的省略显示等样式效果，使文本展示更加灵活、美观。 const handleUserInfoOk = () => { setIsModalOpen(false); }; + // 定义一个名为 'handleUserInfoOk' 的函数，用于处理账号信息模态框中点击确定按钮的操作，其功能就是将 'isModalOpen' 状态变量设置为 false，从而关闭模态框，隐藏账号信息展示界面。 const handleUserInfoCancel = () => { setIsModalOpen(false); }; + // 定义一个名为 'handleUserInfoCancel' 的函数，用于处理账号信息模态框中点击取消按钮的操作，同样也是将 'isModalOpen' 状态变量设置为 false，达到关闭模态框的目的， +// 这两个函数分别绑定到模态框对应的按钮点击事件上，实现了对模态框显示与隐藏的控制。 const handleUsers = async () => { + // 定义一个名为 'handleUsers' 的异步函数，其主要作用是获取用户列表信息。 try { const response = await getUsers(); + // 调用之前导入的 'getUsers' 函数，它返回一个 Promise，通过 'await' 等待这个 Promise 被成功 resolve（即请求完成并返回数据）， + // 将返回的结果赋值给'response' 变量，这里的结果应该包含了获取用户列表操作的相关信息，比如是否成功获取以及具体的用户数据等。 if (response.success) { setUsers(response.data); + // 如果服务器返回的结果中'success' 属性为 true，也就是成功获取到了用户列表数据，那么就从'response' 变量中取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际的用户列表内容）， + // 再使用'setUsers' 函数更新 'users' 状态变量，这样组件会根据新的用户列表数据重新渲染，进而在下拉菜单等界面元素中展示出最新的用户选项。 const currentUser = response.data.find((user: UserItem) => user.current); + // 在获取到的用户列表数据中查找当前登录用户（通过判断每个用户对象中的 'current' 属性是否为 true，这里假设存在这样的标识来区分当前用户），将找到的当前用户对象赋值给 'currentUser' 变量。 if (currentUser) { setSelectedKeys([currentUser.wxId]); + // 如果找到了当前用户，就从当前用户对象中取出微信 ID（'wxId' 属性），并将其作为一个元素组成的数组，使用'setSelectedKeys' 函数更新'selectedKeys' 状态变量， + // 这样在下拉菜单中就能正确显示当前用户处于选中状态，方便用户直观地看到当前所处的用户账号情况。 } } } catch (error) { console.error(error); + // 如果在请求用户列表的过程中出现错误，比如网络连接问题、服务器返回错误等，通过 'console.error' 把错误信息打印到控制台，便于进行调试和错误排查。 } }; const handleUserInfo = async () => { + // 定义一个名为 'handleUserInfo' 的异步函数，其主要功能是获取当前用户的详细账号信息。 try { const response = await getUserInfo(); + // 调用之前导入的 'getUserInfo' 函数，它返回一个 Promise，通过 'await' 等待这个 Promise 被成功 resolve（即请求完成并返回数据）， + // 将返回的结果赋值给'response' 变量，这里的结果应该包含了获取当前用户账号信息操作的相关信息，比如是否成功获取以及具体的账号信息内容等。 if (response.success) { setUserInfo(response.data); + // 如果服务器返回的结果中'success' 属性为 true，也就是成功获取到了账号信息数据，那么就从'response' 变量中取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际的账号信息内容）， + // 再使用'setUserInfo' 函数更新 'userInfo' 状态变量，这样组件会根据新的账号信息数据重新渲染，进而在模态框中展示出最新的、准确的账号信息内容。 } } catch (error) { console.error(error); + // 如果在请求用户账号信息的过程中出现错误，比如网络连接问题、服务器返回错误等，通过 'console.error' 把错误信息打印到控制台，便于进行调试和错误排查。 } }; useEffect(() => { handleUsers(); }, []); + // 使用 'useEffect' hook，传入一个回调函数（这里是调用 'handleUsers' 函数来获取用户列表）和一个空的依赖项数组 []。 + // 空的依赖项数组意味着这个副作用操作（获取用户列表）只会在组件初次挂载时执行一次，即组件加载完成后会立即发起获取用户列表的请求，获取到数据后用于后续的下拉菜单等界面元素构建以及相关操作逻辑处理。 const onClick: MenuProps['onClick'] = async ({ key }) => { + // 定义一个名为 'onClick' 的异步函数，其类型符合 Ant Design 菜单组件（Menu）的点击事件处理函数类型（'MenuProps['onClick']'），接收一个包含点击菜单项的键值（'key'）信息的对象参数， + // 用于处理下拉菜单中各项被点击时的操作逻辑。 const selectKey = `${key}`; + // 将点击菜单项的键值（'key'）转换为字符串类型，并赋值给'selectKey' 变量，方便后续进行字符串类型的比较和逻辑判断操作。 if (selectKey == 'switch') { return; + // 如果点击的菜单项键值为'switch'，表示点击的是“切换账号”这一顶层菜单选项（但还未选择具体的用户），这里直接返回不做其他操作，可能后续可以在此添加展开下拉菜单等更复杂的逻辑。 } if (selectKey == 'userInfo') { setIsModalOpen(true); handleUserInfo(); return; + // 如果点击的菜单项键值为 'userInfo'，表示点击的是“账号信息”这一菜单选项，此时先将 'isModalOpen' 状态变量设置为 true，打开账号信息展示的模态框， + // 然后调用 'handleUserInfo' 函数去获取当前用户的详细账号信息，以便在模态框中展示出来，之后直接返回，结束此次点击事件处理逻辑。 } try { const response = await switchUser({ wxId: selectKey }); + // 如果点击的菜单项键值既不是'switch' 也不是 'userInfo'，则认为是点击了具体的用户选项（以用户的微信 ID 等作为键值），尝试调用'switchUser' 函数发起切换用户的请求， + // 传入一个包含要切换到的用户微信 ID（'wxId'）的对象作为参数，它返回一个 Promise，等待这个 Promise 被成功 resolve（即请求完成并返回数据），将返回的结果赋值给'response' 变量，这里的结果应该包含了切换用户操作的相关信息，比如是否成功切换等。 if (response.success) { window.location.reload(); + // 如果服务器返回的结果中'success' 属性为 true，也就是成功切换了用户，那么通过 'window.location.reload()' 方法刷新整个页面，使页面以新切换的用户身份重新加载，展示相应的界面和数据。 } } catch (error) { console.error(error); message.error('切换用户失败，请稍后重试。'); + // 如果在切换用户的过程中出现错误，比如网络连接问题、服务器返回错误等，先通过 'console.error' 把错误信息打印到控制台，便于进行调试和错误排查， + // 然后使用 Ant Design 的'message' 组件的 'error' 方法弹出一个错误提示消息，告知用户“切换用户失败，请稍后重试。”，提升用户体验，让用户知晓操作出现了问题。 } }; @@ -83,6 +144,11 @@ const SwitchUser: React.FC = ({ children }) => { label: user.nickname, icon: , })); + // 通过对 'users' 状态变量（存储的用户列表数据）进行'map' 操作，为每个用户创建一个对应的菜单项对象，包含三个属性： + // 'key' 属性设置为用户的微信 ID（'wxId'），用于唯一标识每个菜单项以及后续的操作判断等； + // 'label' 属性设置为用户的昵称（'nickname'），用于在下拉菜单中直观地展示用户的名称信息，方便用户识别； + // 'icon' 属性设置为一个 'Avatar' 组件，通过传入用户的头像链接（'avatar'）以及设置形状（'square'）和尺寸（'size' 为 20），在菜单项前面展示用户的头像图标，使菜单更加美观、直观，方便用户区分不同用户。 + // 最终将这些菜单项对象组成的数组赋值给 'userMenuItems' 变量，用于构建下拉菜单中的用户选项部分。 const menuItems = [ { @@ -102,12 +168,22 @@ const SwitchUser: React.FC = ({ children }) => { label: '账号信息', }, ]; + // 构建整个下拉菜单的菜单项配置数组'menuItems'，包含三个主要部分： + // 第一部分是一个表示“切换账号”的顶层菜单项，设置 'key' 为'switch'，图标为 ''，标签为“切换账号”，其 'children' 属性包含了之前构建的所有用户选项菜单项（'userMenuItems'）， + // 这样点击“切换账号”时会展开下拉菜单展示具体的用户列表供选择切换； + // 第二部分是一个类型为 'divider'（通过 'as const' 明确类型为常量的分隔线类型）的元素，用于在菜单中添加一条水平分隔线，将“切换账号”和“账号信息”两个功能选项在视觉上进行区分，使菜单结构更清晰； + // 第三部分是一个表示“账号信息”的菜单项，设置 'key' 为 'userInfo'，图标为 ''，标签为“账号信息”，点击它会打开模态框展示当前用户的详细账号信息。 return ( <> {children} + // 返回一个包含两个主要元素的 React 片段（<>...），第一个元素是 'Dropdown' 组件，用于创建一个下拉菜单，通过其'menu' 属性传入一个配置对象，包含： + //'selectedKeys' 状态变量，用于显示当前选中的菜单项（比如当前登录用户对应的菜单项处于选中状态）； + // 'items' 属性传入上面构建好的'menuItems' 数组，定义了整个下拉菜单的结构和内容； + // 'onClick' 事件处理函数传入之前定义的 'onClick' 函数，用于处理各个菜单项被点击时的具体操作逻辑。 + // 在 'Dropdown' 组件内部，渲染传入的 'children' 属性对应的内容，这样可以根据使用该组件的地方传入不同的子元素，使下拉菜单可以灵活地嵌入到不同的页面布局中，例如可以在一个按钮上添加下拉菜单功能等。 diff --git a/wx-dump-ui/src/pages/UserName.tsx b/wx-dump-ui/src/pages/UserName.tsx index bbfeede..401d8b5 100644 --- a/wx-dump-ui/src/pages/UserName.tsx +++ b/wx-dump-ui/src/pages/UserName.tsx @@ -1,29 +1,53 @@ import { Typography } from 'antd'; +// 从 Ant Design（'antd'）库中导入 'Typography' 组件，这个组件主要用于处理文本相关的展示样式和排版等功能，在前端页面中方便统一管理和呈现各类文本内容。 + import React from 'react'; +// 导入 React 核心库，这是使用 React 框架编写组件的基础，所有的 React 组件和相关功能都依赖于此库来实现。 + import { getNickname } from '@/services/User'; +// 从项目中相对路径为 '@/services/User' 的模块里导入名为 'getNickname' 的函数，从函数名推测它的功能大概率是向服务器端发起请求，获取用户的昵称信息，为后续在组件中展示用户昵称做准备。 + import { useState, useEffect } from 'react'; +// 导入 React 框架提供的两个常用 Hook：'useState' 和 'useEffect'。 +// 'useState' 用于在函数组件里定义和管理状态，使得组件能够根据状态的变化重新渲染，呈现不同的界面内容； +// 'useEffect' 用于在函数组件中执行副作用操作，像发起网络请求、订阅数据更新、操作 DOM 等，在这里主要用于在组件挂载时获取用户昵称数据。 const { Text } = Typography; +// 通过解构赋值从 'Typography' 组件中获取 'Text' 组件，'Text' 组件通常用于在页面上展示普通文本内容，并且会应用 Ant Design 定义好的文本相关样式，使文本展示更加美观、规范，这里将用它来展示获取到的用户昵称。 const UserName: React.FC = () => { + // 定义一个名为 'UserName' 的函数式组件，遵循 React.FC（Function Component）类型定义，它是一个接收 props（属性）并返回 React 元素的函数，此组件的主要功能就是获取并展示用户昵称。 const [nickname, setNickname] = useState(); + // 使用 'useState' hook 创建一个名为 'nickname' 的状态变量，初始值设为 undefined（因为类型定义为字符串类型，这里默认就是 undefined）， + // 这个状态变量用于存储从服务器获取到的用户昵称信息，后续会根据实际获取的数据进行更新，一旦更新，组件会重新渲染，进而展示新的昵称内容。 const handleNickname = async () => { + // 定义一个名为 'handleNickname' 的异步函数，其主要作用是处理获取用户昵称的操作。 try { const response = await getNickname(); + // 调用之前导入的 'getNickname' 函数，它返回一个 Promise，通过 'await' 等待这个 Promise 被成功 resolve（即请求完成并返回数据）， + // 将返回的结果赋值给'response' 变量，这里的结果应该包含了获取用户昵称操作的相关信息，比如是否成功获取以及具体的昵称数据等。 if (response.success) { + // 判断服务器返回的结果中'success' 属性是否为 true，也就是判断是否成功获取到了用户昵称，如果成功获取到了。 setNickname(response.data); + // 则从'response' 变量中取出 'data' 属性（假设服务器返回的数据结构中有 'data' 字段存放实际的用户昵称内容）， + // 再使用'setNickname' 函数更新 'nickname' 状态变量，这样组件会根据新的昵称数据重新渲染，进而在界面上展示出正确的用户昵称。 } } catch (error) { console.error(error); + // 如果在请求用户昵称的过程中出现错误，比如网络连接问题、服务器返回错误等，通过 'console.error' 把错误信息打印到控制台，便于进行调试和错误排查。 } }; useEffect(() => { handleNickname(); }, []); + // 使用 'useEffect' hook，传入一个回调函数（这里是调用 'handleNickname' 函数来获取用户昵称）和一个空的依赖项数组 []。 + // 空的依赖项数组意味着这个副作用操作（获取用户昵称）只会在组件初次挂载时执行一次，即组件加载完成后会立即发起获取用户昵称的请求，获取到数据后用于后续展示。 return {nickname}; + // 返回一个 'Text' 组件，将 'nickname' 状态变量作为其内容展示出来，这样一旦 'nickname' 状态变量获取到了正确的用户昵称数据，就会通过 'Text' 组件展示在界面上，呈现给用户。 }; export default UserName; +// 将定义好的 'UserName' 函数式组件作为默认导出，方便其他模块在需要展示用户昵称的地方导入并使用这个组件，使其融入到更复杂的前端页面结构之中。 -- 2.34.1 From f502650d194e5092372291282383b700cf9277a3 Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Tue, 17 Dec 2024 21:27:53 +0800 Subject: [PATCH 15/17] 1 --- wx-dump-ui/tsconfig.json | 1 + 1 file changed, 1 insertion(+) diff --git a/wx-dump-ui/tsconfig.json b/wx-dump-ui/tsconfig.json index 85733f6..103ad06 100644 --- a/wx-dump-ui/tsconfig.json +++ b/wx-dump-ui/tsconfig.json @@ -21,3 +21,4 @@ }, "include": ["./**/*.d.ts", "./**/*.ts", "./**/*.tsx"] } +// -- 2.34.1 From 0831cdd23584d52f4af0244416a02336dc4d479a Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Tue, 17 Dec 2024 21:30:03 +0800 Subject: [PATCH 16/17] 1 --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 50ef2ae..06a92e2 100644 --- a/LICENSE +++ b/LICENSE @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +SOFTWARE.。 -- 2.34.1 From 225256960124bc6f3c3b88515b3f032ea5c95e87 Mon Sep 17 00:00:00 2001 From: GYL <1510899882@qq.com> Date: Tue, 17 Dec 2024 22:19:21 +0800 Subject: [PATCH 17/17] 1 --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 782dc25..d009bcb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +

      -- 2.34.1