23. Mybatis 分页插件-PageHelperPlus

电玩女神 2024-04-17 15:00 47阅读 0赞

对于PageHelper, 笔者认为其API 设计有些不够友好, 导致写出的代码不够优雅. 所以, 笔者基于PageHelper 开发了一个PageHelperPlus 插件, 以实现更优雅地方式使用PageHelper. 笔者期望实现的是, 当接口参数中包含分页参数时, 自动进行分页, 并将结果集封装为PageResult 对象, 而无须手动封装为PageInfo 对象.

## 1. 集成方式 ##

*  由于jar包暂未共享在maven中央私服上, 所以需要实现下载jar包, 部署maven 本地仓库或私有仓库.
 *  jar包下载地址: https://download.csdn.net/download/zongf0504/11241003

### 1.1 引入依赖 ###

<dependency>
        <groupId>org.zongf.plugins</groupId>
        <artifactId>mybatis-pagehelper-plus</artifactId>
        <version>1.0-RELEASE</version>
    </dependency>

### 1.2 集成配置 ###

参数完全兼容PageHelper 的所有参数, 笔者只习惯设置reasonable.

## 2. 使用示例 ##

### 2.1 接口设计 ###

*  当参数中包含PageBounds 参数时, 会自动进行分页查询, 并将结果集自动封装为PageResult 对象.
 *  当参数中不包含PageBounds 参数时, 不会进行分页查询, 结果集会返回ArrayList对象.

// 不分页
    List<StudentPO> queryAll();
    
    // 分页
    PageResult<StudentPO> queryAll(PageBounds pagerBounds);
    
    // 不分页
    List<StudentPO> queryBySex(@Param("sex") String sex );
    
    // 分页
    PageResult<StudentPO> queryBySex(@Param("sex") String sex, PageBounds pagerBounds);

### 2.2 sql映射文件 ###

<select id="queryAll" resultType="StudentPO">
        select * from t_student
    </select>
    
    
    <select id="queryBySex" resultType="StudentPO">
        select * from t_student where sex = #{sex}
    </select>

### 2.3 测试用例 ###

// 测试无条件, 不分页
    @Test
    public void test1(){ 
    
        StudentMapper mapper = SqlSessionUtil.getMapper(StudentMapper.class);
    
        List<StudentPO> list = mapper.queryAll();
        System.out.println(list.getClass() + ":" + list.size());
    }
    
    // 测试无条件, 分页
    @Test
    public void test2(){ 
    
        StudentMapper mapper = SqlSessionUtil.getMapper(StudentMapper.class);
    
        PageResult<StudentPO> pageList = mapper.queryAll(new PageBounds(1, 10));
        System.out.println(pageList.getClass() + ":" + pageList.size());
        System.out.println(pageList);
    }
    
    // 测试有条件, 不分页
    @Test
    public void test3(){ 
    
        StudentMapper mapper = SqlSessionUtil.getMapper(StudentMapper.class);
    
        List<StudentPO> list = mapper.queryBySex("W");
        System.out.println(list.getClass() + ":" + list.size());
    }
    
    // 测试有条件, 分页
    @Test
    public void test4(){ 
    
        StudentMapper mapper = SqlSessionUtil.getMapper(StudentMapper.class);
    
        PageResult<StudentPO> pageList = mapper.queryBySex("W", PageBounds.of(1, 10000));
        System.out.println(pageList.getClass() + ":" + pageList.size());
        System.out.println(pageList);
    }