Hibernate关联关系映射

1.  Hibernate关系映射基础

1.1.  Doctype

<!DOCTYPE hibernate-mapping PUBLIC “-//Hibernate/Hibernate Mapping DTD 3.0//EN”

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

指定根元素和dtd文件的命名空间。

1.2.  hibernate-mapping

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

 />

1)        schema (可选): 数据库schema的名称。

2)        catalog (可选): 数据库catalog的名称。

3)        default-cascade (可选 – 默认为 none): 默认的级联风格。

4)        default-access (可选 – 默认为property): Hibernate用来访问所有属性的策略。可以通过实现PropertyAccessor接口自定义。

5)        default-lazy (可选 – 默认为 true): 指定了未明确注明lazy属性的Java属性和集合类,Hibernate会采取什么样的默认加载风格。

6)        auto-import (可选 – 默认为 true): 指定我们是否可以在查询语言中使用非全限定的类名(仅限于本映射文件中的类)。

7)        package (可选): 指定一个包前缀,如果在映射文档中没有指定全限定的类名, 就使用这个作为包名。

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=”true|false”

        entity-name=”EntityName”

        check=”arbitrary sql check condition”

        rowid=”rowid”

        subselect=”SQL expression”

        abstract=”true|false”

        node=”element-name”

/>

1)        name (可选): 持久化类(或者接口)的Java全限定名。如果这个属性不存在,Hibernate将假定这是一个非POJO的实体映射。

2)        table (可选 – 默认是类的非全限定名): 对应的数据库表名。

3)        discriminator-value (可选 – 默认和类名一样): 一个用于区分不同的子类的值,在多态行为时使用。它可以接受的值包括 null 和 not null。

4)        mutable (可选,默认值为true):表明该类的实例是可变的或者不可变的。

5)        schema (可选): 覆盖在根<hibernate-mapping>元素中指定的schema名字。

6)        catalog (可选): 覆盖在根<hibernate-mapping>元素中指定的catalog名字。

7)        proxy (可选): 指定一个接口,在延迟装载时作为代理使用。 你可以在这里使用该类自己的名字。

8)        dynamic-update (可选, 默认为 false): 指定用于UPDATE 的SQL将会在运行时动态生成,并且只更新那些改变过的字段。

9)        dynamic-insert (可选, 默认为 false): 指定用于INSERT的 SQL 将会在运行时动态生成,并且只包含那些非空值字段。

10)    select-before-update (可选, 默认为 false): 指定Hibernate除非确定对象真正被修改了(如果该值为true),否则不会执行SQL UPDATE操作。在特定场合(实际上,它只在一个瞬时对象(transient object)关联到一个新的session中时执行的update()中生效),这说明Hibernate会在UPDATE 之前执行一次额外的SQL SELECT操作,来决定是否应该执行 UPDATE。

11)    polymorphism(多态) (可选, 默认值为 implicit(隐式) ): 界定是隐式还是显式的使用多态查询(这只在Hibernate的具体表继承策略中用到)。

12)    where (可选) 指定一个附加的SQLWHERE条件, 在抓取这个类的对象时会一直增加这个条件。

13)    persister (可选): 指定一个定制的ClassPersister。

14)    batch-size (可选,默认是1) 指定一个用于 根据标识符(identifier)抓取实例时使用的”batchsize”(批次抓取数量)。

15)    optimistic-lock(乐观锁定) (可选,默认是version):决定乐观锁定的策略。

Ø  version(版本检查)检查version/timestamp字段

Ø  all(全部)检查全部字段

Ø  dirty(脏检查)只检察修改过的字段

Ø  none(不检查)不使用乐观锁定

16)    lazy (可选): 通过设置lazy=”false”, 所有的延迟加载(Lazy fetching)功能将被全部禁用(disabled)。

17)    entity-name (可选,默认为类名):Hibernate3允许一个类进行多次映射(前提是映射到不同的表),并且允许使用Maps或XML代替Java层次的实体映射(也就是实现动态领域模型,不用写持久化类)。

18)    check (可选): 这是一个SQL表达式, 用于为自动生成的schema添加多行(multi-row)约束检查。

19)    rowid (可选):Hibernate可以使用数据库支持的所谓的ROWIDs,例如: Oracle数据库,如果你设置这个可选的rowid, Hibernate可以使用额外的字段rowid实现快速更新。ROWID是这个功能实现的重点,它代表了一个存储元组(tuple)的物理位置。

20)    subselect (可选): 它将一个不可变(immutable)并且只读的实体映射到一个数据库的 子查询中。当你想用视图代替一张基本表的时候,这是有用的,但最好不要这样做。

21)    abstract (可选): 用于在<union-subclass>的继承结构 (hierarchies)中标识抽象超类。

1.4.  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>

1)        name (可选): 标识属性的名字。

2)        type (可选): 标识Hibernate类型的名字。

3)        column (可选 – 默认为属性名): 主键字段的名字。

4)        unsaved-value (可选 – 默认为一个切合实际(sensible)的值): 一个特定的标识属性值,用来标志该实例是刚刚创建的,尚未保存。这可以把这种实例和从以前的session中装载过(可能又做过修改–译者注)但未再次持久化的实例区分开来。

5)        access (可选 – 默认为property):Hibernate用来访问属性值的策略。

1.5.  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提供了很多内置的实现。下面是一些内置生成器的快捷名字:

1)        increment 用于为long,short或者int类型生成唯一标识。只有在没有其他进程往同一张表中插入数据时才能使用。在集群下不要使用。

2)        identity 对DB2,MySQL,MS SQL Server, Sybase和HypersonicSQL的内置标识字段提供支持。返回的标识符是long, short 或者int类型的。

3)        sequence 在DB2,PostgreSQL,Oracle, SAP DB, McKoi中使用序列(sequence),而在Interbase中使用生成器(generator)。返回的标识符是long, short或者 int类型的。

4)        hilo 使用一个高/低位算法高效的生成long,short 或者 int类型的标识符。给定一个表和字段(默认分别是 hibernate_unique_key 和next_hi)作为高位值的来源。高/低位算法生成的标识符只在一个特定的数据库中是唯一的。

5)        seqhilo 使用一个高/低位算法来高效的生成long,short 或者 int类型的标识符,给定一个数据库序列(sequence)的名字。

6)        uuid 用一个128-bit的UUID算法生成字符串类型的标识符, 这在一个网络中是唯一的(使用了IP地址)。UUID被编码为一个32位16进制数字的字符串。

7)        guid 在MS SQLServer 和 MySQL 中使用数据库生成的GUID字符串。

8)        native 根据底层数据库的能力选择identity,sequence 或者hilo中的一个。

9)        assigned 让应用程序在save()之前为对象分配一个标示符。这是 <generator>元素没有指定时的默认生成策略。

10)    select 通过数据库触发器选择一些唯一主键的行并返回主键值来分配一个主键。

11)    foreign 使用另外一个相关联的对象的标识符。通常和<one-to-one>联合起来使用。

1.5.1.  increment

Ø  由Hibernate自动以递增方式生成标识符,每次增量为1。

Ø  优点:不依赖于底层数据库系统,适用于所有的数据库系统。

Ø  缺点:适用于单进程环境下,在多线程环境下很可能生成相同主键值,而且OID必须为数值类型,比如long,int,short类型

Ø  配置方式:

<id name=“id” type=”long” column=”ID”>

 <generator class=”increment”/>

</id>

1.5.2.  identity

Ø  由底层数据库生成标识符。

Ø  前提条件:数据库支持自动增长字段类型,比如(sql server,mysql),而且OID必须为数值类型,比如long,int,short类型。

Ø  配置文件:

<id name=”id” type=”long” column=”ID”>

                 <generator class=”identity”/>

         </id>

1.5.3.  sequence

Ø  依赖于底层数据库系统的序列

Ø  前提条件:需要数据库支持序列机制(如:oracle等),而且OID必须为数值类型,比如long,int,short类型。

Ø  配置文件:

<id name=”id” type=”java.lang.Long” column=”ID”>

                 <generator class=”sequence”>

     <param name=”sequence”>my_seq</param>

                 </generator>

         </id>

1.5.4.  native

Ø  native生成器能根据底层数据库系统的类型,自动选择合适的标识符生成器,因此非常适用于跨数据库平台开发,他会由Hibernate根据数据库适配器中的定义,自动采用identity,hilo,sequence的其中一种作为主键生成方式,但是OID必须为数值类型(比如long,short,int等)

Ø  配置文件:

<id name=”id” type=”java.lang.Integer” column=”ID”>

                 <generator class=”native”/>

</id>

1.5.5.  hilo

Ø  hilo标识符生成器由Hibernate按照一种high/low算法生成标识符,

他从数据库中的特定表的字段中获取high值,因此需要额外的数据库表

保存主键生成的历史状态,hilo生成方法不依赖于底层数据库,因此适

用于每一种数据库,但是OID必须为数值类型(long,int,shor类型)。

Ø  配置文件:

<id name=”id” type=”java.lang.Integer” column=”ID”>

        <generator class=”hilo”>

   <param name=”table”>my_hi_value</param>

   <param name=”column”>next_value</param>

        </generator>

</id>

1.5.6.  uuid标识符生成器

Ø  由Hibernate基于128位唯一值产生算法,根据当前设备IP,时间,JVM启动时间,内部自增量等4个参数生成16进制数值作为主键,OID一般使用是String类型。

Ø  配置文件:

<id name=”id” type=”java.lang.String” column=”ID”>

                 <generator class=”uuid”/>

</id>

1.5.7.  assigned标识符生成器

Ø  采用assign生成策略表示由应用程序逻辑来负责生成主键标识符,OID类型没有限制。

Ø  配置文件:

<id name=”id” type=”java.lang.Integer” column=”ID”>

                 <generator class=”assigned”/>

</id>

1.6.  property

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

/>

1)        name: 属性的名字,以小写字母开头。

2)        column (可选 – 默认为属性名字): 对应的数据库字段名。 也可以通过嵌套的<column>元素指定。

3)        type (可选): 一个Hibernate类型的名字。

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属性。

4)        update, insert (可选 – 默认为 true) : 表明用于UPDATE 和/或 INSERT 的SQL语句中是否包含这个被映射了的字段。这二者如果都设置为false 则表明这是一个“外源性(derived)”的属性,它的值来源于映射到同一个(或多个)字段的某些其他属性,或者通过一个trigger(触发器)或其他程序生成。

5)        formula (可选): 一个SQL表达式,定义了这个计算 (computed) 属性的值。计算属性没有和它对应的数据库字段。

6)        access (可选 – 默认值为property): Hibernate用来访问属性值的策略。

7)        lazy (可选 – 默认为 false): 指定 指定实例变量第一次被访问时,这个属性是否延迟抓取(fetched lazily)(需要运行时字节码增强)。

8)        unique (可选): 使用DDL为该字段添加唯一的约束。 同样,允许它作为property-ref引用的目标。

9)        not-null (可选): 使用DDL为该字段添加可否为空(nullability)的约束。

10)    optimistic-lock (可选 – 默认为 true): 指定这个属性在做更新时是否需要获得乐观锁定(optimistic lock)。换句话说,它决定这个属性发生脏数据时版本(version)的值是否增长。

11)    generated (可选 – 默认为 never): 表明此属性值是否实际上是由数据库生成的。

1.7.  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”

/>

1)        name: 属性名。

2)        column (可选): 外间字段名。它也可以通过嵌套的 <column>元素指定。

3)        class (可选 – 默认是通过反射得到属性类型):关联的类的名字。

4)        cascade(级联) (可选): 指明哪些操作会从父对象级联到关联的对象。

5)        fetch (可选 – 默认为 select): 在外连接抓取(outer-joinfetching)和序列选择抓取(sequential select fetching)两者中选择其一。

6)        update, insert (可选 – 默认为 true) 指定对应的字段是否包含在用于UPDATE 和/或 INSERT 的SQL语句中。如果二者都是false,则这是一个纯粹的“外源性(derived)”关联,它的值是通过映射到同一个(或多个)字段的某些其他属性得到或者通过trigger(触发器)、或其他程序生成。

7)         property-ref: (可选) 指定关联类的一个属性,这个属性将会和本外键相对应。 如果没有指定,会使用对方关联类的主键。

8)        access (可选 – 默认是property): Hibernate用来访问属性的策略。

9)        unique (可选): 使用DDL为外键字段生成一个唯一约束。此外, 这也可以用作property-ref的目标属性。这使关联同时具有 一对一的效果。

10)    not-null (可选): 使用DDL为外键字段生成一个非空约束。

11)    optimistic-lock (可选 – 默认为 true): 指定这个属性在做更新时是否需要获得乐观锁定(optimistic lock)。换句话说,它决定这个属性发生脏数据时版本(version)的值是否增长。

12)    lazy (可选 – 默认为 proxy): 默认情况下,单点关联是经过代理的。lazy=”no-proxy”指定此属性应该在实例变量第一次被访问时应该延迟抓取(fetche lazily)(需要运行时字节码的增强)。 lazy=”false”指定此关联总是被预先抓取。

13)    not-found (可选 – 默认为exception): 指定外键引用的数据不存在时如何处理: ignore会将行数据不存在视为一个空(null)关联。

14)    entity-name (可选): 被关联的类的实体名。

15)     formula (可选): SQL表达式,用于定义computed(计算出的)外键值。

1.8.  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”

/>

1)        name: 属性的名字。

2)        class (可选 – 默认是通过反射得到的属性类型):被关联的类的名字。

3)        cascade(级联) (可选) 表明操作是否从父对象级联到被关联的对象。

4)        constrained(约束) (可选) 表明该类对应的表对应的数据库表,和被关联的对象所对应的数据库表之间,通过一个外键引用对主键进行约束。这个选项影响save()和delete()在级联执行时的先后顺序以及决定该关联能否被委托(也在schema export tool中被使用).

5)        fetch (可选 – 默认设置为选择): 在外连接抓取或者序列选择抓取选择其一.

6)        property-ref: (可选) 指定关联类的属性名,这个属性将会和本类的主键相对应。如果没有指定,会使用对方关联类的主键。

7)        access (可选 – 默认是property): Hibernate用来访问属性的策略。

8)        formula (可选):绝大多数一对一的关联都指向其实体的主键。在一些少见的情况中,你可能会指向其他的一个或多个字段,或者是一个表达式,这些情况下,你可以用一个SQL公式来表示。(可以在org.hibernate.test.onetooneformula找到例子)

9)        lazy (可选 – 默认为 proxy): 默认情况下,单点关联是经过代理的。lazy=”no-proxy”指定此属性应该在实例变量第一次被访问时应该延迟抓取(fetche lazily)(需要运行时字节码的增强)。 lazy=”false”指定此关联总是被预先抓取。注意,如果constrained=”false”,不可能使用代理,Hibernate会采取预先抓取!

10)    entity-name (可选): 被关联的类的实体名。

1.9.  key

<key

        column=”columnname”

        on-delete=”noaction|cascade”

        property-ref=”propertyName”

        not-null=”true|false”

        update=”true|false”

        unique=”true|false”

/>

1)        column (可选): 外键字段的名称。也可以通过嵌套的 <column>指定。

2)        on-delete (可选, 默认是noaction): 表明外键关联是否打开数据库级别的级联删除。

3)        property-ref (可选): 表明外键引用的字段不是原表的主键(提供给遗留数据)。

4)        not-null (可选): 表明外键的字段不可为空(这意味着无论何时外键都是主键的一部分)。

5)        update (可选): 表明外键决不应该被更新(这意味着无论何时外键都是主键的一部分)。

6)        unique (可选): 表明外键应有唯一性约束 (这意味着无论何时外键都是主键的一部分)。

1.10.    实例

Employee.hbm.xml

<?xml version=“1.0” encoding=“utf-8”?>

<!DOCTYPE hibernate-mapping PUBLIC “-//Hibernate/Hibernate Mapping DTD 3.0//EN”

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

<!–

    Mapping file autogenerated by MyEclipse Persistence Tools

–>

<hibernate-mapping>

    <class name=“com.morris.hql.entity.Employee” table=“EMPLOYEE” schema=“SCOTT”>

        <id name=“empid” type=“java.lang.String”>

            <column name=“EMPID” length=“20” />

            <generator class=“assigned” />

        </id>

        <many-to-one name=“department” class=“com.morris.hql.entity.Department” fetch=“select”>

            <column name=“DEPTID” length=“20” />

        </many-to-one>

        <property name=“empname” type=“java.lang.String”>

            <column name=“EMPNAME” length=“20” not-null=“true” />

        </property>

    </class>

</hibernate-mapping>

Department.hbm.xml

<?xml version=“1.0” encoding=“utf-8”?>

<!DOCTYPE hibernate-mapping PUBLIC “-//Hibernate/Hibernate Mapping DTD 3.0//EN”

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

<!–

    Mapping file autogenerated by MyEclipse Persistence Tools

–>

<hibernate-mapping>

    <class name=“com.morris.hql.entity.Department” table=“DEPARTMENT” schema=“SCOTT”>

        <id name=“deptid” type=“java.lang.String”>

            <column name=“DEPTID” length=“20” />

            <generator class=“assigned” />

        </id>

        <property name=“deptname” type=“java.lang.String”>

            <column name=“DEPTNAME” length=“20” not-null=“true” />

        </property>

        <set name=“employees” inverse=“true”>

            <key>

                <column name=“DEPTID” length=“20” />

            </key>

            <one-to-many class=“com.morris.hql.entity.Employee” />

        </set>

    </class>

</hibernate-mapping>

标签