springboot使用Mybatis分页插件pagehelper

前言：分页查询是十分常用且重要的一个功能，可以减轻数据库的查询压力，且方便前端的展示。

当今的 java 框架中，springboot已经占据了很大的优势，也吸了很多开发者粉丝，因为便捷快速！那么如何在springboot中使用分页查询呢？上代码与图片

注：需要使用到几个工具类，PageQuery、SqlFixlnjectionUtils

首先在pom.xml中引入分页插件：

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>4.1.6</version>
</dependency>

需要注意的是，工具类中使用的stringUtils是 org.apache.commons.lang3 包，如果找不到此包请自行百度 maven 引入

PageQuery实体的主要属性如下（get 和 set 方法自行补充）：

public class PageQuery<T> implements Serializable {

    private String orderBy;
    /**
     * 每页多少个元素
     */
    private Integer pageSize = 10;
    /**
     * 当前页码
     */
    private Integer pageNo = 1;
    /**
     * 元素总个数
     */
    private Long total;
    /**
     * 总页码
     */
    private Integer pages;
    /**
     * 元素列表
     */
    private List<T> list;

}

SqlFixlnjectionUtils 工具类的代码如下：

public class SqlFixInjectionUtils {

    public static String fixOrderBy(String orderBy) {
        if (StringUtils.isBlank(orderBy)) {
            return orderBy;
        }
        String reg = "(?:')|(?:--)|(/\\*(?:.|[\\n\\r])*?\\*/)|"
                + "(\\b(select|update|and|or|delete|insert|trancate|char|into|substr|ascii|declare|exec|count|master|into|drop|execute)\\b)";
        Pattern sqlPattern = Pattern.compile(reg, Pattern.CASE_INSENSITIVE);
        if (sqlPattern.matcher(orderBy).find()) {
            return "";
        }
        return orderBy;
    }
}

以上就对分页需要用到的工具类和插件包，那么现在可以开始写service了，在service层中写 findPage 的分页方法，代码如下：

public PageQuery<T> findPage(PageQuery pageQuery, T entity) {
        String orderBy = pageQuery.getOrderBy();
        PageHelper.orderBy(SqlFixInjectionUtils.fixOrderBy(orderBy));
        PageHelper.startPage(pageQuery.getPageNo(), pageQuery.getPageSize());
        Page<T> page = (Page<T>)dao.selectList(entity);
        List<T> list = Lists.newArrayList(page);
        PageQuery pageResult = new PageQuery();
        pageResult.setList(list);
        pageResult.setOrderBy(orderBy);
        pageResult.setPageNo(pageQuery.getPageNo());
        pageResult.setPageSize(page.getPageSize());
        pageResult.setPages(page.getPages());
        pageResult.setTotal(page.getTotal());
        return pageResult;
}

实体T就是你要对分页查询获取的实体，自行修改为使用的实体对象。dao.selectList 的 selectList 对应 sql 的正常查询方法，无需做特殊处理。

那么现在直接在 controller 调用 findPage 即可实现分页查询！

激动得赶紧运行项目，但发现查询报错了，报了 lists 和 pageHelper 转换失败的错误。

这时候还需配置一下 pageHelper

在配置文件xml中加上这句话即可，大概的作用是声明了pageHelper拦截器，因为本身分页插件就是在执行sql前进行拦截然后修改sql语句，实现分页查询的

<plugins>
    <plugin interceptor="com.github.pagehelper.PageHelper">
            <!--<property name="dialect" value="mysql"/>-->
    </plugin>
</plugins>

再次访问 controller 返回的数据大概是这样：

说明分页成功啦！恭喜哈哈哈哈

再附上之前初次使用分页遇到的一些问题截图

springboot使用Mybatis分页插件pagehelper

猜你喜欢