Hibernate 注解

本文由Hibernate注解版关联关系映射全解析+案例修改而来.

1、对象

1.Entity

@Entity(name=”EntityName”)
必须,name为可选,对应数据库中一的个表，此处的EntryName要注意，在代码中使用hql进行查询时，需要from Xxx，那么Xxx就是对应的此处的EntryName，所以要注意EntryName的命名，否则会出现映射问题。

2.Table

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

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

3.SequenceGenerator

可选 ，可写与类前或类内。
@SequenceGenerator(name=”teacherSEQ”, sequenceName=”teacherSEQ_DB”)
在属性中由@GeneratedValue中的generator指定。如果@SequenceGenerator直接写在@GeneratedValue后，@GeneratedValue的generator可不写 。
注意：@GeneratedValue中的generator不是sequence的名字，而是@SequenceGenerator中的name的名字；@SequenceGenerator中的sequenceName才是定义sequence的名字。

2、属性

注解到底是写在 get方法上，还是写在属性上，这个一定要统一，千万不能混淆使用，推荐写在getter方法上。

1.id

@id
必须

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

2.GeneratedValue

@GeneratedValue(strategy=GenerationType,generator=”“)
可选

strategy：表示主键生成策略，有AUTO、INDENTITY(使用于sql server,mysql数据库中,oracle不适用)、SEQUENCE(oracle使用)和 TABLE（用一张表给所有表的主键创建序列，跨数据库平台以后数据也不受影响） 4种，分别表示让ORM框架自动选择、根据数据库的Identity字段生成、根据数据库表的Sequence字段生成、以及根据一个额外的表生成主键。默认为AUTO

generator：表示主键生成器的名称，这个属性通常和ORM框架相关。例如，Hibernate可以指定uuid等主键生成方式

示例:

    @Id    @GeneratedValues(strategy=StrategyType.SEQUENCE)    public int getPk() {       return pk;    }

3.GenericGenerator

详细参看基于annotation的hibernate主键生成策略

4.Basic

@Basic(fetch=FetchType,optional=true)
可选

@Basic表示一个简单的属性到数据库表的字段的映射，对于没有任何标注的getXxxx()方法。默认即为@Basic

fetch：表示该属性的读取策略，有EAGER和LAZY两种，分别表示主支抓取和延迟加载。默认为EAGER
optional：表示该属性是否允许为null，默认为true
示例:

    @Basic(optional=false)    public String getAddress() {       return address;    }

5.Column

@Column
可选

@Column描述了数据库表中该字段的详细定义，这对于根据JPA注解生成数据库表结构的工具非常有作用
name：表示数据库表中该字段的名称。默认情形属性名称一致
nullable：表示该字段是否允许为null。默认为true
unique：表示该字段是否是唯一标识。默认为false
length：表示该字段的大小，仅对String类型的字段有效
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;    }

6.Transient

@Transient
可选

@Transient表示该属性并非一个到数据库表的字段的映射，ORM框架将忽略该属性

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

示例:

    //根据birth计算出age属性    @Transient    public int getAge() {       return getYear(new Date()) -getYear(birth);    }

3、关联映射

1.ManyToOne

@ManyToOne(fetch=FetchType,cascade=CascadeType)
可选

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

optional：是否允许该字段为null，该属性应该根据数据库表的外键约束来确定，默认为true
fetch：表示抓取策略，默认为FetchType.EAGER
cascade：表示默认的级联操作策略，可以指定为ALL、PERSIST、MERGE、REFRESH和REMOVE中的若干组合，默认为无级联操作
targetEntity：表示该属性关联的实体类型，该属性通常不必指定，ORM框架根据属性类型自动判断targetEntity

示例:

    //订单Order和用户User是一个ManyToOne的关系    //在Order类中定义    @ManyToOne()    @JoinColumn(name="USER")    public User getUser() {       return user;    }

2.JoinColumn

@JoinColumn
可选

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

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

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

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

示例:

见@ManyToOne 

3.OneToMany

@OneToMany(fetch=FetchType,cascade=CascadeType)
可选

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

fetch：表示抓取策略，默认为FetchType.LAZY，因为关联的多个对象通常不必从数据库预先读取到内存
cascade：表示级联操作策略，对于OneToMany类型的关联非常重要，通常该实体更新或删除时，其关联的实体也应当被更新或删除

例如：实体User和Order是OneToMany的关系，则实体User被删除时，其关联的实体Order也应该被全部删除

示例:

    @OneTyMany(cascade=ALL)    public List getOrders() {       return orders;    }

4.OneToOne

@OneToOne(fetch=FetchType,cascade=CascadeType)
可选

@OneToOne描述一个一对一的关联

fetch：表示抓取策略,默认为FetchType.LAZY

cascade：表示级联操作策略

示例:

    @OneToOne(fetch=FetchType.LAZY)    public Blog getBlog() {       return blog;    }

5.ManyToMany

@ManyToMany
可选

@ManyToMany描述一个多对多的关联，多对多关联上是两个一对多关联，但是在ManyToMany描述中，中间表是由ORM框架自动处理

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

mappedBy：表示多对多关联的另一个实体类的对应集合属性名称

4、其他

1.MappedSuperclass

@MappedSuperclass
可选

@MappedSuperclass可以将超类的JPA注解传递给子类,使子类能够继承超类的JPA注解

示例:

    @MappedSuperclass    public class Employee() {       ....    }    @Entity    public class Engineer extends Employee {       .....    }    @Entity    public class Manager extends Employee {       .....    }

1、标注为@MappedSuperclass的类将不是一个完整的实体类，他不会映射到数据库表，但是他的属性都将映射到其子类的数据库字段中。

2、标注为@MappedSuperclass的类不能再标注@Entity或@Table注解，也无需实现序列化接口。

3、如果一个标注为@MappedSuperclass的类继承了另外一个实体类或者另外一个同样标注了@MappedSuperclass的类的话，他将可以使用@AttributeOverride或@AttributeOverrides注解重定义其父类(无论是否是实体类)的属性映射到数据库表中的字段。比如可以重定义字段名或长度等属性，使用@AttributeOverride中的子属性@Column进行具体的定义。

注意：对于其父类中标注@Lob注解的属性将不能重载，并且@AttributeOverride里的@Column设置都将不起作用。JPA规范中对@Lob注解并没有说明不能同时标注@Column注解，但是在实际使用中Hibernate JPA不支持这种标注方式。

4、标注为@MappedSuperclass的类其属性最好设置为protected或default类型的，以保证其同一个包下的子类可以直接调用它的属性。

2.Embedded

@Embedded

可选

@Embedded将几个字段组合成一个类，并作为整个Entity的一个属性

例如User包括id、name、city、street、zip属性

我们希望city、street、zip属性映射为Address对象。这样，User对象将具有id、name和address这三个属性.

Address对象必须定义为@Embededable

示例:

    @Embeddable    public class Address {city,street,zip}    @Entity    public class User {       @Embedded       public Address getAddress() {          ..........      }

快捷键

• 加粗 Ctrl + B
• 斜体 Ctrl + I
• 引用 Ctrl + Q
• 插入链接 Ctrl + L
• 插入代码 Ctrl + K
• 插入图片 Ctrl + G
• 提升标题 Ctrl + H
• 有序列表 Ctrl + O
• 无序列表 Ctrl + U
• 横线 Ctrl + R
• 撤销 Ctrl + Z
• 重做 Ctrl + Y