hibernate.hbm.xml文件配置入门小结（1）

在Hibernate中，各表的映射文件xxx.hbm.xml可以通过工具生成，例如在使用MyEclipse开发时，它提供了自动生成映射文件的工具。

hibernate.hbm.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代码

<span style="white-space:pre">	</span><id name="id" column="id" type="java.lang.Integer">
<generator class="native"/>
</id>

另外还可以扩展Hibernate的类来做自己的主键生成策略，具体例子见：http://www.javaeye.com/topic/93391。

2. 普通属性（property）

       开发人员可以打开网址：http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd

来查看hibernate3.0的dtd信息，可看到property的定义如下：

Xml代码         

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

2        <!ATTLIST property nameCDATA #REQUIRED>  

3        <!ATTLIST property nodeCDATA #IMPLIED>  

4        <!ATTLIST property accessCDATA #IMPLIED>  

5        <!ATTLIST property typeCDATA #IMPLIED>  

6        <!ATTLIST property columnCDATA #IMPLIED>  

7        <!ATTLIST property lengthCDATA #IMPLIED>  

8        <!ATTLIST property precisionCDATA #IMPLIED>  

9        <!ATTLIST property scaleCDATA #IMPLIED>  

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

…………

它的各属性中比较常用的有：

name（对应的java类的属性名称）

column（对应的表中的字段）

type（属性的类型，eg.java.lang.String）

not-null（设置该属性是否为空，为true时表示非空，默认为false）

length(字段的长度限制)。 

示例如下：

Xml代码

1	<property name="accessname" column="accessName" type="java.lang.String" not-null="true" />
<!--类属性名/对应一张表——表中字段——该字段属性类型——该字段是否为空-->
2	<property name="state" column="state" type="java.lang.Byte" not-null="true" />
3	<property name="description" column="description" type="java.lang.String" />

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

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

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

Xml代码       

2	<set name="java映射类中对应的属性" inverse="true" lazy="true">
3	  <key column="表中对应字段"/>
4	     <one-to-many class="多方的类"/>
5	</set>
6
7	<!-- 示例 -->
8	<set name="userSet" inverse="true" lazy="true">
9	      <key column="orgId"/>
10	      <one-to-many class="User"/>
11	</set>

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

xml代码

2	<many-to-one name="java映射类中对应的属性" column="表中对应字段" class="类名" not-null="true" />
3
4	<!-- 示例 -->
5	<many-to-one name="org" colum
4000
n="orgId" class="Organization" not-null="true" />

注：

1>set 元素

      (1).name: 映射类属性的名字

      (2).table: 关联的目标数据库表

      (3).schema: 目标数据库表的schema名字

      (4).catalog: 目标数据库表的catalog名字

      (5).subselect: 定义一个子查询

      (6).sort: 设置排序的类型 默认值为 unsorted不排序 可选值为natural自然排序、comparatorClass实现接口类作为排序算法 避免与order-by同时使用

      (7).lazy: 是否采用延迟加载

      (8).inverse: 用于标识双向关联中被动的一方 默认值为false

      (9).cascade: 设置级联操作时的级联类型

      (10).mutable: 标识被关联对象是否可以改变 默认值为true

      (11).order-by: 设置排序规则

      (12).where: 增加筛选条件

      (13).batch-size: 延迟加载时，一次读取数据的数量 默认值为1

      (14).fetch: 设置抓取数据的策略 可选值为 join外连接抓取、select序列选择抓取

   2>list 元素（略）

   3>map 元素

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

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

Xml代码

1	<!-- 其中主表（eg. 用户的基本信息表）的配置 -->
2
3	<one-to-one name="主表对象中子表对象的属性名" class="子表对象的类名" cascade="save-update"/>
4
5	<one-to-one name="password" class="com.amigo.dao.pojo.Passwd" cascade="save-update"/>
6
7	<!-- 子表（eg. 用户的密码表）的配置 -->
8
9	<one-to-one name="子表对象中主表对象的属性名" class="主表对象的类名" constrained="true" />
10
11	<one-to-one name="user" class="com.amigo.dao.pojo.User " constrained="true" />

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

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

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

Xml代码

1	<set name="java对象的属性名" table="表名" cascade="all" outer-join="false">
2	    <key column="表的对应字段"/>
3	    <many-to-many class="另一个表的对象类" column="另一个表的字段"/>
4	</set>
5
6	<!-- t_user方 -->
7	<set name="roleSet" table="t_user" cascade="all" outer-join="false">
8	    <key column="roleId"/>
9	    <many-to-many class="com.amigo.dao.pojo.Role" column="roleId"/>
10	</set>
11
12	<!-- t_role方 -->
13	<set name="userSet" table="t_role" cascade="all" outer-join="false">
14	    <key column="roleId"/>
15	    <many-to-many class="com.amigo.dao.pojo.User" column="roleId"/>
16	</set>

6. 完整实例

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

（1）用户表（tbl_user）——tbl_user.hbm.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">   <!--一一个用户表有多个用户--> </span>
24	        <key column="loginName"/>
25	        <one-to-many class="UserRole"/>
26	    </set>
27	</hibernate-mapping>

（2）用户与角色关联表（tbl_user_role）——tbl_organization.hbm.xml

<?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>

（3）角色表（tbl_role）——tbl_user_role.hbm.xml

<pre name="code" class="html"><span style="font-family: Arial, Helvetica, sans-serif;">1	<?xml version="1.0" encoding='UTF-8'?>   </span>
2	<!DOCTYPE hibernate-mapping PUBLIC
3	                            "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
4	                            "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd" >
5	<hibernate-mapping package="com.cotel.netvote.dao.model">
<!--表名——主键-->
6	    <class name="UserRole" table="tbl_user_role">
7	        <id name="urid" column="urId" type="java.lang.Integer">
8	            <generator class="native"/>
9	        </id>
<!--表间关系，多个角色身份对应一个用户-->
10	        <many-to-one name="role" column="roleId" class="Role" not-null="true" />
11	        <many-to-one name="user" column="loginName" class="User" not-null="true" />
12	    </class>
13	</hibernate-mapping>

（4）组织表（tbl_organization）——tbl_ role.hbm.xml 

<?xml version="1.0" encoding='UTF-8'?>
2	<!DOCTYPE hibernate-mapping PUBLIC
3	                            "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
4	                            "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd" >
5	<hibernate-mapping package="com.cotel.netvote.dao.model">
6	 	 <!--表名Role，主键roleid-->
<class name="Role" table="tbl_role">
7	        <id name="roleid" column="roleId" type="java.lang.Integer">
8	            <generator class="native"/>
9	        </id>
<!--普通属性-->
10	        <property name="rolename" column="roleName" type="java.lang.String" not-null="true" />
11	        <property name="createdate" column="createDate" type="java.util.Date" not-null="true" />
12	        <property name="description" column="description" type="java.lang.String" />
<!--一个组织对应多个用户-->
13	        <set name="userRoleSet" inverse="true" lazy="true" cascade="all">
14	            <key column="roleId"/>
15	            <one-to-many class="UserRole"/>
16	        </set>
17	    </class>
18	</hibernate-mapping>
19