PageHelper排序詳解

一、什麼是PageHelper

PageHelper是一個MyBatis的分頁插件，使用簡單方便，支持多種資料庫，能夠快捷地實現頁面分頁功能。

在實際項目中，我們經常需要對查詢結果進行分頁展示，使用PageHelper插件可以有效地減少代碼量，提高開發效率。

二、PageHelper基礎使用

1. 引入依賴：

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

2. 在mybatis-config.xml文件中配置插件：

<plugins>
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <property name="dialect" value="mysql"/>
        <property name="reasonable" value="true"/>
    </plugin>
</plugins>

3. 在Mapper類上添加@Mapper註解，以便Mapper介面被Spring掃描到。

4. 在查詢方法前加上PageHelper.startPage(pageNum, pageSize)方法，指定當前頁碼和每頁數據條數。

完整代碼示例：

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user")
    List getAllUsers();
}

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

    @Override
    public List 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");

2. 多欄位排序

在orderBy字元串中加入多個排序欄位即可實現多欄位排序。

例如，按照用戶年齡降序、註冊時間升序排列：

PageHelper.startPage(pageNum, pageSize).orderBy("age DESC, create_time ASC");

3. 複雜排序

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插件可以快速方便地實現頁面分頁功能，同時還支持各種複雜的排序方式。在使用插件時，應注意參數填寫的合法性，及時進行異常處理。