JPA 注解参考

2018-01-24 本文已影响244人聪明的奇瑞

@Entity：映射实体类，必须指定主键

属性	描述
name	可选，对应数据库中的一个表，若表名与实体类相同可忽略

@Table：配合@Entity使用，表示实体对应数据库表信息

属性	描述
name	可选，映射表的名称，默认表名和实体名一致
catalog	可选，表示catalog目录，一个目录包含多个schema
schema	可选，表示schema模式，一个schema包含多个表、视图等
uniqueConstraints	可选，为实体映射的表设置唯一的约束。该属性可以是一个@UniqueConstraint Annotation数组

@Indexed：定义索引

@Entity
@Table(name="person_table", indexes = {
        @Index(name="idx_person", columnList="name")
        })
@NamedQuery(
        name="simpleByTest",
        query="SELECT x FROM SimpleModel x WHERE x.test LIKE :test"
    )
public class Person {

    @Id
    @GeneratedValue
    private Long id;
    private String name;
    //...
}

@Embeddable：表示一个非 Entity 类可以嵌入到另一个 Entity 中作为属性存在
@Id：指定主键属性，可以指定一个或多个，如果定义多个则需要实现序列话接口，并且如果用字符串作为主键，则长度不能超过最大长度范围（默认String为Varchar255长度），可用@Column设置长度
@Column：指定数据库列

属性	描述
length	可选，指定长度大小
name	可选，字段名称，默认和属性名一致
nullable	可选，是否允许位 null
unique	可选，是否唯一
insertable	可选，表示该字段是否可以出现在 INSERT 语句中
updateable	可选，表示该字段是否可以更新，这对像 birthday 这些一旦创建不能更改属性很有用
columnDefinition	可选，指定创建列时的 SQL 语句

@GeneratedValue：指定主键生成策略

属性	描述
strategy	可选，表示主键生成策略，基于数据库自身功能
generator	可选，指定主键生成器名字，与 @GenericGenerator 结合使用，并与其 name 属性对应

strategy可选	描述
GenerationType.AUTO	根据底层数据库自动选择（默认）
GenerationType.INDENTITY	根据数据库的 Identity（自增长）字段生成
GenerationType.SEQUENCE	使用 Sequence（序列）来决定主键取值
GenerationType.TABLE	使用指定表来决定主键取值，结合 @TableGenerator

@GenericGenerator：定义主键生成器

属性	描述
name	主键生成器名字
strategy	生成策略有 identity（自增）、sequence（序列）、native（根据底层数据库使用不同的策略）、increment（自然递增，与identity不同的是不依赖于底层数据库，而是每次自增长1）、uuid（32位16进制字符串）、assigned（手工分配主键ID）

@Embedded：表示该属性是一个嵌入类，与 @Embedable 结合使用
@EmbeddedId：使用嵌入式主键类实现复合主键，嵌入主键类必须实现序列话接口，包含无参构造方法，覆盖 euqals 和 hashCode
@Transient：表示该属性不映射到表中的字段
@PrimaryKeyJoinColumn：两个实体通过主键关联需要使用该属性，不再添加新的外键列
@OneToOne：一对一单向关联

属性	描述
cascade	可选，表示级联关系
targetEntity	可选，表示关联的实体类型，默认为当前标注实体类
fetch	可选，抓取策略 LAZY、EAGER
optional	可选，表示关联实体能否存在null值，默认为true
mapperBy	可选，双向关联时使用，该属性指定关联实体中哪一个属性可引用到关联实体时采取抓取

cascade可选	描述
CascadeType.ALL	包含所有
CascadeType.PERSIST	级联新建
CascadeType.REMOVE	级联删除
CascadeType.REFRESH	级联刷新
CascadeType.MERGE	级联更新

@JoinColumn：定义外键，若 @ManyToOne、@OneToMany 设置@JoinColumn则不产生中间表，而是在多方添加一方的外键列

属性	描述
name	可选，生成的外键列字段名称，默认为：关联表的名称+"_"+关联表主键字段名
referencedColumnName	可选，默认情况下，关联实体的主键一般用来做外键，若不想使用主键作为外键，则需要设置改属性

@ManyToOne：多对一关联，会产生中间表

属性	描述
cascade	可选，表示级联关系
fetch	可选，抓取策略 LAZY、EAGER
optional	可选，表示关联实体能否存在null值，默认为true

@OneToMany：一对多关联，会产生中间表

属性	描述
cascade	可选，表示级联关系
targetEntity	可选，表示关联的实体类型，默认为当前标注实体类
fetch	可选，抓取策略 LAZY、EAGER
optional	可选，表示关联实体能否存在null值，默认为true
mapperBy	可选，双向关联时使用，该属性指定关联实体中哪一个属性可引用到关联实体时采取抓取

@ManyToMany：多对多，会产生中间表，配合 @JoinTable 设置中间表@org.hibernate.annotations.ForeignKey：name值为 "null" 时取消外键约束

---- 持续更新 ----

JPA 注解参考

猜你喜欢

热点阅读