Hibernate的addScalar()方法 | Baeldung中文网

1. 概述

在这个快速教程中，我们将通过一个实例来讨论Hibernate中的addScalar()方法。我们将学习如何使用这个方法以及它带来的好处。

2. `addScalar()`解决的问题

通常，当我们使用Hibernate的原生SQL查询获取结果时，我们会使用createNativeQuery()方法，然后配合list()方法：

session.createNativeQuery("SELECT * FROM Student student")
  .list();

在这种情况下，Hibernate会使用ResultSetMetadata来查找列详情，并返回一个Object数组列表。

但是，过度使用ResultSetMetadata可能导致性能下降，这时addScalar()方法就派上用场了。

通过使用addScalar()方法，我们可以阻止Hibernate使用ResultSetMetadata。

3. 如何使用`addScalar()`？

让我们创建一个新的方法，使用addScalar()方法来获取学生列表：

public List<Object[]> fetchColumnWithScalar() {
    return session.createNativeQuery("SELECT * FROM Student student")
      .addScalar("studentId", StandardBasicTypes.LONG)
      .addScalar("name", StandardBasicTypes.STRING)
      .addScalar("age", StandardBasicTypes.INTEGER)
      .list();
}

在这里，我们需要将列名和其数据类型作为addScalar()方法的参数。

现在，由于我们在addScalar()中提前定义了列详情，Hibernate将不会使用ResultSetMetadata。因此，相比于之前的方案，我们能得到更好的性能。

4. 其他优势

让我们看看更多使用addScalar()方法的情况。

4.1. 限制返回的列数

我们还可以使用addScalar()方法来限制查询返回的列数。

编写另一个方法fetchLimitedColumnWithScalar()，只获取学生姓名列：

public List<String> fetchLimitedColumnWithScalar() {
    return session.createNativeQuery("SELECT * FROM Student student")
      .addScalar("name", StandardBasicTypes.STRING)
      .list();
}

在查询中，我们使用星号(*)来获取学生列表：

SELECT * FROM Student student

但它不会获取所有列，而是返回一个包含name的单列List，因为我们只在addScalar()方法中指定了一个列。

让我们创建一个JUnit方法来验证fetchLimitedColumnWithScalar()方法返回的列：

List<String> list = scalarExample.fetchLimitedColumnWithScalar();
for (String colValue : list) {
    assertTrue(colValue.startsWith("John"));
}

如我们所见，这将返回字符串列表，而不是Object数组。在示例数据中，我们已将所有学生姓名设为以“John”开头，因此我们在单元测试中对此进行断言。

这样使我们的代码在返回内容方面更加明确。

4.2. 直接返回单个标量值

我们还可以使用addScalar()方法直接返回单个标量值，而不是列表。

创建一个方法，用于获取所有学生的平均年龄：

public Double fetchAvgAgeWithScalar() {
    return (Double) session.createNativeQuery("SELECT AVG(age) as avgAge FROM Student student")
      .addScalar("avgAge")
      .uniqueResult();
}

现在，让我们通过一个单元测试方法来验证这一点：

Double avgAge = scalarExample.fetchAvgAgeWithScalar();
assertEquals(true, (avgAge >= 5 && avgAge <= 24));

如我们所见，fetchAvgAgeScalar()方法直接返回一个Integer值，我们对其进行断言。

在示例数据中，我们提供了5到24岁之间的随机学生年龄。因此，在断言时，我们期望平均值在5到24之间。

同样地，我们也可以使用SQL中的其他聚合函数，如COUNT、MAX、MIN、SUM等，直接使用addScalar()方法获取单个标量值。

5. `addScalar()`的重载方法

我们还有一种重载的addScalar()方法，它接受单一的列名作为参数。

创建一个新的方法，使用重载的addScalar()方法，它不指定类型来获取“age”列：

public List<Object[]> fetchWithOverloadedScalar() {
    return session.createNativeQuery("SELECT * FROM Student student")
      .addScalar("name", StandardBasicTypes.STRING)
      .addScalar("age")
      .list();
}

现在，编写另一个JUnit方法来验证我们的方法是否返回两个或更多的列：

List<Object[]> list = scalarExample.fetchColumnWithOverloadedScalar();
for (Object[] colArray : list) {
    assertEquals(2, colArray.length);
}

如我们所见，这返回一个Object数组列表，数组的大小为2，表示列表中的姓名和年龄列。

6. 总结

在这篇文章中，我们了解了Hibernate中的addScalar()方法的使用方式及其应用场景，以及一个实例。如往常一样，这些示例的代码可以在GitHub上找到。

Persistence

REST

Security