PageHelper 配置sqlServer分页查询

在 **SQL Server** 数据库中使用 **PageHelper** 进行分页查询时，需要正确配置 **方言（dialect）** 和 **分页参数处理**，因为 SQL Server 的分页语法（如 `OFFSET-FETCH` 或 `ROW_NUMBER()`）与其他数据库（如 MySQL 的 `LIMIT`）不同。以下是详细配置和代码示例： --- ## **1. 配置 PageHelper 支持 SQL Server** ### **(1) 添加依赖** 确保项目中包含 `pagehelper-spring-boot-starter`（推荐）或 `pagehelper` 核心依赖： ```xml <!-- Spring Boot 集成 PageHelper --> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.4.6</version> <!-- 检查最新版本 --> </dependency> ``` ### **(2) 配置 `application.yml`** 在 Spring Boot 配置文件中指定 SQL Server 的方言： ```yaml pagehelper: helper-dialect: sqlserver2012 # 使用 SQL Server 2012+ 的 OFFSET-FETCH 语法 reasonable: true # 启用合理化分页（自动修正页码） support-methods-arguments: true # 支持通过方法参数传递分页参数 ``` > **注意**： > - 如果使用 SQL Server 2008 或更早版本，需设置为 `sqlserver`（使用 `ROW_NUMBER()` 分页）。 > - 推荐 SQL Server 2012+，因其支持更简洁的 `OFFSET-FETCH` 语法。 --- ## **2. 分页查询代码示例** ### **(1) 基础分页查询** ```java @Service public class UserService { @Autowired private UserMapper userMapper; public PageInfo<User> getUsersByPage(int pageNum, int pageSize) { // 1. 启动分页 PageHelper.startPage(pageNum, pageSize); // 2. 执行查询（自动被 PageHelper 拦截并改写为分页 SQL） List<User> users = userMapper.selectAll(); // 3. 封装分页结果 return new PageInfo<>(users); } } ``` ### **(2) 动态 SQL 分页（MyBatis XML）** 在 Mapper XML 中编写普通查询，PageHelper 会自动改写 SQL： ```xml <!-- UserMapper.xml --> <select id="selectAll" resultType="com.example.User"> SELECT id, name, email FROM users WHERE status = 1 ORDER BY create_time DESC </select> ``` ### **(3) 复杂条件分页** 如果需要传递动态参数，结合 `@Param` 或 `Map`： ```java // Mapper 接口 List<User> selectByCondition(@Param("name") String name, @Param("status") Integer status); // Service 调用 PageHelper.startPage(1, 10); List<User> users = userMapper.selectByCondition("John", 1); PageInfo<User> pageInfo = new PageInfo<>(users); ``` --- ## **3. SQL Server 分页原理** PageHelper 根据配置的方言生成不同的分页 SQL： ### **(1) SQL Server 2012+（推荐）** 使用 `OFFSET-FETCH` 语法： ```sql SELECT id, name, email FROM users WHERE status = 1 ORDER BY create_time DESC OFFSET 10 ROWS FETCH NEXT 10 ROWS ONLY; ``` ### **(2) SQL Server 2008 及以下** 使用 `ROW_NUMBER()` 窗口函数： ```sql WITH numbered_rows AS ( SELECT id, name, email, ROW_NUMBER() OVER (ORDER BY create_time DESC) AS row_num FROM users WHERE status = 1 ) SELECT id, name, email FROM numbered_rows WHERE row_num BETWEEN 11 AND 20; ``` --- ## **4. 常见问题与解决** ### **问题 1：分页无效或 SQL 未改写** - **原因**：未正确配置 `helper-dialect` 或未在查询前调用 `PageHelper.startPage()`。 - **解决**： 1. 检查 `application.yml` 中的方言配置。 2. 确保 `PageHelper.startPage()` 紧邻查询方法（中间不能有其他逻辑）。 ### **问题 2：SQL Server 2008 报错** - **原因**：`sqlserver2012` 方言不适用于旧版本。 - **解决**：修改配置为 `sqlserver`： ```yaml pagehelper: helper-dialect: sqlserver ``` ### **问题 3：分页总数（`total`）不准确** - **原因**：SQL Server 的 `COUNT(*)` 优化可能导致总数计算错误。 - **解决**： 1. 确保查询中有明确的 `ORDER BY`（PageHelper 需要它来生成分页 SQL）。 2. 检查 SQL 日志，确认 `COUNT` 查询是否被正确生成。 --- ## **5. 高级配置** ### **(1) 自定义分页参数解析** 如果需要从请求头或自定义参数中获取分页信息： ```java @Configuration public class PageHelperConfig { @Bean public PageHelper pageHelper() { PageHelper pageHelper = new PageHelper(); Properties properties = new Properties(); properties.setProperty("helper-dialect", "sqlserver2012"); properties.setProperty("params", "count=countSql"); // 自定义参数名 pageHelper.setProperties(properties); return pageHelper; } } ``` ### **(2) 手动分页（无拦截器）** 如果不想依赖 MyBatis 拦截器，可以直接使用 `PageInfo` 和 `PageHelper` 工具类： ```java List<User> rawList = userMapper.selectAll(); // 未分页的完整数据 PageInfo<User> pageInfo = PageHelper.offsetPage(10, 20).doSelectPageInfo(() -> rawList); ``` --- ## **6. 关键总结** | 配置项 | 作用 | 示例值 | |--------|------|--------| | `helper-dialect` | 指定数据库方言 | `sqlserver2012`（推荐）或 `sqlserver` | | `reasonable` | 自动修正非法页码 | `true` | | `support-methods-arguments` | 支持方法参数分页 | `true` | ### **最佳实践** 1. **使用 SQL Server 2012+**：优先选择 `OFFSET-FETCH` 语法（性能更好）。 2. **明确 `ORDER BY`**：确保分页结果的顺序一致。 3. **避免嵌套分页**：PageHelper 仅对紧邻的查询生效。 ---