详解Java的Hibernate框架中的List映射表与Bag映射

list映射表
list列表是一个java集合存储在序列中的元素，并允许重复的元素。此接口的用户可以精确地控制，其中列表中的每个元素插入。用户可以通过他们的整数索引访问元素，并搜索列表中的元素。更正式地说，列表通常允许对元素e1和e2，使得e1.equals（e2），它们通常允许多个null元素，如果他们允许的null元素。

list列表被映射在该映射表中的<list>元素，并将java.util.arraylist中初始化。

定义rdbms表：
考虑一个情况，需要员工记录存储在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)
);

此外，假设每个员工都可以有一个或多个与他/她相关的证书。list集合映射需要在一个集合表的索引列。索引列定义集合中的元素的位置。因此，我们将存储证书的相关信息在一个单独的表，该表具有以下结构：

create table certificate (
  id int not null auto_increment,
  certificate_name varchar(30) default null,
  idx int default null, 
  employee_id int default null,
  primary key (id)
);

将有一个对多( one-to-many)的employee和证书对象之间的关系。

定义pojo类：
让我们实现一个pojo类员工将被用于保存与employee表中的对象和有证书的列表变量的集合。

import java.util.*;

public class employee {
  private int id;
  private string firstname; 
  private string lastname;  
  private int salary;
  private list certificates;

  public employee() {}
  public employee(string fname, string lname, int salary) {
   this.firstname = fname;
   this.lastname = lname;
   this.salary = salary;
  }
  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;
  }

  public list getcertificates() {
   return certificates;
  }
  public void setcertificates( list certificates ) {
   this.certificates = certificates;
  }
}

我们需要相应的证书表定义另一个pojo类，这样的证书对象可以存储和检索到的证书表。

public class certificate{
  private int id;
  private string name; 

  public certificate() {}
  public certificate(string name) {
   this.name = name;
  }
  public int getid() {
   return id;
  }
  public void setid( int id ) {
   this.id = id;
  }
  public string getname() {
   return name;
  }
  public void setname( string name ) {
   this.name = name;
  }
}

定义hibernate映射文件：
让我们开发指定hibernate如何定义的类映射到数据库表的映射文件。<list>元素将被用来定义使用list集合的规则。表的索引是整数类型总是和使用<list-index>元素定义映射。

<?xml version="1.0" encoding="utf-8"?>
<!doctype hibernate-mapping public 
 "-//hibernate/hibernate mapping dtd//en"
 "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd"> 

<hibernate-mapping>
  <class name="employee" table="employee">
   <meta attribute="class-description">
     this class contains the employee detail. 
   </meta>
   <id name="id" type="int" column="id">
     <generator class="native"/>
   </id>
   <list name="certificates" cascade="all">
     <key column="employee_id"/>
     <list-index column="idx"/>
     <one-to-many class="certificate"/>
   </list>
   <property name="firstname" column="first_name" type="string"/>
   <property name="lastname" column="last_name" type="string"/>
   <property name="salary" column="salary" type="int"/>
  </class>

  <class name="certificate" table="certificate">
   <meta attribute="class-description">
     this class contains the certificate records. 
   </meta>
   <id name="id" type="int" column="id">
     <generator class="native"/>
   </id>
   <property name="name" column="certificate_name" type="string"/>
  </class>

</hibernate-mapping>

应该保存的映射文件中的格式<classname>.hbm.xml。我们保存我们的映射文件中的文件employee.hbm.xml。你已经熟悉了大部分的映射细节，映射文件中的所有元素：

映射文档是具有<hibernate-mapping>为对应于每一个类包含2个<class>元素的根元素的xml文档。

<class>元素被用于定义数据库表从一个java类特定的映射。 java类名指定使用class元素的name属性和使用表属性数据库表名指定。

<meta>元素是可选元素，可以用来创建类的描述。

<id>元素映射在类中的唯一id属性到数据库表的主键。 id元素的name属性是指属性的类和column属性是指在数据库表中的列。 type属性保存了hibernate映射类型，这种类型的映射将会从java转换为sql数据类型。

id元素内的<generator>元素被用来自动生成的主键值。将生成元素的class属性设置为原生让hibernate拿起无论是identity，sequence或者hilo中的算法来创建主键根据底层数据库的支持能力。

<property>元素用于一个java类的属性映射到数据库表中的列。元素的name属性是指属性的类和column属性是指在数据库表中的列。 type属性保存了hibernate映射类型，这种类型的映射将会从java转换为sql数据类型。

<list>元素用于设置证书和employee类之间的关系。我们使用cascade属性中<list>元素来告诉hibernate来保存证书的对象，同时为employee对象。 name属性被设置为在父类中定义的listvariable，在我们的情况下，它是证书。

<key>元素是包含外键的父对象，即在证书表中的列。即，表employee。

<list-index>元素定义用于保持元件的位置，并与在该集合表的索引列映射。持久性列表的索引从零开始。你可以改变这一点，例如，在你的映射<list-index base="1".../>。

<one-to-many>元素表示一个employee对象涉及到很多证书的对象，并因此，证书对象必须有与之劳动者家长有关。您可以根据您的需要使用任何和<one-to-one>，<many-to-one>进行或<many-to-many>这个元素。如果我们改变了这个例子使用一个many-to-many的关系，我们需要一个关联表到父和子对象之间的映射。

创建应用程序类：
最后，我们将创建应用程序类的main（）方法来运行应用程序。我们将使用这个应用程序，以节省一些员工的记录连同的证书，然后我们将申请crud操作上的记录。

import java.util.*;
 
import org.hibernate.hibernateexception; 
import org.hibernate.session; 
import org.hibernate.transaction;
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 configuration().configure().buildsessionfactory();
   }catch (throwable ex) { 
     system.err.println("failed to create sessionfactory object." + ex);
     throw new exceptionininitializererror(ex); 
   }
   manageemployee me = new manageemployee();
   /* let us have a set of certificates for the first employee */
   arraylist set1 = new arraylist();
   set1.add(new certificate("mca"));
   set1.add(new certificate("mba"));
   set1.add(new certificate("pmp"));
   
   /* add employee records in the database */
   integer empid1 = me.addemployee("manoj", "kumar", 4000, set1);

   /* another set of certificates for the second employee */
   arraylist set2 = new arraylist();
   set2.add(new certificate("bca"));
   set2.add(new certificate("ba"));

   /* add another employee record in the database */
   integer empid2 = me.addemployee("dilip", "kumar", 3000, set2);

   /* list down all the employees */
   me.listemployees();

   /* update employee's salary records */
   me.updateemployee(empid1, 5000);

   /* delete an employee from the database */
   me.deleteemployee(empid2);

   /* list down all the employees */
   me.listemployees();

  }

  /* method to add an employee record in the database */
  public integer addemployee(string fname, string lname, 
                   int salary, arraylist cert){
   session session = factory.opensession();
   transaction tx = null;
   integer employeeid = null;
   try{
     tx = session.begintransaction();
     employee employee = new employee(fname, lname, salary);
     employee.setcertificates(cert);
     employeeid = (integer) session.save(employee); 
     tx.commit();
   }catch (hibernateexception e) {
     if (tx!=null) tx.rollback();
     e.printstacktrace(); 
   }finally {
     session.close(); 
   }
   return employeeid;
  }

  /* method to list all the employees detail */
  public void listemployees( ){
   session session = factory.opensession();
   transaction tx = null;
   try{
     tx = session.begintransaction();
     list employees = session.createquery("from employee").list(); 
     for (iterator iterator1 = 
              employees.iterator(); iterator1.hasnext();){
      employee employee = (employee) iterator1.next(); 
      system.out.print("first name: " + employee.getfirstname()); 
      system.out.print(" last name: " + employee.getlastname()); 
      system.out.println(" salary: " + employee.getsalary());
      list certificates = employee.getcertificates();
      for (iterator iterator2 = 
             certificates.iterator(); iterator2.hasnext();){
         certificate certname = (certificate) iterator2.next(); 
         system.out.println("certificate: " + certname.getname()); 
      }
     }
     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(); 
   }
  }
}

编译和执行：
下面是步骤来编译并运行上述应用程序。请确保您已在进行的编译和执行之前，适当地设置path和classpath。

• 创建hibernate.cfg.xml配置文件中配置章节解释。
• 创建employee.hbm.xml映射文件，如上图所示。
• 创建employee.java源文件，如上图所示，并编译它.
• 创建certificate.java源文件，如上图所示，并编译它。
• 创建manageemployee.java源文件，如上图所示，并编译它。
• 执行manageemployee二进制文件来运行程序。

会在屏幕上获得以下结果，并同时记录会在员工和证书表被创建。可以看到证书已排序顺序相反。可以通过改变映射文件试试，只需设置sort="natural"和执行程序，并比较结果。

$java manageemployee

.......various log messages will display here........

first name: manoj last name: kumar salary: 4000
certificate: mca
certificate: mba
certificate: pmp
first name: dilip last name: kumar salary: 3000
certificate: bca
certificate: ba
first name: manoj last name: kumar salary: 5000
certificate: mca
certificate: mba
certificate: pmp

如果检查员工和证书表，就应该记录下了：

mysql> select * from employee;

+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
| 51 | manoj   | kumar   |  5000 |
+----+------------+-----------+--------+
1 row in set (0.00 sec)

mysql> select * from certificate;

+----+------------------+------+-------------+
| id | certificate_name | idx | employee_id |
+----+------------------+------+-------------+
| 6 | mca       |  0 |     51 |
| 7 | mba       |  1 |     51 |
| 8 | pmp       |  2 |     51 |
+----+------------------+------+-------------+
3 rows in set (0.00 sec)

或者，您也可以映射java数组，而不是一个列表。一个数组的映射几乎是相同的前面的例子，除了与不同的元素和属性名称（<array>和<array-index>）。然而，原因如前所述，hibernate应用程序很少使用数组。

bag映射
bag是一个java集合存储元素无需关心顺序，但允许列表中的重复元素。bag是在列表中的对象的随机分组。

collection集合被映射在该映射表中的<bag>元件和与java.util.arraylist中初始化。
下面的示例中rdbms表和pojo类依然使用上面定义好的。
定义hibernate映射文件：
让我们开发指示hibernate如何定义的类映射到数据库表的映射文件。<bag>元素将被用来定义所使用的集合规则。

<?xml version="1.0" encoding="utf-8"?>
<!doctype hibernate-mapping public 
 "-//hibernate/hibernate mapping dtd//en"
 "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd"> 

<hibernate-mapping>
  <class name="employee" table="employee">
   <meta attribute="class-description">
     this class contains the employee detail. 
   </meta>
   <id name="id" type="int" column="id">
     <generator class="native"/>
   </id>
   <bag name="certificates" cascade="all">
     <key column="employee_id"/>
     <one-to-many class="certificate"/>
   </bag>
   <property name="firstname" column="first_name" type="string"/>
   <property name="lastname" column="last_name" type="string"/>
   <property name="salary" column="salary" type="int"/>
  </class>

  <class name="certificate" table="certificate">
   <meta attribute="class-description">
     this class contains the certificate records. 
   </meta>
   <id name="id" type="int" column="id">
     <generator class="native"/>
   </id>
   <property name="name" column="certificate_name" type="string"/>
  </class>

</hibernate-mapping>

应该保存的映射文件中的格式<classname>.hbm.xml。我们保存映射文件employee.hbm.xml。前面已经熟悉了大部分的映射细节，但让我们看到了映射文件中的所有元素再次：

映射文档是具有<hibernate-mapping>为对应于每一个类包含2个<class>元素的根元素的xml文档。

<class>元素被用于定义数据库表从一个java类特定的映射。 java类名指定使用class元素的name属性和使用表属性数据库表名指定。

<meta>元素是可选元素，可以用来创建类的描述。

<id>元素映射在类中的唯一id属性到数据库表的主键。 id元素的name属性是指属性的类和column属性是指在数据库表中的列。 type属性保存了hibernate映射类型，这种类型的映射将会从java转换为sql数据类型。

id元素内的<generator>元素被用来自动生成的主键值。将生成元素的class属性设置为原生让hibernate拿起无论是identity，sequence或者hilo中的算法来创建主键根据底层数据库的支持能力。

<property>元素用于一个java类的属性映射到数据库表中的列。元素的name属性是指属性的类和column属性是指在数据库表中的列。 type属性保存了hibernate映射类型，这种类型的映射将会从java转换为sql数据类型。

<bag>元素用于设置证书和employee类之间的关系。我们使用cascade属性的<bag>高的元素要告诉hibernate来保存证书的对象，同时为employee对象。 name属性被设置为在父类中的definedcollection变量，在我们的情况下，它是证书。

<key>元素是包含外键的父对象，即在证书表中的列。表employee。

<one-to-many>元素表示一个employee对象涉及到很多证书的对象，并因此，证书对象必须有与employee父类有关联。可以根据需要使用<one-to-one>，<many-to-one>或<many-to-many>这个元素。

创建应用程序类：
最后，我们将创建应用程序类的main（）方法来运行应用程序。我们将使用这个应用程序，以节省一些员工的记录连同的证书，然后我们将申请crud操作上的记录。

import java.util.*;
 
import org.hibernate.hibernateexception; 
import org.hibernate.session; 
import org.hibernate.transaction;
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 configuration().configure().buildsessionfactory();
   }catch (throwable ex) { 
     system.err.println("failed to create sessionfactory object." + ex);
     throw new exceptionininitializererror(ex); 
   }
   manageemployee me = new manageemployee();
   /* let us have a set of certificates for the first employee */
   arraylist set1 = new arraylist();
   set1.add(new certificate("mca"));
   set1.add(new certificate("mba"));
   set1.add(new certificate("pmp"));
   
   /* add employee records in the database */
   integer empid1 = me.addemployee("manoj", "kumar", 4000, set1);

   /* another set of certificates for the second employee */
   arraylist set2 = new arraylist();
   set2.add(new certificate("bca"));
   set2.add(new certificate("ba"));

   /* add another employee record in the database */
   integer empid2 = me.addemployee("dilip", "kumar", 3000, set2);

   /* list down all the employees */
   me.listemployees();

   /* update employee's salary records */
   me.updateemployee(empid1, 5000);

   /* delete an employee from the database */
   me.deleteemployee(empid2);

   /* list down all the employees */
   me.listemployees();

  }

  /* method to add an employee record in the database */
  public integer addemployee(string fname, string lname, 
                   int salary, arraylist cert){
   session session = factory.opensession();
   transaction tx = null;
   integer employeeid = null;
   try{
     tx = session.begintransaction();
     employee employee = new employee(fname, lname, salary);
     employee.setcertificates(cert);
     employeeid = (integer) session.save(employee); 
     tx.commit();
   }catch (hibernateexception e) {
     if (tx!=null) tx.rollback();
     e.printstacktrace(); 
   }finally {
     session.close(); 
   }
   return employeeid;
  }

  /* method to list all the employees detail */
  public void listemployees( ){
   session session = factory.opensession();
   transaction tx = null;
   try{
     tx = session.begintransaction();
     list employees = session.createquery("from employee").list(); 
     for (iterator iterator1 = 
              employees.iterator(); iterator1.hasnext();){
      employee employee = (employee) iterator1.next(); 
      system.out.print("first name: " + employee.getfirstname()); 
      system.out.print(" last name: " + employee.getlastname()); 
      system.out.println(" salary: " + employee.getsalary());
      collection certificates = employee.getcertificates();
      for (iterator iterator2 = 
             certificates.iterator(); iterator2.hasnext();){
         certificate certname = (certificate) iterator2.next(); 
         system.out.println("certificate: " + certname.getname()); 
      }
     }
     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(); 
   }
  }
}

编译和执行：

会在屏幕上获得以下结果，并同时记录会在员工和证书表被创建。可以看到证书已排序顺序相反。可以通过改变映射文件试试，只需设置sort="natural"和执行程序，并比较结果。

$java manageemployee

.......various log messages will display here........

first name: manoj last name: kumar salary: 4000
certificate: mca
certificate: mba
certificate: pmp
first name: dilip last name: kumar salary: 3000
certificate: bca
certificate: ba
first name: manoj last name: kumar salary: 5000
certificate: mca
certificate: mba
certificate: pmp

如果检查员工和证书表，就应该记录下了：

mysql> select * from employee;

+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
| 53 | manoj   | kumar   |  5000 |
+----+------------+-----------+--------+
1 row in set (0.00 sec)

mysql> select * from certificate;

+----+------------------+-------------+
| id | certificate_name | employee_id |
+----+------------------+-------------+
| 11 | mca       |     53 |
| 12 | mba       |     53 |
| 13 | pmp       |     53 |
+----+------------------+-------------+
3 rows in set (0.00 sec)