MyBatis-Plus分页查询教程

MyBatis-Plus分页查询教程

MyBatis-Plus是MyBatis的一个增强工具，用于简化开发。其中一个很强大的特点就是分页查询。在本教程中，我们将探索如何使用MyBatis-Plus进行分页查询。

1. 前置条件

确保你的项目已经集成了MyBatis-Plus。首先，你需要将MyBatis-Plus的依赖加入到你的pom.xml文件中：

<!-- MyBatis-Plus 核心库 -->
<dependency>
    <groupId>com.baomidou.mybatisplus</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>版本</version>
</dependency>

2. 配置分页插件

首先，你需要在MyBatis配置中添加分页插件。

在Spring Boot的配置类中添加以下代码：

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisPlusConfig {
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

这样，当你的应用启动时，MyBatis-Plus的分页插件将自动配置并启动。

3. 实现分页查询

假设我们有一个名为User的实体类和一个对应的UserMapper。

3.1 在Service中创建一个分页方法

在UserService接口中定义一个分页方法：

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.entity.User;

public interface UserService {
    Page<User> getUsersByPage(int currentPage, int pageSize);
}

现在，我们将实现该方法。在UserServiceImpl中：

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import com.example.demo.service.UserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User>
    implements UserService {
    
    @Override
    public Page<User> getUsersByPage(int currentPage, int pageSize) {
        Page<User> page = new Page<>(currentPage, pageSize);
        return baseMapper.selectPage(page, null);
    }
}

3.2 在Controller中使用

在你的UserController中，你可以调用上面创建的分页方法：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.entity.User;
import com.example.demo.service.UserService;

@RestController
public class UserController {
    
    @Autowired
    private UserService userService;
    
    @GetMapping("/users")
    public Page<User> getUsersByPage(
        @RequestParam(defaultValue = "1") int currentPage,
        @RequestParam(defaultValue = "10") int pageSize
    ) {
        return userService.getUsersByPage(currentPage, pageSize);
    }
}

访问/users，并使用currentPage和pageSize参数，你可以得到分页的用户数据。

4. 结束语

使用MyBatis-Plus进行分页查询是一个简单而强大的功能，特别适合初学者。只需几个简单的步骤，你就可以为你的应用添加分页功能。希望本教程对你有所帮助，并鼓励你更深入地探索MyBatis-Plus的其他功能！