SpringBoot+MyBatis分页失效问题解决(已解决)

本文围绕SpringBoot项目中使用PageHelper实现分页展开。作者采用pagehelper - spring - boot - starter方式,却遇到分页不生效、总返回全量数据的问题。经查看官网文档,发现是PageHelper方法与MyBatis查询方法调用顺序有误,导致分页参数提前被消费。

官方文档:pagehelper
SpringBoot项目,直接导入 pagehelper-spring-boot-starter

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

SpringBoot的自动配置都帮我们实现配置了可以不需要上面的配置,因为SpringBoot很多配置采用了默认机制,我是使用 pagehelper-spring-boot-starter 方式的,发现分页总是返回所有的数据total,但是分页就是不生效,每次都会查出全量数据,因为配置文件都配置好没有错,那肯定是代码出错,当我查看官网文档的时候,发现官网的介绍分页失效的原因:

什么时候会导致不安全的分页?
PageHelper 方法使用了静态的 ThreadLocal 参数,分页参数和线程是绑定的。
只要你可以保证在 PageHelper 方法调用后紧跟 MyBatis 查询方法,这就是安全的。
因为 PageHelper 在 finally 代码段中自动清除了 ThreadLocal 存储的对象。
如果代码在进入 Executor 前发生异常,就会导致线程不可用,这属于人为的 Bug
(例如接口方法和 XML 中的不匹配,导致找不到 MappedStatement 时), 这种情况由于线程不可用,也不会导致 ThreadLocal 参数被错误的使用。

错误代码:

public PageInfo<T> get88( int pageNum, int pageSize) {
        PageHelper.startPage(pageNum,pageSize);
        String district = areaMapper.selectAreaNameByCode(districtCode);
        List<Home> homeList = homeMapper.selectAllHomeByFeatureIdDistrict(featureId, district);
        PageInfo<Home> pageResult = new PageInfo<>(homeList);
        return ServerResponse.createBySuccess(pageResult);
    }

看了我的代码,顿时醒悟,PageHelper.startPage(pageNum,pageSize); 后面接的方法是areaMapper.selectAreaNameByCode(); 而我需要分页的方法是下面selectAllHomeByFeatureIdDistrict()方法,所有PageHelper.startPage被提前消费使用了,只需要交代码改为:


public PageInfo<T> get88( int pageNum, int pageSize) {
       String district = areaMapper.selectAreaNameByCode(districtCode); 
       //记住:PageHelper.startPage要紧跟着要分页的方法
       PageHelper.startPage(pageNum,pageSize);
       List<Home> homeList = homeMapper.selectAllHomeByFeatureIdDistrict(featureId, district);
       PageInfo<Home> pageResult = new PageInfo<>(homeList);
       return ServerResponse.createBySuccess(pageResult);
   }
<think>嗯,用户问的是如何在Spring Boot项目中使用PageHelper实现分页功能。我需要根据提供的引用资料来组织回答。首先,引用的资料提到了几个步骤:引入依赖、配置、使用和测试。那我可以按照这个结构来写。 首先,引入依赖。引用1、2、3都提到了需要添加Maven依赖,比如pagehelper-spring-boot-starter,版本可能不同,但用户可能不需要具体版本号,除非有特别需要注意的。所以第一步应该是添加依赖到pom.xml。 然后是配置部分。引用4提到在配置文件中设置helperDialect为mysql,还有其他参数比如reasonable、supportMethodsArguments等。需要说明在application.yml里配置这些参数,可能还要提到不同的数据库方言需要调整helperDialect。 接下来是使用部分。引用2和3说明了在Service层使用PageHelper.startPage(pageNum, pageSize),然后执行查询,用PageInfo包装结果。这里要注意PageHelper.startPage必须紧跟在查询语句之前,否则可能不生效。还要提到返回PageInfo对象的好处,比如包含分页的详细信息。 测试部分可能需要写一个简单的Controller,接收分页参数,调用Service方法,返回结果。代码示例的话,可能需要给出一个简单的例子,比如UserController,使用@GetMapping接收参数,然后调用分页方法。 然后生成相关问题,根据引用中的内容,可能的问题包括配置参数的作用、如何自定义分页、与MyBatis的整合问题、PageInfo的其他功能以及常见问题处理,比如分页失效的原因。 需要注意的是用户可能对配置参数的具体作用不清楚,所以在回答中需要解释每个参数的意义,比如reasonable开启后页码超出时会自动调整,pageSizeZero是否允许返回所有数据等。 还要确保代码示例的语法正确,比如在Controller中使用@RequestParam设置默认值,Service中的方法正确使用PageHelper,并在返回时使用PageInfo。 最后检查是否引用了正确的资料,比如引用1到4都涉及到了不同的方面,确保每个步骤都有对应的引用标注。比如引入依赖引用1、3,配置引用4,使用部分引用2、3等。</think>### Spring Boot集成PageHelper分页功能详解 #### 一、集成步骤 1. **添加Maven依赖** 在`pom.xml`中引入PageHelper的Spring Boot Starter依赖: ```xml <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.4.6</version> </dependency> ``` [^1][^3] 2. **配置参数(可选)** 在`application.yml`中配置分页参数,例如: ```yaml pagehelper: helper-dialect: mysql # 指定数据库方言(如mysql/oracle) reasonable: true # 页码超出范围时自动修正到合理值 support-methods-arguments: true # 支持接口参数传递分页条件 params: count=countSql # 统计查询的SQL别名 ``` [^4] --- #### 二、使用方法 1. **Service层分页查询** 在需要分页的方法中调用`PageHelper.startPage(pageNum, pageSize)`,**必须紧邻查询语句**: ```java public PageInfo<User> getUsers(int pageNum, int pageSize) { PageHelper.startPage(pageNum, pageSize); List<User> users = userMapper.selectAll(); return new PageInfo<>(users); } ``` [^2] 2. **Controller层调用** ```java @GetMapping("/users") public Result listUsers(@RequestParam(defaultValue = "1") int pageNum, @RequestParam(defaultValue = "10") int pageSize) { PageInfo<User> pageInfo = userService.getUsers(pageNum, pageSize); return Result.success(pageInfo); } ``` 3. **分页结果结构** `PageInfo`包含分页元数据: ```json { "total": 100, // 总记录数 "pageNum": 1, // 当前页码 "pageSize": 10, // 每页数量 "list": [/*数据列表*/] } ``` --- #### 三、注意事项 1. **SQL优化** PageHelper自动生成`count`语句统计总数,需确保SQL无语法错误[^4]。 2. **多数据源兼容** 若项目使用多数据源,需为每个数据源单独配置`helperDialect`。 3. **参数传递** 支持通过方法参数或`ThreadLocal`隐式传递分页条件。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值