Hibernate - 注释

---

到目前为止，您已经了解了 Hibernate 如何使用 XML 映射文件将数据从 POJO 转换为数据库表，反之亦然。Hibernate 注释是无需使用 XML 文件即可定义映射的最新方法。您可以使用注释作为 XML 映射元数据的补充或替代。

Hibernate Annotations 是为对象和关系表映射提供元数据的强大方法。所有元数据都与代码一起放入 POJO java 文件中，这有助于用户在开发过程中同时了解表结构和 POJO。

如果您打算使您的应用程序可移植到其他符合 EJB 3 的 ORM 应用程序，则必须使用注释来表示映射信息，但如果您想要更大的灵活性，那么您应该使用基于 XML 的映射。

Hibernate 注解的环境设置

首先，您必须确保您使用的是 JDK 5.0，否则您需要将 JDK 升级到 JDK 5.0 才能利用对注释的本机支持。

其次，您需要安装 Hibernate 3.x 注释分发包，可从 sourceforge 获取：（下载 Hibernate Annotation）并复制hibernate-annotations.jar、lib/hibernate-comons-annotations.jar和lib/ejb3-persistence。将 Hibernate Annotations 发行版中的jar 文件添加到您的 CLASSPATH 中。

带注释的类示例

正如我上面提到的，在使用 Hibernate Annotation 时，所有元数据都与代码一起合并到 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注解

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

@表注解

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

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

@Id 和 @GenerateValue 注解

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

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

@Column注解

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

• name属性允许显式指定列的名称。

• length属性允许用于映射值（特别是字符串值）的列的大小。

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

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

创建应用程序类

最后，我们将使用 main() 方法创建应用程序类来运行应用程序。我们将使用此应用程序保存一些员工记录，然后对这些记录应用 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(); 
      }
   }
}

数据库配置

现在让我们创建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>

编译与执行

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

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

• 如上所示创建 Employee.java 源文件并编译它。

• 如上所示创建 ManageEmployee.java 源文件并编译它。

• 执行 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>