7.17 SpringBoot项目实战【学生入驻审核】（上）：分页查询PageHelper

た入场券 2023-10-16 15:56 12阅读 0赞

![CSDN成就一亿技术人][CSDN]

#### 文章目录 ####

*  前言
 *  一、service层 StudentService
 *  二、web层 StudentController
 *  三、PostMan测试
 *  最后

--------------------

## 前言 ##

在上文，学生已发起**提交借阅资格申请**（借阅证），那么将由**管理员审核**，审核的入口我们设计成**学生列表**，在这里查看待审核的学生，并可以执行审核等操作。本文我们花几分钟来实现这个学生列表，相关的知识点：**分页查询PageHelper**、**参数校验Validation**、**管理员权限校验**、**API接口定义**。

--------------------

## 一、service层 StudentService ##

> StudentService方法定义 (其它方法省略了)：

public interface StudentService {
        
        /**
         * 分页获取学生列表
         * @param pageNum 第几页
         * @param pageSize 一页显示多少条
         * @param examineStatus 审核状态：0-待审核 1-审核通过 2-驳回，如果为null，查询全部
         **/
        Page<StudentBO> getStudentPage(Integer pageNum, Integer pageSize, Integer examineStatus);
    }

> pageNum 第几页;
> 
> pageSize 一页显示多少条;
> 
> examineStatus，审核状态：0-待审核 1-审核通过 2-驳回，如果为null，查询全部

实现类 StudentServiceImpl：

@Service
    public class StudentServiceImpl implements StudentService {
        
        
        @Override
        public Page<StudentBO> getStudentPage(Integer pageNum, Integer pageSize, Integer examineStatus) {
        
            StudentExample example = new StudentExample();
            if (examineStatus != null) {
        
                example.createCriteria().andIsApprovedEqualTo(examineStatus);
            }
            // 查询并分页
            Page<Student> page = PageHelper.startPage(pageNum, pageSize)
                    .doSelectPage(() -> studentMapper.selectByExample(example));
            return CopyUtils.copyPage(page, StudentBO::new);
        }
    }

> 可以看出来，通过我们之前的积累，现在实现1个分页查询，只需要几行代码~

复习一下代码要点：

*  **MBG自动生成 by example**

> studentMapper.`selectByExample` 是`MBG`代码生成器提供的 `by example`，可以按条件查询学生列表，这里可选条件是`.andIsApprovedEqualTo(examineStatus)`  
> 详见：[5.6 Mybatis代码生成器Mybatis Generator (MBG)实战详解][5.6 Mybatis_Mybatis Generator _MBG]

*  **PageHelper.startPage**

> springboot整合pageHelper：`pagehelper-spring-boot-starter`  
> 个人喜欢的使用方式：
> 
>     Page<XxxBO> page = PageHelper.startPage(pgeNum, pageSize)
>     .doSelectPage(() -> 你的查询方法);
> 
> 详见：[7.3 SpringBoot整合MyBatis分页插件github.pageHelper：实现图书列表API][7.3 SpringBoot_MyBatis_github.pageHelper_API]

*  **CopyUtils.copyPage**

> 我们之前实现了`Page<T>`泛型对象的拷贝  
> 详见：[7.9 SpringBoot实战 拷贝工具类，扩展BeanUtils.copyProperties][7.9 SpringBoot_ _BeanUtils.copyProperties]

--------------------

## 二、web层 StudentController ##

> StudentController接口定义 (其它方法省略了)：

@RestController
    @RequestMapping("/student")
    @Validated
    public class StudentController {
        
    
        @Autowired
        private StudentService studentService;
    
        @Role
        @GetMapping("/list")
        public TgResult getStudentList(@Valid StudentListVO studentListVO) {
        
            Page<StudentBO> studentPage = studentService.getStudentPage(studentListVO.getPageNum()
                    , studentListVO.getPageSize(), studentListVO.getExamineStatus());
            return TgResult.ok(studentPage);
        }
    }

对于`StudentController`上的三个注解，复习一下：

*  **@RestController**

> 等同于@Controller + @ResponseBody，用于定义SpringBoot项目的控制器类

*  **@RequestMapping**

> 用于处理`请求映射`，定义请求路径，也就是这个类中接口前缀为`/student`

*  **@Validated**

> Spring Validation参数校验注解

对于`getStudentList`，说明如下：

*  **@Role注解**

> 是我们自定义的注解，用于管理员权限校验，当不是管理员调用该API时，会返回`403 无权限`。  
> 共通过两种方式实现：
> 
> 1.  通过`拦截器Interceptor`的实现：[7.5 SpringBoot 拦截器Interceptor实战 统一角色权限校验][7.5 SpringBoot _Interceptor_]
> 2.  通过`@Aspect` AOP实现：[7.6 SpringBoot AOP实战 统一角色权限校验][7.6 SpringBoot AOP_]

*  **@GetMapping(“/list”)**

> GET请求的标准方式，加上Controller上的路径，完整接口路径为：`/student/list`

*  **@Valid注解**

> 凡是使用Validation校验参数对象，都需要加`@Valid`或`@Validated`注解  
> 详见：[7.13 在SpringBoot中 正确使用Validation实现参数效验][7.13 _SpringBoot_ _Validation]

*  **TgResult**

> 封装的统一返回结果  
> 详见：[2-2. SpringBoot API开发详解 --SpringMVC注解+封装结果+支持跨域+打包][2-2. SpringBoot API_ --SpringMVC]

新建的`StudentListVO`代码如下：

@Data
    public class StudentListVO implements Serializable {
        
        @Min(value = 1, message = "pageNum必须大于0")
        private Integer pageNum = 1;
    
        @Max(value = 100, message = "pageSize不能超过100")
        private Integer pageSize = 100;
    
        @Min(value = 0, message = "examineStatus：0-待审核 1-审核通过 2-驳回")
        @Max(value = 2, message = "examineStatus：0-待审核 1-审核通过 2-驳回")
        private Integer examineStatus;
    }

> 这里主要使用的就是【7.13】的Validation

## 三、PostMan测试 ##

1.  学生调用，返回403，无权限

![在这里插入图片描述][8f0595bec0d34fdbb2444e7db90a2da7.png_pic_center]

1.  管理员调用

> 使用管理员账号，可以正常访问到`待审核的学生列表`

![在这里插入图片描述][19ece8b761854721bc72b17df57dd0e2.png_pic_center]

> `examineStatus`参数为空，则查询所有学生，如下图

![在这里插入图片描述][b5a2b68cdeeb4acda890a872c0cb02c3.png_pic_center]

--------------------

## 最后 ##

看到这，觉得有帮助的，刷波666，感谢大家的支持~

想要看更多实战好文章，还是给大家推荐我的实战专栏–>《基于SpringBoot+SpringCloud+Vue前后端分离项目实战》，由我和 [前端狗哥][Link 1] 合力打造的一款专栏，可以让你从0到1快速拥有企业级规范的项目实战经验！

具体的优势、规划、技术选型都可以在《[开篇][Link 2]》试读！

订阅专栏后可以添加我的微信，我会为每一位用户进行针对性指导！

另外，别忘了关注我：[天罡gg][gg] ，怕你找不到我，发布新文不容易错过： https://blog.csdn.net/scm\_2008

[CSDN]: https://img-blog.csdnimg.cn/63748e72dc314943857316f3b1f6a386.gif#pic_center
[5.6 Mybatis_Mybatis Generator _MBG]: https://blog.csdn.net/scm_2008/article/details/130630861
[7.3 SpringBoot_MyBatis_github.pageHelper_API]: https://blog.csdn.net/scm_2008/article/details/131374809
[7.9 SpringBoot_ _BeanUtils.copyProperties]: https://blog.csdn.net/scm_2008/article/details/132263328
[7.5 SpringBoot _Interceptor_]: https://blog.csdn.net/scm_2008/article/details/131711216
[7.6 SpringBoot AOP_]: https://blog.csdn.net/scm_2008/article/details/131840651
[7.13 _SpringBoot_ _Validation]: https://blog.csdn.net/scm_2008/article/details/132790737
[2-2. SpringBoot API_ --SpringMVC]: https://blog.csdn.net/scm_2008/article/details/129674701
[8f0595bec0d34fdbb2444e7db90a2da7.png_pic_center]: https://img-blog.csdnimg.cn/8f0595bec0d34fdbb2444e7db90a2da7.png#pic_center
[19ece8b761854721bc72b17df57dd0e2.png_pic_center]: https://img-blog.csdnimg.cn/19ece8b761854721bc72b17df57dd0e2.png#pic_center
[b5a2b68cdeeb4acda890a872c0cb02c3.png_pic_center]: https://img-blog.csdnimg.cn/b5a2b68cdeeb4acda890a872c0cb02c3.png#pic_center
[Link 1]: https://blog.csdn.net/xingyu_qie?type=blog
[Link 2]: https://blog.csdn.net/scm_2008/article/details/129387927
[gg]: https://blog.csdn.net/scm_2008