在MyBatis中進行分頁查詢的兩種方法詳解

更新時間：2025年11月17日 09:23:05 作者：java1234_小鋒

在 MyBatis 中進行分頁查詢通常有兩種方法：一種是通過手動拼接 LIMIT 和 OFFSET,另一種是使用 MyBatis 插件（如 MyBatis-PageHelper）來自動處理分頁邏輯,下面分別介紹這兩種方法,需要的朋友可以參考下

如何在MyBatis中進行分頁查詢？

在 MyBatis 中進行分頁查詢通常有兩種方法：一種是通過手動拼接 LIMIT 和 OFFSET，另一種是使用 MyBatis 插件（如 MyBatis-PageHelper）來自動處理分頁邏輯。下面分別介紹這兩種方法。

1.手動實現分頁查詢

手動分頁查詢需要在 SQL 語句中使用數據庫支持的分頁語法，如 LIMIT（MySQL、PostgreSQL）或 ROWNUM（Oracle）等。你可以通過傳遞 offset（起始行）和 limit（每頁的條目數）來實現分頁。

1.1 修改 Mapper XML 文件

在 XML 文件中，通常通過傳遞 offset 和 limit 參數來構造分頁查詢 SQL。

Mapper 接口：

public interface UserMapper {
    List<User> selectUsersByPage(@Param("offset") int offset, @Param("limit") int limit);
}

Mapper XML 文件：

<mapper namespace="com.example.UserMapper">
    <select id="selectUsersByPage" resultType="com.example.User">
        SELECT * FROM users
        LIMIT #{limit} OFFSET #{offset}
    </select>
</mapper>

1.2 計算offset

通常，offset 的計算方式是 (currentPage - 1) * pageSize，其中：

currentPage 是當前頁碼（從 1 開始）。
pageSize 是每頁顯示的記錄數。

調用分頁查詢：

int currentPage = 1; // 當前頁
int pageSize = 10;   // 每頁的條數
int offset = (currentPage - 1) * pageSize;

List<User> users = userMapper.selectUsersByPage(offset, pageSize);

2.使用 MyBatis 插件（如 PageHelper）進行分頁

如果你不想手動編寫分頁邏輯，可以使用第三方分頁插件，如 PageHelper，它可以自動處理分頁，簡化分頁操作。

2.1 引入 PageHelper 插件

在 pom.xml 中添加 PageHelper 的依賴。

<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.2.0</version> <!-- 確保使用最新版本 -->
</dependency>

2.2 配置 PageHelper 插件

在 MyBatis 的配置文件 mybatis-config.xml 中配置 PageHelper 插件。

<plugins>
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <property name="helperDialect" value="mysql"/> <!-- 針對 MySQL -->
        <property name="reasonable" value="true"/>
        <property name="supportMethodsArguments" value="true"/>
    </plugin>
</plugins>

2.3 使用 PageHelper 進行分頁查詢

PageHelper 插件通過 PageHelper.startPage(pageNum, pageSize) 來啟用分頁。分頁的實際 SQL 會在查詢時動態(tài)生成。

Mapper 接口：

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

調用分頁查詢：

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;

int currentPage = 1;  // 當前頁
int pageSize = 10;    // 每頁記錄數

// 啟動分頁
PageHelper.startPage(currentPage, pageSize);

// 執(zhí)行查詢
List<User> users = userMapper.selectAllUsers();

// 獲取分頁信息
PageInfo<User> pageInfo = new PageInfo<>(users);
System.out.println("Total pages: " + pageInfo.getPages());
System.out.println("Total records: " + pageInfo.getTotal());

返回分頁信息：

pageInfo.getTotal() 獲取總記錄數。
pageInfo.getPages() 獲取總頁數。
pageInfo.getList() 獲取當前頁的數據。

總結

手動分頁：適用于簡單的分頁需求，你需要手動計算 offset 和 limit，并在 SQL 中使用適當的分頁語法。
PageHelper 插件：適用于復雜分頁查詢，通過自動生成分頁的 SQL，簡化了分頁的配置和調用。它支持多種數據庫（MySQL、Oracle、PostgreSQL 等）和復雜的查詢場景。

如果你的項目中經常需要分頁查詢，推薦使用 PageHelper 插件，因為它能自動處理很多復雜的分頁邏輯，減少了代碼量。

到此這篇關于在MyBatis中進行分頁查詢的兩種方法詳解的文章就介紹到這了,更多相關MyBatis進行分頁查詢內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: