第 5 章对象/关系数据库映射基础（Basic O/R Mapping）


<?xml version="1.0"?>

<!DOCTYPE hibernate-mapping PUBLIC

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

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



<hibernate-mapping package="eg">



        <class name="Cat"

            table="cats"

            discriminator-value="C">



                <id name="id">

                        <generator class="native"/>

                </id>



                <discriminator column="subclass"

                     type="character"/>



                <property name="weight"/>



                <property name="birthdate"

                    type="date"

                    not-null="true"

                    update="false"/>



                <property name="color"

                    type="eg.types.ColorUserType"

                    not-null="true"

                    update="false"/>



                <property name="sex"

                    not-null="true"

                    update="false"/>



                <property name="litterId"

                    column="litterId"

                    update="false"/>



                <many-to-one name="mother"

                    column="mother_id"

                    update="false"/>



                <set name="kittens"

                    inverse="true"

                    order-by="litter_id">

                        <key column="mother_id"/>

                        <one-to-many class="Cat"/>

                </set>



                <subclass name="DomesticCat"

                    discriminator-value="D">



                        <property name="name"

                            type="string"/>



                </subclass>



        </class>



        <class name="Dog">

                <!-- mapping for Dog could go here -->

        </class>



</hibernate-mapping

>

我们现在开始讨论映射文档的内容。我们只描述 Hibernate 在运行时用到的文档元素和属性。映射文档还包括一些额外的可选属性和元素，它们在使用 schema 导出工具的时候会影响导出的数据库 schema 结果（比如，not-null 属性）。

5.1.1. Doctype

所有的 XML 映射都需要定义如上所示的 doctype。DTD 可以从上述 URL 中获取，也可以从 hibernate-x.x.x/src/org/hibernate 目录中、或 hibernate.jar 文件中找到。Hibernate 总是会首先在它的 classptah 中搜索 DTD 文件。如果你发现它是通过连接 Internet 查找 DTD 文件，就对照你的 classpath 目录检查 XML 文件里的 DTD 声明。

5.1.1.1. EntityResolver

Hibernate 首先试图在其 classpath 中解析 DTD。这是依靠在系统中注册的 org.xml.sax.EntityResolver 的一个具体实现，SAXReader 依靠它来读取 xml 文件。这个自定义的 EntityResolver 能辨认两种不同的 systenId 命名空间：

若 resolver 遇到了一个以 http://hibernate.sourceforge.net/ 为开头的 systemId，它会辨认出是 hibernate namespace，resolver 就试图通过加载 Hibernate 类的 classloader 来查找这些实体。
若 resolver 遇到了一个使用 classpath:// URL 协议的 systemId，它会辨认出这是 user namespace，resolver 试图通过（1) 当前线程上下文的 classloader 和（2) 加载 Hibernate class 的 classloader 来查找这些实体。

下面是一个使用用户命名空间（user namespace）的例子：


<?xml version="1.0"?>

<!DOCTYPE hibernate-mapping PUBLIC '-//Hibernate/Hibernate Mapping DTD 3.0//EN' 'http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd' [

<!ENTITY version "3.5.6-Final">

<!ENTITY today "September 15, 2010">



    <!ENTITY types SYSTEM "classpath://your/domain/types.xml">





]>





<hibernate-mapping package="your.domain">

    <class name="MyEntity">

        <id name="id" type="my-custom-id-type">

            ...

        </id>

    <class>

    &types;

</hibernate-mapping>

这里的 types.xml 是 your.domain 包中的一个资源，它包含了一个自定义的 typedef。

5.1.2. Hibernate-mapping

这个元素包括一些可选的属性。schema 和 catalog 属性，指明了这个映射所连接（refer）的表所在的 schema 和/或 catalog 名称。假若指定了这个属性，表名会加上所指定的 schema 和 catalog 的名字扩展为全限定名。假若没有指定，表名就不会使用全限定名。default-cascade 指定了未明确注明 cascade 属性的 Java 属性和集合类 Hibernate 会采取什么样的默认级联风格。auto-import 属性默认让我们在查询语言中可以使用非全限定名的类名。

<hibernate-mapping
         schema="schemaName"
         catalog="catalogName"
         default-cascade="cascade_style"
         default-access="field|property|ClassName"
         default-lazy="true|false"
         auto-import="true|false"
         package="package.name"
 />

	`schema`（可选）：数据库 schema 的名称。
	`catalog`（可选）：数据库 catalog 的名称。
	`default-cascade`（可选 — 默认为 `none`）：默认的级联风格。
	`default-access`（可选 — 默认为 `property`）：Hibernate 用来访问所有属性的策略。可以通过实现 `PropertyAccessor` 接口自定义。
	`default-lazy`（可选 — 默认为 `true`）：指定了未明确注明 `lazy` 属性的 Java 属性和集合类，Hibernate 会采取什么样的默认加载风格。
	`auto-import`（可选 — 默认为 `true`）：指定我们是否可以在查询语言中使用非全限定的类名（仅限于本映射文件中的类）。
	`package`（可选）：指定一个包前缀，如果在映射文档中没有指定全限定的类名，就使用这个作为包名。

假若你有两个持久化类，它们的非全限定名是一样的（就是两个类的名字一样，所在的包不一样 — 译者注），你应该设置 auto-import="false"。如果你把一个“导入过”的名字同时对应两个类，Hibernate 会抛出一个异常。

注意 hibernate-mapping 元素允许你嵌套多个如上所示的 <class> 映射。但是最好的做法（也许一些工具需要的）是一个持久化类（或一个类的继承层次）对应一个映射文件，并以持久化的超类名称命名，例如：Cat.hbm.xml、Dog.hbm.xml，或者如果使用继承，Animal.hbm.xml。

5.1.3. 类

你可以使用 class 元素来定义一个持久化类。例如：

<class
        name="ClassName"
        table="tableName"
        discriminator-value="discriminator_value"
        mutable="true|false"
        schema="owner"
        catalog="catalog"
        proxy="ProxyInterface"
        dynamic-update="true|false"
        dynamic-insert="true|false"
        select-before-update="true|false"
        polymorphism="implicit|explicit"
        where="arbitrary sql where condition"
        persister="PersisterClass"
        batch-size="N"
        optimistic-lock="none|version|dirty|all"
        lazy="(16)true|false"
        entity(17)-name="EntityName"
        check=(18)"arbitrary sql check condition"
        rowid=(19)"rowid"
        subsel(20)ect="SQL expression"
        abstra(21)ct="true|false"
        node="element-name"
/>

	`name`（可选）：持久化类（或者接口）的 Java 全限定名。如果这个属性不存在，Hibernate 将假定这是一个非 POJO 的实体映射。
	`table`（可选 — 默认是类的非全限定名）：对应的数据库表名。
	`discriminator-value`（可选 — 默认和类名一样）：一个用于区分不同的子类的值，在多态行为时使用。它可以接受的值包括 `null` 和 `not null`。
	`mutable`（可选，默认值为 `true`）：表明该类的实例是可变的或者不可变的。
	`schema`（可选）：覆盖在根 `<hibernate-mapping>` 元素中指定的 schema 名字。
	`catalog`（可选）：覆盖在根 `<hibernate-mapping>` 元素中指定的 catalog 名字。
	`proxy`（可选）：指定一个接口，在延迟装载时作为代理使用。你可以在这里使用该类自己的名字。
	`dynamic-update`（可选，默认为 `false`）：指定用于 `UPDATE` 的 SQL 将会在运行时动态生成，并且只更新那些改变过的字段。
	`dynamic-insert`（可选，默认为 `false`）：指定用于 `INSERT` 的 SQL 将会在运行时动态生成，并且只包含那些非空值字段。
	`select-before-update`（可选，默认为 `false`）：指定 Hibernate 除非确定对象真正被修改了（如果该值为 true — 译注），否则不会执行 SQL `UPDATE` 操作。在特定场合（实际上，它只在一个瞬时对象（transient object）关联到一个新的 session 中时执行的 update() 中生效），这说明 Hibernate 会在 `UPDATE` 之前执行一次额外的 SQL `SELECT` 操作来决定是否确实需要执行 `UPDATE`。
	`polymorphism（多态）`（可选，默认值为 `implicit （隐式）`）：界定是隐式还是显式的使用多态查询（这只在 Hibernate 的具体表继承策略中用到 — 译注）。
	`where`（可选）指定一个附加的 SQL `WHERE` 条件，在抓取这个类的对象时会一直增加这个条件。
	`persister`（可选）：指定一个定制的 `ClassPersister`。
	`batch-size`（可选,默认是 `1`）指定一个用于根据标识符（identifier）抓取实例时使用的 "batch size"（批次抓取数量）。
	`optimistic-lock（乐观锁定）`（可选，默认是 `version`）：决定乐观锁定的策略。
(16)	`lazy`（可选）：通过设置 `lazy="false"`，所有的延迟加载（Lazy fetching）功能将被全部禁用（disabled）。
(17)	`entity-name` (optional - defaults to the class name): Hibernate3 allows a class to be mapped multiple times, potentially to different tables. It also allows entity mappings that are represented by Maps or XML at the Java level. In these cases, you should provide an explicit arbitrary name for the entity. See 第 4.4 节 “动态模型（Dynamic models）” and 第 19 章 XML 映射 for more information.
(18)	`check`（可选）：这是一个 SQL 表达式，用于为自动生成的 schema 添加多行（multi-row）约束检查。
(19)	`rowid`（可选）：Hibernate 可以使用数据库支持的所谓的 ROWIDs，例如：Oracle 数据库，如果你设置这个可选的 `rowid`，Hibernate 可以使用额外的字段 `rowid` 实现快速更新。ROWID 是这个功能实现的重点，它代表了一个存储元组（tuple）的物理位置。
(20)	`subselect`（可选）：它将一个不可变（immutable）并且只读的实体映射到一个数据库的子查询中。当你想用视图代替一张基本表的时候，这是有用的，但最好不要这样做。更多的介绍请看下面内容。
(21)	`abstract`（可选）：用于在 `<union-subclass>` 的层次结构（hierarchies）中标识抽象超类。

若指明的持久化类实际上是一个接口，这也是完全可以接受的。之后你可以用元素 <subclass> 来指定该接口的实际实现类。你可以持久化任何 static（静态的）内部类。你应该使用标准的类名格式来指定类名，比如：Foo$Bar。

不可变类，mutable="false" 不可以被应用程序更新或者删除。这允许 Hibernate 实现一些小小的性能优化。

可选的 proxy 属性允许延迟加载类的持久化实例。Hibernate 开始会返回实现了这个命名接口的 CGLIB 代理。当代理的某个方法被实际调用的时候，真实的持久化对象才会被装载。参见下面的“用于延迟装载的代理”。

Implicit（隐式）的多态是指，如果查询时给出的是任何超类、该类实现的接口或者该类的名字，都会返回这个类的实例；如果查询中给出的是子类的名字，则会返回子类的实例。Explicit（显式）的多态是指，只有在查询时给出明确的该类名字时才会返回这个类的实例；同时只有在这个 <class> 的定义中作为 <subclass> 或者 <joined-subclass> 出现的子类，才会可能返回。在大多数情况下，默认的 polymorphism="implicit" 都是合适的。显式的多态在有两个不同的类映射到同一个表的时候很有用。（允许一个“轻量级”的类，只包含部分表字段）。

persister 属性可以让你定制这个类使用的持久化策略。你可以指定你自己实现 org.hibernate.persister.EntityPersister 的子类，你甚至可以完全从头开始编写一个 org.hibernate.persister.ClassPersister 接口的实现，比如是用储存过程调用、序列化到文件或者 LDAP 数据库来实现。参阅 org.hibernate.test.CustomPersister，这是持久化到 Hashtable 的一个简单例子。

请注意 dynamic-update 和 dynamic-insert 的设置并不会继承到子类，所以在 <subclass> 或者 <joined-subclass> 元素中可能需要再次设置。这些设置在某些情况下能够提高效率，而其他情况下则反而可能降低性能。

使用 select-before-update 通常会降低性能。如果你重新连接一个脱管（detached）对象实例到一个 Session 中时，它可以防止数据库不必要的触发 update。这就很有用了。

如果你打开了dynamic-update，你可以选择几种乐观锁定的策略：

version（版本检查）：检查 version/timestamp 字段
all（全部）：检查全部字段
dirty（脏检查）：只检察修改过的字段，允许某些并行更新
none（不检查）：不使用乐观锁定

我们强烈建议你在 Hibernate 中使用 version/timestamp 字段来进行乐观锁定。这个选择可以优化性能，且能够处理对脱管实例的修改（例如：在使用 Session.merge() 的时候）。

对 Hibernate 映射来说视图和表是没有区别的，这是因为它们在数据层都是透明的（注意：一些数据库不支持视图属性，特别是更新的时候）。有时你想使用视图，但却不能在数据库中创建它（例如：在遗留的 schema 中）。这样的话，你可以映射一个不可变的（immutable）并且是只读的实体到一个给定的 SQL 子查询表达式：


<class name="Summary">

    <subselect>

        select item.name, max(bid.amount), count(*)

        from item

        join bid on bid.item_id = item.id

        group by item.name

    </subselect>

    <synchronize table="item"/>

    <synchronize table="bid"/>

    <id name="name"/>

    ...

</class

>

定义这个实体用到的表为同步（synchronize），确保自动刷新（auto-flush）正确执行，并且依赖原实体的查询不会返回过期数据。在属性元素和嵌套映射元素中都可使用 <subselect>。

5.1.4. id

被映射的类必须定义对应数据库表主键字段。大多数类有一个 JavaBeans 风格的属性，为每一个实例包含唯一的标识。<id> 元素定义了该属性到数据库表主键字段的映射。

<id
        name="propertyName"
        type="typename"
        column="column_name"
        unsaved-value="null|any|none|undefined|id_value"
        access="field|property|ClassName">
        node="element-name|@attribute-name|element/@attribute|."

        <generator class="generatorClass"/>
</id
>

	`name`（可选）：标识属性的名字。
	`type`（可选）：一个 Hibernate 类型的名字。
	`column`（可选 — 默认为属性名）：主键字段的名字。
	`unsaved-value`（可选 — 默认为一个切合实际（sensible）的值）：一个特定的标识属性值，用来标志该实例是刚刚创建的，尚未保存。这可以把这种实例和从以前的 session 中装载过（可能又做过修改--译者注）但未再次持久化的实例区分开来。
	`access`（可选 — 默认为 `property`）：Hibernate 用来访问属性值的策略。

如果 name 属性不存在，会认为这个类没有标识属性。

unsaved-value 属性在 Hibernate3 中几乎不再需要。

还有一个另外的 <composite-id> 定义可以访问旧式的多主键数据。我们非常不鼓励使用这种方式。

5.1.4.1. Generator

可选的 <generator> 子元素是一个 Java 类的名字，用来为该持久化类的实例生成唯一的标识。如果这个生成器实例需要某些配置值或者初始化参数，用 <param> 元素来传递。


<id name="id" type="long" column="cat_id">

        <generator class="org.hibernate.id.TableHiLoGenerator">

                <param name="table"

>uid_table</param>

                <param name="column"

>next_hi_value_column</param>

        </generator>

</id

>

所有的生成器都实现 org.hibernate.id.IdentifierGenerator 接口。这是一个非常简单的接口；某些应用程序可以选择提供他们自己特定的实现。当然，Hibernate 提供了很多内置的实现。下面是一些内置生成器的快捷名字：

increment: 用于为 long, short 或者 int 类型生成唯一标识。只有在没有其他进程往同一张表中插入数据时才能使用。在集群下不要使用。
identity: 对 DB2，MySQL，MS SQL Server，Sybase 和 HypersonicSQL 的内置标识字段提供支持。返回的标识符是 long，short 或者 int 类型的。
sequence: 在 DB2，PostgreSQL，Oracle，SAP DB，McKoi 中使用序列（sequence），而在 Interbase 中使用生成器（generator）。返回的标识符是 long，short 或者 int 类型的。
hilo: 使用一个高/低位算法高效的生成 long，short 或者 int 类型的标识符。给定一个表和字段（默认分别是 hibernate_unique_key 和 next_hi）作为高位值的来源。高/低位算法生成的标识符只在一个特定的数据库中是唯一的。
seqhilo: 使用一个高/低位算法来高效的生成 long，short 或者 int 类型的标识符，给定一个数据库序列（sequence)的名字。
uuid: 用一个 128-bit 的 UUID 算法生成字符串类型的标识符，这在一个网络中是唯一的（使用了 IP 地址）。UUID 被编码为一个 32 位 16 进制数字的字符串。
guid: 在 MS SQL Server 和 MySQL 中使用数据库生成的 GUID 字符串。
native: 根据底层数据库的能力选择 identity、sequence 或者 hilo 中的一个。
assigned: 让应用程序在调用 save() 之前为对象分配一个标识符。这是 <generator> 元素没有指定时的默认生成策略。
select: 通过数据库触发器选择一些唯一主键的行并返回主键值来分配一个主键。
foreign: 使用另外一个相关联的对象的标识符。它通常和 <one-to-one> 联合起来使用。
sequence-identity: 一种特别的序列生成策略，它使用数据库序列来生成实际值，但将它和 JDBC3 的 getGeneratedKeys 结合在一起，使得在插入语句执行的时候就返回生成的值。目前为止只有面向 JDK 1.4 的 Oracle 10g 驱动支持这一策略。由于 Oracle 驱动程序的一个 bug，这些插入语句的注释被关闭了。

5.1.4.2. 高/低位算法（Hi/Lo Algorithm）

hilo 和 seqhilo 生成器给出了两种 hi/lo 算法的实现，这是一种很令人满意的标识符生成算法。第一种实现需要一个“特殊”的数据库表来保存下一个可用的“hi”值。第二种实现使用一个 Oracle 风格的序列（在被支持的情况下）。


<id name="id" type="long" column="cat_id">

        <generator class="hilo">

                <param name="table"

>hi_value</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

>

可惜的是，你在为 Hibernate 自行提供 Connection 时无法使用 hilo。当 Hibernate 使用 JTA 获取应用服务器的数据源连接时，你必须正确地配置 hibernate.transaction.manager_lookup_class。

5.1.4.3. UUID 算法（UUID Algorithm ）

UUID 包含：IP 地址、JVM 的启动时间（精确到 1/4 秒）、系统时间和一个计数器值（在 JVM 中唯一）。在 Java 代码中不可能获得 MAC 地址或者内存地址，所以这已经是我们在不使用 JNI 的前提下的能做的最好实现了。

5.1.4.4. 标识字段和序列（Identity columns and Sequences）

对于内部支持标识字段的数据库（DB2、MySQL、Sybase 和 MS SQL），你可以使用 identity 关键字生成。对于内部支持序列的数据库（DB2、Oracle、PostgreSQL、Interbase、McKoi 和 SAP DB），你可以使用 sequence 风格的关键字生成。这两种方式对于插入一个新的对象都需要两次 SQL 查询。例如：


<id name="id" type="long" column="person_id">

        <generator class="sequence">

                <param name="sequence"

>person_id_sequence</param>

        </generator>

</id

>


<id name="id" type="long" column="person_id" unsaved-value="0">

        <generator class="identity"/>

</id

>

对于跨平台开发，native 策略会从 identity、sequence 和 hilo 中进行选择，选择哪一个，这取决于底层数据库的支持能力。

5.1.4.5. 程序分配的标识符（Assigned Identifiers）

如果你需要应用程序分配一个标示符（而非 Hibernate 来生成），你可以使用 assigned 生成器。这种特殊的生成器会使用已经分配给对象的标识符属性的标识符值。这个生成器使用一个自然键（natural key，有商业意义的列－译注）作为主键，而不是使用一个代理键（ surrogate key，没有商业意义的列－译注）。这是没有指定 <generator> 元素时的默认行为。

当选择 assigned 生成器时，除非有一个 version 或 timestamp 属性，或者你定义了 Interceptor.isUnsaved()，否则需要让 Hiberante 使用 unsaved-value="undefined"，强制 Hibernatet 查询数据库来确定一个实例是瞬时的（transient）还是脱管的（detached）。

5.1.4.6. 触发器实现的主键生成器（Primary keys assigned by triggers）

仅仅用于遗留的 schema 中（Hibernate 不能用触发器生成 DDL）。


<id name="id" type="long" column="person_id">

        <generator class="select">

                <param name="key"

>socialSecurityNumber</param>

        </generator>

</id

>

在上面的例子中，类定义了一个命名为 socialSecurityNumber 的具有唯一值的属性，它是一个自然键（natural key），命名为 person_id 的代理键（surrogate key）的值由触发器生成。

5.1.5. 增强的标识符生成器

从 3.2.3 版本开始，有两个代表不同标识符生成概念的新的生成器。第一个概念是数据库移植性；第二个是优化。优化表示你不需对每个新标识符的请求都查询数据库。从 3.3.x 开始，这两个新的生成器都是用来取代上面所述的生成器的。然而，它们也包括在当前版本里且可以由 FQN 进行引用。

这些生成器的第一个是 org.hibernate.id.enhanced.SequenceStyleGenerator，首先，它是作为 sequence 生成器的替代物，其次，它是比 native 具有更好移植性的生成器。这是因为 native 通常在 identity 和 sequence 之间选择，它有差别很大的 semantic，在移植时会导致潜在的问题。然而，org.hibernate.id.enhanced.SequenceStyleGenerator 以不同的方式实现移植性。它根据所使用的方言的能力，在数据库表或序列之间选择以存储其增量。这和 native 的区别是基于表或序列的存储具有恰好相同的 semantic。实际上，序列就是 Hibernate 试图用基于表的生成器来模拟的。这个生成器有如下的配置参数：

sequence_name（可选 — 默认为 hibernate_sequence）：序列或表的名字
initial_value（可选，默认为 1）：从序列/表里获取的初始值。按照序列创建的术语，这等同于子句 "STARTS WITH"。
increment_size（可选 - 缺省为 1）：对序列/表的调用应该区分的值。按照序列创建的术语，这等同于子句 "INCREMENT BY"。
force_table_use（可选 - 缺省为 false）：即使方言可能支持序列，是否也应该强制把表用作后台结构。
value_column（可选 - 缺省为 next_val）：只和表结构相关，它是用于保存值的字段的名称。
optimizer (optional - defaults to none): See 第 5.1.6 节 “标识符生成器的优化”

新生成器的第二个是 org.hibernate.id.enhanced.TableGenerator，它的目的首先是替代 table 生成器，即使它实际上比 org.hibernate.id.MultipleHiLoPerTableGenerator 功能要强得多；其次，作为利用可插拔 optimizer 的 org.hibernate.id.MultipleHiLoPerTableGenerator 的替代品。基本上这个生成器定义了一个可以利用多个不同的键值记录存储大量不同增量值的表。这个生成器有如下的配置参数：

table_name（可选 — 默认是 hibernate_sequences）：所用的表的名称。
value_column_name（可选 — 默认为 next_val）：用于存储这些值的表的字段的名字。
segment_column_name（可选，默认为 sequence_name）：用于保存 "segment key" 的字段的名称。这是标识使用哪个增量值的值。
segment_value（可选，默认为 default）：我们为这个生成器获取增量值的 segment 的 "segment key"。
segment_value_length（可选 — 默认为 255）：用于 schema 生成；创建 Segment Key 字段的字段大小。
initial_value（可选 — 默认是 1）：从表里获取的初始值。
increment_size（可选 — 默认是 1）：对表随后的调用应该区分的值。
optimizer (optional - defaults to ): See 第 5.1.6 节 “标识符生成器的优化”

`5.1.6. 标识符生成器的优化`

For identifier generators that store values in the database, it is inefficient for them to hit the database on each and every call to generate a new identifier value. Instead, you can group a bunch of them in memory and only hit the database when you have exhausted your in-memory value group. This is the role of the pluggable optimizers. Currently only the two enhanced generators (第 5.1.5 节 “增强的标识符生成器” support this operation.

none（如果没有指定 optimizer，通常这是缺省配置）：这不会执行任何优化，在每次请求时都访问数据库。
hilo：对从数据库获取的值应用 hi/lo 算法。用于这个 optimizer 的从数据库获取的值应该是有序的。它们表明“组编号”。increment_size 将乘以内存里的值来定义组的“hi 值”。
pooled：和 hilo 一样，这个 optimizer 试图最小化对数据库的访问。然而，我们只是简单地把“下一组”的起始值而不是把序列值和分组算法的组合存入到数据库结构里。在这里，increment_size 表示数据库里的值。

`5.1.7. composite-id`


<composite-id

        name="propertyName"

        class="ClassName"

        mapped="true|false"

        access="field|property|ClassName">

        node="element-name|."



        <key-property name="propertyName" type="typename" column="column_name"/>

        <key-many-to-one name="propertyName" class="ClassName" column="column_name"/>

        ......

</composite-id

>

如果表使用联合主键，你可以映射类的多个属性为标识符属性。<composite-id> 元素接受 <key-property> 属性映射和 <key-many-to-one> 属性映射作为子元素。


<composite-id>

        <key-property name="medicareNumber"/>

        <key-property name="dependent"/>

</composite-id

>

你的持久化类必须覆盖 equals() 和 hashCode() 方法，来实现组合的标识符的相等判断。实现 Serializable 接口也是必须的。

不幸的是，这种组合关键字的方法意味着一个持久化类是它自己的标识。除了对象自己之外，没有什么方便的“把手”可用。你必须初始化持久化类的实例，填充它的标识符属性，再 load() 组合关键字关联的持久状态。我们把这种方法称为 embedded（嵌入式）的组合标识符，在重要的应用中不鼓励使用这种用法。

第二种方法我们称为 mapped（映射式）组合标识符（mapped composite identifier），<composite-id> 元素中列出的标识属性不但在持久化类出现，还形成一个独立的标识符类。


<composite-id class="MedicareId" mapped="true">

        <key-property name="medicareNumber"/>

        <key-property name="dependent"/>

</composite-id

>

在这个例子中，组合标识符类 MedicareId 和实体类都含有 medicareNumber 和 dependent 属性。标识符类必须重载 equals() 和 hashCode() 并且实现 Serializable 接口。这种方法的缺点是出现了明显的代码重复。

下面列出的属性是用来指定一个映射式组合标识符的：

mapped（可选，默认为 false）：指明使用一个映射式组合标识符，其包含的属性映射同时在实体类和组合标识符类中出现。
class（可选,但对映射式组合标识符必须指定）：作为组合标识符类使用的类名。

We will describe a third, even more convenient approach, where the composite identifier is implemented as a component class in 第 8.4 节 “组件作为联合标识符（Components as composite identifiers）”. The attributes described below apply only to this alternative approach:

name（可选,但对这种方法而言必须）：包含此组件标识符的组件类型的名字（参阅第 9 章）。
access（可选 — 默认为 property）：Hibernate 用来访问属性值的策略。
class（可选 — 默认会用反射来自动判定属性类型）：用来作为组合标识符的组件类的类名（参阅下一节）。

第三种方式，被称为 identifier component（标识符组件）是我们对几乎所有应用都推荐使用的方式。

`5.1.8. 鉴别器（discriminator）`

在"一棵对象继承树对应一个表"的策略中，<discriminator> 元素是必需的，它定义了表的鉴别器字段。鉴别器字段包含标志值，用于告知持久化层应该为某个特定的行创建哪一个子类的实例。如下这些受到限制的类型可以使用：string、character、integer、byte、short、boolean、yes_no、true_false。

<discriminator
        column="discriminator_column"
        type="discriminator_type"
        force="true|false"
        insert="true|false"
        formula="arbitrary sql expression"
/>

	`column`（可选 — 默认为 `class`）discriminator 器字段的名字。
	`type`（可选 — 默认为 `string`）一个 Hibernate 字段类型的名字
	`force(强制)`（可选 — 默认为 `false`）"强制" Hibernate 指定允许的鉴别器值,即使当取得的所有实例都是根类的。
	`insert`（可选 - 默认为`true`）如果你的鉴别器字段也是映射为复合标识（composite identifier）的一部分，则需将这个值设为 `false`。（告诉 Hibernate 在做 SQL `INSERT` 时不包含该列）
	`formula`（可选）一个 SQL 表达式，在类型判断（判断是父类还是具体子类 — 译注）时执行。可用于基于内容的鉴别器。

鉴别器字段的实际值是根据 <class> 和 <subclass> 元素中的 discriminator-value 属性得来的。

force 属性仅仅在这种情况下有用的：表中包含没有被映射到持久化类的附加辨别器值。这种情况不会经常遇到。

使用 formula 属性你可以定义一个 SQL 表达式，用来判断一行数据的类型。


<discriminator

    formula="case when CLASS_TYPE in ('a', 'b', 'c') then 0 else 1 end"

    type="integer"/>

`5.1.9. 版本（version）（可选）`

<version> 元素是可选的，表明表中包含附带版本信息的数据。这在你准备使用长事务（long transactions）的时候特别有用。下面是更多信息：

<version
        column="version_column"
        name="propertyName"
        type="typename"
        access="field|property|ClassName"
        unsaved-value="null|negative|undefined"
        generated="never|always"
        insert="true|false"
        node="element-name|@attribute-name|element/@attribute|."
/>

	`column`（可选 — 默认为属性名）：指定持有版本号的字段名。
	`name`：持久化类的属性名。
	`type`（可选 — 默认是 `integer`）：版本号的类型。
	`access`（可选 — 默认为 `property`）：Hibernate 用来访问属性值的策略。
	`unsaved-value`（可选 — 默认是 `undefined`）：用于标明某个实例时刚刚被实例化的（尚未保存）版本属性值，依靠这个值就可以把这种情况和已经在先前的 session 中保存或装载的脱管（detached）实例区分开来。（`undefined` 指明应被使用的标识属性值。）
	`generated`（可选 — 默认是 `never`）：表明此版本属性值是否实际上是由数据库生成的。请参阅 generated properties 部分的讨论。
	`insert`（可选 — 默认是 `true`）：表明此版本列应该包含在 SQL 插入语句中。只有当数据库字段有默认值 `0` 的时候，才可以设置为 `false`。

版本号必须是以下类型：long、integer、short、timestamp 或者 calendar。

一个脱管（detached）实例的 version 或 timestamp 属性不能为空（null），因为 Hibernate 不管 unsaved-value 被指定为何种策略，它将任何属性为空的 version 或 timestamp 实例看作为瞬时（transient）实例。避免 Hibernate 中的传递重附（transitive reattachment）问题的一个简单方法是定义一个不能为空的 version 或 timestamp 属性，特别是在人们使用程序分配的标识符（assigned identifiers）或复合主键时非常有用。

`5.1.10. timestamp（可选)`

可选的 <timestamp> 元素指明了表中包含时间戳数据。这用来作为版本的替代。时间戳本质上是一种对乐观锁定的一种不是特别安全的实现。当然，有时候应用程序可能在其他方面使用时间戳。

<timestamp
        column="timestamp_column"
        name="propertyName"
        access="field|property|ClassName"
        unsaved-value="null|undefined"
        source="vm|db"
        generated="never|always"
        node="element-name|@attribute-name|element/@attribute|."
/>

	`column`（可选 — 默认为属性名）：存有时间戳的字段名。
	`name`：在持久化类中的 JavaBeans 风格的属性名，其 Java 类型是 `Date` 或者 `Timestamp` 的。
	`access`（可选 — 默认为 `property`）：Hibernate 用来访问属性值的策略。
	`unsaved-value`（可选 — 默认是 `null`）：用于标明某个实例时刚刚被实例化的（尚未保存）版本属性值，依靠这个值就可以把这种情况和已经在先前的 session 中保存或装载的脱管（detached）实例区分开来。（`undefined` 指明使用标识属性值进行这种判断。）
	`source`（可选 — 默认是 `vm`）：Hibernate 如何才能获取到时间戳的值呢？从数据库，还是当前 JVM？从数据库获取会带来一些负担，因为 Hibernate 必须访问数据库来获得“下一个值”，但是在集群环境中会更安全些。还要注意，并不是所有的 `Dialect（方言）`都支持获得数据库的当前时间戳的，而支持的数据库中又有一部分因为精度不足，用于锁定是不安全的（例如 Oracle 8）。
	`generated`（可选 - 默认是 `never`）：指出时间戳值是否实际上是由数据库生成的。请参阅 generated properties 的讨论。

`注意`

注意，<timestamp> 和 <version type="timestamp"> 是等价的。并且 <timestamp source="db"> 和 <version type="dbtimestamp"> 是等价的。

`5.1.11. Property`

<property> 元素为类定义了一个持久化的、JavaBean 风格的属性。

<property
        name="propertyName"
        column="column_name"
        type="typename"
        update="true|false"
        insert="true|false"
        formula="arbitrary SQL expression"
        access="field|property|ClassName"
        lazy="true|false"
        unique="true|false"
        not-null="true|false"
        optimistic-lock="true|false"
        generated="never|insert|always"
        node="element-name|@attribute-name|element/@attribute|."
        index="index_name"
        unique_key="unique_key_id"
        length="L"
        precision="P"
        scale="S"
/>

	`name`：属性的名字，以小写字母开头。
	`column`（可选 — 默认为属性名字）：对应的数据库字段名。也可以通过嵌套的 `<column>` 元素指定。
	`type`（可选）：一个 Hibernate 类型的名字。
	`update, insert`（可选 — 默认为 `true`）：表明用于　`UPDATE` 和/或 `INSERT` 的 SQL 语句中是否包含这个被映射了的字段。这二者如果都设置为 `false` 则表明这是一个“外源性（derived）”的属性，它的值来源于映射到同一个（或多个）字段的某些其他属性，或者通过一个 trigger（触发器）或其他程序生成。
	`formula`（可选）：一个 SQL 表达式，定义了这个计算（computed）属性的值。计算属性没有和它对应的数据库字段。
	`access`（可选 — 默认为 `property`）：Hibernate 用来访问属性值的策略。
	`lazy`（可选 — 默认为 `false`）：指定指定实例变量第一次被访问时，这个属性是否延迟抓取（fetched lazily）（需要运行时字节码增强）。
	`unique`（可选）：使用 DDL 为该字段添加唯一的约束。同样，允许它作为 `property-ref` 引用的目标。
	`not-null`（可选）：使用 DDL 为该字段添加可否为空（nullability）的约束。
	`optimistic-lock`（可选 — 默认为 `true`）：指定这个属性在做更新时是否需要获得乐观锁定（optimistic lock）。换句话说，它决定这个属性发生脏数据时版本（version）的值是否增长。
	`generated`（可选 — 默认为 `never`）：表明此属性值是否实际上是由数据库生成的。请参阅 generated properties 的讨论。

typename 可以是如下几种：

Hibernate 基本类型名（比如：integer, string, character,date, timestamp, float, binary, serializable, object, blob）。
一个 Java 类的名字，这个类属于一种默认基础类型（比如：int, float,char, java.lang.String, java.util.Date, java.lang.Integer, java.sql.Clob)。
一个可以序列化的 Java 类的名字。
一个自定义类型的类的名字。（比如：com.illflow.type.MyCustomType)。

如果你没有指定类型，Hibernarte 会使用反射来得到这个名字的属性，以此来猜测正确的 Hibernate 类型。Hibernate 会按照规则 2，3，4 的顺序对属性读取器（getter方法）的返回类进行解释。然而，这还不够。在某些情况下你仍然需要 type 属性。（比如，为了区别Hibernate.DATE 和Hibernate.TIMESTAMP,或者为了指定一个自定义类型。）

access 属性用来让你控制 Hibernate 如何在运行时访问属性。在默认情况下，Hibernate 会使用属性的 get/set 方法对（pair）。如果你指明 access="field"，Hibernate 会忽略 get/set 方法对，直接使用反射来访问成员变量。你也可以指定你自己的策略，这就需要你自己实现 org.hibernate.property.PropertyAccessor 接口，再在 access 中设置你自定义策略类的名字。

衍生属性（derive propertie）是一个特别强大的特征。这些属性应该定义为只读，属性值在装载时计算生成。你用一个 SQL 表达式生成计算的结果，它会在这个实例转载时翻译成一个 SQL 查询的 SELECT 子查询语句。




<property name="totalPrice"

    formula="( SELECT SUM (li.quantity*p.price) FROM LineItem li, Product p

                WHERE li.productId = p.productId

                AND li.customerId = customerId

                AND li.orderNumber = orderNumber )"/>

注意，你可以使用实体自己的表，而不用为这个特别的列定义别名（上面例子中的 customerId）。同时注意，如果你不喜欢使用属性，你可以使用嵌套的 <formula> 映射元素。

`5.1.12. 多对一（many-to-one）`

通过 many-to-one 元素,可以定义一种常见的与另一个持久化类的关联。这种关系模型是多对一关联（实际上是一个对象引用－译注）：这个表的一个外键引用目标表的主键字段。

<many-to-one
        name="propertyName"
        column="column_name"
        class="ClassName"
        cascade="cascade_style"
        fetch="join|select"
        update="true|false"
        insert="true|false"
        property-ref="propertyNameFromAssociatedClass"
        access="field|property|ClassName"
        unique="true|false"
        not-null="true|false"
        optimistic-lock="true|false"
        lazy="proxy|no-proxy|false"
        not-found="ignore|exception"
        entity-name="EntityName"
        formula="arbitrary SQL expression"
        node="element-name|@attribute-name|element/@attribute|."
        embed-xml="true|false"
        index="index_name"
        unique_key="unique_key_id"
        foreign-key="foreign_key_name"
/>

	`name`：属性名。
	`column`（可选）：外键字段的名称。也可以通过嵌套的 `<column>` 指定。
	`class`（可选 — 默认是通过反射得到的属性类型）：被关联的类的名字。
	`cascade（级联）`（可选）表明操作是否从父对象级联到被关联的对象。
	`fetch`（可选 — 默认为 `select`）：在外连接抓取（outer-join fetching）和序列选择抓取（sequential select fetching）两者中选择其一。
	`update, insert`（可选 — 默认为 `true`）指定对应的字段是否包含在用于 `UPDATE` 和/或 `INSERT` 的 SQL 语句中。如果二者都是`false`,则这是一个纯粹的 “外源性（derived）”关联，它的值是通过映射到同一个（或多个）字段的某些其他属性得到或者通过 trigger（触发器）、或其他程序生成。
	`property-ref`：（可选）被关联到此外键的类中的对应属性的名字。如果没有指定，被关联类的主键将被使用。
	`access`（可选 — 默认为 `property`）：Hibernate 用来访问属性值的策略。
	`unique`（可选）：使用 DDL 为外键字段生成一个唯一约束。此外，这也可以用作 `property-ref` 的目标属性。这使关联同时具有一对一的效果。
	`not-null`（可选）：使用 DDL 为外键字段生成一个非空约束。
	`optimistic-lock`（可选 — 默认为 `true`）：指定这个属性在做更新时是否需要获得乐观锁定（optimistic lock）。换句话说，它决定这个属性发生脏数据时版本（version）的值是否增长。
	`lazy`（可选 — 默认为 `proxy`）：默认情况下，单点关联是经过代理的。`lazy="no-proxy"` 指定此属性应该在实例变量第一次被访问时应该延迟抓取（fetche lazily）（需要运行时字节码的增强）。`lazy="false"` 指定此关联总是被预先抓取。
	`not-found`（可选 - 默认为`exception`）：指定如何处理引用缺失行的外键：`ignore` 会把缺失的行作为一个空关联处理。
	`entity-name`（可选）：被关联的类的实体名。
	`formula`（可选）：SQL 表达式，用于定义 computed（计算出的）外键值。

Setting a value of the cascade attribute to any meaningful value other than none will propagate certain operations to the associated object. The meaningful values are divided into three categories. First, basic operations, which include: persist, merge, delete, save-update, evict, replicate, lock and refresh; second, special values: delete-orphan; and third, all comma-separated combinations of operation names: cascade="persist,merge,evict" or cascade="all,delete-orphan". See 第 10.11 节 “传播性持久化（transitive persistence）” for a full explanation. Note that single valued, many-to-one and one-to-one, associations do not support orphan delete.

一个典型的简单 many-to-one 定义例子：


<many-to-one name="product" class="Product" column="PRODUCT_ID"/>

property-ref 属性只应该用来对付遗留下来的数据库系统，可能有外键指向对方关联表的是个非主键字段（但是应该是一个惟一关键字）的情况下。这是一种十分丑陋的关系模型。比如说，假设 Product 类有一个惟一的序列号，它并不是主键。（unique 属性控制 Hibernate 通过 SchemaExport 工具进行的 DDL 生成。）


<property name="serialNumber" unique="true" type="string" column="SERIAL_NUMBER"/>

那么关于 OrderItem 的映射可能是：


<many-to-one name="product" property-ref="serialNumber" column="PRODUCT_SERIAL_NUMBER"/>

当然，我们决不鼓励这种用法。

如果被引用的唯一主键由关联实体的多个属性组成，你应该在名称为 <properties> 的元素里面映射所有关联的属性。

假若被引用的唯一主键是组件的属性，你可以指定属性路径：


<many-to-one name="owner" property-ref="identity.ssn" column="OWNER_SSN"/>

`5.1.13. 一对一`

持久化对象之间一对一的关联关系是通过 one-to-one 元素定义的。

<one-to-one
        name="propertyName"
        class="ClassName"
        cascade="cascade_style"
        constrained="true|false"
        fetch="join|select"
        property-ref="propertyNameFromAssociatedClass"
        access="field|property|ClassName"
        formula="any SQL expression"
        lazy="proxy|no-proxy|false"
        entity-name="EntityName"
        node="element-name|@attribute-name|element/@attribute|."
        embed-xml="true|false"
        foreign-key="foreign_key_name"
/>

	`name`：属性名。
	`class`（可选 — 默认是通过反射得到的属性类型）：被关联的类的名字。
	`cascade（级联）`（可选）表明操作是否从父对象级联到被关联的对象。
	`constrained（约束）`（可选）表明该类对应的表对应的数据库表，和被关联的对象所对应的数据库表之间，通过一个外键引用对主键进行约束。这个选项影响 `save()` 和 `delete()` 在级联执行时的先后顺序以及决定该关联能否被委托（也在 schema export tool 中被使用）。
	`fetch`（可选 — 默认为 `select`）：在外连接抓取（outer-join fetching）和序列选择抓取（sequential select fetching）两者中选择其一。
	`property-ref`：（可选）指定关联类的属性名，这个属性将会和本类的主键相对应。如果没有指定，会使用对方关联类的主键。
	`access`（可选 — 默认为 `property`）：Hibernate 用来访问属性值的策略。
	`formula` （可选）：绝大多数一对一的关联都指向其实体的主键。在一些少见的情况中，你可能会指向其他的一个或多个字段，或者是一个表达式，这些情况下，你可以用一个 SQL 公式来表示。（可以在 org.hibernate.test.onetooneformula 找到例子）
	`lazy`（可选 — 默认为 `proxy`）：默认情况下，单点关联是经过代理的。`lazy="no-proxy"`指定此属性应该在实例变量第一次被访问时应该延迟抓取（fetche lazily）（需要运行时字节码的增强）。 `lazy="false"`指定此关联总是被预先抓取。注意，如果`constrained="false"`, 不可能使用代理，Hibernate会采取预先抓取。
	`entity-name`（可选）：被关联的类的实体名。

有两种不同的一对一关联：

主键关联
惟一外键关联

主键关联不需要额外的表字段；如果两行是通过这种一对一关系相关联的，那么这两行就共享同样的主关键字值。所以如果你希望两个对象通过主键一对一关联，你必须确认它们被赋予同样的标识值。

比如说，对下面的 Employee 和 Person 进行主键一对一关联：


<one-to-one name="person" class="Person"/>


<one-to-one name="employee" class="Employee" constrained="true"/>

现在我们必须确保 PERSON 和 EMPLOYEE 中相关的字段是相等的。我们使用一个被成为 foreign 的特殊的 hibernate 标识符生成策略：


<class name="person" table="PERSON">

    <id name="id" column="PERSON_ID">

        <generator class="foreign">

            <param name="property"

>employee</param>

        </generator>

    </id>

    ...

    <one-to-one name="employee"

        class="Employee"

        constrained="true"/>

</class

>

一个刚刚保存的 Person 实例被赋予和该 Person 的 employee 属性所指向的 Employee 实例同样的关键字值。

另一种方式是一个外键和一个惟一关键字对应，上面的 Employee 和 Person 的例子，如果使用这种关联方式，可以表达成：


<many-to-one name="person" class="Person" column="PERSON_ID" unique="true"/>

如果在 Person 的映射加入下面几句，这种关联就是双向的：


<one-to-one name="employee" class="Employee" property-ref="person"/>

`5.1.14. 自然 ID（natural-id）`


<natural-id mutable="true|false"/>

        <property ... />

        <many-to-one ... />

        ......

</natural-id

>

我们建议使用代用键（键值不具备实际意义）作为主键，我们仍然应该尝试为所有的实体采用自然的键值作为（附加——译者注）标示。自然键（natural key）是单个或组合属性，他们必须唯一且非空。如果它还是不可变的那就更理想了。在 <natural-id> 元素中列出自然键的属性。Hibernate 会帮你生成必须的唯一键值和非空约束，你的映射会更加的明显易懂（原文是 self-documenting，自我注解）。

我们强烈建议你实现 equals() 和 hashCode() 方法,来比较实体的自然键属性。

这一映射不是为了把自然键作为主键而准备的。

mutable（可选，默认为 false）：默认情况下，自然标识属性被假定为不可变的（常量）。

`5.1.15. 组件（component）和动态组件（dynamic-component）`

<component> 元素把子对象的一些元素与父类对应的表的一些字段映射起来。然后组件可以定义它们自己的属性、组件或者集合。参见后面的“Components”一章。

<component
        name="propertyName"
        class="className"
        insert="true|false"
        update="true|false"
        access="field|property|ClassName"
        lazy="true|false"
        optimistic-lock="true|false"
        unique="true|false"
        node="element-name|."
>

        <property ...../>
        <many-to-one .... />
        ........
</component
>

	`name`：属性名。
	`class`（可选 — 默认为通过反射得到的属性类型）：组件（子）类的名字。
	`insert`：被映射的字段是否出现在 SQL 的 `INSERT` 语句中？
	`update`：被映射的字段是否出现在 SQL 的 `UPDATE` 语句中？
	`access`（可选 — 默认为 `property`）：Hibernate 用来访问属性值的策略。
	`lazy`（可选 — 默认是 `false`）：表明此组件应在实例变量第一次被访问的时候延迟加载（需要编译时字节码装置器）。
	`optimistic-lock`（可选 — 默认是 `true`）：表明更新此组件是否需要获取乐观锁。换句话说，当这个属性变脏时，是否增加版本号（Version）。
	`unique`（可选 — 默认是 `false`）：表明组件映射的所有字段上都有唯一性约束。

其 <property> 子标签为子类的一些属性与表字段之间建立映射。

<component> 元素允许加入一个 <parent> 子元素，在组件类内部就可以有一个指向其容器的实体的反向引用。

The <dynamic-component> element allows a Map to be mapped as a component, where the property names refer to keys of the map. See 第 8.5 节 “动态组件（Dynamic components）” for more information.

`5.1.16. 属性（Properties）`

<properties> 元素允许定义一个命名的逻辑分组（grouping）包含一个类中的多个属性。这个元素最重要的用处是允许多个属性的组合作为 property-ref 的目标（target）。这也是定义多字段唯一约束的一种方便途径。例如：

<properties
        name="logicalName"
        insert="true|false"
        update="true|false"
        optimistic-lock="true|false"
        unique="true|false"
>

        <property ...../>
        <many-to-one .... />
        ........
</properties
>

	`name`：分组的逻辑名称 — 不是实际属性的名称。
	`insert`：被映射的字段是否出现在 SQL 的 `INSERT` 语句中？
	`update`：被映射的字段是否出现在 SQL 的 `UPDATE` 语句中？
	`optimistic-lock`（可选 — 默认是 `true`）：表明更新此组件是否需要获取乐观锁。换句话说，当这个属性变脏时，是否增加版本号（Version）。
	`unique`（可选 — 默认是 `false`）：表明组件映射的所有字段上都有唯一性约束。

例如，如果我们有如下的 <properties> 映射：


<class name="Person">

    <id name="personNumber"/>



    ...

    <properties name="name"

            unique="true" update="false">

        <property name="firstName"/>

        <property name="initial"/>

        <property name="lastName"/>

    </properties>

</class

>

然后，我们可能有一些遗留的数据关联，引用 Person 表的这个唯一键，而不是主键：


<many-to-one name="person"

         class="Person" property-ref="name">

    <column name="firstName"/>

    <column name="initial"/>

    <column name="lastName"/>

</many-to-one

>

我们并不推荐这样使用，除非在映射遗留数据的情况下。

`5.1.17. 子类（subclass）`

最后，多态持久化需要为父类的每个子类都进行定义。对于“每一棵类继承树对应一个表”的策略来说，就需要使用 <subclass> 定义。

<subclass
        name="ClassName"
        discriminator-value="discriminator_value"
        proxy="ProxyInterface"
        lazy="true|false"
        dynamic-update="true|false"
        dynamic-insert="true|false"
        entity-name="EntityName"
        node="element-name"
        extends="SuperclassName">

        <property .... />
        .....
</subclass
>

	`name`：子类的全限定名。
	`discriminator-value（辨别标志）`（可选 — 默认为类名）：一个用于区分每个独立的子类的值。
	`proxy`（可选）：指定一个类或者接口，在延迟装载时作为代理使用。
	`lazy`（可选，默认是 `true`）：设置为 `lazy="false"` 禁止使用延迟装载。

每个子类都应该定义它自己的持久化属性和子类。<version> 和 <id> 属性可以从根父类继承下来。在一棵继承树上的每个子类都必须定义一个唯一的 discriminator-value。如果没有指定，就会使用 Java 类的全限定名。

For information about inheritance mappings see 第 9 章继承映射（Inheritance Mapping） .

`5.1.18. 连接的子类（joined-subclass）`

此外，每个子类可能被映射到他自己的表中（每个子类一个表的策略）。被继承的状态通过和超类的表关联得到。我们使用 <joined-subclass> 元素。

<joined-subclass
        name="ClassName"
        table="tablename"
        proxy="ProxyInterface"
        lazy="true|false"
        dynamic-update="true|false"
        dynamic-insert="true|false"
        schema="schema"
        catalog="catalog"
        extends="SuperclassName"
        persister="ClassName"
        subselect="SQL expression"
        entity-name="EntityName"
        node="element-name">

        <key .... >

        <property .... />
        .....
</joined-subclass
>

	`name`：子类的全限定名。
	`table`：子类的表名。
	`proxy`（可选）：指定一个类或者接口，在延迟装载时作为代理使用。
	`lazy`（可选，默认是 `true`）：设置为 `lazy="false"` 禁止使用延迟装载。

这种映射策略不需要指定辨别标志（discriminator）字段。但是，每一个子类都必须使用 <key> 元素指定一个表字段来持有对象的标识符。本章开始的映射可以被用如下方式重写：


<?xml version="1.0"?>

<!DOCTYPE hibernate-mapping PUBLIC

        "-//Hibernate/Hibernate Mapping DTD//EN"

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



<hibernate-mapping package="eg">



        <class name="Cat" table="CATS">

                <id name="id" column="uid" type="long">

                        <generator class="hilo"/>

                </id>

                <property name="birthdate" type="date"/>

                <property name="color" not-null="true"/>

                <property name="sex" not-null="true"/>

                <property name="weight"/>

                <many-to-one name="mate"/>

                <set name="kittens">

                        <key column="MOTHER"/>

                        <one-to-many class="Cat"/>

                </set>

                <joined-subclass name="DomesticCat" table="DOMESTIC_CATS">

                    <key column="CAT"/>

                    <property name="name" type="string"/>

                </joined-subclass>

        </class>



        <class name="eg.Dog">

                <!-- mapping for Dog could go here -->

        </class>



</hibernate-mapping

>

For information about inheritance mappings see 第 9 章继承映射（Inheritance Mapping） .

`5.1.19. 联合子类（union-subclass）`

第三种选择是仅仅映射类继承树中具体类部分到表中（每个具体类一张表的策略）。其中，每张表定义了类的所有持久化状态，包括继承的状态。在 Hibernate 中，并不需要完全显式地映射这样的继承树。你可以简单地使用单独的 <class> 定义映射每个类。然而，如果你想使用多态关联（例如，一个对类继承树中超类的关联），你需要使用 <union-subclass> 映射。

<union-subclass
        name="ClassName"
        table="tablename"
        proxy="ProxyInterface"
        lazy="true|false"
        dynamic-update="true|false"
        dynamic-insert="true|false"
        schema="schema"
        catalog="catalog"
        extends="SuperclassName"
        abstract="true|false"
        persister="ClassName"
        subselect="SQL expression"
        entity-name="EntityName"
        node="element-name">

        <property .... />
        .....
</union-subclass
>

	`name`：子类的全限定名。
	`table`：子类的表名。
	`proxy`（可选）：指定一个类或者接口，在延迟装载时作为代理使用。
	`lazy`（可选，默认是 `true`）：设置为 `lazy="false"` 禁止使用延迟装载。

这种映射策略不需要指定辨别标志（discriminator）字段。

For information about inheritance mappings see 第 9 章继承映射（Inheritance Mapping） .

`5.1.20. 连接（join）`

使用 <join> 元素，假若在表之间存在一对一关联,可以将一个类的属性映射到多张表中。

<join
        table="tablename"
        schema="owner"
        catalog="catalog"
        fetch="join|select"
        inverse="true|false"
        optional="true|false">

        <key ... />

        <property ... />
        ...
</join
>

	`table`：被连接表的名称。
	`schema`（可选）：覆盖在根 `<hibernate-mapping>` 元素中指定的 schema 名字。
	`catalog`（可选）：覆盖在根 `<hibernate-mapping>` 元素中指定的 catalog 名字。
	`fetch`（可选 — 默认是 `join`）：如果设置为默认值 `join`，Hibernate 将使用一个内连接来得到这个类或其超类定义的 `<join>`，而使用一个外连接来得到其子类定义的 `<join>`。如果设置为 `select`，则 Hibernate 将为子类定义的 `<join>` 使用顺序选择。这仅在一行数据表示一个子类的对象的时候才会发生。对这个类和其超类定义的 `<join>`，依然会使用内连接得到。
	`inverse`（可选 — 默认是 `false`）：如果打开，Hibernate 不会插入或者更新此连接定义的属性。
	`optional`（可选 — 默认是 `false`）：如果打开，Hibernate 只会在此连接定义的属性非空时插入一行数据，并且总是使用一个外连接来得到这些属性。

例如，一个人（person）的地址（address）信息可以被映射到单独的表中（并保留所有属性的值类型语义）：


<class name="Person"

    table="PERSON">



    <id name="id" column="PERSON_ID"

>...</id>



    <join table="ADDRESS">

        <key column="ADDRESS_ID"/>

        <property name="address"/>

        <property name="zip"/>

        <property name="country"/>

    </join>

    ...

`5.1.21. Key`

我们目前已经见到过 <key> 元素多次了。这个元素在父映射元素定义了对新表的连接，并且在被连接表中定义了一个外键引用原表的主键的情况下经常使用。

<key
        column="columnname"
        on-delete="noaction|cascade"
        property-ref="propertyName"
        not-null="true|false"
        update="true|false"
        unique="true|false"
/>

	`column`（可选）：外键字段的名称。也可以通过嵌套的 `<column>` 指定。
	`on-delete`（可选，默认是 `noaction`）：表明外键关联是否打开数据库级别的级联删除。
	`property-ref`（可选）：表明外键引用的字段不是原表的主键（提供给遗留数据）。
	`not-null`（可选）：表明外键的字段不可为空（这意味着无论何时外键都是主键的一部分）。
	`update`（可选）：表明外键决不应该被更新（这意味着无论何时外键都是主键的一部分）。
	`unique`（可选）：表明外键应有唯一性约束（这意味着无论何时外键都是主键的一部分）。

not-null 和 update 属性在映射单向一对多关联的时候有用。如果你映射一个单向一对多关联到非空的（non-nullable）外键，你必须用 <key not-null="true"> 定义此键字段。

`5.1.22. 字段和规则元素（column and formula elements）`

任何接受 column 属性的映射元素都可以选择接受 <column> 子元素。同样的，formula 子元素也可以替换 <formula> 属性。


<column

        name="column_name"

        length="N"

        precision="N"

        scale="N"

        not-null="true|false"

        unique="true|false"

        unique-key="multicolumn_unique_key_name"

        index="index_name"

        sql-type="sql_type_name"

        check="SQL expression"

        default="SQL expression"

        read="SQL expression"

        write="SQL expression"/>


<formula

>SQL expression</formula

>

column 上的大多数属性都提供了在自动模式生成过程中对 DDL 进行裁剪的方法。read 和 write 属性允许你指定 Hibernate 用于访问字段值的自定义的 SQL。关于更多的内容，请参考 column read and write expressions。

column 和 formula 属性甚至可以在同一个属性或关联映射中被合并来表达，例如，一些奇异的连接条件。


<many-to-one name="homeAddress" class="Address"

        insert="false" update="false">

    <column name="person_id" not-null="true" length="10"/>

    <formula

>'MAILING'</formula>

</many-to-one

>

`5.1.23. 引用（import）`

假设你的应用程序有两个同样名字的持久化类，但是你不想在 Hibernate 查询中使用他们的全限定名。除了依赖 auto-import="true" 以外，类也可以被显式地“import（引用）”。你甚至可以引用没有被明确映射的类和接口。


<import class="java.lang.Object" rename="Universe"/>

<import
        class="ClassName"
        rename="ShortName"
/>

	`class`：任何 Java 类的全限定名。
	`rename`（可选 — 默认为类的全限定名）：在查询语句中可以使用的名字。

`5.1.24. Any`

这是属性映射的又一种类型。<any> 映射元素定义了一种从多个表到类的多态关联。这种类型的映射常常需要多于一个字段。第一个字段持有被关联实体的类型，其他的字段持有标识符。对这种类型的关联来说，不可能指定一个外键约束，所以这当然不是映射（多态）关联的通常的方式。你只应该在非常特殊的情况下使用它(比如，审计 log，用户会话数据等等)。

meta-type 属性使得应用程序能指定一个将数据库字段的值映射到持久化类的自定义类型。这个持久化类包含有用 id-type 指定的标识符属性。你必须指定从 meta-type 的值到类名的映射。


<any name="being" id-type="long" meta-type="string">

    <meta-value value="TBL_ANIMAL" class="Animal"/>

    <meta-value value="TBL_HUMAN" class="Human"/>

    <meta-value value="TBL_ALIEN" class="Alien"/>

    <column name="table_name"/>

    <column name="id"/>

</any

>

<any
        name="propertyName"
        id-type="idtypename"
        meta-type="metatypename"
        cascade="cascade_style"
        access="field|property|ClassName"
        optimistic-lock="true|false"
>
        <meta-value ... />
        <meta-value ... />
        .....
        <column .... />
        <column .... />
        .....
</any
>

	`name`：属性名
	`id-type`：标识符类型
	`meta-type`（可选 -默认是 `string`）：允许辨别标志(discriminator)映射的任何类型。
	`cascade`（可选 — 默认是`none`）：级联的类型。
	`access`（可选 — 默认为 `property`）：Hibernate 用来访问属性值的策略。
	`optimistic-lock`（可选 — 默认是 `true`）：表明更新此组件是否需要获取乐观锁。换句话说，当这个属性变脏时，是否增加版本号（Version）。

`5.2. Hibernate 的类型`


<property name="twoStrings" type="org.hibernate.test.DoubleStringType">

    <column name="first_string"/>

    <column name="second_string"/>

</property

>

注意使用 <column> 标签来把一个属性映射到多个字段的做法。

CompositeUserType，EnhancedUserType，UserCollectionType 和 UserVersionType 接口为更特殊的使用方式提供支持。

你甚至可以在一个映射文件中提供参数给一个 UserType。为了这样做，你的 UserType 必须实现 org.hibernate.usertype.ParameterizedType 接口。为了给自定义类型提供参数，你可以在映射文件中使用 <type> 元素。


<property name="priority">

    <type name="com.mycompany.usertypes.DefaultValueIntegerType">

        <param name="default"

>0</param>

    </type>

</property

>

现在，UserType 可以从传入的 Properties 对象中得到 default 参数的值。

如果你非常频繁地使用某一 UserType，可以为他定义一个简称。这可以通过使用 <typedef> 元素来实现。Typedefs 为一自定义类型赋予一个名称，并且如果此类型是参数化的，还可以包含一系列默认的参数值。


<typedef class="com.mycompany.usertypes.DefaultValueIntegerType" name="default_zero">

    <param name="default"

>0</param>

</typedef

>


<property name="priority" type="default_zero"/>

也可以根据具体案例通过属性映射中的类型参数覆盖在 typedef 中提供的参数。

尽管 Hibernate 内建的丰富的类型和对组件的支持意味着你可能很少需要使用自定义类型。不过，为那些在你的应用中经常出现的(非实体)类使用自定义类型也是一个好方法。例如，一个 MonetaryAmount 类使用 CompositeUserType 来映射是不错的选择，虽然他可以很容易地被映射成组件。这样做的动机之一是抽象。使用自定义类型，以后假若你改变表示金额的方法时，它可以保证映射文件不需要修改。

`5.3. 多次映射同一个类`

对特定的持久化类，映射多次是允许的。这种情形下，你必须指定 entity name 来区别不同映射实体的对象实例。（默认情况下，实体名字和类名是相同的。） Hibernate 在操作持久化对象、编写查询条件，或者把关联映射到指定实体时，允许你指定这个 entity name（实体名字）。

<class name="Contract" table="Contracts"
        entity-name="CurrentContract">
    ...
    <set name="history" inverse="true"
            order-by="effectiveEndDate desc">
        <key column="currentContractId"/>
        <one-to-many entity-name="HistoricalContract"/>
    </set>
</class>

<class name="Contract" table="ContractHistory"
        entity-name="HistoricalContract">
    ...
    <many-to-one name="currentContract"
            column="currentContractId"
            entity-name="CurrentContract"/>
</class
>

注意这里关联是如何用 entity-name 来代替 class 的。

`5.4. SQL 中引号包围的标识符`

你可通过在映射文档中使用反向引号（`）把表名或者字段名包围起来，以强制 Hibernate 在生成的 SQL 中把标识符用引号包围起来。Hibernate 会使用相应的 SQLDialect（方言）来使用正确的引号风格(通常是双引号，但是在 SQL Server 中是括号，MySQL 中是反向引号)。


<class name="LineItem" table="`Line Item`">

    <id name="id" column="`Item Id`"/><generator class="assigned"/></id>

    <property name="itemNumber" column="`Item #`"/>

    ...

</class

>

`5.5. 其他元数据（Metadata）`

XML 并不适用于所有人, 因此有其他定义 Hibernate O/R 映射元数据（metadata）的方法。

`5.5.1. 使用 XDoclet 标记`

很多 Hibernate 使用者更喜欢使用 XDoclet@hibernate.tags 将映射信息直接嵌入到源代码中。我们不会在本文档中涉及这个方法，因为严格说来，这属于 XDoclet 的一部分。然而，我们包含了如下使用 XDoclet 映射的 Cat 类的例子。

package eg;

import java.util.Set;

import java.util.Date;


/**

 * @hibernate.class

 *  table="CATS"

 */

public class Cat {

    private Long id; // identifier

    private Date birthdate;

    private Cat mother;

    private Set kittens

    private Color color;

    private char sex;

    private float weight;


    /*

     * @hibernate.id

     *  generator-class="native"

     *  column="CAT_ID"

     */

    public Long getId() {

        return id;

    }

    private void setId(Long id) {

        this.id=id;

    }


    /**

     * @hibernate.many-to-one

     *  column="PARENT_ID"

     */

    public Cat getMother() {

        return mother;

    }

    void setMother(Cat mother) {

        this.mother = mother;

    }


    /**

     * @hibernate.property

     *  column="BIRTH_DATE"

     */

    public Date getBirthdate() {

        return birthdate;

    }

    void setBirthdate(Date date) {

        birthdate = date;

    }

    /**

     * @hibernate.property

     *  column="WEIGHT"

     */

    public float getWeight() {

        return weight;

    }

    void setWeight(float weight) {

        this.weight = weight;

    }


    /**

     * @hibernate.property

     *  column="COLOR"

     *  not-null="true"

     */

    public Color getColor() {

        return color;

    }

    void setColor(Color color) {

        this.color = color;

    }

    /**

     * @hibernate.set

     *  inverse="true"

     *  order-by="BIRTH_DATE"

     * @hibernate.collection-key

     *  column="PARENT_ID"

     * @hibernate.collection-one-to-many

     */

    public Set getKittens() {

        return kittens;

    }

    void setKittens(Set kittens) {

        this.kittens = kittens;

    }

    // addKitten not needed by Hibernate

    public void addKitten(Cat kitten) {

        kittens.add(kitten);

    }


    /**

     * @hibernate.property

     *  column="SEX"

     *  not-null="true"

     *  update="false"

     */

    public char getSex() {

        return sex;

    }

    void setSex(char sex) {

        this.sex=sex;

    }

}

`5.5.2. 使用 JDK 5.0 的注解（Annotation）`

JDK 5.0 在语言级别引入了 XDoclet 风格的标注，并且是类型安全的，在编译期进行检查。这一机制比 XDoclet 的注解更为强大，有更好的工具和 IDE 支持。例如，IntelliJ IDEA，支持 JDK 5.0 注解的自动完成和语法高亮。EJB 规范的新修订版 (JSR-220) 使用 JDK 5.0 的注解作为entity beans的主要元数据（metadata）机制。Hibernate 3 实现了JSR-220(the persistence API) 的 EntityManager，支持通过 Hibernate Annotations 包定义映射元数据。这个包作为单独的部分下载，支持 EJB3(JSR-220) 和 Hibernate3 的元数据。

这是一个被注解为 EJB entity bean 的 POJO 类的例子

@Entity(access = AccessType.FIELD)

public class Customer implements Serializable {


    @Id;

    Long id;


    String firstName;

    String lastName;

    Date birthday;


    @Transient

    Integer age;


    @Embedded

    private Address homeAddress;


    @OneToMany(cascade=CascadeType.ALL)

    @JoinColumn(name="CUSTOMER_ID")

    Set<Order

> orders;


    // Getter/setter and business methods

}

`注意`

注意：对 JDK 5.0 注解（和 JSR-220)支持的工作仍然在进行中,并未完成。更多细节请参阅 Hibernate Annotations 模块。

`5.6. 数据库生成属性（Generated Properties）`

Generated properties 指的是其值由数据库生成的属性。一般来说，如果对象有任何属性由数据库生成值，Hibernate 应用程序需要进行刷新（refresh）。但如果把属性标明为 generated，就可以转由 Hibernate 来负责这个动作。实际上。对定义了 generated properties 的实体,每当 Hibernate 执行一条 SQL INSERT 或者 UPDATE 语句，会立刻执行一条 select 来获得生成的值。

被标明为 generated 的属性还必须是 non-insertable 和 non-updateable 的。只有 versions、timestamps 和 simple properties 可以被标明为 generated。

never（默认）标明此属性值不是从数据库中生成。

insert — 标明此属性值在 insert 的时候生成，但是不会在随后的 update 时重新生成。比如说创建日期就归属于这类。注意虽然 version 和 timestamp 属性可以被标注为 generated，但是不适用这个选项。

always — 标明此属性值在 insert 和 update 时都会被生成。

`5.7. 字段的读写表达式`

Hibernate allows you to customize the SQL it uses to read and write the values of columns mapped to simple properties. For example, if your database provides a set of data encryption functions, you can invoke them for individual columns like this:

<!-- XML : generated by JHighlight v1.0 (http://jhighlight.dev.java.net) -->
<span class="xml_tag_symbols">&lt;</span><span class="xml_tag_name">property</span><span class="xml_plain">&nbsp;</span><span class="xml_attribute_name">name</span><span class="xml_tag_symbols">=</span><span class="xml_attribute_value">&quot;creditCardNumber&quot;</span><span class="xml_tag_symbols">&gt;</span><span class="xml_plain"></span><br />
<span class="xml_plain">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="xml_tag_symbols">&lt;</span><span class="xml_tag_name">column</span><span class="xml_plain">&nbsp;</span><br />
<span class="xml_plain">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="xml_attribute_name">name</span><span class="xml_tag_symbols">=</span><span class="xml_attribute_value">&quot;credit_card_num&quot;</span><span class="xml_plain"></span><br />
<span class="xml_plain">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="xml_attribute_name">read</span><span class="xml_tag_symbols">=</span><span class="xml_attribute_value">&quot;decrypt(credit_card_num)&quot;</span><span class="xml_plain"></span><br />
<span class="xml_plain">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="xml_attribute_name">write</span><span class="xml_tag_symbols">=</span><span class="xml_attribute_value">&quot;encrypt(?)&quot;</span><span class="xml_tag_symbols">/&gt;</span><span class="xml_plain"></span><br />
<span class="xml_tag_symbols">&lt;/</span><span class="xml_tag_name">property</span><span class="xml_plain"></span><br />
<span class="xml_tag_symbols">&gt;</span><span class="xml_plain"></span><br />

每当属性在查询里被引用时，Hibernate 都自动应用自定义的表达式。这种功能和 derived-property formula 相似，但有两个不同的地方：

属性由一个或多个属性组成，它作为自动模式生成的一部分导出。
属性是可读写的，非只读的。

如果指定了 write 表达式，它必须只包含一个“?”占位符。

`5.8. 辅助数据库对象（Auxiliary Database Objects）`

允许 CREATE 和 DROP 任意数据库对象，与 Hibernate 的 schema 交互工具组合起来，可以提供在 Hibernate 映射文件中完全定义用户 schema 的能力。虽然这是为创建和销毁 trigger（触发器）或stored procedure（存储过程）等特别设计的，实际上任何可以在 java.sql.Statement.execute() 方法中执行的 SQL 命令都可以在此使用（比如ALTER, INSERT，等等）。本质上有两种模式来定义辅助数据库对象...

第一种模式是在映射文件中显式声明 CREATE 和 DROP 命令：


<hibernate-mapping>

    ...

    <database-object>

        <create

>CREATE TRIGGER my_trigger ...</create>

        <drop

>DROP TRIGGER my_trigger</drop>

    </database-object>

</hibernate-mapping

>

第二种模式是提供一个类，这个类知道如何组织 CREATE 和 DROP 命令。这个特别类必须实现 org.hibernate.mapping.AuxiliaryDatabaseObject 接口。


<hibernate-mapping>

    ...

    <database-object>

        <definition class="MyTriggerDefinition"/>

    </database-object>

</hibernate-mapping

>

还有，这些数据库对象可以特别指定为仅在特定的方言中才使用。


<hibernate-mapping>

    ...

    <database-object>

        <definition class="MyTriggerDefinition"/>

        <dialect-scope name="org.hibernate.dialect.Oracle9iDialect"/>

        <dialect-scope name="org.hibernate.dialect.Oracle10gDialect"/>

    </database-object>

</hibernate-mapping

>