hibernate ...hbm.xml详解

在Hibernate中，各表的映射文件….hbm.xml可以通过工具生成，例如在使用MyEclipse开发时，它提供了自动生成映射文件的工具。配置文件的基本结构如下：

Xml代码

在Hibernate中，各表的映射文件….hbm.xml可以通过工具生成，例如在使用MyEclipse开发时，它提供了自动生成映射文件的工具。配置文件的基本结构如下：

Xml代码

1         <?xml version="1.0" encoding='UTF-8'?>  

2           

3         <!DOCTYPE hibernate-mapping PUBLIC  

4              "-//Hibernate/Hibernate Mapping DTD 3.0//EN"  

5              "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">  

6         <hibernate-mapping package="包名">  

7            <class name="类名" table="表名">  

8               <id name="主键在java类中的字段名" column="对应表中字段" type="类型 ">  

9                   <generator class="主键生成策略"/>  

10           </id>  

11       

12               ……  

13         </class>  

14     </hibernate-mapping>  

1. 主键（id）
Hibernate的主键生成策略有如下几种：
1) assigned
主键由外部程序负责生成，在 save() 之前指定。
2) hilo
通过hi/lo 算法实现的主键生成机制，需要额外的数据库表或字段提供高位值来源。
3) seqhilo
与hilo 类似，通过hi/lo 算法实现的主键生成机制，需要数据库中的 Sequence，适用于支持 Sequence 的数据库，如Oracle。
4) increment
主键按数值顺序递增。此方式的实现机制为在当前应用实例中维持一个变量，以保存着当前的最大值，之后每次需要生成主键的时候将此值加1作为主键。这种方式可能产生的问题是：不能在集群下使用。
5) identity
采用数据库提供的主键生成机制。如DB2、SQL Server、MySQL 中的主键生成机制。
6) sequence
采用数据库提供的 sequence 机制生成主键。如 Oralce 中的Sequence。
7) native
由 Hibernate 根据使用的数据库自行判断采用 identity、hilo、sequence 其中一种作为主键生成方式。
8) uuid.hex
由 Hibernate 基于128 位 UUID 算法 生成16 进制数值（编码后以长度32 的字符串表示）作为主键。
9) uuid.string
与uuid.hex 类似，只是生成的主键未进行编码（长度16），不能应用在 PostgreSQL 数据中。
10) foreign
使用另外一个相关联的对象的标识符作为主键。
主键配置举例如下：

Xml代码

15     <id name="id" column="id" type="java.lang.Integer">  

16                  <generator class="native"/>  

17     </id>  

另外还可以扩展Hibernate的类来做自己的主键生成策略，具体例子见：http://www.javaeye.com/topic/93391。
2. 普通属性（property）
       开发人员可以打开网址：http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd
来查看hibernate3.0的dtd信息，可看到property的定义如下：

Xml代码

18     <!ELEMENT property (meta*,(column|formula)*,type?)>  

19     <!ATTLIST property name CDATA #REQUIRED>  

20     <!ATTLIST property node CDATA #IMPLIED>  

21     <!ATTLIST property access CDATA #IMPLIED>  

22     <!ATTLIST property type CDATA #IMPLIED>  

23     <!ATTLIST property column CDATA #IMPLIED>  

24     <!ATTLIST property length CDATA #IMPLIED>  

25     <!ATTLIST property precision CDATA #IMPLIED>  

26     <!ATTLIST property scale CDATA #IMPLIED>  

27     <!ATTLIST property not-null (true|false) #IMPLIED>  

28     <!ATTLIST property unique (true|false) "false">  

29     <!ATTLIST property unique-key CDATA #IMPLIED>  

30     <!ATTLISTpropertyindexCDATA#IMPLIED>     

31     <!-- include the columns spanned by this property in an index -->  

32     <!ATTLIST property update (true|false) #IMPLIED>  

33     <!ATTLIST property insert (true|false) #IMPLIED>  

34     <!ATTLIST property optimistic-lock (true|false) "true">          

35     <!-- only supported for properties of a class (not component) -->  

36     <!ATTLIST property formula CDATA #IMPLIED>  

37     <!ATTLIST property lazy (true|false) "false">  

38     <!ATTLIST property generated (never|insert|always) "never">  

它的各属性中比较常用的有：name（对应的java类的属性名称）、column（对应的表中的字段）、type（属性的类型，eg.java.lang.String）、not-null（设置该属性是否为空，为true时表示非空，默认为false）和length(字段的长度限制)。 示例如下：

Xml代码

39     <property name="accessname" column="accessName" type="java.lang.String" not-null="true" />  

40     <property name="state" column="state" type="java.lang.Byte" not-null="true" />  

41     <property name="description" column="description" type="java.lang.String" /> 

3. 一对多关系（<many-to-one…/>和<set…></set>）

       一对多关系一般是用在一个表与另一个表存在外键关联的时候，例如用户表的组织id与组织表存在外键关联，则“一”方为组织表，“多”方为用户表，因为一个组织可以包含多个用户，而一个用户只能隶属于一个组织。

    对于存在一对多关系和多对一关系的双方，需要在…hbm.xml中进行相应配置，这时在“一”方（例如：组织）需要在映射文件中添加<set…></set>元素，因为它包含多个“多”方的对象，一般的格式如下：

Xml代码

42     <set name="java映射类中对应的属性" inverse="true" lazy="true">  

43       <key column="表中对应字段"/>  

44          <one-to-many class="多方的类"/>  

45     </set>  

46       

47     <!-- 示例 --> 

48     <set name="userSet" inverse="true" lazy="true">  

49           <key column="orgId"/>  

50           <one-to-many class="User"/>  

51     </set>  

“多”方（例如：用户）隶属于一个“一”方对象，一般的格式如下：

Xml代码

52     <many-to-one name="java映射类中对应的属性" column="表中对应字段" class="类名" not-null="true" />  

53       

54     <!-- 示例 --> 

55     <many-to-one name="org" column="orgId" class="Organization" not-null="true" />  

4. 一对一关系（<one-to-one…/>）

一对一关系相对一对多关系来说比较少见，但也在某些情况下要用到，例如有一个用户的基本信息表（USER）和一个用户的密码表（PASSWD）就存在一对一的关系。下面来看一下一对一关系在Hibernate的配置。

Xml代码

56     <!-- 其中主表（eg. 用户的基本信息表）的配置 --> 

57       

58     <one-to-one name="主表对象中子表对象的属性名" class="子表对象的类名" cascade="save-update"/>  

59       

60     <one-to-one name="password" class="com.amigo.dao.pojo.Passwd" cascade="save-update"/>  

61       

62     <!-- 子表（eg. 用户的密码表）的配置 --> 

63       

64     <one-to-one name="子表对象中主表对象的属性名" class="主表对象的类名" constrained="true" />  

65       

66     <one-to-one name="user" class="com.amigo.dao.pojo.User " constrained="true" />  

5. 多对多关系（<many-to-many…/>）

在数据库设计时，一般将多对多关系转换为两个一对多（或多对一）关系，例如在基于角色的权限系统中，用户和角色存在的关系就是典型的多对多关系，即一个用户可以具有多个角色，而一个角色又可以为多个用户所有，一般在设计时，都会加一个用户与角色的关联表，该表与用户表以及角色表都存在外键关联。

在本小节中讲述的是没有分解的多对多关系在Hibernate中如何配置。设置格式如下：

Xml代码

67     <set name="java对象的属性名" table="表名" cascade="all" outer-join="false">    

68         <key column="表的对应字段"/>    

69         <many-to-many class="另一个表的对象类" column="另一个表的字段"/>    

70     </set>    

71       

72     <!-- t_user方 --> 

73     <set name="roleSet" table="t_user" cascade="all" outer-join="false">    

74         <key column="roleId"/>    

75         <many-to-many class="com.amigo.dao.pojo.Role" column="roleId"/>    

76     </set>    

77       

78     <!-- t_role方 --> 

79     <set name="userSet" table="t_role" cascade="all" outer-join="false">    

80         <key column="roleId"/>    

81         <many-to-many class="com.amigo.dao.pojo.User" column="roleId"/>    

82     </set>

6. 完整实例

在本小节中举一些.hbm.xml映射文件的例子，让开发人员对其有一个感性的认识。接下来讲述一个用户表（tbl_user）、用户与角色关联表（tbl_user_role）、角色表（tbl_role）以及组织表（tbl_organization）的例子。

（1）tbl_user

Xml代码

1         <?xml version="1.0" encoding='UTF-8'?>  

2           

3         <!DOCTYPE hibernate-mapping PUBLIC  

4                   "-//Hibernate/Hibernate Mapping DTD 3.0//EN"  

5                "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">  

6           

7         <hibernate-mapping package="com.amigo.dao.pojo">  

8             <class name="User" table="tbl_user">  

9               <id name="loginname" column="loginName" type="java.lang.String">  

10               <generator class="assigned"/>  

11          </id>  

12          <property name="name" column="name" type="java.lang.String" not-null="true" />  

13          <property name="password" column="password" type="java.lang.String" not-null="true" />  

14          <property name="mobile" column="mobile" type="java.lang.String" />  

15          <property name="telephone" column="telephone" type="java.lang.String" />  

16          <property name="email" column="email" type="java.lang.String" />  

17          <property name="createtime" column="createTime" type="java.util.Date" not-null="true" />  

18          <property name="lastlogintime" column="lastLoginTime" type="java.util.Date" />  

19         <property name="logintimes" column="loginTimes" type="java.lang.Long" not-null="true" />  

20          <property name="state" column="state" type="java.lang.Byte" not-null="true" />  

21         <property name="description" column="description" type="java.lang.String" />  

22         <many-to-one name="organization" column="orgId" class="Organization" not-null="true" />  

23         <set name="userRoleSet" inverse="true" cascade="all-delete-orphan" lazy="true">  

24             <key column="loginName"/>  

25             <one-to-many class="UserRole"/>  

26         </set>  

27     </hibernate-mapping>  

（2）tbl_organization

Xml代码

28     <?xml version="1.0" encoding='UTF-8'?>  

29       

30     <!DOCTYPE hibernate-mapping PUBLIC  

31                  "-//Hibernate/Hibernate Mapping DTD 3.0//EN"  

32                      "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">  

33       

34     <hibernate-mapping package="com.amigo.dao.pojo">  

35        <class name="Organization" table="tbl_organization">  

36             <id name="orgid" column="orgId" type="java.lang.Long">  

37                <generator class="native"/>  

38             </id>  

39       

40             <property name="parentorgid" column="parentOrgId" type="java.lang.Long" not-null="true" />  

41             <property name="orgname" column="orgName" type="java.lang.String" not-null="true" />  

42             <property name="orgfullname" column="orgFullName" type="java.lang.String" />   

43             <property name="orglevel" column="orgLevel" type="java.lang.Integer" not-null="true" />  

44             <property name="state" column="state" type="java.lang.Byte" not-null="true" />  

45             <property name="description" column="description" type="java.lang.String" />  

46             <property name="creator" column="creator" type="java.lang.String" />  

47             <property name="createtime" column="createTime" type="java.util.Date" />  

48             <set name="userSet" inverse="true" lazy="true">  

49                 <key column="orgId"/>  

50                 <one-to-many class="User"/>  

51             </set>  

52         </class>  

53     </hibernate-mapping>  

（3）tbl_user_role

 

1         １、到底在哪用cascade="..."？  

2            cascade属性并不是多对多关系一定要用的，有了它只是让我们在插入或删除对像时更方便一些，只要在cascade的源头上插入或是删除，所有 cascade的关系就会被自己动的插入或是删除。便是为了能正确的cascade，unsaved-value是个很重要的属性。Hibernate通 过这个属性来判断一个对象应该save还是update，如果这个对象的id是unsaved-value的话，那说明这个对象不是 persistence    object要save（insert)；如果id是非unsaved-value的话，那说明这个对象是persistence    object（数据库中已存在），只要update就行了。saveOrUpdate方法用的也是这个机制。     

3               

4            ２、到底在哪用inverse="ture"?    

5             “set的inverse属性决定是否把对set的改动反映到数据库中去。inverse=false————反映；inverse=true————不反映”inverse属性默认为false 

6               

7            inverse属性默认是false的，就是说关系的两端都来维护关系。这个意思就是说，如有一个Student,    Teacher和TeacherStudent表，Student和Teacher是多对多对多关系，这个关系由TeacherStudent这个表来表 现。那么什么时候插入或删除TeacherStudent表中的记录来维护关系呢？在用hibernate时，我们不会显示的对 TeacherStudent表做操作。对TeacherStudent的操作是hibernate帮我们做的。hibernate就是看hbm文件中指 定的是"谁"维护关系，那个在插入或删除"谁"时，就会处发对关系表的操作。前提是"谁"这个对象已经知道这个关系了，就是说关系另一头的对象已经set 或是add到"谁"这个对象里来了。前面说过inverse默认是false，就是关系的两端都维护关系，对其中任一个操作都会处发对表系表的操作。当在 关系的一头，如Student中的bag或set中用了inverse＝"true"时，那就代表关系是由另一关维护的（Teacher）。就是说当这插 入Student时，不会操作TeacherStudent表，即使Student已经知道了关系。只有当Teacher插入或删除时才会处发对关系表的 操作。所以，当关系的两头都用inverse="true"是不对的，就会导致任何操作都不处发对关系表的操作。当两端都是inverse="false"或是default值是，在代码对关系显示的维护也是不对的，会导致在关系表中插入两次关系。    

8               

9            在一对多关系中inverse就更有意义了。在多对多中，在哪端inverse="true"效果差不多（在效率上）。但是在一对多中，如果要一方维护关 系，就会使在插入或是删除"一"方时去update"多"方的每一个与这个"一"的对象有关系的对象。而如果让"多"方面维护关系时就不会有update 操作，因为关系就是在多方的对象中的，直指插入或是删除多方对象就行了。当然这时也要遍历"多"方的每一个对象显示的操作修关系的变化体现到DB中。不管 怎样说，还是让"多"方维护关系更直观一些。  

10       

11          （1）对one-to-many而言，改变set，会让hibernate执行一系列的update语句， 不会delete/insert数据  

12          （2）对many-to-many而言，改变set,只修改关系表的数据，不会影响many-to-many的另一方。  

13          （3）虽然one-to-many和many-to-many的数据库操作不一样，但目的都是一个：维护数据的一致性。    

14           

15        ３、cascade和inverse有什么区别？    

16        可以这样理解，cascade定义的是关系两端对象到对象的级联关系；而inverse定义的是关系和对象的级联关系。  

17        inverse只对set+one-to-many(或many-to-many)有效，对many-to-one, one-to-one无效。cascade对关系标记都有效。  

18       

19        inverse对集合对象整体起作用，cascade对集合对象中的一个一个元素起作用，如果集合为空，那么cascade不会引发关联操作。  

20        比如将集合对象置为null， school.setStudentSet(null)  

21         inverse导致hibernate执行:udpate STUDENT set SCHOOL_ID=null where SCHOOL_ID=?  

22         cascade则不会执行对STUDENT表的关联更新， 因为集合中没有元素。  

23        再比新增一个school, session.save(school)  

24         inverse导致hibernate执行：  

25         for( 对(school的每一个student ){  

26           udpate STUDENT set SCHOOL_ID=? where STUDENT_ID=?//将学生的school_id改为新的school的id 

27          }  

28         cascade导致hibernate执行：  

29         for( 对school的每一个student ){  

30           session.save(aStudent);//对学生执行save操作 

31          }  

32       extends:如果改变集合中的部分元素（比如新增一个元素），  

33         inverse: hibernate先判断哪些元素改变了，对改变的元素执行相应的sql  

34         cascade: 它总是对集合中的每个元素执行关联操作。  

35          （在关联操作中，hibernate会判断操作的对象是否改变）  

36        两个起作用的时机不同：  

37         cascade：在对主控方操作时，级联发生。  

38         inverse: 在flush时（commit会自动执行flush)，对session中的所有set，hibernate判断每个set是否有变化，  

39         对有变化的set执行相应的sql，执行之前，会有个判断：if( inverse ==true )return;可以看出cascade在先，inverse在后。  

40         inverse 对set + one-to-many 和 set + many-to-many 起的作用不同。hibernate生成的sql不同。  

41            对one-to-many，hibernate对many方的数据库表执行update语句。  

42            对many-to-many, hibernate对关系表执行insert/update/delte语句，注意不是对many方的数据库表而是关系表。  

43          cascase 对set都是一致的，不管one-to-many还是many-to-many。都简单地把操作传递到set中的每个元素。所以它总是更新many方的数据库表。  

44       

45       4、cascade和inverse有什么相同？  

46        这两个属性本身互不影响，但起的作用有些类似，都能引发对关系表的更新。  

47       

48       5、 建议：只对set + many-to-many设置inverse=false，其他的标记不考虑inverse属性，都设为inverse=true。对cascade，一 般对many-to-one，many-to-many，constrained=true的one-to-one 不设置级联删除。