1. 简介
在开发企业级应用时，分页查询是一个非常常见的需求。Spring Boot JPA提供了强大的分页功能，通过Page接口和Pageable接口，我们可以轻松实现灵活的分页查询。本文将详细介绍Page组件的使用方法及其核心特性。
2. 核心概念
2.1 Page接口
Page接口继承自Slice接口，是Spring Data提供的分页核心接口，它定义了以下重要方法：
getTotalElements(): 获取总记录数getTotalPages(): 获取总页数getNumber(): 获取当前页码（从0开始）getSize(): 获取每页显示的记录数getContent(): 获取当前页的数据列表isEmpty(): 当前页是否为空
2.2 Pageable接口
Pageable接口是分页请求的抽象，主要包含：
- 页码（page）
- 每页大小（size）
- 排序信息（sort）
3. 实战示例
3.1 基础配置
首先在pom.xml中添加依赖：
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
3.2 实体类定义
java">@Entity
@Table(name = "users")
public class User {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;private String username;private String email;// getter和setter方法省略
}
3.3 Repository层实现
java">@Repository
public interface UserRepository extends JpaRepository<User, Long> {// 基础分页查询Page<User> findAll(Pageable pageable);// 条件分页查询Page<User> findByUsernameLike(String username, Pageable pageable);
}
3.4 Service层实现
java">@Service
public class UserService {@Autowiredprivate UserRepository userRepository;public Page<User> findUsers(int page, int size) {// 创建分页请求PageRequest pageRequest = PageRequest.of(page, size);return userRepository.findAll(pageRequest);}public Page<User> findUsersByUsername(String username, int page, int size) {PageRequest pageRequest = PageRequest.of(page, size);return userRepository.findByUsernameLike("%" + username + "%", pageRequest);}
}
3.5 Controller层实现
java">@RestController
@RequestMapping("/api/users")
public class UserController {@Autowiredprivate UserService userService;@GetMappingpublic ResponseEntity<Map<String, Object>> getUsers(@RequestParam(defaultValue = "0") int page,@RequestParam(defaultValue = "10") int size) {Page<User> userPage = userService.findUsers(page, size);Map<String, Object> response = new HashMap<>();response.put("content", userPage.getContent());response.put("currentPage", userPage.getNumber());response.put("totalItems", userPage.getTotalElements());response.put("totalPages", userPage.getTotalPages());return ResponseEntity.ok(response);}
}
4. 高级特性
4.1 排序功能
可以在分页查询时添加排序条件：
java">// 创建排序对象
Sort sort = Sort.by(Sort.Direction.DESC, "username");// 创建带排序的分页请求
PageRequest pageRequest = PageRequest.of(page, size, sort);
4.2 动态条件查询
结合Specification接口实现动态条件查询：
java">@Service
public class UserService {public Page<User> findUsersWithFilters(UserFilter filter, Pageable pageable) {Specification<User> spec = (root, query, cb) -> {List<Predicate> predicates = new ArrayList<>();if (filter.getUsername() != null) {predicates.add(cb.like(root.get("username"), "%" + filter.getUsername() + "%"));}if (filter.getEmail() != null) {predicates.add(cb.like(root.get("email"), "%" + filter.getEmail() + "%"));}return cb.and(predicates.toArray(new Predicate[0]));};return userRepository.findAll(spec, pageable);}
}
5. 最佳实践
5.1 性能优化
- 避免不必要的count查询：
java">Slice<User> findBy(Pageable pageable); // 不执行count查询
- 使用countQuery优化总数查询：
java">@Query(value = "SELECT u FROM User u WHERE u.active = true",countQuery = "SELECT COUNT(u.id) FROM User u WHERE u.active = true")
Page<User> findActiveUsers(Pageable pageable);
5.2 异常处理
java">@ControllerAdvice
public class PageableExceptionHandler {@ExceptionHandler(IllegalArgumentException.class)public ResponseEntity<String> handleIllegalArgument(IllegalArgumentException e) {return ResponseEntity.badRequest().body("Invalid page parameters: " + e.getMessage());}
}
6. 总结
Spring Boot JPA的Page组件提供了强大而灵活的分页功能：
- 简单易用的API
- 灵活的排序支持
- 动态条件查询能力
- 性能优化选项
通过合理使用Page组件，我们可以轻松实现高效的分页查询功能，提升应用性能和用户体验。在实际开发中，建议结合项目需求选择适当的分页策略，并注意性能优化。
