Spring Boot 实现分页与排序，这一篇就够了！

原创已于 2024-12-29 17:53:51 修改 · 689 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java

于 2024-12-25 17:45:24 首次发布

java 同时被 2 个专栏收录

59 篇文章

订阅专栏

spring boot

38 篇文章

订阅专栏

Spring Boot 实现分页与排序，这一篇就够了！

在现代 Web 开发中，面对大量数据的展示，分页和排序功能是必不可少的。Spring Boot 作为一款流行的 Java 开发框架，为我们提供了简洁高效的方式来实现这些功能。今天，就来详细讲讲如何在 Spring Boot 项目中运用相关技术达成完美的分页与排序效果。

一、准备工作

首先，确保你的开发环境已经搭建好 Spring Boot 项目。可以使用 Spring Initializr（https://start.spring.io/）快速初始化一个包含必要依赖的项目骨架，起码要有 Web 依赖引入。

二、分页的实现

引入依赖：在 pom.xml 文件中，确保已经引入了 Spring Data JPA（如果使用数据库持久化）或者 MyBatis 相关依赖，它们内置了强大的分页支持。例如，使用 Spring Data JPA：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>runtime</scope>
</dependency>

这里引入 H2 数据库只是为了演示方便，实际开发中可替换成 MySQL、PostgreSQL 等。

创建实体类与 Repository：假设我们有一个 Book 实体类，代表书籍信息。

@Entity
public class Book {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String title;
    private String author;
    // 省略 getters 和 setters
}

接着创建对应的 JPA Repository 接口：

@Repository
public interface BookRepository extends JpaRepository<Book, Long> {
}

Service 层实现分页逻辑：在 BookService 类中，注入 BookRepository，编写分页查询方法。

@Service
public class BookService {
    @Autowired
    private BookRepository bookRepository;

    public Page<Book> getBooksPage(int pageNumber, int pageSize) {
        PageRequest pageRequest = PageRequest.of(pageNumber, pageSize);
        return bookRepository.findAll(pageRequest);
    }
}

这里 PageRequest.of() 方法用于构建分页请求，指定页码（从 0 开始）和每页大小。

Controller 层暴露接口：

@RestController
@RequestMapping("/books")
public class BookController {
    @Autowired
    private BookService bookService;

    @GetMapping
    public ResponseEntity<Page<Book>> getBooks(
            @RequestParam(defaultValue = "0") int pageNumber,
            @RequestParam(defaultValue = "10") int pageSize) {
        Page<Book> booksPage = bookService.getBooksPage(pageNumber, pageSize);
        return ResponseEntity.ok(booksPage);
    }
}

这样，当访问 /books 接口，带上 pageNumber 和 pageSize 参数，就能获取分页后的书籍数据。

三、排序的实现

单字段排序：在上述 getBooksPage 方法基础上稍作修改，即可实现根据某个字段排序。比如按照书籍标题升序排序：

public Page<Book> getBooksPage(int pageNumber, int pageSize) {
    Sort sort = Sort.by(Sort.Direction.ASC, "title");
    PageRequest pageRequest = PageRequest.of(pageNumber, pageSize, sort);
    return bookRepository.findAll(pageRequest);
}

这里 Sort.by() 方法指定排序字段和方向，然后传入 PageRequest。

多字段排序：要是想先按作者排序，作者相同再按标题排序，也是轻而易举：

public Page<Book> getBooksPage(int pageNumber, int pageSize) {
    Sort sort = Sort.by(Sort.Direction.ASC, "author")
           .and(Sort.by(Sort.Direction.ASC, "title"));
    PageRequest pageRequest = PageRequest.of(pageNumber, pageSize, sort);
    return bookRepository.findAll(pageRequest);
}

通过链式调用 and() 方法添加多个排序条件。

四、结合分页与排序

实际场景往往需要同时分页和排序，直接整合上述代码就行：

@GetMapping
public ResponseEntity<Page<Book>> getBooks(
        @RequestParam(defaultValue = "0") int pageNumber,
        @RequestParam(defaultValue = "10") int pageSize,
        @RequestParam(defaultValue = "id") String sortBy,
        @RequestParam(defaultValue = "asc") String sortDir) {
    Sort.Direction direction = Sort.Direction.fromString(sortDir);
    Sort sort = Sort.by(direction, sortBy);
    PageRequest pageRequest = PageRequest.of(pageNumber, pageSize, sort);
    Page<Book> booksPage = bookRepository.findAll(pageRequest);
    return ResponseEntity.ok(booksPage);
}