📜  Hibernate-注释

📅  最后修改于: 2020-11-16 07:00:38             🧑  作者: Mango


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

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

如果要使您的应用程序可移植到其他符合EJB 3的ORM应用程序,则必须使用批注来表示映射信息,但是,如果您仍然希望更大的灵活性,则应该使用基于XML的映射。

休眠注释的环境设置

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

其次,您将需要安装Hibernate 3.x批注分发包,该包可从sourceforge获得:(下载Hibernate Annotation )并复制hibernate-annotations.jar,lib / 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批注位于字段上,并假定它应在运行时直接通过字段访问对象的属性。如果将@Id注释放在getId()方法上,则默认情况下将允许通过getter和setter方法访问属性。因此,遵循所选策略,所有其他注释也将放置在字段或getter方法上。

下一节将解释以上类中使用的注释。

@实体注释

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

@表注释

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

@Table批注提供了四个属性,使您可以覆盖表的名称,目录和架构,并对表中的列施加唯一约束。现在,我们仅使用表名,即EMPLOYEE。

@Id和@GeneratedValue注释

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

默认情况下,@ Id批注将自动确定要使用的最合适的主键生成策略,但是您可以通过应用@GeneratedValue批注来覆盖此策略,该批注包含两个参数策略生成器,在此不再赘述。让我们只使用默认的密钥生成策略。让Hibernate确定使用哪种生成器类型,可以使您的代码在不同数据库之间可移植。

@列注释

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

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

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

  • 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配置文件来定义与数据库相关的参数。





   
   
      
         org.hibernate.dialect.MySQLDialect
      
   
      
         com.mysql.jdbc.Driver
      

      
   
      
         jdbc:mysql://localhost/test
      
   
      
         root
      
   
      
         cohondob
      

   

编译与执行

这是编译和运行上述应用程序的步骤。在继续进行编译和执行之前,请确保已正确设置了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>