Java、Hibernate(JPA)常用注解整理

小灰灰 2022-08-19 13:13 212阅读 0赞

## 一、详细说明 ##

1.  @Entity(name=”EntityName”)  
    必须,name为可选,对应数据库中一的个表
2.  @Table(name=””,catalog=””,schema=””)  
    可选,通常和@Entity配合使用,只能标注在实体的class定义处,表示实体对应的数据库表的信息  
    name:可选,表示表的名称.默认地,表名和实体名称一致,只有在不一致的情况下才需要指定表名  
    catalog:可选,表示Catalog名称,默认为Catalog(“”).  
    schema:可选,表示Schema名称,默认为Schema(“”).
3.  @id  
    必须，@id定义了映射到数据库表的主键的属性,一个实体只能有一个属性被映射为主键.置于getXxxx()前.
4.  @GeneratedValue(strategy=GenerationType,generator=””)  
    可选，strategy:表示主键生成策略,有AUTO,INDENTITY,SEQUENCE 和 TABLE 4种,分别表示让ORM框架自动选择,根据数据库的Identity字段生成,根据数据库表的Sequence字段生成,以有根据一个额外的表生成主键,默认为AUTO  
    generator:表示主键生成器的名称,这个属性通常和ORM框架相关,例如,Hibernate可以指定uuid等主键生成方式.  
    示例:

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

1.  、@Basic(fetch=FetchType,optional=true)  
    可选，@Basic表示一个简单的属性到数据库表的字段的映射,对于没有任何标注的getXxxx()方法,默认即为@Basic  
    fetch: 表示该属性的读取策略,有EAGER和LAZY两种,分别表示主支抓取和延迟加载,默认为EAGER.  
    optional:表示该属性是否允许为null,默认为true  
    示例:

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

1.  @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;
    }

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

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

1.  、@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;
    }

1.  @JoinColumn  
    可选，@JoinColumn和@Column类似,介量描述的不是一个简单字段,而一一个关联字段,例如.描述一个@ManyToOne的字段.  
    name:该字段的名称.由于@JoinColumn描述的是一个关联字段,如ManyToOne,则默认的名称由其关联的实体决定.  
    例如,实体Order有一个user属性来关联实体User,则Order的user属性为一个外键,  
    其默认的名称为实体User的名称+下划线+实体User的主键名称  
    示例:  
    见@ManyToOne
2.  @OneToMany(fetch=FetchType,cascade=CascadeType)  
    可选，@OneToMany描述一个一对多的关联,该属性应该为集体类型,在数据库中并没有实际字段.  
    fetch:表示抓取策略,默认为FetchType.LAZY,因为关联的多个对象通常不必从数据库预先读取到内存  
    cascade:表示级联操作策略,对于OneToMany类型的关联非常重要,通常该实体更新或删除时,其关联的实体也应当被更新或删除  
    例如:实体User和Order是OneToMany的关系,则实体User被删除时,其关联的实体Order也应该被全部删除  
    示例:

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

1.  @OneToOne(fetch=FetchType,cascade=CascadeType)  
    可选，@OneToOne描述一个一对一的关联  
    fetch:表示抓取策略,默认为FetchType.LAZY  
    cascade:表示级联操作策略  
    示例:

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

1.  、@ManyToMany  
    可选，@ManyToMany 描述一个多对多的关联.多对多关联上是两个一对多关联,但是在ManyToMany描述中,中间表是由ORM框架自动处理  
    targetEntity:表示多对多关联的另一个实体类的全名,例如:package.Book.class  
    mappedBy:表示多对多关联的另一个实体类的对应集合属性名称  
    示例:  
    User实体表示用户,Book实体表示书籍,为了描述用户收藏的书籍,可以在User和Book之间建立ManyToMany关联

@Entity
    public class User { 
        private List books;
        @ManyToMany(targetEntity=package.Book.class)
        public List getBooks() {
            return books;
        }
        public void setBooks(List books) {
            this.books=books;
        }
    }
    @Entity
    public class Book { 
        private List users;
        @ManyToMany(targetEntity=package.Users.class,    mappedBy=”books”)
        public List getUsers() {
            return users;
        }
        public void setUsers(List users) {
            this.users=users;
        }
    }

两个实体间相互关联的属性必须标记为@ManyToMany,并相互指定targetEntity属性,  
需要注意的是,有且只有一个实体的@ManyToMany注解需要指定mappedBy属性,指向targetEntity的集合属性名称  
利用ORM工具自动生成的表除了User和Book表外,还自动生成了一个User\_Book表,用于实现多对多关联  
13. @MappedSuperclass  
可选，@MappedSuperclass可以将超类的JPA注解传递给子类,使子类能够继承超类的JPA注解  
示例:

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

1.  @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() {
        }
    }

## 二、常用说明： ##

1.  @NotFound(action=NotFoundAction.IGNORE)  
    使用hibernate注解配置实体类的关联关系，在many-to-one,one-to-one关联中，一边引用自另一边的属性，如果属性值为某某的数据在数据库不存在了，hibernate默认会抛出异常。解决此问题，加上如下注解就可以了：  
    @NotFound(action=NotFoundAction.IGNORE)，意思是找不到引用的外键数据时忽略，NotFound默认是exception
2.  cascade = CascadeType.REFRESH，cascade=CascadeType.ALL  
    cascade表示级联操作  
    CascadeType.MERGE级联更新：若items属性修改了那么order对象保存时同时修改items里的对象。对应EntityManager的merge方法  
    CascadeType.PERSIST级联刷新：获取order对象里也同时也重新获取最新的items时的对象。对应EntityManager的refresh(object)方法有效。即会重新查询数据库里的最新数据  
    CascadeType.REFRESH级联保存：对order对象保存时也对items里的对象也会保存。对应EntityManager的presist方法  
    CascadeType.REMOVE级联删除：对order对象删除也对items里的对象也会删除。对应EntityManager的remove方法  
    CascadeType.PERSIST只有A类新增时，会级联B对象新增。若B对象在数据库存（跟新）在则抛异常（让B变为持久态）  
    CascadeType.MERGE指A类新增或者变化，会级联B对象（新增或者变化）  
    CascadeType.REMOVE只有A类删除时，会级联删除B类；  
    CascadeType.ALL包含所有；  
    CascadeType.REFRESH没用过。  
    综上：大多数情况用CascadeType.MERGE就能达到级联跟新又不报错，用CascadeType.ALL时要斟酌下CascadeType.REMOVE
3.  @Fetch:  
    定义了加载关联关系的获取策略. FetchMode 可以是  
    SELECT (在需要加载关联的时候触发select操作), SUBSELECT(只对集合有效,使用了子查询策略,详情参考Hibernate参考文档)  
    JOIN (在加载主实体(owner entity)的时候使用SQL JOIN来加载关联关系).  
    JOIN 将覆写任何延迟属性 (通过 JOIN策略加载的关联将不再具有延迟性).  
    fetch=FetchType.LAZY  
    Hibernate的数据加载方式：  
    1）.即时加载 immediately loading  
    实体加载完成后，立即加载其关联的数据。  
    2）.延迟加载lazy loading  
    实体相关联的数据在第一次访问时再进行读取。  
    3）.预先加载 eager loading  
    与immediately loading类似，但实体和相关联的数据是通过一条sql同时读取。  
    4）.批量加载 batch loading

## 三、Hibernate验证注解 ##

注解 适用类型 说明 示例

![这里写图片描述][20160115142701439]  
以上每个注解都可能性有一个message属性，用于在验证失败后向用户返回的消息，还可以三个属性上使用多个注解

[20160115142701439]: /images/20220731/be2e7282315b4684a2235e65f0af8a7d.png