+ * 错题本控制器，处理与错题本相关的HTTP请求 + *
+ * + * @author 聪明笨狗 + * @since 2020-05-27 17:56 + */ +@Api(tags={"错题本"}) +@RestController +@RequestMapping("/exam/api/user/wrong-book") +public class UserBookController extends BaseController { + + /** + * 注入错题本服务类，用于处理错题本相关的业务逻辑 + */ + @Autowired + private UserBookService baseService; + + /** + * 批量删除错题本记录 + * @param reqDTO 包含要删除记录ID列表的请求对象 + * @return 操作结果的统一响应对象 + */ + @ApiOperation(value = "批量删除") + @RequestMapping(value = "/delete", method = { RequestMethod.POST}) + public ApiRest delete(@RequestBody BaseIdsReqDTO reqDTO) { + // 根据传入的ID列表删除对应的错题本记录 + baseService.removeByIds(reqDTO.getIds()); + // 返回操作成功的响应 + return super.success(); + } + + /** + * 分页查找错题本记录 + * @param reqDTO 包含分页信息和查询条件的请求对象 + * @return 包含分页结果的统一响应对象 + */ + @ApiOperation(value = "分页查找") + @RequestMapping(value = "/paging", method = { RequestMethod.POST}) + public ApiRest+ * 错题本请求类，用于在不同层之间传输错题本相关的数据。 + * 该类包含了错题本记录的基本信息，如考试ID、用户ID、题目ID等。 + *
+ * + * @author 聪明笨狗 + * @since 2020-05-27 17:56 + */ +@Data +@ApiModel(value="错题本", description="错题本") +public class UserBookDTO implements Serializable { + + // 序列化版本号，用于保证序列化和反序列化过程中类的版本一致性 + private static final long serialVersionUID = 1L; + + /** + * 错题本记录的唯一标识ID + */ + @ApiModelProperty(value = "ID", required=true) + private String id; + + /** + * 关联的考试ID，表明该错题属于哪次考试 + */ + @ApiModelProperty(value = "考试ID", required=true) + private String examId; + + /** + * 关联的用户ID，表明该错题属于哪个用户 + */ + @ApiModelProperty(value = "用户ID", required=true) + private String userId; + + /** + * 关联的题目ID，表明具体是哪道题目做错了 + */ + @ApiModelProperty(value = "题目ID", required=true) + private String quId; + + /** + * 该错题加入错题本的时间 + */ + @ApiModelProperty(value = "加入时间", required=true) + private Date createTime; + + /** + * 该错题最近一次出错的时间 + */ + @ApiModelProperty(value = "最近错误时间", required=true) + private Date updateTime; + + /** + * 该错题累计出错的次数 + */ + @ApiModelProperty(value = "错误时间", required=true) + private Integer wrongCount; + + /** + * 错题的题目标题，用于快速识别题目内容 + */ + @ApiModelProperty(value = "题目标题", required=true) + private String title; + + /** + * 错题在错题本中的排序序号 + */ + @ApiModelProperty(value = "错题序号", required=true) + private Integer sort; +} diff --git a/user/book/entity/UserBook.java b/user/book/entity/UserBook.java new file mode 100644 index 0000000..a36fb6a --- /dev/null +++ b/user/book/entity/UserBook.java @@ -0,0 +1,80 @@ +package com.yf.exam.modules.user.book.entity; + +import com.baomidou.mybatisplus.annotation.IdType; +import com.baomidou.mybatisplus.annotation.TableField; +import com.baomidou.mybatisplus.annotation.TableId; +import com.baomidou.mybatisplus.annotation.TableName; +import com.baomidou.mybatisplus.extension.activerecord.Model; +import lombok.Data; + +import java.util.Date; + +/** + *+ * 错题本实体类，对应数据库表 `el_user_book`，用于存储用户错题相关信息。 + * 该类继承自 MyBatis-Plus 的 `Model` 类，可使用其提供的 ActiveRecord 功能。 + *
+ * + * @author 聪明笨狗 + * @since 2020-05-27 17:56 + */ +@Data +@TableName("el_user_book") +public class UserBook extends Model+ * 错题本Mapper接口，用于与数据库中错题本相关表进行数据交互。 + * 该接口继承自MyBatis-Plus的BaseMapper接口，可直接使用BaseMapper提供的基础CRUD操作方法。 + *
+ * + * @author 聪明笨狗 + * @since 2020-05-27 17:56 + */ +public interface UserBookMapper extends BaseMapper+ * 错题本业务类接口，定义了错题本相关的业务操作方法。 + * 该接口继承自 MyBatis-Plus 的 IService 接口，可使用其提供的基础服务方法。 + *
+ * + * @author 聪明笨狗 + * @since 2020-05-27 17:56 + */ +public interface UserBookService extends IService+ * 错题本服务实现类，实现了错题本相关的业务逻辑。 + *
+ * + * @author 聪明笨狗 + * @since 2020-05-27 17:56 + */ +@Service +public class UserBookServiceImpl extends ServiceImpl+ * 考试记录控制器，处理与用户考试记录相关的 HTTP 请求。 + * 该控制器提供了分页查询考试记录的接口。 + *
+ * + * @author 聪明笨狗 + * @since 2020-09-21 15:13 + */ +@Api(tags={"考试记录"}) +@RestController +@RequestMapping("/exam/api/user/exam") +public class UserExamController extends BaseController { + + /** + * 注入用户考试记录服务类，用于处理考试记录相关的业务逻辑。 + */ + @Autowired + private UserExamService baseService; + + /** + * 分页查找考试记录 + * @param reqDTO 包含分页信息和查询条件的请求对象，泛型为 UserExamReqDTO + * @return 包含分页结果的统一响应对象，分页结果为 UserExamRespDTO 类型 + */ + @ApiOperation(value = "分页查找") + @RequestMapping(value = "/paging", method = { RequestMethod.POST}) + public ApiRest+ * 考试记录数据传输类，用于在不同层（如控制层、服务层、数据访问层）之间传输考试记录相关的数据。 + * 该类封装了考试记录的基本信息，如用户ID、考试ID、考试次数、最高分数等。 + *
+ * + * @author 聪明笨狗 + * @since 2020-09-21 15:13 + */ +// 使用 Lombok 的 Data 注解，简化代码，自动生成常用方法 +@Data +// 使用 Swagger 的 ApiModel 注解，为 API 文档提供该类的描述信息 +@ApiModel(value="考试记录", description="考试记录") +public class UserExamDTO implements Serializable { + + // 序列化版本号，用于保证序列化和反序列化过程中类的版本一致性，避免版本不一致导致的错误 + private static final long serialVersionUID = 1L; + + /** + * 考试记录的唯一标识ID，用于在数据库中唯一确定一条考试记录。 + */ + private String id; + + /** + * 参加考试的用户ID，该字段为必填项，用于关联参加考试的用户。 + */ + @ApiModelProperty(value = "用户ID", required=true) + private String userId; + + /** + * 关联的考试ID，该字段为必填项。 + * @Dict 注解用于从 `el_exam` 表中根据 `id` 字段获取对应的 `title` 作为字典文本， + * 方便在前端展示考试的标题信息。 + */ + @Dict(dictTable = "el_exam", dicText = "title", dicCode = "id") + @ApiModelProperty(value = "考试ID", required=true) + private String examId; + + /** + * 用户参加该考试的次数，该字段为必填项，用于统计用户参加特定考试的频率。 + */ + @ApiModelProperty(value = "考试次数", required=true) + private Integer tryCount; + + /** + * 用户参加该考试获得的最高分数，该字段为必填项，用于记录用户在该考试中的最佳成绩。 + */ + @ApiModelProperty(value = "最高分数", required=true) + private Integer maxScore; + + /** + * 用户是否通过该考试，该字段为必填项，用于判断用户在考试中的最终结果。 + */ + @ApiModelProperty(value = "是否通过", required=true) + private Boolean passed; + + /** + * 考试记录的创建时间，记录该考试记录首次被创建的时间。 + */ + @ApiModelProperty(value = "创建时间") + private Date createTime; + + /** + * 考试记录的更新时间，记录该考试记录最后一次被修改的时间。 + */ + @ApiModelProperty(value = "更新时间") + private Date updateTime; + +} diff --git a/user/exam/dto/request/UserExamReqDTO.java b/user/exam/dto/request/UserExamReqDTO.java new file mode 100644 index 0000000..594eeb7 --- /dev/null +++ b/user/exam/dto/request/UserExamReqDTO.java @@ -0,0 +1,42 @@ +package com.yf.exam.modules.user.exam.dto.request; + +// 导入 UserExamDTO 类，作为当前类的父类 +import com.yf.exam.modules.user.exam.dto.UserExamDTO; +// 导入 Swagger 注解，用于 API 文档生成 +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +// 导入 Lombok 的 Data 注解，自动生成 getter、setter、toString 等方法 +import lombok.Data; + +/** + *+ * 考试记录数据传输类，用于封装考试记录相关的请求数据。 + * 该类继承自 UserExamDTO，可复用其属性，同时添加了额外的请求所需属性。 + *
+ * + * @author 聪明笨狗 + * @since 2020-09-21 15:13 + */ +// 使用 Lombok 的 Data 注解，自动生成常用方法 +@Data +// 使用 Swagger 的 ApiModel 注解，为 API 文档提供模型描述 +@ApiModel(value="考试记录", description="考试记录") +public class UserExamReqDTO extends UserExamDTO { + + // 序列化版本号，用于保证序列化和反序列化过程中类的版本一致性 + private static final long serialVersionUID = 1L; + + /** + * 考试名称，用于标识具体的考试，在请求中为必填项。 + */ + // 使用 Swagger 的 ApiModelProperty 注解，为 API 文档描述该属性 + @ApiModelProperty(value = "考试名称", required=true) + private String title; + + /** + * 参考人员的真实姓名，用于关联参加考试的人员，在请求中为必填项。 + */ + // 使用 Swagger 的 ApiModelProperty 注解，为 API 文档描述该属性 + @ApiModelProperty(value = "人员名称", required=true) + private String realName; +} diff --git a/user/exam/dto/response/UserExamRespDTO.java b/user/exam/dto/response/UserExamRespDTO.java new file mode 100644 index 0000000..982a836 --- /dev/null +++ b/user/exam/dto/response/UserExamRespDTO.java @@ -0,0 +1,36 @@ +package com.yf.exam.modules.user.exam.dto.response; + +import com.yf.exam.modules.user.exam.dto.UserExamDTO; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import lombok.Data; + +/** + *+ * 考试记录响应数据传输类，用于封装返回给前端的考试记录相关信息。 + * 该类继承自 UserExamDTO，复用其属性，同时添加了额外的响应所需属性。 + *
+ * + * @author 聪明笨狗 + * @since 2020-09-21 15:13 + */ +@Data +@ApiModel(value="考试记录", description="考试记录") +public class UserExamRespDTO extends UserExamDTO { + + // 序列化版本号，用于保证序列化和反序列化过程中类的版本一致性 + private static final long serialVersionUID = 1L; + + /** + * 考试名称，标识具体的考试，该信息在响应中为必填项。 + */ + @ApiModelProperty(value = "考试名称", required=true) + private String title; + + /** + * 参考人员的真实姓名，用于关联参加考试的人员，该信息在响应中为必填项。 + */ + @ApiModelProperty(value = "人员名称", required=true) + private String realName; + +} diff --git a/user/exam/entity/UserExam.java b/user/exam/entity/UserExam.java new file mode 100644 index 0000000..b1104ae --- /dev/null +++ b/user/exam/entity/UserExam.java @@ -0,0 +1,85 @@ +package com.yf.exam.modules.user.exam.entity; + +// 导入 MyBatis-Plus 主键类型注解，用于指定主键生成策略 +import com.baomidou.mybatisplus.annotation.IdType; +// 导入 MyBatis-Plus 表字段注解，用于指定实体类属性与数据库表字段的映射关系 +import com.baomidou.mybatisplus.annotation.TableField; +// 导入 MyBatis-Plus 表主键注解，用于指定实体类的主键属性 +import com.baomidou.mybatisplus.annotation.TableId; +// 导入 MyBatis-Plus 表名注解，用于指定实体类对应的数据库表名 +import com.baomidou.mybatisplus.annotation.TableName; +// 导入 MyBatis-Plus 活动记录模型类，实体类继承该类可使用活动记录模式操作数据库 +import com.baomidou.mybatisplus.extension.activerecord.Model; +// 导入 Lombok 的 Data 注解，自动生成 getter、setter、equals、hashCode 和 toString 方法 +import lombok.Data; +// 导入日期类，用于表示时间相关的属性 +import java.util.Date; + +/** + *+ * 考试记录实体类，对应数据库中的 `el_user_exam` 表，用于封装考试记录的相关信息。 + * 该类继承自 MyBatis-Plus 的 Model 类，可使用活动记录模式进行数据库操作。 + *
+ * + * @author 聪明笨狗 + * @since 2020-09-21 15:13 + */ +// 使用 Lombok 的 Data 注解，简化代码，自动生成常用方法 +@Data +// 使用 MyBatis-Plus 的 TableName 注解，指定该实体类对应的数据库表名为 `el_user_exam` +@TableName("el_user_exam") +public class UserExam extends Model+ * 考试记录Mapper接口，用于定义与考试记录相关的数据库操作方法。 + * 该接口继承自 MyBatis-Plus 的 BaseMapper 接口，可使用其提供的基础数据库操作方法。 + *
+ * + * @author 聪明笨狗 + * @since 2020-09-21 15:13 + */ +public interface UserExamMapper extends BaseMapper+ * 考试记录业务类，定义了与考试记录相关的业务操作接口。 + * 该接口继承自 MyBatis-Plus 的 IService 接口，可使用其提供的基础服务方法。 + *
+ * + * @author 聪明笨狗 + * @since 2020-09-21 15:13 + */ +public interface UserExamService extends IService+ * 考试记录业务实现类，实现了 UserExamService 接口，处理考试记录相关的业务逻辑。 + * 继承自 MyBatis-Plus 的 ServiceImpl 类，可使用其提供的基础服务方法。 + *
+ * + * @author 聪明笨狗 + * @since 2020-09-21 15:13 + */ +@Service +public class UserExamServiceImpl extends ServiceImpl