pagehelper是怎么实现分页的，

PageHelper 是基于 MyBatis 的分页插件，其核心实现原理是通过 拦截器（Interceptor） 动态修改 SQL 语句并自动计算分页参数。以下是其实现分页的主要步骤：

一、核心实现机制

1、拦截 MyBatis 的 SQL 执行流程

PageHelper 实现 MyBatis 的 Interceptor 接口，拦截 Executor 的 query() 方法。在 SQL 执行前，动态修改原始 SQL，添加分页逻辑（如 LIMIT、ROWNUM 等）。

2、分页参数存储（ThreadLocal）

调用 PageHelper.startPage(pageNum, pageSize) 时，分页参数（页码、每页条数）会被存储到 ThreadLocal 中，确保同一线程内后续查询自动应用分页。

3、数据库方言适配（Dialect）

根据配置的数据库类型（如 MySQL、Oracle），选择对应的 Dialect 实现类，生成适配当前数据库的分页 SQL。

示例：

o MySQL: SELECT * FROM table LIMIT {offset}, {pageSize} 

oOracle: SELECT * FROM ( SELECT tmp.*, ROWNUM row_id FROM (原始SQL) tmp ) WHERE row_id > {offset} AND row_id <= {offset + pageSize}

4、自动计算总记录数

执行分页查询前，会先执行 COUNT 查询获取总记录数，用于生成分页信息（总页数、总条数等）。

二、分页流程详解

1、用户调用 startPage()

PageHelper.startPage(1, 10); // 第1页，每页10条
List<User> users = userMapper.selectAll();

o 分页参数存入 ThreadLocal。

2、拦截 SQL 并重写

o 拦截 selectAll() 对应的 SQL，根据数据库类型生成分页 SQL。

o 原始 SQL: SELECT * FROM user o 改写后（MySQL）: SELECT * FROM user LIMIT 0, 10

3、执行分页查询和 COUNT 查询

o 主查询：执行改写后的 SQL，获取当前页数据。

o COUNT 查询：自动生成 SELECT COUNT(1) FROM user，计算总记录数。

4、封装分页结果（Page 对象）

o 将分页数据、总记录数、页码等信息封装到 Page 或 PageInfo 对象中。

PageInfo<User> pageInfo = new PageInfo<>(users);
System.out.println("总条数: " + pageInfo.getTotal());

三、关键代码实现

1、拦截器配置（MyBatis 插件）

<!-- mybatis-config.xml -->
<plugins>
  <plugin interceptor="com.github.pagehelper.PageInterceptor">
    <!-- 配置数据库方言 -->
    <property name="helperDialect" value="mysql"/>
  </plugin>
</plugins>

2、SQL 改写逻辑（Dialect 实现）

public class MySqlDialect extends AbstractHelperDialect {
  @Override
  public String getPageSql(String sql, Page page) {
    StringBuilder sqlBuilder = new StringBuilder(sql);
    sqlBuilder.append(" LIMIT ?, ?");
    return sqlBuilder.toString();
  }
}

3、ThreadLocal 存储分页参数

public class PageHelper {
  private static final ThreadLocal<Page> LOCAL_PAGE = new ThreadLocal<>();
  
  public static void startPage(int pageNum, int pageSize) {
    Page page = new Page(pageNum, pageSize);
    LOCAL_PAGE.set(page);
  }
}
 

四、注意事项

1、分页紧跟查询语句 startPage()

必须紧跟在需要分页的查询方法前调用，否则 ThreadLocal 参数可能被其他查询误用。

2、清除 ThreadLocal

建议在 finally 块中调用 PageHelper.clearPage()，避免内存泄漏。

try {
  PageHelper.startPage(1, 10);
  userMapper.selectAll();
} finally {
  PageHelper.clearPage();
}

3、复杂 SQL 处理

对于嵌套查询或多表联查，需确保 SQL 能被正确解析和改写，必要时手动优化 SQL。

五、高级特性

1、物理分页 vs 内存分页

o 物理分页（默认）：通过改写 SQL 在数据库层面分页（高效）。

o 内存分页：设置 pageSizeZero=true 且 pageSize=0 时，先查全部数据再内存分页（低效，慎用）。

2、多数据源支持

通过 autoRuntimeDialect=true 配置，自动识别不同数据源的数据库类型。

3、排序支持（orderBy）

PageHelper.startPage(1, 10).setOrderBy("id DESC");

六、项目demo

以下是基于 Spring Boot + MyBatis + PageHelper 的完整分页示例 Demo，包含代码、配置和详细说明：

1、项目结构

src/
├── main/
│   ├── java/
│   │   └── com/
│   │       └── example/
│   │           ├── config/
│   │           │   └── MyBatisConfig.java  # MyBatis 配置
│   │           ├── controller/
│   │           │   └── UserController.java # 控制器
│   │           ├── entity/
│   │           │   └── User.java            # 实体类
│   │           ├── mapper/
│   │           │   └── UserMapper.java     # Mapper 接口
│   │           └── Application.java        # 启动类
│   └── resources/
│       ├── mapper/
│       │   └── UserMapper.xml              # MyBatis XML 映射
│       └── application.yml                 # 配置文件

2、依赖配置（pom.xml）

<dependencies>
    <!-- Spring Boot Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- MyBatis + PageHelper -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper-spring-boot-starter</artifactId>
        <version>1.4.6</version>
    </dependency>

    <!-- MySQL 驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.27</version>
    </dependency>
</dependencies>

3、配置文件（application.yml）

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test?useSSL=false&characterEncoding=utf8
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

# PageHelper 配置
pagehelper:
  helper-dialect: mysql   # 数据库方言
  reasonable: true        # 分页合理化（pageNum<=0 时返回第一页）
  support-methods-arguments: true

4、实体类（User.java）

public class User {
    private Long id;
    private String name;
    private Integer age;
    
    // Getters and Setters
}

5、Mapper 接口（UserMapper.java）

@Mapper
public interface UserMapper {
    List<User> selectAllUsers();
}

6、XML 映射（UserMapper.xml）

<?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.example.mapper.UserMapper">
    <select id="selectAllUsers" resultType="com.example.entity.User">
        SELECT id, name, age FROM user
    </select>
</mapper>

七、Service 层（UserService.java）

@Service
public class UserService {
    @Autowired
    private UserMapper userMapper;

    public PageInfo<User> getUsersByPage(int pageNum, int pageSize) {
        // 开启分页
        PageHelper.startPage(pageNum, pageSize);
        try {
            List<User> users = userMapper.selectAllUsers();
            return new PageInfo<>(users);
        } finally {
            // 确保 ThreadLocal 参数被清除
            PageHelper.clearPage();
        }
    }
}

8、Controller 层（UserController.java）

@RestController
@RequestMapping("/users")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping
    public PageInfo<User> listUsers(
            @RequestParam(defaultValue = "1") int pageNum,
            @RequestParam(defaultValue = "10") int pageSize) {
        return userService.getUsersByPage(pageNum, pageSize);
    }
}

9、测试分页接口

0. 启动应用 运行 Application.java 启动 Spring Boot。
1. 请求示例 访问 http://localhost:8080/users?pageNum=2&pageSize=5，返回 JSON 结果：

{
  "total": 100,         // 总记录数
  "list": [ ... ],      // 当前页的5条数据
  "pageNum": 2,         // 当前页码
  "pageSize": 5,        // 每页条数
  "pages": 20,          // 总页数
  "hasPreviousPage": true,
  "hasNextPage": true
}

10、原理解析（结合代码）

0. 分页拦截 o PageHelper.startPage() 将分页参数存入 ThreadLocal。 o MyBatis 执行查询时，PageInterceptor 拦截 SQL，根据方言（如 mysql）动态添加 LIMIT 子句。
1. SQL 改写 o 原始 SQL: SELECT id, name, age FROM user o 改写后: SELECT id, name, age FROM user LIMIT 5, 5（第二页，每页5条）
2. COUNT 查询 o 自动生成 SELECT COUNT(1) FROM user 获取总记录数。

11、常见问题解决

0. 分页失效 o 确保 PageHelper.startPage() 后紧跟查询方法，中间不能有其他数据库操作。
1. 内存泄漏 o 必须调用 PageHelper.clearPage() 或使用 try-finally 确保清除 ThreadLocal。
2. 复杂 SQL 分页 若 SQL 包含嵌套查询，需手动优化：

<select id="selectComplex" resultType="...">
  SELECT * FROM (
    SELECT id, name, ROW_NUMBER() OVER(ORDER BY id) AS row_num
    FROM user
  ) tmp WHERE row_num BETWEEN #{start} AND #{end}
</select>