Spring Boot 学习研究笔记(九) - Spring Data JPA常用注解

Spring Data JPA 常用注解详细说明

 

1、@Entity

Entity 说明这个class 是实体类，并且使用默认的orm 规则，即 class 名对应数据库表中的表明，class 字段名即表中的字段名。 如果想要改变这种默认的orm 规则，就要使用 @Table 来改变 class 名与数据库中表名的映射规则，@Column 来改变class 中字段与 db 中表的字段名的映射规则。

 

元数据属性说明：

name:表名

下面的示例说明，Custommer 类对应数据库中的 Custommer 表，其中name 为可选，缺省类名即表名！

  @Entity(name=”Customer”)   public class Customer { ... }

2、@Table

Table 用来定义 entity 主表的name 、catalog 、schema 等属性。

元数据属性说明：

name : 表名

catalog：对应关系数据库中的 catalog

schema：对应关系数据库中的 schema

UniqueConstraints：定义一个UniqueConstraint 数组，指定需要建唯一的约束的列。

schema与catalog的理解

sql环境中Catalog和Schema都属于抽象概念，主要用来解决命名冲突问题。一个数据库系统包含多个Catalog,每个Catalog包含多个Schema，每个Schema包含多个数据库对象（表、视图、字段等）。

数据库的完全限定名称可以为 Catalog名称.Schema名称.表名称。

 

UniqueConstraint的理解

定义在Table或SecondaryTable元数据里，用来指定建表时需要建唯一约束的列。

元数据属性说明： columnNames:定义一个字符串数组，指定要建唯一约束的列名。

 

联合约束:

@Entity
@Table(name="tbl_sky",
  uniqueConstraints = {@UniqueConstraint(columnNames={"month", "day"})})

单一字段约束:

@Entity
@Table(name="tbl_sky",
  uniqueConstraints = {@UniqueConstraint(columnNames="month")})

3、@Id

@Id 标注用于声明一个实体类的属性映射为数据库的主键列。该属性通常置于属性声明语句之前，可与声明语句同行，也可写在单独行上。@Id标注也可置于属性的getter方法之前。 元数据属性说明： • generate():主键值的获取类型 • generator():TableGenerator的名字（当generate=GeneratorType.TABLE才需要指定该属性）

@Table(name="CUSTOMERS")
@Entity
public class Customer {
    @GeneratedValue(strategy=GenerationType.AUTO)
    @Id
    private Integer id

 

4、@GeneratedValue

@GeneratedValue 用于标注主键的生成策略，通过strategy 属性指定。默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略。

GeneratedValue推荐两种写法：

第一种，写在属性之上：

@Table(name="CUSTOMERS")
@Entity
public class Customer {
    @GeneratedValue(strategy=GenerationType.AUTO)
    @Id
    private Integer id;
    private String name;
    private String email;
    private int age;
 
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }

 

第二种，写在getter方法之上：

@Table(name="CUSTOMERS")
@Entity
public class Customer {
    private Integer id;
    private String name;
    private String email;
    private int age;
 
    @GeneratedValue(strategy=GenerationType.AUTO)
    @Id
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }

GenerationType :

JPA提供的四种标准用法为 TABLE，SEQUENCE，IDENTITY，AUTO。

• TABLE：使用一个特定的数据库表格来保存主键。
• SEQUENCE：根据底层数据库的序列来生成主键，条件是数据库支持序列。
• IDENTITY：主键由数据库自动生成（主要是自动增长型）
• AUTO：主键由程序控制。
   

（1）、TABLE：

@Id  
@GeneratedValue(strategy = GenerationType.TABLE, generator="payablemoney_gen")  
@TableGenerator(name = "pk_gen",  
    table="tb_generator",  
    pkColumnName="gen_name",  
    valueColumnName="gen_value",  
    pkColumnValue="PAYABLEMOENY_PK",  
    allocationSize=1  
)

在主键生成后，这条记录的value值，按allocationSize递增。

@TableGenerator 定义如下：

@Target({TYPE, METHOD, FIELD})   
@Retention(RUNTIME)  
public @interface TableGenerator {  
  String name();  
  String table() default "";  
  String catalog() default "";  
  String schema() default "";  
  String pkColumnName() default "";  
  String valueColumnName() default "";  
  String pkColumnValue() default "";  
  int initialValue() default 0;  
  int allocationSize() default 50;  
  UniqueConstraint[] uniqueConstraints() default {};  
}

 

@TableGenerator属性说明如下：

• name ：属性表示该表主键生成策略的名称，它被引用在@GeneratedValue中设置的“generator”值。
• table： 属性表示表生成策略所持久化的表名，例如，这里表使用的是数据库中的“tb_generator”。
• catalog 属性和 schema属性具体指定表所在的目录名或是数据库模式名。
• pkColumnName： 属性的值表示在持久化表中，该主键生成策略所对应键值的名称。例如在“tb_generator”中将“gen_name”作为主键的键值。
• valueColumnName： 属性的值表示在持久化表中，该主键当前所生成的值，它的值将会随着每次创建累加。例如，在“tb_generator”中将“gen_value”作为主键的值。
• pkColumnValue： 属性的值表示在持久化表中，该生成策略所对应的主键。例如在“tb_generator”表中，将“gen_name”的值为“CUSTOMER_PK”。
• initialValue： 表示主键初始值，默认为0。
• allocationSize： 表示每次主键值增加的大小。例如设置成1，则表示每次创建新记录后自动加1，默认为50。
• UniqueConstraint： 与@Table标记中的用法类似。

 

(2)、SEQUENCE

@Id  
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator="payablemoney_seq")  
@SequenceGenerator(name="payablemoney_seq", sequenceName="seq_payment")

@SequenceGenerator定义如下：

@Target({TYPE, METHOD, FIELD})   
@Retention(RUNTIME)  
public @interface SequenceGenerator {  
 String name();  
 String sequenceName() default "";  
 int initialValue() default 0;  
 int allocationSize() default 50;  
}

以上属性说明如下：

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

（3）、IDENTITY

@Id  
@GeneratedValue(strategy = GenerationType.IDENTITY)

（4）、AUTO

@Id  
@GeneratedValue(strategy = GenerationType.AUTO)

在指定主键时，如果不指定主键生成策略，默认为AUTO。

 

5、@Basic

@Basic 是实体类与数据库字段映射时最简单的类型。它可以用于持久类属性或实例变量（instance variable）上，类型包含java基本类型（byte，short，int，long,float，double,char,boolean），包装类，枚举类，以及实现了Serializable接口的类型。

@basic注解有两个属性：

FetchType fetch() default EAGER; boolean optional() default true; fetch用来指定属性的加载机制 有两个选项：EAGER（即时加载，默认值）和LAZY（懒加载），即时加载意味着当实例化对象的时候必须加载该属性值，懒加载是指当实例化对象时不加载该属性，只有当调用该属性时才加载. optional用来指定属性是否可空 有两个选项：true（可空，默认值）和false 如果你在实体类属性上不加@Basic注解，它也会自动加上@Basic，并使用默认值。

 

6、@Column

Column元数据定义了映射到数据库的列的所有属性：列名，是否唯一，是否允许为空，是否允许更新等。

元数据属性说明： • name:列名。 • unique: 是否唯一 • nullable: 是否允许为空 • insertable: 是否允许插入 • updatable: 是否允许更新 • columnDefinition: 定义建表时创建此列的DDL

• secondaryTable: 从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字。

 

public class Person { @Column(name = "PERSONNAME", unique = true, nullable = false, updatable = true) private String name; @Column(name = "PHOTO", columnDefinition = "BLOB NOT NULL", secondaryTable="PER_PHOTO") private byte[] picture;

columnDefinition可以指定创建表时一些SQL语句，比如这里可以一次性指定，varchar长度128，且不能为空 . 当然，相同的结果可以通过nullable和length属性结合实现。

@Table(name = "CUSTOMERS")
@Entity
public class Customer {
    @Column(name = "ID")
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Id
    private Integer id;
    @Column(name = "Name")
    private String name;
    @Column(name = "Email", nullable = true, length = 128)
    private String email;
    @Column(name = "Age")
    private int age;
    ......
}

 

columnDefinition属性的特殊使用： 编程语言中字符串一般都用String表示，但是数据库中varcahr数值类型有长度限制，一旦需要大文本，则需要text数值类型 但是String类型默认映射的数值类型是varchar，columnDefinition可以进行额外指定。

@Table(name = "CUSTOMERS")
@Entity
public class Customer {
    @Column(name = "ID")
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Id
    private Integer id;
    @Column(name = "Name")
    private String name;
    @Column(name = "Email", nullable = true, length = 128)
    private String email;
    @Column(name = "Age")
    private int age;
    @Column(name = "Remark",columnDefinition="text")
    private String remark;
    ......
}

7、@IdClass

当entity class 使用复合主键时，需要定义一个类作为id class。

id class 必须符合以下要求：

类必须声明为public , 并提供一个声明为public 的空构造函数。

必须实现Serializable 接口，覆写 equals() 和 hashCode()方法。

entity class的所有id field在id class都要定义，且类型一样。

元数据属性说明：

value: id class的类名

public class EmployeePK implements java.io.Serializable{
       String empName;
       Integer empAge;

	   public EmployeePK(){}

	   public boolean equals(Object obj){ ......}
	   public int hashCode(){......}
    }


    @IdClass(value=com.acme.EmployeePK.class)
    @Entity(access=FIELD)
    public class Employee {
        @Id String empName;
        @Id Integer empAge;
    }

 

8、@MapKey

在一对多，多对多关系中，我们可以用Map来保存集合对象。默认用主键值做key，如果使用复合主键，则用id class的实例做key，如果指定了name属性，就用指定的field的值做key。

元数据属性说明： name: 用来做key的field名字

下面的代码说明Person和Book之间是一对多关系。Person的books字段是Map类型，用Book的isbn字段的值作为Map的key。

@Table(name = "PERSON")
    public class Person {

	@OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person")
	@MapKey(name = "isbn")
	private Map books = new HashMap();
    }

9、@OrderBy

在一对多，多对多关系中，有时我们希望从数据库加载出来的集合对象是按一定方式排序的，这可以通过OrderBy来实现，默认是按对象的主键升序排列。

元数据属性说明： value: 字符串类型，指定排序方式。

格式为"fieldName1 [ASC|DESC],fieldName2 [ASC|DESC],…",排序类型可以不指定，默认是ASC。

下面的代码说明Person和Book之间是一对多关系。集合books按照Book的isbn升序，name降序排列。

@Table(name = "MAPKEY_PERSON")
    public class Person {

	@OneToMany(targetEntity = Book.class, cascade = CascadeType.ALL, mappedBy = "person")
	@OrderBy(name = "isbn ASC, name DESC")
	private List books = new ArrayList();
    }

 

10、@PrimaryKeyJoinColumn

在三种情况下会用到PrimaryKeyJoinColumn。

• 继承
• entity class映射到一个或多个从表。从表根据主表的主键列（列名为referencedColumnName值的列），建立一个类型一样的主键列，列名由name属性定义。
• one2one关系，关系维护端的主键作为外键指向关系被维护端的主键，不再新建一个外键列。
   

元数据属性说明：

• name:列名
• referencedColumnName:该列引用列的列名
• columnDefinition: 定义建表时创建此列的DDL
   

下面的代码说明Customer映射到两个表，主表CUSTOMER,从表CUST_DETAIL，从表需要建立主键列CUST_ID，该列和主表的主键列id除了列名不同，其他定义一样。

@Entity
    @Table(name="CUSTOMER")
	@SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID"，referencedColumnName="id"))
	public class Customer { 
	 @Id(generate = GeneratorType.AUTO)
	  public Integer getId() {
		  return id;
	  }
	}

下面的代码说明Employee和EmployeeInfo是一对一关系，Employee的主键列id作为外键指向EmployeeInfo的主键列INFO_ID。

@Table(name = "Employee")
    public class Employee {
	@OneToOne
	@PrimaryKeyJoinColumn(name = "id", referencedColumnName="INFO_ID")
	EmployeeInfo info;
	}

11、@PrimaryKeyJoinColumns

如果entity class使用了复合主键，指定单个PrimaryKeyJoinColumn不能满足要求时，可以用PrimaryKeyJoinColumns来定义多个PrimaryKeyJoinColumn。

元数据属性说明： value: 一个PrimaryKeyJoinColumn数组，包含所有PrimaryKeyJoinColumn。

 

下面的代码说明了Employee和EmployeeInfo是一对一关系。他们都使用复合主键，建表时需要在Employee表建立一个外键，从Employee的主键列id,name指向EmployeeInfo的主键列INFO_ID和INFO_NAME.

@Entity
   @IdClass(EmpPK.class)
   @Table(name = "EMPLOYEE")
   public class Employee {

	private int id;

	private String name;

	private String address;

	@OneToOne(cascade = CascadeType.ALL)
	@PrimaryKeyJoinColumns({
	@PrimaryKeyJoinColumn(name="id", referencedColumnName="INFO_ID"),
	@PrimaryKeyJoinColumn(name="name" , referencedColumnName="INFO_NAME")})
	EmployeeInfo info;
    }

    @Entity
    @IdClass(EmpPK.class)
    @Table(name = "EMPLOYEE_INFO")
    public class EmployeeInfo {

	@Id
	@Column(name = "INFO_ID")
	private int id;

	@Id
	@Column(name = "INFO_NAME")
	private String name;
	}

12、@Transient

@Transient表示该属性并不是一个到数据库表的字段的映射，指定的这些属性不会被持久化，ORM框架将忽略该属性。 如果一个属性并非数据库表的字段映射。就务必将其标示为@Transient。否则，ORM框架默认其注解为@Basic

@Transient
   private String name;

 

13、@SecondaryTable

一个entity class可以映射到多表，SecondaryTable用来定义单个从表的名字，主键名字等属性。

元数据属性说明：

name:表名

catalog:对应关系数据库中的catalog

schema：对应关系数据库中的 schema

pkJoin: 定义一个PrimaryKeyJoinColumn数组，指定从表的主键列

UniqueConstraints: 定义一个UniqueConstraint数组，指定需要建唯一约束的列。

下面的代码说明Customer类映射到两个表，主表名是CUSTOMER，从表名是CUST_DETAIL，从表的主键列和主表的主键列类型相同，列名为CUST_ID。

@Entity
@Table(name="CUSTOMER")
@SecondaryTable(name="CUST_DETAIL",pkJoin=@PrimaryKeyJoinColumn(name="CUST_ID"))
	public class Customer { ... }

14、@SecondaryTables

当一个entity class映射到一个主表和多个从表时，用SecondaryTables来定义各个从表的属性。

元数据属性说明： value： 定义一个SecondaryTable数组，指定每个从表的属性。

@Table(name = "CUSTOMER")
@SecondaryTables( value = {
@SecondaryTable(name = "CUST_NAME", pkJoin = { @PrimaryKeyJoinColumn(name = "STMO_ID", referencedColumnName = "id") }),
@SecondaryTable(name = "CUST_ADDRESS", pkJoin = { @PrimaryKeyJoinColumn(name = "STMO_ID", referencedColumnName = "id") }) })
public class Customer {}

 

15、@Version

Version指定实体类在事务中的version属性。在实体类重新由EntityManager管理并且加入到事务中时，保证完整性。每一个类只能有一个属性被指定为version，version属性应该映射到实体类的主表上。

@Version
    @Column("OPTLOCK")
    protected int getVersionNum() { return versionNum; }

16、@Lob

Lob指定一个属性作为数据库支持的大对象类型在数据库中存储。使用LobType这个枚举来定义Lob是二进制类型还是字符类型。

 

LobType枚举类型说明：

• BLOB 二进制大对象，Byte[]或者Serializable的类型可以指定为BLOB。
• CLOB 字符型大对象，char[]、Character[]或String类型可以指定为CLOB。

 

元数据属性说明：

• fetch： 定义这个字段是lazy loaded还是eagerly fetched。数据类型是FetchType枚举，默认为LAZY,即lazy loaded.
• type： 定义这个字段在数据库中的JDBC数据类型。数据类型是LobType枚举，默认为BLOB。
   

下面的代码定义了一个BLOB类型的属性和一个CLOB类型的属性。

@Lob
    @Column(name="PHOTO" columnDefinition="BLOB NOT NULL")
    protected JPEGImage picture;
    
    @Lob(fetch=EAGER, type=CLOB)
    @Column(name="REPORT")
    protected String report;

17、@JoinTable

JoinTable在many-to-many关系的所有者一边定义。如果没有定义JoinTable，使用JoinTable的默认值。

元数据属性说明：

• table:这个join table的Table定义。
• joinColumns:定义指向所有者主表的外键列，数据类型是JoinColumn数组。
• inverseJoinColumns:定义指向非所有者主表的外键列，数据类型是JoinColumn数组。

下面的代码定义了一个连接表CUST和PHONE的join table。join table的表名是CUST_PHONE，包含两个外键，一个外键是CUST_ID，指向表CUST的主键ID，另一个外键是PHONE_ID，指向表PHONE的主键ID。

@JoinTable(
    table=@Table(name=CUST_PHONE),
    joinColumns=@JoinColumn(name="CUST_ID", referencedColumnName="ID"),
    inverseJoinColumns=@JoinColumn(name="PHONE_ID", referencedColumnName="ID")
    )

18、@DiscriminatorColumn

DiscriminatorColumn定义在使用SINGLE_TABLE或JOINED继承策略的表中区别不继承层次的列。

元数据属性说明：

• name:column的名字。默认值为TYPE。
• columnDefinition:生成DDL的sql片断。
• length:String类型的column的长度，其他类型使用默认值10。

下面的代码定义了一个列名为DISC，长度为20的String类型的区别列。

@Entity
    @Table(name="CUST")
    @Inheritance(strategy=SINGLE_TABLE,
        discriminatorType=STRING,
       discriminatorValue="CUSTOMER")
    @DiscriminatorColumn(name="DISC", length=20)
    public class Customer { ... }

19、@OneToOne、@JoinColumn

@OneToOne注释只能确定实体与实体的关系是一对一的关系，不能指定数据库表中的保存的关联字段。所以此时要结合@JoinColumn标记来指定保存实体关系的配置。

@JoinColumn与@Column注释类似，它的定义如下代码所示。

@Target({METHOD, FIELD})
 @Retention(RUNTIME) 
String name() default ""; 
String referencedColumnName() default ""; 
boolean unique() default false; 
boolean nullable() default true; 
boolean insertable() default true; 
boolean updatable() default true; 
String columnDefinition() default ""; 
String table() default ""; 
}

在使用@JoinColumn时，应注意以下几个问题：

（1）、 @JoinColumn与@Column标记一样，是用于注释表中的字段的。它的属性与@Column属性有很多相同之处

（2）、@JoinColumn与@Column相区别的是：@JoinColumn注释的是保存表与表之间关系的字段，它要标注在实体属性上。而@Column标注的是表中不包含表关系的字段。

（3）、与@Column标记一样，name属性是用来标识表中所对应的字段的名称。

例如customer表中存在字段addr_id，标识的代码如下所示。

@OneToOne 
@JoinColumn(name = "addr_id") 
public AddressEO getAddress() {
   return address; 
}

若此时，不设置name的值，则在默认情况下，name的取值遵循以下规则： name=关联表的名称+“_”+ 关联表主键的字段名

例如，CustomerEO实体中，如果不指定name的值，默认将对应name=address_id；

因为@JoinColumn注释在实体 AddressEO属性上，实体AddressEO对应的表名为“address”；表address的主键是“id”，所以此时对应的默认的字段名称为 “address_id”。

注意：

此规则只适用于与@OneToOne标记同时使用时。若与@ManyToOne或@ManyToMany标记同时使用时，将遵循其他的规则。

默认情况下，关联的实体的主键一般是用来做外键的。但如果此时不想主键作为外键，则需要设置referencedColumnName属性。

例如，将address表中增加一个字段“ref_id”，address表的建表SQL变为以下所示。

CREATE TABLE address (
    id int(20) NOT NULL auto_increment, 
ref_id int int(20) NOT NULL, 
province varchar(50) ,   
city varchar(50) , 
postcode varchar(50) , 
detail varchar(50) , 
PRIMARY KEY (id) 
)

此时，通过customer表中的“address_id”字段关联的是address表中的“ref_id”，而“ref_id”并不是address表中的主键，则实体中标注如代码下所示。

@OneToOne 
@JoinColumn(name = "address_id",referencedColumnName="ref_id") 
public AddressEO getAddress() {
         return address;     
}

20、Hibernate验证注解

注解	适用类型	说明	示例
@Pattern	String	通过正则表达式来验证字符串	@attern(regex=”[a-z]{6}”)
@Length	String	验证字符串的长度	@length(min=3,max=20)
@Email	String	验证一个Email地址是否有效	@email
@Range	Long	验证一个整型是否在有效的范围内	@Range(min=0,max=100)
@Min	Long	验证一个整型必须不小于指定值	@Min(value=10)
@Max	Long	验证一个整型必须不大于指定值	@Max(value=20)
@Size	集合或数组	集合或数组的大小是否在指定范围内	@Size(min=1,max=255)

以上每个注解都可能性有一个message属性，用于在验证失败后向用户返回的消息。