Hibernate - 注解

上一页
下一页

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

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

如果您打算使您的应用程序可移植到其他符合 EJB 3 的 ORM 应用程序，则必须使用注解来表示映射信息，但如果您仍希望获得更大的灵活性，则应使用基于 XML 的映射。

Hibernate 注解的环境设置

首先，您必须确保您正在使用 JDK 5.0，否则您需要将 JDK 升级到 JDK 5.0 以利用对注解的原生支持。

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

带注解的类示例

如上所述，在使用 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 注解

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

@Table 注解

@Table 注解允许您指定将用于在数据库中持久化实体的表的详细信息。

@Table 注解提供了四个属性，允许您覆盖表名称、其目录和模式，并对表中的列强制实施唯一约束。目前，我们只使用表名，即 EMPLOYEE。

@Id 和 @GeneratedValue 注解

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

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

@Column 注解

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

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

  • length 属性允许指定用于映射值的列的大小，特别是对于 String 值。

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

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

创建应用程序类

最后，我们将创建包含 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(); 
      }
   }
}

数据库配置

现在让我们创建 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://127.0.0.1/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>
打印页面
上一页
下一页
广告