Hibernate 简明教程

Hibernate - Annotations

到目前为止，你已经看到了 Hibernate 如何使用 XML 映射文件将数据从 POJO 转换为数据库表，反之亦然。Hibernate 注释是无需使用 XML 文件便可以定义映射的最新方式。你可以除了或替换 XML 映射元数据以外，还可以使用注释。

Hibernate 注释是以强大方式为对象和关系表映射提供元数据的方法。所有元数据与代码一起打包到 POJO Java 文件中，这有助于用户在开发期间同时了解表结构和 POJO。

如果你打算让应用程序可移植到其他 EJB 3 兼容的 ORM 应用程序，则必须使用注释来表示映射信息，但如果你仍然想要更大的灵活性，则应该选择基于 XML 的映射。

Environment Setup for Hibernate Annotation

首先，你必须确保正在使用 JDK 5.0，否则需要将 JDK 升级到 JDK 5.0 以利用对注释的本机支持。

其次，你需要安装 Hibernate 3.x 注释发行包，该包可从 Sourceforge 获得：( Download Hibernate Annotation )，并将 hibernate-annotations.jar, lib/hibernate-comons-annotations.jar 和 lib/ejb3-persistence.jar 从 Hibernate 注释发行包复制到 CLASSPATH。

Annotated Class Example

如上所述，在使用 Hibernate 注释时，所有元数据与代码一起打包到 POJO Java 文件中，这有助于用户在开发期间同时了解表结构和 POJO。

考虑我们准备使用以下 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)
);

以下是 Employee 类的映射，带有注释，以将对象映射到定义的 EMPLOYEE 表中 -

import javax.persistence.*;

@Entity
@Table(name = "EMPLOYEE")
public class Employee {
   @Id @GeneratedValue
   @Column(name = "id")
   private int id;

   @Column(name = "first_name")
   private String firstName;

   @Column(name = "last_name")
   private String lastName;

   @Column(name = "salary")
   private int salary;

   public Employee() {}

   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;
   }
}

Hibernate 检测到 @Id 注释位于一个字段上，并假设它应该在运行时直接通过字段访问对象的属性。如果将 @Id 注释放在 getId() 方法上，就会默认允许通过 getter 和 setter 方法访问属性。因此，根据所选策略，所有其他的注释也都会放在字段上或 getter 方法上。

以下部分将解释在上述类中使用的注释。

@Entity Annotation

EJB 3 标准注释包含在 javax.persistence 包中，因此我们将此包作为第一步导入。其次，我们在 Employee 类中使用了 @Entity 注释，它将此类标记为实体 bean，因此它必定有一个无参数构造函数，并且至少具有受保护的作用域可见性。

@Table Annotation

@Table 注释允许您指定表中的详细信息，这些信息将用于保留数据库中的实体。

@Table 注释提供了四个属性，允许您覆盖表名称、其目录以及其架构，并强制执行表中列的唯一约束。目前，我们仅使用表名称，即 EMPLOYEE。

@Id and @GeneratedValue Annotations

每个实体 bean 都将有一个主键，您使用 @Id 注释在类上为此进行注释。主键可以是单个字段或多个字段的组合，具体取决于您的表结构。

默认情况下，@Id 注释将自动确定要使用的最合适的主键生成策略，但是您可以通过应用 @GeneratedValue 注释来覆盖该策略，该注释采用两个参数 strategy 和 generator ，我将不会在这里讨论它们，因此让我们仅使用默认的主键生成策略。让 Hibernate 确定要使用哪种生成器类型，可以使您的代码在不同的数据库之间具有可移植性。

@Column Annotation

@Column 注释用于指定字段或属性将映射到的列的详细信息。您可以将列注释与以下最常用的属性一起使用 -

  1. name 属性允许显式地指定列的名称。

  2. length 属性允许映射值的大小，特别是对于 String 值。

  3. nullable 属性允许在生成架构时将列标记为 NOT NULL。

  4. unique 属性允许将列标记为仅包含唯一值。

Create Application Class

最后，我们将使用 main() 方法创建我们的应用程序类来运行应用程序。我们将使用此应用程序来保存一些 Employee 的记录，然后我们将对这些记录应用 CRUD 操作。

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.cfg.AnnotationConfiguration;
import org.hibernate.SessionFactory;
import org.hibernate.cfg.Configuration;

public class ManageEmployee {
   private static SessionFactory factory;
   public static void main(String[] args) {

      try {
         factory = new AnnotationConfiguration().
                   configure().
                   //addPackage("com.xyz") //add package if used.
                   addAnnotatedClass(Employee.class).
                   buildSessionFactory();
      } catch (Throwable ex) {
         System.err.println("Failed to create sessionFactory object." + ex);
         throw new ExceptionInInitializerError(ex);
      }

      ManageEmployee ME = new ManageEmployee();

      /* Add few employee records in database */
      Integer empID1 = ME.addEmployee("Zara", "Ali", 1000);
      Integer empID2 = ME.addEmployee("Daisy", "Das", 5000);
      Integer empID3 = ME.addEmployee("John", "Paul", 10000);

      /* List down all the employees */
      ME.listEmployees();

      /* Update employee's records */
      ME.updateEmployee(empID1, 5000);

      /* Delete an employee from the database */
      ME.deleteEmployee(empID2);

      /* List down new list of the employees */
      ME.listEmployees();
   }

   /* Method to CREATE an employee in the database */
   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();
         employee.setFirstName(fname);
         employee.setLastName(lname);
         employee.setSalary(salary);
         employeeID = (Integer) session.save(employee);
         tx.commit();
      } catch (HibernateException e) {
         if (tx!=null) tx.rollback();
         e.printStackTrace();
      } finally {
         session.close();
      }
      return employeeID;
   }

   /* Method to  READ all the employees */
   public void listEmployees( ){
      Session session = factory.openSession();
      Transaction tx = null;

      try {
         tx = session.beginTransaction();
         List employees = session.createQuery("FROM Employee").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();
      }
   }

   /* Method to UPDATE salary for an employee */
   public void updateEmployee(Integer EmployeeID, int salary ){
      Session session = factory.openSession();
      Transaction tx = null;

      try {
         tx = session.beginTransaction();
         Employee employee = (Employee)session.get(Employee.class, EmployeeID);
         employee.setSalary( salary );
		 session.update(employee);
         tx.commit();
      } catch (HibernateException e) {
         if (tx!=null) tx.rollback();
         e.printStackTrace();
      } finally {
         session.close();
      }
   }

   /* Method to DELETE an employee from the records */
   public void deleteEmployee(Integer EmployeeID){
      Session session = factory.openSession();
      Transaction tx = null;

      try {
         tx = session.beginTransaction();
         Employee employee = (Employee)session.get(Employee.class, EmployeeID);
         session.delete(employee);
         tx.commit();
      } catch (HibernateException e) {
         if (tx!=null) tx.rollback();
         e.printStackTrace();
      } finally {
         session.close();
      }
   }
}

Database Configuration

现在，让我们创建 hibernate.cfg.xml 配置文件来定义与数据库相关的参数。

<?xml version = "1.0" encoding = "utf-8"?>
<!DOCTYPE hibernate-configuration SYSTEM
"http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">

<hibernate-configuration>
   <session-factory>

      <property name = "hibernate.dialect">
         org.hibernate.dialect.MySQLDialect
      </property>

      <property name = "hibernate.connection.driver_class">
         com.mysql.jdbc.Driver
      </property>

      <!-- Assume students is the database name -->

      <property name = "hibernate.connection.url">
         jdbc:mysql://localhost/test
      </property>

      <property name = "hibernate.connection.username">
         root
      </property>

      <property name = "hibernate.connection.password">
         cohondob
      </property>

   </session-factory>
</hibernate-configuration>

Compilation and Execution

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

  1. 从路径中删除 Employee.hbm.xml 映射文件。

  2. 创建 Employee.java 源文件（如上所示），并进行编译。

  3. 按上方代码创建一个 ManageEmployee.java 源文件并进行编译。

  4. 执行 ManageEmployee 二进制文件来运行该程序。

您将获得以下结果，并且记录将被创建到 EMPLOYEE 表中。

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

First Name: Zara  Last Name: Ali  Salary: 1000
First Name: Daisy  Last Name: Das  Salary: 5000
First Name: John  Last Name: Paul  Salary: 10000
First Name: Zara  Last Name: Ali  Salary: 5000
First Name: John  Last Name: Paul  Salary: 10000

如果检查您的 EMPLOYEE 表，它应包含以下记录 −

mysql> select * from EMPLOYEE;
+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
| 29 | Zara       | Ali       |   5000 |
| 31 | John       | Paul      |  10000 |
+----+------------+-----------+--------+
2 rows in set (0.00 sec

mysql>