添加依赖: 在pom.xml文件中添加PageHelper依赖:
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
- 配置PageHelper: 在application.properties(或application.yml)文件中添加PageHelper的配置信息:
# PageHelper配置
pagehelper.helper-dialect=mysql # 数据库方言,可选值:oracle, mysql, mariadb, sqlite, hsqldb, derby, postgresql, sqlserver
pagehelper.reasonable=true # 是否进行合理化查询,默认值为false,如果为true,则pageNum<=0的时候会查询第一页,pageNum>pages的时候会查询最后一页
pagehelper.support-methods-arguments=true # 支持通过Mapper接口参数来传递分页参数,默认值为false
pagehelper.params=count=countSql # 分页合理化参数,默认值为pageNum=pageNum;pageSize=pageSize;进行count查询时,使用的SQL必须与查询数据的SQL相同,count查询时,不需要Order By语句
- 创建Mapper接口: 创建一个Mapper接口,并在其中定义需要的查询方法,例如:
@Mapper
public interface UserMapper {
List<User> getUserList();
}
- 创建Mapper XML文件: 在resources目录下创建与Mapper接口对应的XML文件,例如UserMapper.xml,编写查询语句:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.mapper.UserMapper">
<select id="getUserList" resultType="com.example.entity.User">
SELECT * FROM user
</select>
</mapper>
在Service层使用PageHelper进行分页查询: 在Service层中注入UserMapper,并使用PageHelper进行分页查询,例如
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public PageInfo<User> getUserList(int pageNum, int pageSize) {
// 开启分页
PageHelper.startPage(pageNum, pageSize);
// 查询用户列表
List<User> userList = userMapper.getUserList();
// 封装为PageInfo对象
PageInfo<User> pageInfo = new PageInfo<>(userList);
return pageInfo;
}
}
在Controller层中调用Service层方法: 在Controller层中注入UserService,并调用getUserList方法进行分页查询,并将结果返回给前端,例如
@RestController
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/users")
public PageInfo<User> getUserList(@RequestParam(defaultValue = "1") int pageNum,
@RequestParam(defaultValue = "10") int pageSize) {
return userService.getUserList(pageNum, pageSize);
}
}