Pagination Plugin

The MyBatis-Plus pagination plugin PaginationInnerInterceptor provides powerful pagination capabilities, supports multiple databases, and makes paginated queries simple and efficient.

Supported Databases

PaginationInnerInterceptor supports a wide range of databases, including but not limited to:

PostgreSQL MySQL MariaDB Oracle OceanBase GaussDB SQLite SQL Server H2 DB2 HSQL Phoenix ClickHouse Sybase Firebird Cubird Goldilocks Informix TDengine RedShift Derby DuckDB Vastbase GoldenDB 达梦 人大金仓 南大通用 瀚高 神州通用 虚谷 优炫 星瑞格

If the database you need to use is not on the list, you can request its addition via a Pull Request.

Configuration

In a Spring Boot project, you can add the pagination plugin via Java configuration:

@Configuration
@MapperScan("scan.your.mapper.package")
public class MybatisPlusConfig {

    /**
     * Add pagination plugin
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); // If configuring multiple plugins, remember to add pagination last
        // If you have multiple data sources, you can omit the specific type; otherwise, it's recommended to specify the concrete DbType
        return interceptor;
    }
}

Properties

PaginationInnerInterceptor provides the following properties to customize pagination behavior:

It is recommended to set dbType for single database type configurations.

Using Pagination in Custom Mapper Methods

You can use pagination in your Mapper methods in the following ways:

IPage<UserVo> selectPageVo(IPage<?> page, Integer state);
// Or use a custom page class
MyPage selectPageVo(MyPage page);
// Or return List
List<UserVo> selectPageVo(IPage<UserVo> page, Integer state);

Corresponding XML configuration:

<select id="selectPageVo" resultType="xxx.xxx.xxx.UserVo">
    SELECT id,name FROM user WHERE state=#{state}
</select>

If the return type is IPage, the input IPage parameter cannot be null. To temporarily disable pagination, initialize the IPage with a size parameter less than 0. If the return type is List, the input IPage parameter can be null, but you need to manually set IPage.setRecords(returned List). If the XML needs to retrieve values from the page object, use page.property syntax.

Other Considerations

• When generating the countSql, if a table in a left join does not participate in the where condition, it will be optimized (removed). It is recommended to always use aliases for tables and fields in any SQL involving left join.
• When using multiple plugins, place the pagination plugin last in the plugin execution chain to avoid inaccurate COUNT SQL execution.

Page Class

The Page class extends the IPage class, implementing a simple pagination model. If you need to implement your own pagination model, you can extend the Page class or implement the IPage interface.

With these configurations and usage methods, you can easily implement paginated queries in MyBatis-Plus, improving your application’s performance and user experience.