Hibernate_4 实体类映射文件.hbm.xml 介绍

首先看一个简单的 .hbm.xml 配置文件

Student.hbm.xml

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
"http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
<!-- Generated 2017-10-13 16:40:55 by Hibernate Tools 3.4.0.CR1 -->
<hibernate-mapping package="com.cfox.hibernate">
    <class name="Student" table="STUDENT_INFO" select-before-update="true">
        <id name="id" type="java.lang.Integer">
            <column name="ID" />
            <generator class="native" />
        </id>
        <property name="name" type="java.lang.String">
            <column name="NAME" />
        </property>
        <property name="age" type="int">
            <column name="AGE" />
        </property>
        <property name="joinDate" type="java.util.Date">
            <column name="JOINDATE" />
        </property>
    </class>
</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 (可选): 指定一个包前缀，如果在映射文档中没有指定全限定的类名， 就使用这个作为包名。

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: 指定是否使用延迟加载.
• mutable: 若设置为 true, 等价于所有的 <property> 元素的 update 属性为 false, 表示整个实例不能被更新. 默认为 true.
• discriminator-value: 指定区分不同子类的值. 当使用 <subclass/> 元素来定义持久化类的继承关系时需要使用该属性

OID 映射对象标识符

• Hibernate 使用对象标识符(OID) 来建立内存中的对象和数据库表中记录的对应关系. 对象的 OID 和数据表的主键对应. Hibernate 通过标识符生成器来为主键赋值
• Hibernate 推荐在数据表中使用代理主键, 即不具备业务含义的字段. 代理主键通常为整数类型, 因为整数类型比字符串类型要节省更多的数据库空间.
• 在对象-关系映射文件中, <id> 元素用来设置对象标识符. <generator> 子元素用来设定标识符生成器.
• Hibernate 提供了标识符生成器接口: IdentifierGenerator, 并提供了各种内置实现

id：设定持久化类的 OID 和表的主键的映射

• name: 标识持久化类 OID 的属性名
• column: 设置标识属性所映射的数据表的列名(主键字段的名字).
• unsaved-value:若设定了该属性, Hibernate 会通过比较持久化类的 OID 值和该属性值来区分当前持久化类的对象是否为临时对象
• type:指定 Hibernate 映射类型. Hibernate 映射类型是 Java 类型与 SQL 类型的桥梁. 如果没有为某个属性显式设定映射类型, Hibernate 会运用反射机制先识别出持久化类的特定属性的 Java 类型, 然后自动使用与之对应的默认的 Hibernate 映射类型。
• Java 的基本数据类型和包装类型对应相同的 Hibernate 映射类型. 基本数据类型无法表达 null, 所以对于持久化类的 OID 推荐使用包装类型

generator

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

表示生成器	描述
increment	适用于代理主键。 由Hibernate 自动以递增方式生成。
identity	适用于代理主键。 由底层数据库生成标识符。
sequence	使用于代理主键。 Hibernate根据底层数据库的序列生成标识符，这要求底层数据库支持序列。
hilo	适用于代理主键。HIbernate 分局 high/low算法生成标识符。
seqhilo	适用于代理主键。使用一个高/低位算法来高效的生成long , short 或者int类型的标识符。
native	适用于代理主键。根据底层数据库对自动生成标识符的方式，自动选择identity 、 sequence 或 hilo
uuid.hex	使用于代理主键。Hibernate 采用 128位 UUID算法生成标识符。
uuid.string	适用于代理主键。UUID 被编码成一个 16 字符的字符串
assigned	使用于自然主键。Java 应用程序负责生成标识符
foreign	适用于代理主键。使用另外一个相关的对象的标识符

Hibernate提供的内置标识符生成器:

表示生成器	描述
increment	适用于代理主键。 由Hibernate 自动以递增方式生成。
identity	适用于代理主键。 由底层数据库生成标识符。
sequence	使用于代理主键。 Hibernate根据底层数据库的序列生成标识符，这要求底层数据库支持序列。
hilo	适用于代理主键。HIbernate 分局 high/low算法生成标识符。
seqhilo	适用于代理主键。使用一个高/低位算法来高效的生成long , short 或者int类型的标识符。
native	适用于代理主键。根据底层数据库对自动生成标识符的方式，自动选择identity 、 sequence 或 hilo
uuid.hex	使用于代理主键。Hibernate 采用 128位 UUID算法生成标识符。
uuid.string	适用于代理主键。UUID 被编码成一个 16 字符的字符串
assigned	使用于自然主键。Java 应用程序负责生成标识符
foreign	适用于代理主键。使用另外一个相关的对象的标识符

• increment 标识符生成器

  • increment 标识符生成器由 Hibernate 以递增的方式为代理主键赋值
  • Hibernate 会先读取映射数据库表中的主键的最大值, 而接下来向 NEWS 表中插入记录时, 就在 max(id) 的基础上递增, 增量为 1.
  • 适用范围:
    • 由于 increment 生存标识符机制不依赖于底层数据库系统, 因此它适合所有的数据库系统
    • 适用于只有单个 Hibernate 应用进程访问同一个数据库的场合, 在没有其他进程往同一张表中插入数据时才能使用。 在集群下不要使用。
    • OID 必须为 long, int 或 short 类型, 如果把 OID 定义为 byte 类型, 在运行时会抛出异常

• identity 标识符生成器

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

  <id name="id" type="int">
      <column name="ID" />
      <generator class="identity" />
  </id>
  

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

• sequence 标识符生成器

  • sequence 标识符生成器利用底层数据库提供的序列来生成标识符.
  • Hibernate 在持久化一个映射对象时, 先从底层数据库的 student_seq 序列中获得一个唯一的标识号, 再把它作为主键值

  <id name="id" type="int">
      <column name="ID" />
      <generator class="sequence " >
          <param name="sequence">student_seq</param>
      </generator>
  </id>
  

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

• hilo 标识符生成器

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

  <id name="id" type="int">
      <column name="ID" />
      <generator class="hilo" >
          <param name="table">high_val</param>  
          <param name="column">nextval</param>  
          <param name="max_lo">5</param>  
      </generator>
  </id>
  

  • Hibernate 在持久化一个 News 对象时, 由 Hibernate 负责生成主键值. hilo 标识符生成器在生成标识符时, 需要读取并修改 HI_TABLE 表中的 NEXT_VALUE 值.
  • 适用范围:
    • 由于 hilo 生存标识符机制不依赖于底层数据库系统, 因此它适合所有的数据库系统
    • OID 必须为 long, int 或 short 类型, 如果把 OID 定义为 byte 类型, 在运行时会抛出异常
  • 讨论：

  默认请况下使用的表是  
  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 标识符生成器.

  <id name="id" type="int">
      <column name="ID" />
      <generator class="native" />
  </id>
  

• 适用范围:

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

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

先看一个例子：

• 映射的类

  public class Student {
      
      private Integer id;
      private String name;
      private String desc;
      private int age;
      private Date joinDate;
      
      ......
      //get he set 方法省略
      
  }
  

• 映射文件：

  <?xml version="1.0"?>
  <!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
  "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
  <!-- Generated 2017-10-13 16:40:55 by Hibernate Tools 3.4.0.CR1 -->
  <hibernate-mapping package="com.cfox.hibernate">
      <class name="Student" table="STUDENT_INFO" select-before-update="true">
          <id name="id" type="java.lang.Integer">
              <column name="ID" />
              <generator class="native" />
          </id>
          <property name="name" type="java.lang.String">
              <column name="NAME" />
          </property>
          <property name="age" type="int">
              <column name="AGE" />
          </property>
          <property name="joinDate" type="java.util.Date">
              <column name="JOINDATE" />
          </property>
          <!-- 映射派生属性 -->
          <property name="desc" formula="(SELECT concat(name , ':', age) FROM STUDENT_INFO st WHERE st.id=id)"></property>
      </class>
  </hibernate-mapping>
  

在上面的代码中使用了formula， 下面看一下使用简单介绍：

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