Hibernate 注解

到目前为止,我们已经了解了 Hibernate 如何使用 XML 映射文件将数据从 POJO 转换为数据库表,反之亦然。 Hibernate 注解是在不使用 XML 文件的情况下定义映射的最新方法。 我们可以使用注解作为 XML 映射元数据的补充或替代。

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

如果要使我们的应用程序可移植到其他符合 EJB 3 的 ORM 应用程序,我们必须使用注解来表示映射信息,但如果仍然想要更大的灵活性,那么应该使用基于 XML 的映射。


Hibernate Annotation 的环境设置

首先,我们必须确保使用的是 JDK 5.0,否则需要将 JDK 升级到 JDK 5.0 以利用对注解的本机支持。

其次,我们需要安装 Hibernate 3.x 注解分发包,可从 sourceforge 获得:(下载 Hibernate Annotation)并复制 hibernate-annotations.jarlib/hibernate-comons-annotations.jarlib/ejb3-persistence.jar 从 Hibernate Annotations 导入到我们的 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 注解在一个字段上,并假定它应该在运行时直接通过字段访问对象的属性。 如果在 getId() 方法上放置了 @Id 注释,则默认情况下我们将启用通过 getter 和 setter 方法访问属性。 因此,所有其他注解也按照所选策略放置在字段或 getter 方法上。

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


@Entity 注解

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

@Table 注解

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

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

@Id 和 @GeneratedValue 注解

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

默认情况下,@Id 注解将自动确定要使用的最合适的主键生成策略,但我们可以通过应用 @GeneratedValue 注解来覆盖它,它带有两个参数 strategy 和 generator,我不打算在这里讨论,所以 让我们只使用默认的密钥生成策略。 让 Hibernate 确定要使用的生成器类型使我们的代码在不同数据库之间可移植。

@Column 注解

@Column 注解用于指定字段或属性将映射到的列的详细信息。 我们可以使用具有以下最常用属性的列注解

  • name 属性允许明确指定列的名称。
  • length 属性允许用于映射值的列的大小,特别是对于 String 值。
  • 可空属性允许在生成模式时将该列标记为 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") // 如果使用需要添加包。
                   addAnnotatedClass(Employee.class).
                   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", 1000);
      Integer empID2 = ME.addEmployee("Daisy", "Das", 5000);
      Integer empID3 = ME.addEmployee("John", "Paul", 10000);

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

      /* 更新员工记录 */
      ME.updateEmployee(empID1, 5000);

      /* 从数据库中删除员工 */
      ME.deleteEmployee(empID2);

      /* 列出新的员工名单 */
      ME.listEmployees();
   }
   
   /* 在数据库中创建员工的方法 */
   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;
   }
   
   /* 读取所有员工的方法 */
   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(); 
      }
   }
   
   /* 更新员工工资的方法 */
   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(); 
      }
   }
   
   /* 从记录中删除员工的方法 */
   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>
   
      <property name = "hibernate.connection.url">
         jdbc:mysql://localhost/hibernate_demo
      </property>
   
      <property name = "hibernate.connection.username">
         root
      </property>
   
      <property name = "hibernate.connection.password">
         123456
      </property>

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

编译和执行

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

  • 从路径中删除 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

查看笔记

扫码一下
查看教程更方便