pagehelper的使用步骤及原理

目录

1 原理

2 使用方法

2.1 在pom中引入依赖坐标

2.2 在服务层中开启分页查询并封装结果

2.3 编写动态SQL

---

1 原理

PageHelper 是一个用于 MyBatis 的分页插件，其底层原理基于 MyBatis 的插件机制。它通过拦截 SQL 语句，解析用户传递的分页参数，并在原始 SQL 语句的基础上构造新的带有分页信息的 SQL 语句。这样，在查询执行时，实际执行的是带有分页条件的 SQL 语句，从而实现了简便的分页查询功能。 PageHelper 还通过 ThreadLocal 来确保在同一线程内的后续查询可以正确地使用相应的分页参数。

2 使用方法

2.1 在pom中引入依赖坐标

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.3.0</version>
</dependency>

2.2 在服务层中开启分页查询并封装结果

举个例子，如下：

@Service
public class ServiceImpl implements Service {
    //其它代码
    public PageResult pageQuery(EmployeePageQueryDTO employeePageQueryDTO) {
        //开启分页查询
        PageHelper.startPage(employeePageQueryDTO.getPage(), employeePageQueryDTO.getPageSize());
        Page<Employee> employees = employeeMapper.pageQuery(employeePageQueryDTO);

        //封装分页结果
        Long total = employees.getTotal();
        List<Employee> records = employees.getResult();

        return new PageResult(total, records);
    }

}

2.3 编写动态SQL

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.sky.mapper.EmployeeMapper">
    <select id="pageQuery" resultType="com.sky.entity.Employee">
        select * from employee
        <where>
            <if test="name != null and name != ''">
                and name like concat('%', #{name}, '%')
            </if>
        </where>
        order by create_time desc
    </select>
</mapper>