PageHelper排序详解

发布时间：2023-05-19

一、什么是PageHelper

PageHelper是一个MyBatis的分页插件，使用简单方便，支持多种数据库，能够快捷地实现页面分页功能。 在实际项目中，我们经常需要对查询结果进行分页展示，使用PageHelper插件可以有效地减少代码量，提高开发效率。

二、PageHelper基础使用

  1. 引入依赖：
<dependency>
   <groupId>com.github.pagehelper</groupId>
   <artifactId>pagehelper-spring-boot-starter</artifactId>
   <version>1.3.0</version>
</dependency>
  1. 在mybatis-config.xml文件中配置插件：
<plugins>
   <plugin interceptor="com.github.pagehelper.PageInterceptor">
       <property name="dialect" value="mysql"/>
       <property name="reasonable" value="true"/>
   </plugin>
</plugins>
  1. 在Mapper类上添加@Mapper注解，以便Mapper接口被Spring扫描到。
  2. 在查询方法前加上PageHelper.startPage(pageNum, pageSize)方法，指定当前页码和每页数据条数。 完整代码示例：
@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user")
    List<User> getAllUsers();
}
@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;
    @Override
    public List<User> getAllUsers(int pageNum, int pageSize) {
        PageHelper.startPage(pageNum, pageSize);
        return userMapper.getAllUsers();
    }
}

三、PageHelper排序功能

  1. 单字段排序 在调用PageHelper.startPage(pageNum, pageSize)方法后，可以通过PageHelper.orderBy(orderBy)方法实现单字段排序，其中orderBy参数为字符串类型，表示排序的字段名和排序方式。 例如，按照用户年龄降序排列：
PageHelper.startPage(pageNum, pageSize).orderBy("age DESC");
  1. 多字段排序 在orderBy字符串中加入多个排序字段即可实现多字段排序。 例如，按照用户年龄降序、注册时间升序排列：
PageHelper.startPage(pageNum, pageSize).orderBy("age DESC, create_time ASC");
  1. 复杂排序 PageHelper支持更加复杂的排序方式，可以通过自定义OrderBy类实现。 首先定义OrderBy类：
public class OrderBy {
    private String orderByClause;
    public OrderBy(String orderByClause) {
        this.orderByClause = orderByClause;
    }
    public String getOrderByClause() {
        return orderByClause;
    }
    public void setOrderByClause(String orderByClause) {
        this.orderByClause = orderByClause;
    }
}

然后在查询方法中根据需求进行自定义排序：

OrderBy orderBy = new OrderBy("CASE WHEN name = 'Tom' THEN 1 ELSE 2 END, age DESC");
PageHelper.startPage(pageNum, pageSize).setOrderBy(orderBy.getOrderByClause());

以上示例中，根据姓名是否为Tom进行分组，Tom排在前面，其余按照年龄降序排列。

四、PageHelper属性参数详解

  1. pageNum：当前页码，必填。
  2. pageSize：每页数据条数，必填。
  3. count：是否进行count查询，可选，默认为true，表示进行count查询。
  4. reasonable：是否合理化查询，可选，默认为false，表示不进行合理化查询。
  5. pageSizeZero：是否允许pageSize为0，可选，默认为false，表示不允许pageSize为0。
  6. params：额外参数，可选，例如params.put("paramName","paramValue")。

五、PageHelper异常处理

在使用PageHelper插件时，可能会出现一些错误，例如传递错误的pageNum和pageSize参数时，可能会发生分页失效的情况。此时可以采取以下处理方式：

  1. 在进行参数传递前进行参数校验，确保pageNum和pageSize参数的合法性。
  2. 在业务代码中加入异常捕获机制，及时通知用户失败原因，并提出重新操作建议。

六、总结

使用PageHelper插件可以快速方便地实现页面分页功能，同时还支持各种复杂的排序方式。在使用插件时，应注意参数填写的合法性，及时进行异常处理。

推荐文章