hibernate.hbm.xml配置文件解析

 转自：https://www.cnblogs.com/uoar/p/6670612.html

1.

<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">  
<hibernate-mapping package="com.aegop.mto.pojo">  
    <!-- 标识一个类的xml映射,name为类名,table为表名 -->  
    <class name="Street" table="Streets">  
        <!-- 主键的设置,generator标识主键生成方式,因为native便于数据库的移植所以.嘿嘿!你懂的 -->  
        <id name="id" type="int">  
            <column name="Id"/>  
            <generator class="native"/>  
        </id>  
        <!-- 这里配了该类一个属性街道名称 name属性字段,column,数据库对应列 -->  
        <property name="streetName" type="string" column="StreetName" />  
        <!-- 这里同上,写法不同而已 -->  
        <property name="streetPhone" type="string">  
            <column name="Streetphone" />  
        </property>  
        <!-- 下面同样是配该类一个属性,只是比较特殊而已! DisrtictId它是对应实体（数据库中主键，hibernate有缺省）如果加property-ref=DistrictId，效果是一样！此属性用在有联合主键的时候-->  
        <many-to-one name="district" class="District">  
            <column name="DistrictId"/>  
        </many-to-one>  
    </class>  
</hibernate-mapping>  
 
//当column不指定的时候默认是和name相同 
 
//这里简单介绍,<property>简单类型的配置标签,<many-to-one>多对一的配置标签,以此xml为例,需要注意的是该xml是一个街道的实体映射,也就是说一个区可以包含多个街道,所以这里街道配置了和区的多对一关系! 
//name="district";这个仍然代表该类字段,不同的是class="District",他的类型没有用type,而是class!因为不是一个简单数据类型. 
 
//这个只是一个多对一的简单表述,其实一对一,多对多...等!道理是一样的 
 
//District.hbm.xml 
 
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">  
<hibernate-mapping package="com.aegop.mto.pojo">  
    <class name="District" table="Districts">  
        <id name="id" type="int">  
            <column name="Id"/>  
            <generator class="native"/>  
        </id>  
        <property name="districtName" type="string">  
            <column name="DistrictName"/>  
        </property>  
           
    </class>  
</hibernate-mapping>  

2.

一.hibernate映射文件的作用:

Hibernate映射文件是Hibernate与数据库进行持久化的桥梁

二，Hibernate映射文件主要内容:

    (1).映射内容的定义:

       Hibernate映射文件由节点定义映射内容并指定所对应的JavaBean的位置(也可以不在该节点中用package属性指定对应的JavaBean位置,而在该节点下的class节点中的name属性中指定)

    (2).数据库和JavaBean的关联:

      Hibernate映射文件中用<hibernate-mapping>节点下的

   

( 该节点的父节点中用package属性指定了JavaBean的包名时用)/全路径(该节点的父节点中没用package属性指定JavaBean的包名时用)

      (3).主键映射:

       在<class >节点下用

    节点映射对应的主键,该节点必须有且只有一个(因为主键只有一个),同时必须放在<property ...>节点前

        

       (4).普通字段映射:

        在<class ...>节点下用

        节点映射普通字段,该节点可有多个(一个字段用一个该节点来映射)  

三，heibernate的主键映射方式：  

      在<id ...>节点下用<generator class="映射方式"/>节点指定Hibernate向数据库插入数据时主键的生成方式

l assigned：应用程序自身对id赋值。当设置<generator class="assigned"/>时，应用程序自身需要负责主键id的赋值，id l native：由数据库对id赋值。当设置<generator class="native"/>时，数据库负责主键id的赋值，最常见的是int型的自增型主键。例如，在SQLServer中建立表的id字段为identity，配置了该生成器，程序员就不用为该主键设置值，它会自动设置。

lSQL Server、MySQL中的自增主键生成机制。

l hilo：通过hi/lo算法实现的主键生成机制，需要额外的数据库表保存主键生成历史状态。

l seqhilo：与hi/lo类似，通过hi/lo算法实现的主键生成机制，只是主键历史状态保存在sequence中，适用于支持sequence的数据库，如Oracle。

l

l sequence：采用数据库提供的sequence机制生成主键，用于用序列方式产生主键的数据库(如:Oracle、DB2等的Sequence),用于为long/short/int型列生成唯一标识,如:<generator class="sequence"><param name="sequence">序列名</param></generator>如Oracle sequence。

l uuid.hex：由Hibernate基于128位唯一值产生算法，根据当前设备IP、时间、JVM启动时间、内部自增量等4个参数生成十六进制数值（编码后长度为32位的字符串表示）作为主键。即使是在多实例并发运行的情况下，这种算法在最大程度上保证了产生id的唯一性。当然，重复的概率在理论上依然存在，只是概率比较小。一般而言，利用uuid.hex方式生成主键将提供最好的数据插入性能和数据平台适应性。

l uuid.string：与uuid.hex类似，只是对生成的主键进行编码（长度为16位）。在某些数据库中可能出现问题。

l l select：Hibernate 3新引入的主键生成机制，主要针对遗留系统的改造工程。

由于常用的数据库，如SQLServer、MySQL等，都提供了易用的主键生成机制（如auto-increase字段），可以在数据库提供的主键生成机制上，采用native生成器来配置主键生成方式。

四，映射文件的元素结构和属性

    1，根元素：<hibernate-mapping>，每一个hbm.xml文件都有唯一的一个根元素，包含一些可选的属性

<hibernate-mapping package="com.demo.hibernate.beans">
     <class name="User" ...>
</hibernate-mapping>

<hibernate-mapping>
    <class name="com.demo.hibernate.beans.User" ...>
</hibernate-mapping>

   
      (2).schema: 指定当前映射文件对应的数据库表的schema名
      (3).catalog: 指定当前映射文件对应的数据库表的catalog名
      (4).default-cascade: 设置默认的级联方式(默认值为none)
      (5).default-access: 设置默认的属性访问方式(默认值为property)
      (6).default-lazy: 设置对没有指定延迟加载的映射类和集合设定为延迟加载(默认值为true)
      (7).auto-import: 设置当前映射文件中是否可以在HQL中使用非完整的类名(默认值为true)

    hibernate-mapping节点的字节点：
     (1).class: 为当前映射文件指定对应的持久类名和对应的数据库表名
     (2).subclass: 指定多态持久化操作时当前映射文件对应的持久类的子类
     (3).meta: 设置类或属性的元数据属性
     (4).typedef: 设置新的Hibernate数据类型
     (5).joined-subclass: 指定当前联结的子类
     (6).union-subclass: 指定当前联结的子类
     (7).query: 定义一个HQL查询
     (8).sql-query: 定义一个SQL查询
     (9).filter-def: 指定过滤器

    2，<class>定义类：根元素的子元素，用以定义一个持久化类与数据表的映射关系,如下是该元素包含的一些可选的属性

      (1).name: 为当前映射文件指定对应的持久类名
        (3).schema: 设置当前指定的持久类对应的数据库表的schema名
         (4).catalog: 设置当前指定的持久类对应的数据库表的catalog名
         (5).lazy: 设置是否使用延迟加载
         (7).check: 指定一个SQL语句用于Schema前的条件检查
         (8).where: 指定一个附加的SQL语句的where条件
         (9).rowid: 指定是否支持ROWID
         (10).entity-name：实体名称 默认值为类名
         (11).subselect: 将不可变的只读实体映射到数据库的子查询中
         (12).dynamic-update: 指定用于update的SQL语句是否动态生成 默认值为false
         (13).dynamic-insert: 指定用于insert的SQL语句是否动态生成 默认值为false
         (14).insert-before-update: 设定在Hibernate执行update之前是否通过select语句来确定对象是否确实被修改了,如果该对象的值没有改变,update语句将不会被执行(默认值为false)
         (15).abstract: 用于在联合子类中标识抽象的超类(默认值为false)
         (16).emutable: 表明该类的实例是否是可变的 默认值为fals
         (17).proxy: 指定延迟加载代理类
         (18).polymorphism: 指定使用多态查询的方式 默认值为implicit
         (19).persister: 指定一个Persister类
         (20).discriminator-value: 子类识别标识 默认值为类名
         (21).optimistic-lock: 指定乐观锁定的策略 默认值为vesion
class节点的字节点：
     (1).id: 定义当前映射文件对应的持久类的主键属性和数据表中主键字段的相关信息
     (2).property: 定义当前映射文件对应的持久类的属性和数据表中字段的相关信息
     (3).sql-insert: 使用定制的SQL语句执行insert操作
     (4).sql-delete: 使用定制的SQL语句执行delete操作
     (5).sql-update: 使用定制的SQL语句执行update操作
     (6).subselect: 定义一个子查询
     (7).comment: 定义表的注释
     (8).composite-id: 持久类与数据库表对应的联合主键
     (9).many-to-one: 定义对象间的多对一的关联关系
     (10).one-to-one: 定义对象间的一对一的关联关系
     (11).any: 定义any映射类型
     (12).map: map类型的集合映射
     (13).set: set类型的集合映射
     (14).list: list类型的集合映射
     (15).array: array类型的集合映射
     (16).bag: bag类型的集合映射
     (17).primitive-array: primitive-array类型的集合映射
     (18).query: 定义装载实体的HQL语句
     (19).sql-query: 定义装载实体的SQL语句
     (20).synchronize: 定义持久化类所需要的同步资源
     (21).query-list: 映射由查询返回的集合
     (22).natural-id: 声明一个唯一的业务主键
     (23).join: 将一个类的属性映射到多张表中
     (24).sub-class: 声明多态映射中的子类
     (25).joined-subclass: 生命多态映射中的来连接子类
     (26).union-subclass: 声明多态映射中的联合子类
     (27).loader: 定义持久化对象的加载器
     (28).filter: 定义Hibernate使用的过滤器
     (29).component: 定义组件映射
     (30).dynamic-component: 定义动态组件映射
     (31).properties: 定义一个包含多个属性的逻辑分组
     (32).cache: 定义缓存的策略
     (33).discriminator: 定义一个鉴别器
     (34).meta: 设置类或属性的元数据属性
     (35).timestamp: 指定表中包含时间戳的数据
     (36).vesion: 指定表所包含的附带版本信息的数据

4，<id>定义主键：

     Hibernate使用OID(对象标识符)来标识对象的唯一性，OID是关系数据库中主键在Java对象模型中的等价物,在运行时,Hibernate根据OID来维持Java对象和数据库表中记录的对应关系

id节点的属性：
     (1).name: 指定当前映射对应的持久类的主键名
     (2).column: 指定当前映射对应的数据库表中的主键名(默认值为对应持久类的主键/属性名)
     (3).type: 指定当前映射对应的数据库表中的主键的数据类型
     (4).unsaved-value: 判断此对象是否进行了保存
     (5).daccess: Hibernate访问主键属性的策略(默认值为property)

 5.generator节点的属性:
     (1).class: 指定主键生成器
     (2).name: 指定当前映射对应的持久类的主键名
     (3).column: 指定当前映射对应的数据库表中的主键名(默认值为对应持久类中的主键名)
     (4).type: 指定当前映射对应的数据库中主键的数据类型
     (5)not-null: 设置该字段的值是否可以为null(默认值为false)
     (7).update: 设置update操作时是否包含本字段的数据(默认值为true)
     (8).insert: 设置insert操作时是否包含本字段的数据(默认值为true)
     (9).formula: 设置查询操作时该属性的值用指定的SQL来计算
     (10).access: Hibernate访问这个属性的策略(默认值为property)
     (11).lazy: 设置该字段是否采用延迟加载策略(默认值为false)
     (12).optimistic-lock: 指定此属性做更新操作时是否需要乐观锁定(默认值为true)

6.property节点的属性: 
     用于持久化类的属性与数据库表字段之间的映射,包含如下属性：

      (1)name：持久化类的属性名，以小写字母开头
      (2)column：数据库表的字段名
      (3)type：Hibernate映射类型的名字

     (4).formula: 设置当前节点对应的持久类中的属性的值由指定的SQL从数据库获取
注:指定的SQL必须用()括起来,指定SQL中使用列时必须用表的别名加.加列名的方式访问,但如果指定SQL中要使用当前映射对应的列时不能用表的别名加.加列名的方式访问,而是直接访问即可
  如:formula="(select tn.columnName from tableName tn where tn.columnName=当前映射中的属性名)"
     (5).unique: 设置该字段的值是否唯一(默认值为false)
     (6).not-null: 设置该字段的值是否可以为null(默认值为false)
     (7).not-found: 设置当当前节点对应的数据库字段为外键时引用的数据不存在时如何让处理(默认值为exception:产生异常,可选值为ignore:对不存在的应用关联到null)
     (8).property-ref: 设置关联类的属性名，此属性和本类的关联相对应 默认值为关联类的主键
     (9).entity-name: 被关联类的实体名
     (10).lazy: 指定是否采用延迟加载及加载策略(默认值为proxy:通过代理进行关联,可选值为true:此对象采用延迟加载并在变量第一次被访问时抓取、false:此关联对象不采用延迟加载)
     (11).access: Hibernate访问这个属性的策略(默认值为property)
     (12).optimistic-lock: 指定此属性做更新操作时是否需要乐观锁定(默认值为true)

7.one-to-one节点的属性:
     (1).name: 映射类属性的名字
     (2).class: 关联类的名字
     (3).formula: 绝大多数一对一关联都指向其实体的主键。在某些情况下会指向一个或多个字段或是一个表达式，此时可用一个SQL公式来表示
     (4).cascade: 设置级联操作时的级联类型
     (5).constrained: 表明当前类对应的表与被关联的表之间是否存在着外键约束 默认值为false
     (6).fetch: 设置抓取数据的策略 可选值为 join外连接抓取、select序列选择抓取
     (7).property-ref: 设置关联类的属性名，此属性和本类的主键相对应 默认值为关联类的主键
     (8).access: Hibernate访问这个属性的策略(默认值为property)
     (9).lazy: 指定是否采用延迟加载及加载策略 默认值为proxy通过代理进行关联 可选值为 true此对象采用延迟加载并在变量第一次被访问时抓取、false此关联对象不采用延迟加载
     (10).entity-name: 被关联类的实体名

8.many-to-one 元素:
     (1).name: 映射类属性的名字
     (2).class: 关联类的名字
     (3).formula: 绝大多数一对一关联都指向其实体的主键。在某些情况下会指向一个或多个字段或是一个表达式，此时可用一个SQL公式来表示
     (4).column: 中间关联表映射到目标关联表的关联字段
     (5).cascade: 设置级联操作时的级联类型
     (6).fetch: 设置抓取数据的策略 默认值为select序列选择抓取 可选值为join外连接抓取
     (7).lazy: 指定是否采用延迟加载及加载策略 默认值为proxy通过代理进行关联 可选值为 true此对象采用延迟加载并在变量第一次被访问时抓取、false此关联对象不采用延迟加载
     (8).update: 进行update操作时是否包含此字段
     (9).insert: 进行insert操作时是否包含此字段
     (10).not-found: 指定外键引用的数据不存在时如何让处理 默认值为exception产生异常 可选值为ignore对不存在的应用关联到null

9.many-to-many 元素
10.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序列选择抓取
   11.list 元素
   12.map 元素