vo 简化：post 重构

YunaiV
1 parent e8bc284d
Showing 16 changed files with 82 additions and 188 deletions
yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageParam.java
yudao-framework/yudao-spring-boot-starter-mybatis/src/main/java/cn/iocoder/yudao/framework/mybatis/core/mapper/BaseMapperX.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/PostController.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostCreateReqVO.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostExcelVO.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostExportReqVO.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostListReqVO.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostRespVO.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostSimpleRespVO.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostUpdateReqVO.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/convert/dept/PostConvert.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/dal/mysql/dept/PostMapper.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/dept/PostService.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/dept/PostServiceImpl.java
yudao-module-system/yudao-module-system-biz/src/test/java/cn/iocoder/yudao/module/system/service/dept/PostServiceImplTest.java
@@ -15,6 +15,13 @@ public class PageParam implements Serializable {
     private static final Integer PAGE_NO = 1;
     private static final Integer PAGE_SIZE = 10;
+    /**
+     * 每页条数 - 不分页
+     *
+     * 例如说，导出接口，可以设置 {@link #pageSize} 为 -1 不分页，查询所有数据。
+     */
+    public static final Integer PAGE_SIZE_NONE = -1;
+
     @Schema(description = "页码，从 1 开始", requiredMode = Schema.RequiredMode.REQUIRED,example = "1")
     @NotNull(message = "页码不能为空")
     @Min(value = 1, message = "页码最小值为 1")
@@ -26,6 +26,12 @@ import java.util.List;
 public interface BaseMapperX<T> extends MPJBaseMapper<T> {
     default PageResult<T> selectPage(PageParam pageParam, @Param("ew") Wrapper<T> queryWrapper) {
+        // 特殊：不分页，直接查询全部
+        if (PageParam.PAGE_SIZE_NONE.equals(pageParam.getPageNo())) {
+            List<T> list = selectList(queryWrapper);
+            return new PageResult<>(list, (long) list.size());
+        }
+
         // MyBatis Plus 查询
         IPage<T> mpPage = MyBatisUtils.buildPage(pageParam);
         selectPage(mpPage, queryWrapper);
@@ -2,6 +2,7 @@ package cn.iocoder.yudao.module.system.controller.admin.dept;
 import cn.iocoder.yudao.framework.common.enums.CommonStatusEnum;
 import cn.iocoder.yudao.framework.common.pojo.CommonResult;
+import cn.iocoder.yudao.framework.common.pojo.PageParam;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.excel.core.util.ExcelUtils;
 import cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog;
@@ -39,16 +40,16 @@ public class PostController {
     @PostMapping("/create")
     @Operation(summary = "创建岗位")
     @PreAuthorize("@ss.hasPermission('system:post:create')")
-    public CommonResult<Long> createPost(@Valid @RequestBody PostCreateReqVO reqVO) {
-        Long postId = postService.createPost(reqVO);
+    public CommonResult<Long> createPost(@Valid @RequestBody PostReqVO createReqVO) {
+        Long postId = postService.createPost(createReqVO);
         return success(postId);
     }
     @PutMapping("/update")
     @Operation(summary = "修改岗位")
     @PreAuthorize("@ss.hasPermission('system:post:update')")
-    public CommonResult<Boolean> updatePost(@Valid @RequestBody PostUpdateReqVO reqVO) {
-        postService.updatePost(reqVO);
+    public CommonResult<Boolean> updatePost(@Valid @RequestBody PostReqVO updateReqVO) {
+        postService.updatePost(updateReqVO);
         return success(true);
     }
@@ -69,13 +70,13 @@ public class PostController {
     }
     @GetMapping("/list-all-simple")
-    @Operation(summary = "获取岗位精简信息列表", description = "只包含被开启的岗位，主要用于前端的下拉选项")
-    public CommonResult<List<PostSimpleRespVO>> getSimplePostList() {
+    @Operation(summary = "获取岗位全列表", description = "只包含被开启的岗位，主要用于前端的下拉选项")
+    public CommonResult<List<PostRespVO>> getSimplePostList() {
         // 获得岗位列表，只要开启状态的
         List<PostDO> list = postService.getPostList(null, Collections.singleton(CommonStatusEnum.ENABLE.getStatus()));
         // 排序后，返回给前端
         list.sort(Comparator.comparing(PostDO::getSort));
-        return success(PostConvert.INSTANCE.convertList02(list));
+        return success(PostConvert.INSTANCE.convertList(list));
     }
     @GetMapping("/page")
@@ -89,11 +90,12 @@ public class PostController {
     @Operation(summary = "岗位管理")
     @PreAuthorize("@ss.hasPermission('system:post:export')")
     @OperateLog(type = EXPORT)
-    public void export(HttpServletResponse response, @Validated PostExportReqVO reqVO) throws IOException {
-        List<PostDO> posts = postService.getPostList(reqVO);
-        List<PostExcelVO> data = PostConvert.INSTANCE.convertList03(posts);
+    public void export(HttpServletResponse response, @Validated PostPageReqVO reqVO) throws IOException {
+        reqVO.setPageSize(PageParam.PAGE_SIZE_NONE);
+        PageResult<PostDO> pageResult = postService.getPostPage(reqVO);
         // 输出
-        ExcelUtils.write(response, "岗位数据.xls", "岗位列表", PostExcelVO.class, data);
+        PageResult<PostRespVO> list = PostConvert.INSTANCE.convertPage(pageResult);
+        ExcelUtils.write(response, "岗位数据.xls", "岗位列表", PostRespVO.class, list.getList());
     }
 }
-package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.Data;
-import lombok.EqualsAndHashCode;
-
-@Schema(description = "管理后台 - 岗位创建 Request VO")
-@Data
-@EqualsAndHashCode(callSuper = true)
-public class PostCreateReqVO extends PostBaseVO {
-}
-package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
-
-import cn.iocoder.yudao.framework.excel.core.annotations.DictFormat;
-import cn.iocoder.yudao.framework.excel.core.convert.DictConvert;
-import cn.iocoder.yudao.module.system.enums.DictTypeConstants;
-import com.alibaba.excel.annotation.ExcelProperty;
-import lombok.Data;
-
-/**
- * 岗位 Excel 导出响应 VO
- */
-@Data
-public class PostExcelVO {
-
-    @ExcelProperty("岗位序号")
-    private Long id;
-
-    @ExcelProperty("岗位编码")
-    private String code;
-
-    @ExcelProperty("岗位名称")
-    private String name;
-
-    @ExcelProperty("岗位排序")
-    private Integer sort;
-
-    @ExcelProperty(value = "状态", converter = DictConvert.class)
-    @DictFormat(DictTypeConstants.COMMON_STATUS)
-    private String status;
-
-}
-package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.Data;
-
-@Schema(description = "管理后台 - 岗位导出 Request VO，参数和 PostExcelVO 是一致的")
-@Data
-public class PostExportReqVO {
-
-    @Schema(description = "岗位编码，模糊匹配", example = "yudao")
-    private String code;
-
-    @Schema(description = "岗位名称，模糊匹配", example = "芋道")
-    private String name;
-
-    @Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1")
-    private Integer status;
-
-}
-package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.Data;
-import lombok.EqualsAndHashCode;
-
-@Schema(description = "管理后台 - 岗位列表 Request VO")
-@Data
-@EqualsAndHashCode(callSuper = true)
-public class PostListReqVO extends PostBaseVO {
-
-    @Schema(description = "岗位名称，模糊匹配", example = "芋道")
-    private String name;
-
-    @Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1")
-    private Integer status;
-
-}
 package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
+
+import cn.iocoder.yudao.framework.common.enums.CommonStatusEnum;
+import cn.iocoder.yudao.framework.common.validation.InEnum;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
@@ -6,16 +9,16 @@ import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Size;
-/**
- * 岗位 Base VO，提供给添加、修改、详细的子 VO 使用
- * 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成
- */
+@Schema(description = "管理后台 - 岗位创建/修改 Request VO")
 @Data
-public class PostBaseVO {
+public class PostReqVO {
+
+    @Schema(description = "岗位编号", example = "1024")
+    private Long id;
-    @Schema(description = "岗位名称", requiredMode = Schema.RequiredMode.REQUIRED, example = "小博主")
+    @Schema(description = "岗位名称", requiredMode = Schema.RequiredMode.REQUIRED, example = "小土豆")
     @NotBlank(message = "岗位名称不能为空")
-    @Size(max = 50, message = "岗位名称长度不能超过50个字符")
+    @Size(max = 50, message = "岗位名称长度不能超过 50 个字符")
     private String name;
     @Schema(description = "岗位编码", requiredMode = Schema.RequiredMode.REQUIRED, example = "yudao")
@@ -27,10 +30,11 @@ public class PostBaseVO {
     @NotNull(message = "显示顺序不能为空")
     private Integer sort;
-    @Schema(description = "状态，参见 CommonStatusEnum 枚举类", requiredMode = Schema.RequiredMode.REQUIRED, example = "1")
+    @Schema(description = "状态", requiredMode = Schema.RequiredMode.REQUIRED, example = "1")
+    @InEnum(CommonStatusEnum.class)
     private Integer status;
     @Schema(description = "备注", example = "快乐的备注")
     private String remark;
 -}
+}
 \ No newline at end of file
 package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
+import cn.iocoder.yudao.framework.excel.core.annotations.DictFormat;
+import cn.iocoder.yudao.module.system.enums.DictTypeConstants;
+import com.alibaba.excel.annotation.ExcelProperty;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
-import lombok.EqualsAndHashCode;
 import java.time.LocalDateTime;
 @Schema(description = "管理后台 - 岗位信息 Response VO")
 @Data
-@EqualsAndHashCode(callSuper = true)
-public class PostRespVO extends PostBaseVO {
+public class PostRespVO {
     @Schema(description = "岗位序号", requiredMode = Schema.RequiredMode.REQUIRED, example = "1024")
+    @ExcelProperty("岗位序号")
     private Long id;
-    @Schema(description = "创建时间", requiredMode = Schema.RequiredMode.REQUIRED, example = "时间戳格式")
+    @Schema(description = "岗位名称", requiredMode = Schema.RequiredMode.REQUIRED, example = "小土豆")
+    @ExcelProperty("岗位名称")
+    private String name;
+
+    @Schema(description = "岗位编码", requiredMode = Schema.RequiredMode.REQUIRED, example = "yudao")
+    @ExcelProperty("岗位编码")
+    private String code;
+
+    @Schema(description = "显示顺序不能为空", requiredMode = Schema.RequiredMode.REQUIRED, example = "1024")
+    @ExcelProperty("岗位排序")
+    private Integer sort;
+
+    @Schema(description = "状态，参见 CommonStatusEnum 枚举类", requiredMode = Schema.RequiredMode.REQUIRED, example = "1")
+    @DictFormat(DictTypeConstants.COMMON_STATUS)
+    private Integer status;
+
+    @Schema(description = "备注", example = "快乐的备注")
+    private String remark;
+
+    @Schema(description = "创建时间", requiredMode = Schema.RequiredMode.REQUIRED)
     private LocalDateTime createTime;
 }
-package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.AllArgsConstructor;
-import lombok.Data;
-import lombok.NoArgsConstructor;
-
-@Schema(description = "管理后台 - 岗位精简信息 Response VO")
-@Data
-@NoArgsConstructor
-@AllArgsConstructor
-public class PostSimpleRespVO {
-
-    @Schema(description = "岗位编号", requiredMode = Schema.RequiredMode.REQUIRED, example = "1024")
-    private Long id;
-
-    @Schema(description = "岗位名称", requiredMode = Schema.RequiredMode.REQUIRED, example = "芋道")
-    private String name;
-
-}
-package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post;
-
-import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.Data;
-import lombok.EqualsAndHashCode;
-
-import javax.validation.constraints.NotNull;
-
-@Schema(description = "管理后台 - 岗位更新 Request VO")
-@Data
-@EqualsAndHashCode(callSuper = true)
-public class PostUpdateReqVO extends PostBaseVO {
-
-    @Schema(description = "岗位编号", requiredMode = Schema.RequiredMode.REQUIRED, example = "1024")
-    @NotNull(message = "岗位编号不能为空")
-    private Long id;
-
-}
@@ -13,16 +13,12 @@ public interface PostConvert {
     PostConvert INSTANCE = Mappers.getMapper(PostConvert.class);
-    List<PostSimpleRespVO> convertList02(List<PostDO> list);
+    List<PostRespVO> convertList(List<PostDO> list);
     PageResult<PostRespVO> convertPage(PageResult<PostDO> page);
-    PostRespVO convert(PostDO id);
+    PostRespVO convert(PostDO bean);
-    PostDO convert(PostCreateReqVO bean);
-
-    PostDO convert(PostUpdateReqVO reqVO);
-
-    List<PostExcelVO> convertList03(List<PostDO> list);
+    PostDO convert(PostReqVO bean);
 }
@@ -3,7 +3,6 @@ package cn.iocoder.yudao.module.system.dal.mysql.dept;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.mybatis.core.mapper.BaseMapperX;
 import cn.iocoder.yudao.framework.mybatis.core.query.LambdaQueryWrapperX;
-import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostExportReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostPageReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.dept.PostDO;
 import org.apache.ibatis.annotations.Mapper;
@@ -28,13 +27,6 @@ public interface PostMapper extends BaseMapperX&lt;PostDO&gt; {
                 .orderByDesc(PostDO::getId));
     }
-    default List<PostDO> selectList(PostExportReqVO reqVO) {
-        return selectList(new LambdaQueryWrapperX<PostDO>()
-                .likeIfPresent(PostDO::getCode, reqVO.getCode())
-                .likeIfPresent(PostDO::getName, reqVO.getName())
-                .eqIfPresent(PostDO::getStatus, reqVO.getStatus()));
-    }
-
     default PostDO selectByName(String name) {
         return selectOne(PostDO::getName, name);
     }
@@ -2,10 +2,8 @@ package cn.iocoder.yudao.module.system.service.dept;
 import cn.iocoder.yudao.framework.common.enums.CommonStatusEnum;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
-import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostCreateReqVO;
-import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostExportReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostPageReqVO;
-import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostUpdateReqVO;
+import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.dept.PostDO;
 import org.springframework.lang.Nullable;
@@ -24,17 +22,17 @@ public interface PostService {
     /**
      * 创建岗位
      *
-     * @param reqVO 岗位信息
+     * @param createReqVO 岗位信息
      * @return 岗位编号
      */
-    Long createPost(PostCreateReqVO reqVO);
+    Long createPost(PostReqVO createReqVO);
     /**
      * 更新岗位
      *
-     * @param reqVO 岗位信息
+     * @param updateReqVO 岗位信息
      */
-    void updatePost(PostUpdateReqVO reqVO);
+    void updatePost(PostReqVO updateReqVO);
     /**
      * 删除岗位信息
@@ -71,14 +69,6 @@ public interface PostService {
     PageResult<PostDO> getPostPage(PostPageReqVO reqVO);
     /**
-     * 获得岗位列表
-     *
-     * @param reqVO 查询条件
-     * @return 部门列表
-     */
-    List<PostDO> getPostList(PostExportReqVO reqVO);
-
-    /**
      * 获得岗位信息
      *
      * @param id 岗位编号
@@ -3,10 +3,8 @@ package cn.iocoder.yudao.module.system.service.dept;
 import cn.hutool.core.collection.CollUtil;
 import cn.iocoder.yudao.framework.common.enums.CommonStatusEnum;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
-import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostCreateReqVO;
-import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostExportReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostPageReqVO;
-import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostUpdateReqVO;
+import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostReqVO;
 import cn.iocoder.yudao.module.system.convert.dept.PostConvert;
 import cn.iocoder.yudao.module.system.dal.dataobject.dept.PostDO;
 import cn.iocoder.yudao.module.system.dal.mysql.dept.PostMapper;
@@ -35,23 +33,23 @@ public class PostServiceImpl implements PostService {
     private PostMapper postMapper;
     @Override
-    public Long createPost(PostCreateReqVO reqVO) {
+    public Long createPost(PostReqVO createReqVO) {
         // 校验正确性
-        validatePostForCreateOrUpdate(null, reqVO.getName(), reqVO.getCode());
+        validatePostForCreateOrUpdate(null, createReqVO.getName(), createReqVO.getCode());
         // 插入岗位
-        PostDO post = PostConvert.INSTANCE.convert(reqVO);
+        PostDO post = PostConvert.INSTANCE.convert(createReqVO);
         postMapper.insert(post);
         return post.getId();
     }
     @Override
-    public void updatePost(PostUpdateReqVO reqVO) {
+    public void updatePost(PostReqVO updateReqVO) {
         // 校验正确性
-        validatePostForCreateOrUpdate(reqVO.getId(), reqVO.getName(), reqVO.getCode());
+        validatePostForCreateOrUpdate(updateReqVO.getId(), updateReqVO.getName(), updateReqVO.getCode());
         // 更新岗位
-        PostDO updateObj = PostConvert.INSTANCE.convert(reqVO);
+        PostDO updateObj = PostConvert.INSTANCE.convert(updateReqVO);
         postMapper.updateById(updateObj);
     }
@@ -120,11 +118,6 @@ public class PostServiceImpl implements PostService {
     }
     @Override
-    public List<PostDO> getPostList(PostExportReqVO reqVO) {
-        return postMapper.selectList(reqVO);
-    }
-
-    @Override
     public PostDO getPost(Long id) {
         return postMapper.selectById(id);
     }
@@ -4,7 +4,7 @@ import cn.iocoder.yudao.framework.common.enums.CommonStatusEnum;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.common.util.collection.ArrayUtils;
 import cn.iocoder.yudao.framework.test.core.ut.BaseDbUnitTest;
-import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostCreateReqVO;
+import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostExportReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostPageReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.dept.vo.post.PostUpdateReqVO;
@@ -44,7 +44,7 @@ public class PostServiceImplTest extends BaseDbUnitTest {
     @Test
     public void testCreatePost_success() {
         // 准备参数
-        PostCreateReqVO reqVO = randomPojo(PostCreateReqVO.class,
+        PostReqVO reqVO = randomPojo(PostReqVO.class,
                 o -> o.setStatus(randomEle(CommonStatusEnum.values()).getStatus()));
         // 调用
         Long postId = postService.createPost(reqVO);
@@ -103,7 +103,7 @@ public class PostServiceImplTest extends BaseDbUnitTest {
         PostDO postDO = randomPostDO();
         postMapper.insert(postDO);// @Sql: 先插入出一条存在的数据
         // 准备参数
-        PostCreateReqVO reqVO = randomPojo(PostCreateReqVO.class,
+        PostReqVO reqVO = randomPojo(PostReqVO.class,
             // 模拟 name 重复
             o -> o.setName(postDO.getName()));
         assertServiceException(() -> postService.createPost(reqVO), POST_NAME_DUPLICATE);