111

snailmall-user-service/src/main/java/com/njupt/swg/swagger/SwaggerConfig.java

@@ -9,34 +9,52 @@ import springfox.documentation.spi.DocumentationType;
 import springfox.documentation.spring.web.plugins.Docket;
 
 /**
+ * 这个类 `SwaggerConfig` 是用于配置 `Swagger` 的配置类，通过 `Spring` 的配置机制（`@Configuration` 注解标识），
+ * 它定义了如何生成 `Swagger` 接口文档相关的信息以及配置 `Swagger` 的核心组件 `Docket`，使得在项目中能够方便地生成清晰、规范的接口文档，方便前后端开发人员进行接口的对接以及对项目接口的整体了解和测试等操作。
+ *
  * @Author swg.
  * @Date 2019/1/8 11:39
  * @CONTACT 317758022@qq.com
  * @DESC
  */
 @Configuration
+// `@Configuration` 注解表明这个类是一个 `Spring` 的配置类，`Spring` 容器在启动时会扫描并解析该类，将其中定义的 `Bean`（通过 `@Bean` 注解方法定义的对象）注册到容器中，
+// 以便在项目的其他地方可以方便地注入和使用这些对象，在这里主要用于配置 `Swagger` 相关的组件和信息。
 public class SwaggerConfig {
-    // 接口版本号
+
+    // 接口版本号，用于标识当前接口文档所对应的项目接口版本，方便使用者了解接口的迭代情况以及不同版本之间的差异，这里定义为 "3.0"，数据类型为 `String`。
     private final String version = "3.0";
-    // 接口大标题
+    // 接口大标题，通常展示在接口文档的顶部，是对整个接口文档内容的一个总体概括性标题，此处设置为 "快乐蜗牛商城V3.0文档"，用于明确文档所属的项目及版本，数据类型为 `String`。
     private final String title = "快乐蜗牛商城V3.0文档";
-    // 具体的描述
+    // 具体的描述，用于详细说明接口文档涵盖的服务内容等相关信息，在这里明确指出是 "用户服务"，让查看文档的人能快速知晓该文档主要聚焦的业务范围，数据类型为 `String`。
     private final String description = "用户服务";
-    // 服务说明url
+    // 服务说明url，一般指向一个网页地址，该地址可以提供关于整个服务更详细的说明、使用条款、服务协议等相关信息，这里设置为 "http://www.kingeid.com"，数据类型为 `String`。
     private final String termsOfServiceUrl = "http://www.kingeid.com";
-    // 接口作者联系方式
+    // 接口作者联系方式，通过 `Contact` 类的实例来封装作者的相关联系信息，包括姓名、个人主页（如 `GitHub` 主页等）以及邮箱地址，方便使用者在有问题或者需要进一步沟通时能联系到接口的作者，这里进行了相应的初始化设置。
     private final Contact contact = new Contact("fourColor", "https://github.com/sunweiguo", "sunweiguode@gmail.com");
 
+    /**
+     * 这个方法使用 `@Bean` 注解，用于创建并返回一个 `Docket` 对象，`Docket` 是 `Swagger` 框架中用于配置和定制接口文档生成的核心组件。
+     * 通过对 `Docket` 的配置，可以指定要生成文档的接口范围、添加接口相关的元信息（如标题、版本、描述等）以及其他各种定制化的设置，
+     * 最终生成符合项目需求的接口文档，返回的 `Docket` 对象会被 `Spring` 容器管理并在生成接口文档的过程中发挥关键作用。
+     *
+     * @return 返回一个配置好的 `Docket` 对象，用于后续 `Swagger` 生成接口文档的相关操作。
+     */
     @Bean
     public Docket buildDocket() {
         return new Docket(DocumentationType.SWAGGER_2).apiInfo(buildApiInf())
                 .select().build();
     }
 
+    /**
+     * 这个私有方法用于构建 `ApiInfo` 对象，`ApiInfo` 是用于封装接口文档的基本信息（如标题、版本、描述、服务网址、作者联系方式等）的对象，
+     * 这些信息会展示在生成的 `Swagger` 接口文档的开头部分，让使用者能够快速了解接口文档的整体概况和关键信息，通过 `ApiInfoBuilder` 来逐步构建并返回 `ApiInfo` 对象。
+     *
+     * @return 返回一个构建好的 `ApiInfo` 对象，包含了接口文档的标题、版本、描述、服务网址以及作者联系方式等信息，用于配置 `Docket` 对象中的接口文档基本信息部分。
+     */
     private ApiInfo buildApiInf() {
         return new ApiInfoBuilder().title(title).termsOfServiceUrl(termsOfServiceUrl).description(description)
                 .version(version).contact(contact).build();
 
     }
-
 }

snailmall-user-service/src/main/java/com/njupt/swg/vo/UserResVO.java

@@ -1,24 +1,38 @@
 package com.njupt.swg.vo;
 
 import lombok.Data;
-
 import java.util.Date;
 
 /**
+ * 这个类 `UserResVO` 是作为值对象（Value Object，简称 VO）存在的，主要用于在不同层之间传递用户相关的数据，尤其是在向客户端（如前端页面）返回用户信息时使用。
+ * 它对从数据库或业务逻辑处理后得到的用户信息进行了有选择性的封装，只包含了前端可能需要展示或者使用的部分用户属性，与实际数据库实体类（如 `com.njupt.swg.entity.User`）相比，可能更贴合前端的需求，
+ * 并且通过使用 `Lombok` 的 `@Data` 注解简化了代码中常规方法（如 `Getter`、`Setter` 方法等）的编写，提高了代码的简洁性和可读性。
+ *
  * @Author swg.
  * @Date 2019/1/1 11:50
  * @CONTACT 317758022@qq.com
  * @DESC
  */
 @Data
+// `@Data` 注解是 `Lombok` 提供的一个便捷注解，它会自动为类中的所有非静态、非 `final` 的字段生成 `Getter`、`Setter` 方法，
+// 以及 `equals`、`hashCode` 和 `toString` 方法，方便对类中属性的访问和操作，减少了大量重复的代码编写工作，使得在使用这个类的对象时，可以很方便地获取和设置各个属性的值。
 public class UserResVO {
+    // 用户的唯一标识符，用于在系统中唯一确定一个用户，该属性会传递到前端，方便前端在进行一些与用户相关的操作（如展示用户特定信息、发起针对特定用户的请求等）时使用，数据类型为 `int`。
     private int id;
+    // 用户名，用于在前端页面展示给用户或者进行一些基于用户名的操作（如显示欢迎信息、根据用户名查找相关记录等），是一个字符串类型的属性，存储用户在注册时设定的用户名信息，数据类型为 `String`。
     private String username;
+    // 用户的电子邮箱地址，前端可能会利用该邮箱地址展示给用户查看，或者用于一些与邮件相关的功能提示（如告知用户可以通过该邮箱接收系统通知等），数据类型为 `String`。
     private String email;
+    // 用户角色字段，用于区分不同权限的用户，前端可以根据该角色信息来展示不同的用户界面或者控制用户对某些功能的访问权限，这里定义了不同的整数值表示不同角色（具体含义可能在业务中有相应定义），数据类型为 `int`。
     private int role;
+    // 用户的电话号码，前端可以展示该电话号码信息给用户，或者用于一些与电话相关的功能交互（如点击拨打按钮等，若有相关功能拓展的话），数据类型为 `String`。
     private String phone;
+    // 安全问题，通常用于在前端页面提示用户之前设置过的安全问题相关信息（比如在忘记密码等流程中展示给用户回顾），是一个字符串类型的属性，存储用户自己设置的安全问题内容，数据类型为 `String`。
     private String question;
+    // 安全问题的答案，虽然从安全角度来说一般不会直接展示给用户，但在某些特定的业务逻辑中（比如验证用户是否正确输入过答案等情况）可能会涉及到对该属性的使用，数据类型为 `String`。
     private String answer;
-    private Date createTime;//返回前端的是时间戳
+    // 用户创建时间，不过这里需要注意的是，在返回前端时通常是以时间戳的形式（便于前端进行时间的格式化展示等操作，根据前端具体的时间处理机制来定），用于前端展示用户账号的创建时间信息，数据类型为 `Date`。
+    private Date createTime;
+    // 用户信息更新时间，同样可以在前端展示给用户，让用户了解自己的信息最后一次更新是什么时候，数据类型为 `Date`。
     private Date updateTime;
-}
+}