Hibernate注解使用方法总结

最新推荐文章于 2022-05-31 17:16:54 发布

征途的博客

最新推荐文章于 2022-05-31 17:16:54 发布

阅读量318

点赞数

分类专栏： JavaEE 文章标签： hibernate entity

JavaEE 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

1. 类级别注解

@Entity 映射实体类

@Table 映射数句库表

@Entity(name="tableName") - 必须，注解将一个类声明为一个实体bean。

属性：

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

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

属性：

name - 可选，表示表的名称，默认地，表名和实体名称一致，只有在不一致的情况下才需要指定表名

catalog - 可选，表示Catalog名称，默认为 Catalog("").

schema - 可选 , 表示 Schema 名称 , 默认为Schema("").

2.属性级别注解

@Id 映射生成主键

@Version 定义乐观锁

@Column 映射表的列

@Transient 定义暂态属性

2.1 与主键相关注解

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

@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使用。

如：

@Id

@TableGenerator(name="tab_cat_gen",allocationSize=1)

@GeneratedValue(Strategy=GenerationType.Table)

Generator - 表示主键生成器的名称，这个属性通常和ORM框架相关 , 例如：

hibernate 可以指定 uuid 等主键生成方式

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

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

示例 :

@Id

@GeneratedValues(strategy=StrategyType.SEQUENCE)

public int getPk() {

return pk;

}

Hibernate的访问类型为field时，在字段上进行注解声；

访问类型为property时，在getter方法上进行注释声明。

2.2 与非主键相关注解

@Version - 可以在实体bean中使用@Version注解,通过这种方式可添加对乐观锁定的支持

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

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

@Basic(fetch=FetchType.LAZY) 延迟获取

@Temporal - 用于定义映射到数据库的时间精度：

@Temporal(TemporalType=DATE) 日期

@Temporal(TemporalType=TIME) 时间

@Temporal(TemporalType=TIMESTAMP) 两者兼具

@Column - 可将属性映射到列，使用该注解来覆盖默认值，@Column描述了数据库表中该字段的详细定义，这对于根据 JPA 注解生成数据库表结构的工具非常有作用。

属性：

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字段类型，该属性非常有用。

示例 :

@Column(name="BIRTH",nullable="false",columnDefinition="DATE")

public String getBithday() {

return birthday;

}

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

示例 :

// 根据 birth 计算出 age 属性

@Transient

public int getAge() {

return getYear(new Date()) - getYear(birth);

}

2.3无注解属性的默认值

如果属性为单一类型,则映射为@Basic，

否则,如果属性对应的类型定义了@Embeddable注解,则映射为@Embedded，

否则,如果属性对应的类型实现了Serializable, 则属性被映射为@Basic并在一个列中保存该对象的serialized版本，

否则,如果该属性的类型为Java.sql.Clob或 java.sql.Blob,则作为@Lob并映射到适当的LobType.。

3.映射继承关系

@Inheritance注解来定义所选择的策略. 这个注解需要在每个类层次结构(class hierarchy) 最顶端的实体类上使用

4.映射实体bean的关联关系

4.1关联映射的一些定义

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

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

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

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

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

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

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

单向：关系写哪边，就由谁管理。

双向：一般由多方管理。

@OneToMany(mappedBy="对方") //反向配置，对方管理。

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

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

fetch - 配置加载方式。取值有

Fetch.EAGER - 及时加载，多对一默认是Fetch.EAGER

Fetch.LAZY - 延迟加载，一对多默认是Fetch.LAZY

cascade - 设置级联方式，取值有：

CascadeType.PERSIST - 保存

CascadeType.REMOVE - 删除

CascadeType.MERGE - 修改

CascadeType.REFRESH - 刷新

CascadeType.ALL - 全部

targetEntity - 配置集合属性类型，如：@OneToMany(targetEntity=Book.class)

@JoinColumn - 可选，用于描述一个关联的字段。

@JoinColumn和@Column类似，介量描述的不是一个简单字段，而是一个关联字段，例如描述一个 @ManyToOne 的字段。

属性：

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

例如，实体 Order 有一个user 属性来关联实体 User, 则 Order 的 user 属性为一个外键 ,

其默认的名称为实体User的名称 + 下划线 + 实体User的主键名称

4.3 一对一关联

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

1.主表类A与从表类B的主键值相对应。
主表：@OneToOne(cascade = CascadeType.ALL)
@PrimaryKeyJoinColumn
public B getB(){

Return b;

}
从表：无

2.主表A中有一个从表属性是B类型的b

主表：@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="主表外键") //这里指定的是数据库中的外键字段。
public B getB(){

return b;

}

从表：无

3.主表A中有一个从表属性是B类型的b，同时，从表B中有一个主表属性是A类型的a
主表：@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="主表外键") //这里指定的是数据库中的外键字段。
public B getB(){

return b;

}
从表：@OneToOne(mappedBy = "主表类中的从表属性")
public 主表类 get主表类(){

return 主表对象

}
注意：@JoinColumn是可选的。默认值是从表变量名+"_"+从表的主键（注意，这里加的是主键。而不是主键对应的变量）。

4.4 多对一关联

@ManyToOne - 表示一个多对一的映射，该注解标注的属性通常是数据库表的外键。

1.单向多对一：多方有一方的引用，一方没有多方的引用。

在多方

@ManyToOne(targetEntity=XXXX.class) //指定关联对象

@JoinColumn(name="") //指定产生的外键字段名

2.双向多对一：配置方式同双向一对多。

示例 :

// 订单 Order 和用户 User 是一个 ManyToOne 的关系

// 在 Order 类中定义

@ManyToOne()

@JoinColumn(name="USER")

public User getUser() {

return user;

}

4.5 一对多关联

@OneToMany - 描述一个一对多的关联，该属性应该为集合类型，在数据库中并没有实际字段。

1.单向一对多：一方有集合属性，包含多个多方，而多方没有一方的引用。

@OneToMany 默认会使用连接表做一对多关联

添加@JoinColumn(name="xxx_id") 后，就会使用外键关联，而不使用连接表了。

2.双向一对多

1）在多方

@ManyToOne

@JoinColumn(name="自己的数据库外键列名")

2）在一方

@OneToMany(mappedBy="多端的关联属性名")

@JoinColumn(name="对方的数据库外键列名")

4.6 多对多关联

@ManyToMany - 可选，描述一个多对多的关联。

属性：

targetEntity - 表示多对多关联的另一个实体类的全名，例如：package.Book.class

mappedBy - 用在双向关联中，把关系的维护权翻转。

1.单向多对多关联：

在主控方加入@ManyToMany注解即可。

2.双向多对多关联：

两个实体间互相关联的属性必须标记为@ManyToMany，并相互指定targetEntity属性。有且只有一个实体的@ManyToMany注解需要指定mappedBy属性，指向targetEntity的集合属性名称。

以下为使用注解的实例：

我们以产品类型ProductType类和产品Product类为例，一个产品类型对应多个产品，删除产品类型将该类型下的所有产品同时删除。首先需要@OneToMany和@ManyToOne标签来设置外键约束。

在一对多的关系中，一是关系维护端（owner side），多是关系被维护端（inverse side）。

@OneToMany有5个属性：targetEntity，fetch，mappedBy，orphanRemoval，cascade

# targetEntity （Class targetEntity() default void.class;）属性表示默认关联的实体类型，默认为当前标注的实体类；
因为一对多的实体集合时保存在集合类中，因此必须指明集合类中保存的具体类型：
1）指定集合泛型的具体类型；如：public List<Product> getProducts() {...}
2）指定targetEntity属性类型；如：@OneToMany(targetEntity=Product.class,...)

# fetch (FetchType fetch() default LAZY;) 属性是该实体的加载方式，FetchType是枚举类型，值有两种：LAZY和EAGER。一对多，一的一方，FetchType默认是LAZY, 多的一方FetchType默认是EAGER。如果在字段中声明为Eager，那么在取得当前Bean时，同时会抓取Bean中的关联Bean值。即数据库查询多次。反之Lazy则在之后抓取提交查询。具体实验讲解：[Hibernate] - EAGER and LAZY

# mappedBy (String mappedBy() default "";) 属性用于双向关联实体时使用，用在关系的维护端指定关系的被维护端，在hibernate4中与外键标签@JoinColumn冲突，同时使用会报错；如:@OneToMany(targetEntity=Product.class,mappedBy="productType",...)。

#orphanRemoval （boolean orphanRemoval() default false;）属性作用是删除孤立记录，即外键为空的类型，默认为false。该属性为true时会根据外键执行级联删除，因为当你删除productType的记录时，会使product表的记录外键被删除变为孤立记录，该属性进而将孤立记录删除掉。但hibernate实际执行的语句是先删除product表中的记录，后删除productType表中的记录。

#cascade （CascadeType[] cascade() default {};）级联属性，默认为空。该属性其实是一个值为枚举类型CascadeType的数组，在jpa的CascadeType枚举类型里面，有PERSIST（级联保存操作）,MERGE（合并(merge=save+update)）,REMOVE（级联删除操作）,REFRESH（级联刷新操作）,DETACH（级联分离操作）,ALL（所有级联操作）等6个枚举变量，其中DETACH是jpa2.0新加入的变量。这些变量的作用和他们的名字一样，可以很清楚的辨别出。这里我现在仅仅用过级联删除操作，其他的操作都仅仅是从名字和注释上猜测的，留待以后测试。

上面是jpa的级联操作，但在网上很多教程中往往写到用CascadeType.DELETE_ORPHAN，该操作属于hibernate自身的级联操作，在hibernate4中已声明过时，并推荐使用orphanRemoval属性来级联删除记录。

在级联删除记录时，要先用hibernate.load()方法加载持久化对象，然后才能根据外键进行级联删除。至于load()方法和get()方法有什么不同，这里有一篇博文讲的不错：hibernate session的常用方法解析

注意：改变model类的时候可能需要重新建表，如果级联删除不成功可以试一下。

下面开始代码，首先是productType类，要求删除type的时候要删掉该type对应的所有product：

[java]

package com.nanwang.model;
import java.util.ArrayList;
import java.util.List;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.OneToMany;
import org.hibernate.annotations.Cascade;
import org.hibernate.annotations.CascadeType;
/**
* @author wang
* @date 2015年8月3日
*/
@Entity
public class ProductType {
private int id;
private String code;
private String name ;
private String country ;
//外键关系需要用集合类保存
private List<Product> products = new ArrayList<Product>();
@Id
@GeneratedValue
@Column(columnDefinition = "int")
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
@Column(columnDefinition = "varchar(40)")
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getCountry() {
return country;
}
public void setCountry(String country) {
this.country = country;
}
/**
* 用于hibernate级联删除，删除了产品类型，把它下面的产品一起删除
* @return
*/
@OneToMany(targetEntity=Product.class,orphanRemoval=true)
@JoinColumn(name="type") //该标签与@OneToMany中的mappedBy冲突,name属性要和product类中的name一样

[java

package com.nanwang.model;
import java.util.ArrayList;
import java.util.List;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.OneToMany;
import org.hibernate.annotations.Cascade;
import org.hibernate.annotations.CascadeType;
/**
* @author wang
* @date 2015年8月3日
*/
@Entity
public class ProductType {
private int id;
private String code;
private String name ;
private String country ;
//外键关系需要用集合类保存
private List<Product> products = new ArrayList<Product>();
@Id
@GeneratedValue
@Column(columnDefinition = "int")
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
@Column(columnDefinition = "varchar(40)")
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getCountry() {
return country;
}
public void setCountry(String country) {
this.country = country;
}
/**
* 用于hibernate级联删除，删除了产品类型，把它下面的产品一起删除
* @return
*/
@OneToMany(targetEntity=Product.class,orphanRemoval=true)
@JoinColumn(name="type") //该标签与@OneToMany中的mappedBy冲突,name属性要和product类中的name一样

[java]

//也可以去掉@JoinColumn(name="type")，在@OneToMany标签中加入mappedBy属性，如@OneToMany(targetEntity=Product.class,orphanRemoval=true,mappedBy="productType")值为在Product类中，ProductType属性的属性名

[java]

//也可以去掉@JoinColumn(name="type")，在@OneToMany标签中加入mappedBy属性，如@OneToMany(targetEntity=Product.class,orphanRemoval=true,mappedBy="productType")值为在Product类中，ProductType属性的属性名

[java]