Hibernate 条件（Criteria）查询

Hibernate 提供了操作对象以及 RDBMS 表中可用数据的替代方法。 其中一种方法是 Criteria API，它允许我们以编程方式构建条件查询对象，我们可以在其中应用过滤规则和逻辑条件。

Hibernate Session 接口提供了 createCriteria() 方法，该方法可用于创建 Criteria 对象，该对象在应用程序执行条件查询时返回持久对象类的实例。

以下是条件查询的最简单示例之一，它将简单地返回与 Employee 类对应的每个对象。

Criteria cr = session.createCriteria(Employee.class);
List results = cr.list();

条件限制

我们可以使用 Criteria 对象可用的 add() 方法来为条件查询添加限制。 以下是添加限制以返回工资等于 2000 的记录的示例

Criteria cr = session.createCriteria(Employee.class);
cr.add(Restrictions.eq("salary", 2000));
List results = cr.list();

以下是涵盖不同场景的更多示例，可根据要求使用

Criteria cr = session.createCriteria(Employee.class);

// 获取工资超过2000的记录
cr.add(Restrictions.gt("salary", 2000));

// 获取工资低于 2000 的记录
cr.add(Restrictions.lt("salary", 2000));

// 获取以 zara 开头的 firstName 的记录
cr.add(Restrictions.like("firstName", "zara%"));

// 上述限制的区分大小写形式。
cr.add(Restrictions.ilike("firstName", "zara%"));

// 获取工资在 1000 到 2000 之间的记录
cr.add(Restrictions.between("salary", 1000, 2000));

// 检查给定属性是否为空
cr.add(Restrictions.isNull("salary"));

// 检查给定属性是否不为空
cr.add(Restrictions.isNotNull("salary"));

// 检查给定属性是否为空
cr.add(Restrictions.isEmpty("salary"));

// 检查给定属性是否不为空
cr.add(Restrictions.isNotEmpty("salary"));

我们可以使用 LogicalExpression 限制创建 AND 或 OR 条件，如下所示

Criteria cr = session.createCriteria(Employee.class);

Criterion salary = Restrictions.gt("salary", 2000);
Criterion name = Restrictions.ilike("firstNname","zara%");

// 获取符合 OR 条件的记录
LogicalExpression orExp = Restrictions.or(salary, name);
cr.add( orExp );

// 获取符合 AND 条件的记录
LogicalExpression andExp = Restrictions.and(salary, name);
cr.add( andExp );

List results = cr.list();

尽管上述所有条件都可以直接与 HQL 一起使用，如上一教程中所述。

使用标准分页

Criteria 接口有两种分页方法。

结合使用以上两种方法，我们可以在我们的 Web 或 Swing 应用程序中构建一个分页组件。 以下是示例，我们可以将其扩展为一次获取 10 行

Criteria cr = session.createCriteria(Employee.class);
cr.setFirstResult(1);
cr.setMaxResults(10);
List results = cr.list();

对结果进行排序

Criteria API 提供了 org.hibernate.criterion.Order 类，用于根据对象的属性之一来升序或降序对结果集进行排序。 此示例演示如何使用 Order 类对结果集进行排序

Criteria cr = session.createCriteria(Employee.class);

// 获取工资超过2000的记录
cr.add(Restrictions.gt("salary", 2000));

// 按降序对记录进行排序
cr.addOrder(Order.desc("salary"));

// 按升序对记录进行排序
cr.addOrder(Order.asc("salary"));

List results = cr.list();

预测和聚合

Criteria API 提供 org.hibernate.criterion.Projections 类，可用于获取属性值的平均值、最大值或最小值。 Projections 类类似于 Restrictions 类，因为它提供了几个静态工厂方法来获取 Projection 实例。

以下是涵盖不同场景的几个示例，可根据需要使用

Criteria cr = session.createCriteria(Employee.class);

// 获取总行数。
cr.setProjection(Projections.rowCount());

// 获取平均值
cr.setProjection(Projections.avg("salary"));

// 获取属性的不同计数。
cr.setProjection(Projections.countDistinct("firstName"));

// 获取属性的最大值
cr.setProjection(Projections.max("salary"));

// 获取属性的最小值
cr.setProjection(Projections.min("salary"));

// 获取总和
cr.setProjection(Projections.sum("salary"));

条件查询示例

考虑以下 POJO 类

public class Employee {
   private int id;
   private String firstName; 
   private String lastName;   
   private int salary;  

   public Employee() {}
   
   public Employee(String fname, String lname, int salary) {
      this.firstName = fname;
      this.lastName = lname;
      this.salary = salary;
   }
   
   public int getId() {
      return id;
   }
   
   public void setId( int id ) {
      this.id = id;
   }
   
   public String getFirstName() {
      return firstName;
   }
   
   public void setFirstName( String first_name ) {
      this.firstName = first_name;
   }
   
   public String getLastName() {
      return lastName;
   }
   
   public void setLastName( String last_name ) {
      this.lastName = last_name;
   }
   
   public int getSalary() {
      return salary;
   }
   
   public void setSalary( int salary ) {
      this.salary = salary;
   }
}

让我们创建以下 employee 表来存储 Employee 对象

create table employee (
   id INT NOT NULL auto_increment,
   first_name VARCHAR(20) default NULL,
   last_name  VARCHAR(20) default NULL,
   salary     INT  default NULL,
   PRIMARY KEY (id)
);

以下是映射文件。

<?xml version = "1.0" encoding = "utf-8"?>
<!DOCTYPE hibernate-mapping PUBLIC 
"-//Hibernate/Hibernate Mapping DTD//EN"
"http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd"> 

<hibernate-mapping>
   <class name = "Employee" table = "employee">
      
      <meta attribute = "class-description">
         This class contains the employee detail. 
      </meta>
      
      <id name = "id" type = "int" column = "id">
         <generator class="native"/>
      </id>
      
      <property name = "firstName" column = "first_name" type = "string"/>
      <property name = "lastName" column = "last_name" type = "string"/>
      <property name = "salary" column = "salary" type = "int"/>
      
   </class>
</hibernate-mapping>

最后，我们将使用 main() 方法创建我们的应用程序类来运行我们将使用 Criteria 查询的应用程序

import java.util.List; 
import java.util.Date;
import java.util.Iterator; 
 
import org.hibernate.HibernateException; 
import org.hibernate.Session; 
import org.hibernate.Transaction;
import org.hibernate.SessionFactory;
import org.hibernate.Criteria;
import org.hibernate.criterion.Restrictions;
import org.hibernate.criterion.Projections;
import org.hibernate.cfg.Configuration;

public class ManageEmployee {
   private static SessionFactory factory; 
   public static void main(String[] args) {
      
      try {
         factory = new Configuration().configure().buildSessionFactory();
      } catch (Throwable ex) { 
         System.err.println("Failed to create sessionFactory object." + ex);
         throw new ExceptionInInitializerError(ex); 
      }
      
      ManageEmployee ME = new ManageEmployee();

      /* 在数据库中添加一些员工记录 */
      Integer empID1 = ME.addEmployee("Zara", "Ali", 2000);
      Integer empID2 = ME.addEmployee("Daisy", "Das", 5000);
      Integer empID3 = ME.addEmployee("John", "Paul", 5000);
      Integer empID4 = ME.addEmployee("Mohd", "Yasee", 3000);

      /* 列出所有员工 */
      ME.listEmployees();

      /* 打印员工总数 */
      ME.countEmployee();

      /* 打印薪资总数 */
      ME.totalSalary();
   }
   
   /* 在数据库中创建员工的方法 */
   public Integer addEmployee(String fname, String lname, int salary){
      Session session = factory.openSession();
      Transaction tx = null;
      Integer employeeID = null;
      
      try {
         tx = session.beginTransaction();
         Employee employee = new Employee(fname, lname, salary);
         employeeID = (Integer) session.save(employee); 
         tx.commit();
      } catch (HibernateException e) {
         if (tx!=null) tx.rollback();
         e.printStackTrace(); 
      } finally {
         session.close(); 
      }
      return employeeID;
   }

   /* 读取所有工资超过 2000 的员工的方法 */
   public void listEmployees( ) {
      Session session = factory.openSession();
      Transaction tx = null;
      
      try {
         tx = session.beginTransaction();
         Criteria cr = session.createCriteria(Employee.class);
         // 添加限制
         cr.add(Restrictions.gt("salary", 2000));
         List employees = cr.list();

         for (Iterator iterator = employees.iterator(); iterator.hasNext();){
            Employee employee = (Employee) iterator.next(); 
            System.out.print("First Name: " + employee.getFirstName()); 
            System.out.print("  Last Name: " + employee.getLastName()); 
            System.out.println("  Salary: " + employee.getSalary()); 
         }
         tx.commit();
      } catch (HibernateException e) {
         if (tx!=null) tx.rollback();
         e.printStackTrace(); 
      } finally {
         session.close(); 
      }
   }
   
   /* 打印总记录数的方法 */
   public void countEmployee(){
      Session session = factory.openSession();
      Transaction tx = null;
      
      try {
         tx = session.beginTransaction();
         Criteria cr = session.createCriteria(Employee.class);

         // 获取总行数。
         cr.setProjection(Projections.rowCount());
         List rowCount = cr.list();

         System.out.println("Total Coint: " + rowCount.get(0) );
         tx.commit();
      } catch (HibernateException e) {
         if (tx!=null) tx.rollback();
         e.printStackTrace(); 
      } finally {
         session.close(); 
      }
   }
  
   /* 打印工资总额的方法 */
   public void totalSalary(){
      Session session = factory.openSession();
      Transaction tx = null;
      
      try {
         tx = session.beginTransaction();
         Criteria cr = session.createCriteria(Employee.class);

         // 获得总工资。
         cr.setProjection(Projections.sum("salary"));
         List totalSalary = cr.list();

         System.out.println("Total Salary: " + totalSalary.get(0) );
         tx.commit();
      } catch (HibernateException e) {
         if (tx!=null) tx.rollback();
         e.printStackTrace(); 
      } finally {
         session.close(); 
      }
   }
}

编译和执行

以下是编译和运行上述应用程序的步骤。 在继续编译和执行之前，请确保已正确设置 PATH 和 CLASSPATH。

• 按照配置章节中的说明创建 hibernate.cfg.xml 配置文件。
• 如上所示创建Employee.hbm.xml 映射文件。
• 如上所示创建Employee.java 源文件并编译它。
• 如上所示创建 ManageEmployee.java 源文件并编译它。
• 执行 ManageEmployee 二进制文件来运行程序。

我们将获得以下结果，并且将在 employee 表中创建记录。

$ java ManageEmployee
.......VARIOUS LOG MESSAGES WILL DISPLAY HERE........

First Name: Daisy  Last Name: Das  Salary: 5000
First Name: John  Last Name: Paul  Salary: 5000
First Name: Mohd  Last Name: Yasee  Salary: 3000
Total Coint: 4
Total Salary: 15000

如果检查自己的 employee 表，它应该有以下记录

mysql> select * from EMPLOYEE;
+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
| 14 | Zara       | Ali       |   2000 |
| 15 | Daisy      | Das       |   5000 |
| 16 | John       | Paul      |   5000 |
| 17 | Mohd       | Yasee     |   3000 |
+----+------------+-----------+--------+
4 rows in set (0.00 sec)