jpa--4.基本注解

 

1      基本注解

1.1  实体和表

1.1.1  @Entity

@Entity 标注用于实体类声明语句之前，指出该Java 类为实体类，将映射到指定的数据库表。如声明一个实体类 Customer，它将映射到数据库中的customer 表上。

 

1.1.2  @Table

当实体类与其映射的数据库表名不同名时，需要使用 @Table 标注说明，该标注与 @Entity 标注并列使用，置于实体类声明语句之前，可写于单独语句行，也可与声明语句同行。

@Table 标注的常用选项是 name，用于指明数据库的表名

@Table标注还有一个两个选项catalog 和 schema 用于设置表所属的数据库目录或模式，通常为数据库名。uniqueConstraints 选项用于设置约束条件，通常不须设置。

 

1.2  主键、自增策略、uuid

1.2.1  @Id

@Id 标注用于声明一个实体类的属性映射为数据库的主键列。该属性通常置于属性声明语句之前，可与声明语句同行，也可写在单独行上。

@Id标注也可置于属性的getter方法之前。

 

1.2.2  @GeneratedValue

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

在javax.persistence.GenerationType 中定义了以下几种可供选择的策略：

1.IDENTITY：采用数据库 ID自增长的方式来自增主键字段，Oracle 不支持这种方式；

2.AUTO： JPA自动选择合适的策略，是默认选项；

3.SEQUENCE：通过序列产生主键，通过@SequenceGenerator 注解指定序列名，MySql 不支持这种方式

4.TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植。

 

1.2.3  @GenericGenerator

@Id
   @GeneratedValue(generator= "id")
   @GenericGenerator(name= "id",strategy = "uuid")
   @Column(name= "id",length = 32 ,nullable = false)
    private String id ; 

1.3  @Basic（默认自带）

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

fetch: 表示该属性的读取策略,有 EAGER 和 LAZY 两种,分别表示主支抓取和延迟加载,默认为 EAGER.

optional:表示该属性是否允许为null,默认为true

 

1.4  列@Column

1.4.1  结合@id使用

当实体的属性与其映射的数据库表的列不同名时需要使用@Column 标注说明，该属性通常置于实体的属性声明语句之前，还可与 @Id 标注一起使用。

 

1.4.2  常规属性

@Column 标注的常用属性是 name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique 、nullable、length等。

 

1.4.3  columnDefinition 属性

@Column 标注的columnDefinition 属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR, 如果要将 String 类型映射到特定数据库的 BLOB 或TEXT 字段类型.

 

1.4.4  使用位置

@Column标注也可置于属性的getter方法之前

 

2      扩展注解

2.1  @Transient（针对get方法）

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

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

 

2.2  @Temporal（日期）

在核心的 Java API 中并没有定义 Date 类型的精度(temporalprecision).  而在数据库中,表示 Date 类型的数据有 DATE,TIME, 和 TIMESTAMP 三种精度(即单纯的日期,时间,或者两者兼备).在进行属性映射时可使用@Temporal注解来调整精度.

 

2.3  @TableGenerator用 table 来生成主键详解(了解)

2.3.1  概念

将当前主键的值单独保存到一个数据库的表中，主键的值每次都是从指定的表中查询来获得，这种方法生成主键的策略可以适用于任何数据库，不必担心不同数据库不兼容造成的问题。

2.3.2  属性

name 属性表示该主键生成策略的名称，它被引用在@GeneratedValue中设置的generator 值中

table 属性表示表生成策略所持久化的表名

pkColumnName 属性的值表示在持久化表中，该主键生成策略所对应键值的名称

valueColumnName 属性的值表示在持久化表中，该主键当前所生成的值，它的值将会随着每次创建累加

pkColumnValue 属性的值表示在持久化表中，该生成策略所对应的主键

allocationSize 表示每次主键值增加的大小,默认值为 50

 

 

3      参考代码

@Table(name="JPA_CUTOMERS")
@Entity
public class Customer {
	
	private Integer id;
	private String lastName;

	private String email;
	private int age;
	
	private Date createdTime;
	private Date birth;
	
//	@TableGenerator(name="ID_GENERATOR",
//	table="jpa_id_generators",
//	pkColumnName="PK_NAME",
//	pkColumnValue="CUSTOMER_ID",
//	valueColumnName="PK_VALUE",
//	allocationSize=100)
//@GeneratedValue(strategy=GenerationType.TABLE,generator="ID_GENERATOR")
//	@Column(name = "id") 如果与表名一致可省略
	@GeneratedValue(strategy=GenerationType.AUTO)
	@Id
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	
	@Column(name = "last_name", length = 50, nullable = false)
	public String getLastName() {
		return lastName;
	}
	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
	public String getEmail() {
		return email;
	}
	public void setEmail(String email) {
		this.email = email;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	
	@Temporal(TemporalType.TIMESTAMP)
	public Date getCreatedTime() {
		return createdTime;
	}
	public void setCreatedTime(Date createdTime) {
		this.createdTime = createdTime;
	}
	@Temporal(TemporalType.DATE)
	public Date getBirth() {
		return birth;
	}
	public void setBirth(Date birth) {
		this.birth = birth;
	}
	//工具方法. 不需要映射为数据表的一列. 
	@Transient
	public String getInfo(){
		return "lastName: " + lastName + ", email: " + email;
	}
}