Hibernate - 对象关系映射文件(*.hbm.xml)详解

对象关系映射文件，即POJO 类和数据库的映射文件*.hbm.xml(映射文件的扩展名为 .hbm.xml)。

POJO 类和关系数据库之间的映射可以用一个XML文档来定义。

通过 POJO 类的数据库映射文件，Hibernate可以理解持久化类和数据表之间的对应关系，也可以理解持久化类属性与数据库表列之间的对应关系。

在运行时 Hibernate 将根据这个映射文件来生成各种 SQL 语句。

常见结构如下：

hibernate-mapping
	-类层次：class
		--主键：id
		--基本类型:property
		--实体引用类: many-to-one  |  one-to-one
		--集合:set | list | map | array
			---one-to-many
			---many-to-many
		--子类:subclass | joined-subclass
		--其它:component | any 等	
	-查询语句:query（用来放置查询语句，便于对数据库查询的统一管理和优化）

每个Hibernate-mapping中可以同时定义多个类. 但更推荐为每个类都创建一个单独的映射文件。

【1】 hibernate-mapping节点

hibernate-mapping节点属性如下：
在这里插入图片描述

hibernate-mapping 是 hibernate 映射文件的根元素。

schema: 指定所映射的数据库schema的名称。若指定该属性, 则表明会自动添加该 schema 前缀。
catalog:指定所映射的数据库catalog的名称。
default-cascade(默认为 none): 设置hibernate默认的级联风格. 若配置 Java 属性, 集合映射时没有指定 cascade 属性, 则 Hibernate 将采用此处指定的级联风格。
default-access (默认为 property): 指定 Hibernate 的默认的属性访问策略。默认值为 property, 即使用 getter, setter 方法来访问属性。若指定 access, 则 Hibernate 会忽略 getter/setter 方法, 而通过反射访问成员变量。
default-lazy(默认为 true): 设置 Hibernat morning的延迟加载策略. 该属性的默认值为 true, 即启用延迟加载策略. 若配置 Java 属性映射, 集合映射时没有指定 lazy 属性, 则 Hibernate 将采用此处指定的延迟加载策略。
auto-import (默认为 true): 指定是否可以在查询语言中使用非全限定的类名（仅限于本映射文件中的类）。
package (可选): 指定一个包前缀，如果在映射文档中没有指定全限定的类名，就使用这个作为包名。

【2】 class节点

class节点属性如下：

在这里插入图片描述

class 元素用于指定类和表的映射

name:指定该持久化类映射的持久化类的类名。
table:指定该持久化类映射的表名, Hibernate 默认以持久化类的类名作为表名。
dynamic-insert: 若设置为 true, 表示当保存一个对象时, 会动态生成 insert 语句, insert 语句中仅包含所有取值不为 null 的字段. 默认值为 false。
dynamic-update: 若设置为 true, 表示当更新一个对象时, 会动态生成 update 语句, update 语句中仅包含所有取值需要更新的字段。默认值为 false。
select-before-update:设置 Hibernate 在更新某个持久化对象之前是否需要先执行一次查询，默认值为 false。
batch-size:指定根据 OID 来抓取实例时每批抓取的实例数。
lazy: 指定是否使用延迟加载，默认为true。
mutable: 若设置为 true, 等价于所有的 <property> 元素的 update 属性为 false, 表示整个实例不能被更新。默认为 true。
discriminator-value: 指定区分不同子类的值。当使用<subclass/>元素来定义持久化类的继承关系时需要使用该属性。

【3】映射对象标识符

Hibernate 使用对象标识符(OID) 来建立内存中的对象和数据库表中记录的对应关系。对象的 OID 和数据表的主键对应。 Hibernate 通过标识符生成器来为主键赋值。

Hibernate 推荐在数据表中使用代理主键, 即不具备业务含义的字段。代理主键通常为整数类型, 因为整数类型比字符串类型要节省更多的数据库空间。

在对象-关系映射文件中,<id>元素用来设置对象标识符. <generator>子元素用来设定标识符生成器。

① id节点设定持久化类的 OID 和表的主键的映射

name: 标识持久化类 OID 的属性名。
column: 设置标识属性所映射的数据表的列名(主键字段的名字)。
unsaved-value:若设定了该属性, Hibernate 会通过比较持久化类的 OID 值和该属性值来区分当前持久化类的对象是否为临时对象。
type:指定 Hibernate 映射类型。

Hibernate 映射类型是 Java 类型与 SQL 类型的桥梁. 如果没有为某个属性显式设定映射类型, Hibernate 会运用反射机制先识别出持久化类的特定属性的 Java 类型, 然后自动使用与之对应的默认的 Hibernate 映射类型。
Java 的基本数据类型和包装类型对应相同的 Hibernate 映射类型. 基本数据类型无法表达 null, 所以对于持久化类的 OID 推荐使用包装类型。

② generator节点设定持久化类标识符生成器

class: 指定使用的标识符生成器全限定类名或其缩写名

Hibernate 提供了标识符生成器接口: IdentifierGenerator, 并提供了各种内置实现。

③ 几种常见的Hibernate 主键生成策略

标识符生成器	描述
increment	适用于代理主键。由Hibernate自动以递增方式生成。用于为long, short或者int类型生成唯一标识。只有在没有其他进程往同一张表中插进数据时才能使用。在集群下不要使用。
identity	适用于代理主键。由底层数据库生成标识符。对DB2,MySQL, MS SQL Server, Sybase和HypersonicSQL的内置标识字段提供支持。返回的标识符是long, short 或者int类型的。
sequence	适用于代理主键。Hibernate根据底层数据库的序列生成标识符，这要求底层数据库支持序列。在DB2,PostgreSQL, Oracle, SAP DB, McKoi中使用序列（sequence)，而在Interbase中使用天生器(generator)。返回的标识符是long, short或者 int类型的。
hilo	适用于代理主键。Hibernate分局high/low算法生成标识符。使用一个高/低位算法来高效的生成long, short或者 int类型的标识符。给定一个表和字段（默认分别是是hibernate_unique_key 和next_hi）作为高位值得来源。高/低位算法天生的标识符只在一个特定的数据库中是唯一的。在使用JTA获得的连接或者用户自行提供的连接中，不要使用这种。
seqhilo	适用于代理主键。适用于代理主键。使用一个高/低位算法来高效的生成long, short或者 int类型的标识符。
native	适用于代理主键。根据底层数据库对自动生成标识符的方式，自动选择identity、sequence或hilo中的一个。
uuid.hex	适用于代理主键。Hibernate采用128位的UUID算法生成字符串类型的标识符。在一个网络中唯一（使用了IP地址）。UUID被编码为一个32位16进制数字的字符串。
uuid.string	适用于代理主键。UUID被编码成一个16字符长的字符串。使用了与上面一样的UUID算法。UUID被编码为一个16个字符长的任意ASCII字符组成的字符串。不能使用在PostgreSQL数据库中。
assigned	适用于自然主键。由Java应用程序负责生成标识符。让应用程序在save()之前为对象分配一个标示符。
foreign	适用于代理主键。使用另外一个相关联的对象的标识符。
select	hibernate3中新增的。需要提供一个唯一的标识字段进行二次读取，以获取触发器天生的主键值，通过param子元素进行定义。该方法主要针对遗留系统的改造工程，一些早期的系统主键依靠于触发器天生。当数据库insert时，触发器捕捉这一操纵，并为主键赋值，在插进数据库后，再次读取某一识别字段读取已经插进的数据，获取其主键值。

复合主键映射：

< composite-id >
< key-property ? column = "USERID" ? name = "userid" ? type = "java.lang.String" ></ key-property >
< key-property ? column = "WHEN" ? name = "when" ? type = "java.sql.Date" ></ key-property >
</ composite-id >

复合主键的POJO类需要实现equals和hashcode方法，可以使用apache commons lang包中的工具类实现（commons-lang.jar）。

④ increment 标识符生成器

increment 标识符生成器由 Hibernate 以递增的方式为代理主键赋值。

Hibernate 会先读取 NEWS 表中的主键的最大值, 而接下来向 NEWS 表中插入记录时, 就在 max(id) 的基础上递增, 增量为 1.

适用范围:

由于 increment 生存标识符机制不依赖于底层数据库系统, 因此它适合所有的数据库系统；
适用于只有单个 Hibernate 应用进程访问同一个数据库的场合, 在集群环境下不推荐使用它；
OID 必须为 long, int 或 short 类型, 如果把 OID 定义为 byte 类型, 在运行时会抛出异常。

⑤ identity 标识符生成器

identity 标识符生成器由底层数据库来负责生成标识符, 它要求底层数据库把主键定义为自动增长字段类型。

适用范围：

由于 identity 生成标识符的机制依赖于底层数据库系统, 因此, 要求底层数据库系统必须支持自动增长字段类型. 支持自动增长字段类型的数据库包括: DB2, Mysql, MSSQLServer, Sybase 等
OID 必须为 long, int 或 short 类型, 如果把 OID 定义为 byte 类型, 在运行时会抛出异常

⑥ sequence 标识符生成器

sequence 标识符生成器利用底层数据库提供的序列来生成标识符。

<id name="id">
	<generator class="sequence" />
		<param name="sequence">news_seq</param>
	</generator >
</id>

Hibernate 在持久化一个 News 对象时, 先从底层数据库的 news_seq 序列中获得一个唯一的标识号, 再把它作为主键值。
适用范围:

由于 sequence 生成标识符的机制依赖于底层数据库系统的序列, 因此, 要求底层数据库系统必须支持序列。支持序列的数据库包括: DB2, Oracle 等
OID 必须为 long, int 或 short 类型, 如果把 OID 定义为 byte 类型, 在运行时会抛出异常

⑦ hilo 标识符生成器

hilo 标识符生成器由 Hibernate 按照一种 high/low 算法*生成标识符, 它从数据库的特定表的字段中获取 high 值.

 <id name="id">
	<generator class="hilo" />
			<param name="table">HI_TABLE</param>
			<param name="column">NEXT_VALUE</param>
			<param name="max_lo">10</param>
	</generator >
</id>

Hibernate 在持久化一个 News 对象时, 由 Hibernate 负责生成主键值. hilo 标识符生成器在生成标识符时, 需要读取并修改 HI_TABLE 表中的 NEXT_VALUE 值。

适用范围:

由于 hilo 生存标识符机制不依赖于底层数据库系统, 因此它适合所有的数据库系统;
OID 必须为 long, int 或 short 类型, 如果把 OID 定义为 byte 类型, 在运行时会抛出异常。

hilo 和 seqhilo生成器给出了两种hi/lo算法的实现。
第一种情况：

<id name="id" type="id" column="id">
	<generator class="hilo">
		<param name="table">zhxy_hilo_tbl</param>
		<param name="column">next_value</param>
		<param name="max_lo">100</param>
	</generator>
</id>

第二种情况：

<id name="id" type="long" column="cat_id">
	<generator class="seqhilo">
		<param name="sequence">hi_value</param>
		<param name="max_lo">100</param>
	</generator>
</id>

第二种情况需要sequence的支持，这里只讨论更通用的第一种情况。

默认请况下使用的表是hibernate_unique_key，默认字段叫作next_hi。next_hi必须有一条记录否则会出现错误。

几个简写解释：

hi：高值-从数据库取得的那个值
lo：低值-hibernate自动维护，取值1到max_low
max_low:映射文件中配置的那个值。

那hibernate怎样生成主键呢？

1.从数据库中取得hi值，数据库的next_value值加1；

2.hibernate取得lo值（0到max_lo-1循环，lo到max_lo时，执行步骤1，然后lo继续从0到max_lo-1循环）

根据下面的公式计算值：hi*(max_lo+1)+lo;
例如hi初始为2，max_lo为3。生成的值依次是：
读取hi为2，写到数据库为3；
2*(3+1)+0=8；2*(3+1)+1=9；2*(3+1)+2=10；2*(3+1)+3=11；
这有次读写表zhxy_hilo_tbl操作，hi变为3，数据库成为4；
3*(3+1)+0=12；3*(3+1)+1=13；
关闭数据库，下次打开时，读取hi值为4，数据库变为5；4*(3+1)+0=16；
但是有一种特殊情况，就是hi是0的时候，那么第一个值不是0*(max_lo+1)+0=0；而是跳过0，直接就是1 。

⑧ native标识符生成器

native 标识符生成器依据底层数据库对自动生成标识符的支持能力, 来选择使用 identity, sequence 或 hilo 标识符生成器。

适用范围:

由于 native 能根据底层数据库系统的类型, 自动选择合适的标识符生成器, 因此很适合于跨数据库平台开发；
OID 必须为 long, int 或 short 类型, 如果把 OID 定义为 byte 类型, 在运行时会抛出异常。

【4】property节点

property 元素用于指定类的属性和表的字段的映射。

name:指定该持久化类的属性的名字；
column:指定与类的属性映射的表的字段名. 如果没有设置该属性, Hibernate 将直接使用类的属性名作为字段名；
type:指定 Hibernate 映射类型。

Hibernate 映射类型是 Java 类型与 SQL 类型的桥梁. 如果没有为某个属性显式设定映射类型, Hibernate 会运用反射机制先识别出持久化类的特定属性的 Java 类型, 然后自动使用与之对应的默认的 Hibernate 映射类型.
not-null:若该属性值为 true, 表明不允许为 null, 默认为 false
access:指定 Hibernate 的默认的属性访问策略。默认值为 property, 即使用 getter, setter 方法来访问属性. 若指定 field, 则 Hibernate 会忽略getter/setter方法, 而通过反射访问成员变量
unique: 设置是否为该属性所映射的数据列添加唯一约束.
index: 指定一个字符串的索引名称. 当系统需要 Hibernate 自动建表时, 用于为该属性所映射的数据列创建索引, 从而加快该数据列的查询.
length: 指定该属性所映射数据列的字段的长度
scale: 指定该属性所映射数据列的小数位数, 对 double, float, decimal 等类型的数据列有效.
formula：设置一个 SQL 表达式, Hibernate 将根据它来计算出派生属性的值.
派生属性: 并不是持久化类的所有属性都直接和表的字段匹配, 持久化类的有些属性的值必须在运行时通过计算才能得出来, 这种属性称为派生属性。

使用 formula 属性时

formula=“(sql)” 的英文括号不能少；
Sql 表达式中的列名和表名都应该和数据库对应, 而不是和持久化对象的属性对应；
如果需要在 formula 属性中使用参数, 这直接使用 where cur.id=id 形式, 其中 id 就是参数, 和当前持久化对象的 id 属性对应的列的 id 值将作为参数传入。