Hibernate注解的使用详解

1、配置映射关系的xml方式

        我们知道，Hibernate是一个典型的ORM框架，用以解决对象和关系的不匹配。其思想就是将关系数据库中表的记录映射成为对象，以对象形式展现，这样一来，就可以把对数据库的操作转化为对对象的操作。

       而ORM一般是采用xml的格式保存对象与关系数据表的映射，我们也可以从下面示例中看到hibernate中的一个映射配置表的表现形式：

<?xml version="1.0" encoding="utf-8"?> 
2
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
3
        "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
4
5
<hibernate-mapping>
6
    <class name="com.zker.model.job.SysJob" table="SYS_JOB" lazy="true">
7
        <id name="jobId" column="JOB_ID">
8
            <generator class="sequence">
9
                <param name="sequence">SEQ_SYS_JOB</param>
10
            </generator>
11
        </id>
12
        <property name="jobName" type="string" column="JOB_NAME" />
13
        <property name="jobDesc" type="string" column="JOB_DESC" />
14
        <property name="lastModity" type="timestamp" column="LAST_MODIFY" />
15
        <!--与用户关联-->
16
        <set name="sysUsers" table="SYS_USER">
17
            <key column="JOB_ID" />
18
            <one-to-many class="com.zker.model.user.SysUser" />
19
        </set>
20
21
    </class>
22
</hibernate-mapping>

2、注解的优点

而完成这个ORM映射关系配置的方式，还有一种，就是使用注解。

• 充分利用 Java 的反射机制获取类结构信息，这些信息可以有效减少配置的工作
• 注释和 Java 代码位于一个文件中，有助于增强程序的内聚性，便于程序员开发
• 使用注解就不用配置实体和数据库的映射文件了

下面我们来看看注解怎么用：

3、常用注解的使用方法

3.1 类级别的注解

• @Entity     映射实体类
• @Table      映射数句库表

@Entity(name = "tableName") - 必须，注解将一个类声明为一个实体bean，即指出该Java 类为实体类，将映射到指定的数据库表

• 属性：
• name - 可选，对应数据库中的一个表。若表名与实体类名相同，则可以省略

@Table(name = "", catalog = "", schema = "")  - 可选，通常和@Entity 配合使用，只能标注在实体的 class 定义处，表示实体对应的数据库表的信息

• 属性：
• name - 可选，表示表的名称，默认的表名和实体名称一致，只有在不一致的情况下才需要指定表名
• catalog - 可选，表示Catalog 名称，默认为 Catalog("")
• schema - 可选 , 表示 Schema 名称 , 默认为Schema("")

3.2 属性级别的注解

• @Id                                 映射生成主键
• @GeneratedValue         定义主键生成策略
• @SequenceGenerator  声明了一个数据库序列
• @Version                       定义乐观锁
• @Basic                           声明属性的存取策略
• @Column                       映射表的列
• @Transient                    定义暂态属性

属性级别的注解，都是放在其对应的getter前。

3.2.1 与主键相关注解

@Id - 必须，定义了映射到数据库表的主键的属性，一个实体只能有一个属性被映射为主键，置于 getXxx() 前

@GeneratedValue(strategy = GenerationType , generator="") - 可选，用于定义主键生成策略

• 属性：
• strategy - 表示主键生成策略，取值有：
  • GenerationType.AUTO 根据底层数据库自动选择（默认），若数据库支持自动增长类型，则为自动增长
  • GenerationType.INDENTITY 根据数据库的Identity字段生成，支持DB2、MySQL、MS、SQL Server、SyBase与HyperanoicSQL数据库的Identity类型主键
  • GenerationType.SEQUENCE 使用Sequence来决定主键的取值，适合Oracle、DB2等支持Sequence的数据库，一般结合@SequenceGenerator使用（Oracle没有自动增长类型，只能用Sequence）
  • GenerationType.TABLE  使用指定表来决定主键取值，结合@TableGenerator使用
• generator - 表示主键生成器的名称，这个属性通常和ORM框架相关 , 例如：Hibernate 可以指定 uuid 等主键生成方式

@SequenceGenerator — 注解声明了一个数据库序列

• 属性：
• name - 表示该表主键生成策略名称，它被引用在@GeneratedValue中设置的“gernerator”值中
• sequenceName - 表示生成策略用到的数据库序列名称
• initialValue - 表示主键初始值，默认为0
• allocationSize - 每次主键值增加的大小，例如设置成1，则表示每次创建新记录后自动加1，默认为50

3.2.2 与非主键相关注解

@Version - 可以在实体bean中使用@Version注解，通过这种方式可添加对乐观锁定的支持（见参考链接）

@Basic - 用于声明属性的存取策略：

• @Basic(fetch=FetchType.EAGER)   即时获取（默认的存取策略）
• @Basic(fetch=FetchType.LAZY)       延迟获取

@Column - 可将属性映射到列，使用该注解来覆盖默认值，@Column描述了数据库表中该字段的详细定义

• 属性：
• name - 可选，表示数据库表中该字段的名称，默认情形属性名称一致
• nullable - 可选，表示该字段是否允许为 null，默认为 true
• unique - 可选，表示该字段是否是唯一标识，默认为 false
• length - 可选，表示该字段的大小，仅对 String 类型的字段有效，默认值255
• insertable - 可选，表示在ORM框架执行插入操作时，该字段是否应出现INSETRT语句中，默认为 true
• updateable - 可选，表示在ORM 框架执行更新操作时，该字段是否应该出现在UPDATE 语句中，默认为 true。对于一经创建就不可以更改的字段，该属性非常有用，如对于 birthday 字段
• columnDefinition - 可选，表示该字段在数据库中的实际类型。通常ORM 框架可以根据属性类型自动判断数据库中字段的类型，但是对于Date 类型仍无法确定数据库中字段类型究竟是 DATE,TIME 还是 TIMESTAMP. 此外 ,String 的默认映射类型为 VARCHAR, 如果要将 String 类型映射到特定数据库的 BLOB或 TEXT 字段类型，该属性非常有用

@Transient - 可选，表示该属性并非一个到数据库表的字段的映射，ORM框架将忽略该属性，如果一个属性并非数据库表的字段映射，就务必将其标示为@Transient，否则ORM框架默认其注解为 @Basic

3.3 映射实体类的关联关系

单向一对多：一方有集合属性，包含多个多方，而多方没有一方的引用。用户--->电子邮件

单向多对一：多方有一方的引用，一方没有多方的引用。论文类别---> 类别

双向一对多：两边都有多方的引用，方便查询。班级---> 学生

双向多对一：两边都有多方的引用，方便查询。

单向多对多：需要一个中间表来维护两个实体表。论坛--->文章

单向一对一：数据唯一，数据库数据也是一对一。舰船---> 水手

主键相同的一对一：使用同一个主键，省掉外键关联。客户---> 地址

3.3.1 关联映射的一些共有属性

@JoinColumn - 可选，用于描述一个关联的字段。@JoinColumn和@Column类似，这个描述的不是一个简单字段，而是一个关联字段，例如描述一个 @ManyToOne 的字段。（即用来定义外键在我们这个表中的属性名，例如实体Order有一个User user属性来关联实体User，则Order的user属性为一个外键）

• 属性：
• name - 该字段的名称，由于@JoinColumn描述的是一个关联字段，如ManyToOne, 则默认的名称由其关联的实体决定

@OneToOne、@OneToMany、@ManyToOne、ManyToMany 的共有属性：

• fetch - 配置加载方式。取值有：
  • Fetch.EAGER -  及时加载，多对一默认是Fetch.EAGER eager
  • Fetch.LAZY - 延迟加载，一对多默认是Fetch.LAZY
• cascade - 设置级联方式，取值有：
  • CascadeType.PERSIST - 保存  - 调用JPA规范中的persist()，不适用于Hibernate的save()方法
  • CascadeType.REMOVE - 删除  - 调用JPA规范中的remove()时，适用于Hibernate的delete()方法
  • CascadeType.MERGE - 修改  - 调用JPA规范中merge()时，不适用于Hibernate的update()方法 
  • CascadeType.REFRESH - 刷新  - 调用JPA规范中的refresh()时，适用于Hibernate的flush()方法
  • CascadeType.ALL - 全部  - JPA规范中的所有持久化方法
• targetEntity - 配置集合属性类型，如：@OneToMany(targetEntity=Book.class)

@OneToOne – 表示一个一对一的映射:

主表类A与从表类B的主键值相对应
2
主表：
3
@OneToOne(cascade = CascadeType.ALL)
4
@PrimaryKeyJoinColumn
5
public B getB(){
6
  return b;
7
}

从表：无   

 
1
主表A中有一个从表属性是B类型的b
2
主表：
3
@OneToOne(cascade = CascadeType.ALL)
4
@JoinColumn(name="主表外键")   //这里指定的是数据库中的外键字段。
5
public B getB(){
6
  return b;
7
}
8
9
从表：无

 
1
主表A中有一个从表属性是B类型的b，同时，从表B中有一个主表属性是A类型的a
2
主表：
3
@OneToOne(cascade = CascadeType.ALL)
4
@JoinColumn(name="主表外键")   //这里指定的是数据库中的外键字段。
5
public B getB(){
6
  return b;
7
}
8
9
从表：
10
@OneToOne(mappedBy = "主表类中的从表属性")
11
public 主表类 get主表类(){
12
  return 主表对象
13
}