详解Java的Hibernate框架中的List映射表与Bag映射
List映射表
List列表是一个java集合存储在序列中的元素,并允许重复的元素。此接口的用户可以精确地控制,其中列表中的每个元素插入。用户可以通过他们的整数索引访问元素,并搜索列表中的元素。更正式地说,列表通常允许对元素e1和e2,使得e1.equals(e2),它们通常允许多个null元素,如果他们允许的null元素。
List列表被映射在该映射表中的<list>元素,并将java.util.ArrayList中初始化。
定义RDBMS表:
考虑一个情况,需要员工记录存储在EMPLOYEE表,将有以下结构:
createtableEMPLOYEE( idINTNOTNULLauto_increment, first_nameVARCHAR(20)defaultNULL, last_nameVARCHAR(20)defaultNULL, salaryINTdefaultNULL, PRIMARYKEY(id) );
此外,假设每个员工都可以有一个或多个与他/她相关的证书。List集合映射需要在一个集合表的索引列。索引列定义集合中的元素的位置。因此,我们将存储证书的相关信息在一个单独的表,该表具有以下结构:
createtableCERTIFICATE( idINTNOTNULLauto_increment, certificate_nameVARCHAR(30)defaultNULL, idxINTdefaultNULL, employee_idINTdefaultNULL, PRIMARYKEY(id) );
将有一个对多(one-to-many)的EMPLOYEE和证书对象之间的关系。
定义POJO类:
让我们实现一个POJO类员工将被用于保存与EMPLOYEE表中的对象和有证书的列表变量的集合。
importjava.util.*; publicclassEmployee{ privateintid; privateStringfirstName; privateStringlastName; privateintsalary; privateListcertificates; publicEmployee(){} publicEmployee(Stringfname,Stringlname,intsalary){ this.firstName=fname; this.lastName=lname; this.salary=salary; } publicintgetId(){ returnid; } publicvoidsetId(intid){ this.id=id; } publicStringgetFirstName(){ returnfirstName; } publicvoidsetFirstName(Stringfirst_name){ this.firstName=first_name; } publicStringgetLastName(){ returnlastName; } publicvoidsetLastName(Stringlast_name){ this.lastName=last_name; } publicintgetSalary(){ returnsalary; } publicvoidsetSalary(intsalary){ this.salary=salary; } publicListgetCertificates(){ returncertificates; } publicvoidsetCertificates(Listcertificates){ this.certificates=certificates; } }
我们需要相应的证书表定义另一个POJO类,这样的证书对象可以存储和检索到的证书表。
publicclassCertificate{ privateintid; privateStringname; publicCertificate(){} publicCertificate(Stringname){ this.name=name; } publicintgetId(){ returnid; } publicvoidsetId(intid){ this.id=id; } publicStringgetName(){ returnname; } publicvoidsetName(Stringname){ this.name=name; } }
定义Hibernate映射文件:
让我们开发指定Hibernate如何定义的类映射到数据库表的映射文件。<list>元素将被用来定义使用List集合的规则。表的索引是整数类型总是和使用<list-index>元素定义映射。
<?xmlversion="1.0"encoding="utf-8"?> <!DOCTYPEhibernate-mappingPUBLIC "-//Hibernate/HibernateMappingDTD//EN" "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd"> <hibernate-mapping> <classname="Employee"table="EMPLOYEE"> <metaattribute="class-description"> Thisclasscontainstheemployeedetail. </meta> <idname="id"type="int"column="id"> <generatorclass="native"/> </id> <listname="certificates"cascade="all"> <keycolumn="employee_id"/> <list-indexcolumn="idx"/> <one-to-manyclass="Certificate"/> </list> <propertyname="firstName"column="first_name"type="string"/> <propertyname="lastName"column="last_name"type="string"/> <propertyname="salary"column="salary"type="int"/> </class> <classname="Certificate"table="CERTIFICATE"> <metaattribute="class-description"> Thisclasscontainsthecertificaterecords. </meta> <idname="id"type="int"column="id"> <generatorclass="native"/> </id> <propertyname="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-indexbase="1".../>。
<one-to-many>元素表示一个Employee对象涉及到很多证书的对象,并因此,证书对象必须有与之劳动者家长有关。您可以根据您的需要使用任何和<one-to-one>,<many-to-one>进行或<many-to-many>这个元素。如果我们改变了这个例子使用一个many-to-many的关系,我们需要一个关联表到父和子对象之间的映射。
创建应用程序类:
最后,我们将创建应用程序类的main()方法来运行应用程序。我们将使用这个应用程序,以节省一些员工的记录连同的证书,然后我们将申请CRUD操作上的记录。
importjava.util.*; importorg.hibernate.HibernateException; importorg.hibernate.Session; importorg.hibernate.Transaction; importorg.hibernate.SessionFactory; importorg.hibernate.cfg.Configuration; publicclassManageEmployee{ privatestaticSessionFactoryfactory; publicstaticvoidmain(String[]args){ try{ factory=newConfiguration().configure().buildSessionFactory(); }catch(Throwableex){ System.err.println("FailedtocreatesessionFactoryobject."+ex); thrownewExceptionInInitializerError(ex); } ManageEmployeeME=newManageEmployee(); /*Letushaveasetofcertificatesforthefirstemployee*/ ArrayListset1=newArrayList(); set1.add(newCertificate("MCA")); set1.add(newCertificate("MBA")); set1.add(newCertificate("PMP")); /*Addemployeerecordsinthedatabase*/ IntegerempID1=ME.addEmployee("Manoj","Kumar",4000,set1); /*Anothersetofcertificatesforthesecondemployee*/ ArrayListset2=newArrayList(); set2.add(newCertificate("BCA")); set2.add(newCertificate("BA")); /*Addanotheremployeerecordinthedatabase*/ IntegerempID2=ME.addEmployee("Dilip","Kumar",3000,set2); /*Listdownalltheemployees*/ ME.listEmployees(); /*Updateemployee'ssalaryrecords*/ ME.updateEmployee(empID1,5000); /*Deleteanemployeefromthedatabase*/ ME.deleteEmployee(empID2); /*Listdownalltheemployees*/ ME.listEmployees(); } /*Methodtoaddanemployeerecordinthedatabase*/ publicIntegeraddEmployee(Stringfname,Stringlname, intsalary,ArrayListcert){ Sessionsession=factory.openSession(); Transactiontx=null; IntegeremployeeID=null; try{ tx=session.beginTransaction(); Employeeemployee=newEmployee(fname,lname,salary); employee.setCertificates(cert); employeeID=(Integer)session.save(employee); tx.commit(); }catch(HibernateExceptione){ if(tx!=null)tx.rollback(); e.printStackTrace(); }finally{ session.close(); } returnemployeeID; } /*Methodtolistalltheemployeesdetail*/ publicvoidlistEmployees(){ Sessionsession=factory.openSession(); Transactiontx=null; try{ tx=session.beginTransaction(); Listemployees=session.createQuery("FROMEmployee").list(); for(Iteratoriterator1= employees.iterator();iterator1.hasNext();){ Employeeemployee=(Employee)iterator1.next(); System.out.print("FirstName:"+employee.getFirstName()); System.out.print("LastName:"+employee.getLastName()); System.out.println("Salary:"+employee.getSalary()); Listcertificates=employee.getCertificates(); for(Iteratoriterator2= certificates.iterator();iterator2.hasNext();){ CertificatecertName=(Certificate)iterator2.next(); System.out.println("Certificate:"+certName.getName()); } } tx.commit(); }catch(HibernateExceptione){ if(tx!=null)tx.rollback(); e.printStackTrace(); }finally{ session.close(); } } /*Methodtoupdatesalaryforanemployee*/ publicvoidupdateEmployee(IntegerEmployeeID,intsalary){ Sessionsession=factory.openSession(); Transactiontx=null; try{ tx=session.beginTransaction(); Employeeemployee= (Employee)session.get(Employee.class,EmployeeID); employee.setSalary(salary); session.update(employee); tx.commit(); }catch(HibernateExceptione){ if(tx!=null)tx.rollback(); e.printStackTrace(); }finally{ session.close(); } } /*Methodtodeleteanemployeefromtherecords*/ publicvoiddeleteEmployee(IntegerEmployeeID){ Sessionsession=factory.openSession(); Transactiontx=null; try{ tx=session.beginTransaction(); Employeeemployee= (Employee)session.get(Employee.class,EmployeeID); session.delete(employee); tx.commit(); }catch(HibernateExceptione){ 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"和执行程序,并比较结果。
$javaManageEmployee
.......VARIOUSLOGMESSAGESWILLDISPLAYHERE........ FirstName:ManojLastName:KumarSalary:4000 Certificate:MCA Certificate:MBA Certificate:PMP FirstName:DilipLastName:KumarSalary:3000 Certificate:BCA Certificate:BA FirstName:ManojLastName:KumarSalary:5000 Certificate:MCA Certificate:MBA Certificate:PMP
如果检查员工和证书表,就应该记录下了:
mysql>select*fromEMPLOYEE;
+----+------------+-----------+--------+ |id|first_name|last_name|salary| +----+------------+-----------+--------+ |51|Manoj|Kumar|5000| +----+------------+-----------+--------+ 1rowinset(0.00sec)
mysql>select*fromCERTIFICATE;
+----+------------------+------+-------------+ |id|certificate_name|idx|employee_id| +----+------------------+------+-------------+ |6|MCA|0|51| |7|MBA|1|51| |8|PMP|2|51| +----+------------------+------+-------------+ 3rowsinset(0.00sec)
或者,您也可以映射Java数组,而不是一个列表。一个数组的映射几乎是相同的前面的例子,除了与不同的元素和属性名称(<array>和<array-index>)。然而,原因如前所述,Hibernate应用程序很少使用数组。
Bag映射
Bag是一个java集合存储元素无需关心顺序,但允许列表中的重复元素。Bag是在列表中的对象的随机分组。
Collection集合被映射在该映射表中的<bag>元件和与java.util.ArrayList中初始化。
下面的示例中RDBMS表和POJO类依然使用上面定义好的。
定义Hibernate映射文件:
让我们开发指示Hibernate如何定义的类映射到数据库表的映射文件。<bag>元素将被用来定义所使用的集合规则。
<?xmlversion="1.0"encoding="utf-8"?> <!DOCTYPEhibernate-mappingPUBLIC "-//Hibernate/HibernateMappingDTD//EN" "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd"> <hibernate-mapping> <classname="Employee"table="EMPLOYEE"> <metaattribute="class-description"> Thisclasscontainstheemployeedetail. </meta> <idname="id"type="int"column="id"> <generatorclass="native"/> </id> <bagname="certificates"cascade="all"> <keycolumn="employee_id"/> <one-to-manyclass="Certificate"/> </bag> <propertyname="firstName"column="first_name"type="string"/> <propertyname="lastName"column="last_name"type="string"/> <propertyname="salary"column="salary"type="int"/> </class> <classname="Certificate"table="CERTIFICATE"> <metaattribute="class-description"> Thisclasscontainsthecertificaterecords. </meta> <idname="id"type="int"column="id"> <generatorclass="native"/> </id> <propertyname="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操作上的记录。
importjava.util.*; importorg.hibernate.HibernateException; importorg.hibernate.Session; importorg.hibernate.Transaction; importorg.hibernate.SessionFactory; importorg.hibernate.cfg.Configuration; publicclassManageEmployee{ privatestaticSessionFactoryfactory; publicstaticvoidmain(String[]args){ try{ factory=newConfiguration().configure().buildSessionFactory(); }catch(Throwableex){ System.err.println("FailedtocreatesessionFactoryobject."+ex); thrownewExceptionInInitializerError(ex); } ManageEmployeeME=newManageEmployee(); /*Letushaveasetofcertificatesforthefirstemployee*/ ArrayListset1=newArrayList(); set1.add(newCertificate("MCA")); set1.add(newCertificate("MBA")); set1.add(newCertificate("PMP")); /*Addemployeerecordsinthedatabase*/ IntegerempID1=ME.addEmployee("Manoj","Kumar",4000,set1); /*Anothersetofcertificatesforthesecondemployee*/ ArrayListset2=newArrayList(); set2.add(newCertificate("BCA")); set2.add(newCertificate("BA")); /*Addanotheremployeerecordinthedatabase*/ IntegerempID2=ME.addEmployee("Dilip","Kumar",3000,set2); /*Listdownalltheemployees*/ ME.listEmployees(); /*Updateemployee'ssalaryrecords*/ ME.updateEmployee(empID1,5000); /*Deleteanemployeefromthedatabase*/ ME.deleteEmployee(empID2); /*Listdownalltheemployees*/ ME.listEmployees(); } /*Methodtoaddanemployeerecordinthedatabase*/ publicIntegeraddEmployee(Stringfname,Stringlname, intsalary,ArrayListcert){ Sessionsession=factory.openSession(); Transactiontx=null; IntegeremployeeID=null; try{ tx=session.beginTransaction(); Employeeemployee=newEmployee(fname,lname,salary); employee.setCertificates(cert); employeeID=(Integer)session.save(employee); tx.commit(); }catch(HibernateExceptione){ if(tx!=null)tx.rollback(); e.printStackTrace(); }finally{ session.close(); } returnemployeeID; } /*Methodtolistalltheemployeesdetail*/ publicvoidlistEmployees(){ Sessionsession=factory.openSession(); Transactiontx=null; try{ tx=session.beginTransaction(); Listemployees=session.createQuery("FROMEmployee").list(); for(Iteratoriterator1= employees.iterator();iterator1.hasNext();){ Employeeemployee=(Employee)iterator1.next(); System.out.print("FirstName:"+employee.getFirstName()); System.out.print("LastName:"+employee.getLastName()); System.out.println("Salary:"+employee.getSalary()); Collectioncertificates=employee.getCertificates(); for(Iteratoriterator2= certificates.iterator();iterator2.hasNext();){ CertificatecertName=(Certificate)iterator2.next(); System.out.println("Certificate:"+certName.getName()); } } tx.commit(); }catch(HibernateExceptione){ if(tx!=null)tx.rollback(); e.printStackTrace(); }finally{ session.close(); } } /*Methodtoupdatesalaryforanemployee*/ publicvoidupdateEmployee(IntegerEmployeeID,intsalary){ Sessionsession=factory.openSession(); Transactiontx=null; try{ tx=session.beginTransaction(); Employeeemployee= (Employee)session.get(Employee.class,EmployeeID); employee.setSalary(salary); session.update(employee); tx.commit(); }catch(HibernateExceptione){ if(tx!=null)tx.rollback(); e.printStackTrace(); }finally{ session.close(); } } /*Methodtodeleteanemployeefromtherecords*/ publicvoiddeleteEmployee(IntegerEmployeeID){ Sessionsession=factory.openSession(); Transactiontx=null; try{ tx=session.beginTransaction(); Employeeemployee= (Employee)session.get(Employee.class,EmployeeID); session.delete(employee); tx.commit(); }catch(HibernateExceptione){ if(tx!=null)tx.rollback(); e.printStackTrace(); }finally{ session.close(); } } }
编译和执行:
会在屏幕上获得以下结果,并同时记录会在员工和证书表被创建。可以看到证书已排序顺序相反。可以通过改变映射文件试试,只需设置sort="natural"和执行程序,并比较结果。
$javaManageEmployee
.......VARIOUSLOGMESSAGESWILLDISPLAYHERE........ FirstName:ManojLastName:KumarSalary:4000 Certificate:MCA Certificate:MBA Certificate:PMP FirstName:DilipLastName:KumarSalary:3000 Certificate:BCA Certificate:BA FirstName:ManojLastName:KumarSalary:5000 Certificate:MCA Certificate:MBA Certificate:PMP
如果检查员工和证书表,就应该记录下了:
mysql>select*fromEMPLOYEE;
+----+------------+-----------+--------+ |id|first_name|last_name|salary| +----+------------+-----------+--------+ |53|Manoj|Kumar|5000| +----+------------+-----------+--------+ 1rowinset(0.00sec)
mysql>select*fromCERTIFICATE;
+----+------------------+-------------+ |id|certificate_name|employee_id| +----+------------------+-------------+ |11|MCA|53| |12|MBA|53| |13|PMP|53| +----+------------------+-------------+ 3rowsinset(0.00sec)