Hibernate学习笔记整理(五)-----注解(总结)
一、什么是注解?
解析:来源:Hibernate提供了Hibernate Annotations扩展包,它可以替换复杂的hbm.xml文件( Annotations扩展包是hibernate-annotation-3.4.0GA.zip)
作用:使得Hibernate程序的开发大大的简化。利用注解后,可不用定义持久化类对应的*.hbm.xml,而直接以注解方式写入持久化类的实现中。
二、注解的优点
- 充分利用 Java 的反射机制获取类结构信息,这些信息可以有效减少配置的工作
- 注释和 Java 代码位于一个文件中,有助于增强程序的内聚性,便于程序员开发
三、常用注解的使用方法
2.1 类级别的注解
- @Entity 映射实体类
- @Table 映射数句库表
@Entity(name = "tableName") - 必须,注解将一个类声明为一个实体bean,即指出该Java 类为实体类,将映射到指定的数据库表
- 属性:
- name - 可选,对应数据库中的一个表。若表名与实体类名相同,则可以省略
@Table(name = "", catalog = "", schema = "") - 可选,通常和@Entity 配合使用,只能标注在实体的 class 定义处,表示实体对应的数据库表的信息
- 属性:
- name - 可选,表示表的名称,默认的表名和实体名称一致,只有在不一致的情况下才需要指定表名
- catalog - 可选,表示Catalog 名称,默认为 Catalog("")
- schema - 可选 , 表示 Schema 名称 , 默认为Schema("")
2.2 属性级别的注解
- @Id 映射生成主键
- @GeneratedValue 定义主键生成策略
- @SequenceGenerator 声明了一个数据库序列
- @Version 定义乐观锁
- @Basic 声明属性的存取策略
- @Column 映射表的列
- @Transient 定义暂态属性
属性级别的注解,都是放在其对应的getter前。
2.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
2.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
2.3 映射实体类的关联关系
2.3.1 关联映射的一些共有属性
@JoinColumn - 可选,用于描述一个关联的字段。@JoinColumn和@Column类似,介量描述的不是一个简单字段,而是一个关联字段,例如描述一个 @ManyToOne 的字段。(即用来定义外键在我们这个表中的属性名,例如实体Order有一个User user属性来关联实体User,则Order的user属性为一个外键)
- 属性:
- name - 该字段的名称,由于@JoinColumn描述的是一个关联字段,如ManyToOne, 则默认的名称由其关联的实体决定
@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)
@OneToOne – 表示一个一对一的映射
主表类A与从表类B的主键值相对应 主表: @OneToOne(cascade = CascadeType.ALL) @PrimaryKeyJoinColumn public B getB(){ return b; } 从表:无
主表A中有一个从表属性是B类型的b 主表: @OneToOne(cascade = CascadeType.ALL) @JoinColumn(name="主表外键") //这里指定的是数据库中的外键字段。 public B getB(){ return b; } 从表:无
主表A中有一个从表属性是B类型的b,同时,从表B中有一个主表属性是A类型的a 主表: @OneToOne(cascade = CascadeType.ALL) @JoinColumn(name="主表外键") //这里指定的是数据库中的外键字段。 public B getB(){ return b; } 从表: @OneToOne(mappedBy = "主表类中的从表属性") public 主表类 get主表类(){ return 主表对象 }
@OneToMany - 描述一个一对多的关联,该属性应该为集合类型,在数据库中并没有实际字段
单向一对多:一方有集合属性,包含多个多方,而多方没有一方的引用 @OneToMany 默认会使用连接表做一对多关联
//加上@JoinColumn(name="xxx_id") 后,则不会建中间表,他会在多的一端加上外键xxx_id,来维护他们之间的关系
双向一对多: 1)在多方 @ManyToOne @JoinColumn(name="自己的数据库外键列名") 2)在一方 @OneToMany(mappedBy="多端的关联属性名") @JoinColumn(name="对方的数据库外键列名")
@ManyToOne - 表示一个多对一的映射,该注解标注的属性通常是数据库表的外键
单向多对一:多方有一方的引用,一方没有多方的引用 在多方 @ManyToOne(targetEntity=XXXX.class) //指定关联对象 @JoinColumn(name="") //指定产生的外键字段名
双向多对一:配置方式同双向一对多
@ManyToMany - 可选,描述一个多对多的关联
- 属性:
- targetEntity - 表示多对多关联的另一个实体类的全名,例如:package.Book.class
- mappedBy - 用在双向关联中,把关系的维护权翻转。
单向多对多关联:
在主控方加入@ManyToMany注解即可。
双向多对多关联:
两个实体间互相关联的属性必须标记为@ManyToMany,并相互指定targetEntity属性。
有且只有一个实体的@ManyToMany注解需要指定mappedBy属性,指向targetEntity的集合属性名称。
2.3.2 关联映射的其他补充
@JoinTable其实同时也是配合@ManyToMany使用的,@ManyToMany注释表示该对象是多对多关系的一端,然后利用@JoinTable来定义关联关系(利用中间表来建立联系,
其中name属性指定中间表名称,joinColumns定义中间表与该表的外键关系,inverseJoinColumns属性定义了中间表与另外一端的外键关系。
@JoinTable - 定义关联表, 该关联表包含了指回实体表的外键(通过@JoinTable.joinColumns) 以及指向目标实体表的外键(通过@JoinTable.inverseJoinColumns)
如下表示:关联的表为“r_role_x_permission",其中关联外键为"role_id",该表又通过"permission_id"链接第三张表,即目标实体表 (class Role --> table "p_role") @ManyToMany @JoinTable(name = "r_role_x_permission", joinColumns = @JoinColumn(name = "role_id"), inverseJoinColumns = @JoinColumn(name = "permission_id")) public List<Permission> getPermissionList() { return permissionList; }
2.4 映射实体类的继承关系
首先参考这篇文章,很重要:hibernate映射继承关系(一):一张表对应一整棵类继承树,从文中可以知道,用一个表来存储对应的整个类别的数据,比如有Cat和Animal,Cat是Animal的子类,我仅用Animal一个表来存储Animal和Cat的字段和数据,而不是分成两个表。那么当我进行映射关系的时候,假如我要Cat类映射到Animal中Cat的部分,如何处理?在Animal中定义一个字段用来区分不同的表,比如Animal表中我额外增加字段名为Type,那么在Animal这一张表中,我们本属于Animal表内容的,该字段我们设置为animal,本属于Cat表的,该字段我们设置为cat。你可以理解为,新增加字段来用以在同一个表中区分不同类别的内容。
所以对应在注解上的使用的一个映射关系表示,就是这样的:对于”父类“,即准备用来囊括所有内容的那个表,我们需要定义这个对应的类为 @DiscriminatorColumn(name = "xxx", discriminatorType = DiscriminatorType.xxx) ,这里的name就是指定表中用来区别各类内容的字段,而对于”子类“,我们需要注解标明@DiscriminatorValue(xxx),这里的xxx即对应了父类中的 “区别用字段” 里的标识。
举例来说,就是假如我们希望将Animal和Cat的内容都只存储在Animal这张表里,那么为了区分内容,我们对于Animal这个表新增某字段如 type;Animal的类,注解为@DiscriminatorColumn(name = "type", discriminatorType = DiscriminatorType.STRING) ,同时设置@DiscriminatorValue("animal");Cat extends Animal,Cat的类,注解为@DiscriminatorValue(“cat");那么Animal这个表中,字段type中,为animal的元组映射Animal类,为cat的元组映射Cat类。
而这种方式,多用于数据库字典概念。
浙公网安备 33010602011771号