Hibernate 分页

川长思鸟来 2023-09-25 13:37 56阅读 0赞

### **1. 概述** ###

本文是对**Hibernate 中分页的快速介绍**。我们将查看标准 HQL 以及*ScrollableResults*API，最后是使用 Hibernate 标准进行分页。

### **2. 使用 HQL 和*setFirstResult，setMaxResults* API 进行分页** ###

在Hibernate中进行分页的最简单和最常见的方法是**使用HQL**：

Session session = sessionFactory.openSession();
    Query query = sess.createQuery("From Foo");
    query.setFirstResult(0);
    query.setMaxResults(10);
    List<Foo> fooList = fooList = query.list();Copy

此示例使用了一个基本的*Foo*实体，与带有 JQL 实现的 JPA 非常相似——唯一的区别是查询语言。

如果我们为**Hibernate 打开日志记录**，我们将看到以下 SQL 正在运行：

Hibernate: 
        select
            foo0_.id as id1_1_,
            foo0_.name as name2_1_ 
        from
            Foo foo0_ limit ?Copy

#### **2.1. 总数和最后一页** ####

如果不知道**实体总数**，分页解决方案是不完整的：

String countQ = "Select count (f.id) from Foo f";
    Query countQuery = session.createQuery(countQ);
    Long countResults = (Long) countQuery.uniqueResult();Copy

最后，根据总数和给定的页面大小，我们可以计算**最后一页**：

int pageSize = 10;
    int lastPageNumber = (int) (Math.ceil(countResults / pageSize));Copy

在这一点上，我们可以看**一个完整的分页示例**，其中我们正在计算最后一页，然后检索它：

@Test
    public void givenEntitiesExist_whenRetrievingLastPage_thenCorrectSize() {
        int pageSize = 10;
        String countQ = "Select count (f.id) from Foo f";
        Query countQuery = session.createQuery(countQ);
        Long countResults = (Long) countQuery.uniqueResult();
        int lastPageNumber = (int) (Math.ceil(countResults / pageSize));
    
        Query selectQuery = session.createQuery("From Foo");
        selectQuery.setFirstResult((lastPageNumber - 1) * pageSize);
        selectQuery.setMaxResults(pageSize);
        List<Foo> lastPage = selectQuery.list();
    
        assertThat(lastPage, hasSize(lessThan(pageSize + 1)));
    }Copy

### **3. 使用 HQL 和 ScrollableResults API 进行休眠分页** ###

使用*ScrollableResul*ts 实现分页有可能**减少数据库调用**。此方法在程序滚动结果集时流式传输结果集，因此无需重复查询来填充每个页面：

String hql = "FROM Foo f order by f.name";
    Query query = session.createQuery(hql);
    int pageSize = 10;
    
    ScrollableResults resultScroll = query.scroll(ScrollMode.FORWARD_ONLY);
    resultScroll.first();
    resultScroll.scroll(0);
    List<Foo> fooPage = Lists.newArrayList();
    int i = 0;
    while (pageSize > i++) {
        fooPage.add((Foo) resultScroll.get(0));
        if (!resultScroll.next())
            break;
    }Copy

此方法不仅省时（仅一次数据库调用），而且允许用户访问**结果集的总数，而无需其他查询**：

resultScroll.last();
    int totalResults = resultScroll.getRowNumber() + 1;Copy

另一方面，请记住，尽管滚动非常有效，但大窗口可能会占用相当多**的内存**。

### **4. 使用条件 API 进行休眠分页** ###

最后，让我们看一个**更灵活的解决方案**——使用标准：

Criteria criteria = session.createCriteria(Foo.class);
    criteria.setFirstResult(0);
    criteria.setMaxResults(pageSize);
    List<Foo> firstPage = criteria.list();Copy

休眠条件查询 API 使获取**总数**变得非常简单 - 通过使用*投影*对象：

Criteria criteriaCount = session.createCriteria(Foo.class);
    criteriaCount.setProjection(Projections.rowCount());
    Long count = (Long) criteriaCount.uniqueResult();Copy

如您所见，使用此 API 将导致比普通 HQL 更详细的代码，但**该 API 是完全类型安全的，并且更加灵活**。

### **5. 结论** ###

本文简要介绍了在Hibernate中进行分页的各种方法。

这个Spring JPA教程的实现可以在[GitHub项目][GitHub]中找到 - 这是一个基于Eclipse的项目，所以它应该很容易导入和运行。

[GitHub]: https://github.com/eugenp/tutorials/tree/master/persistence-modules/spring-data-jpa-query-2