SpringData专题(二)-JPA常用注解

在MyBatis或者Hibernate框架中，映射文件一般是XML格式的，注解的作用简化开发!

###1.基本注解

JPA常用的注解有 @Entity、@Table、@Id、@GeneratedValue、@Column、@Basic

2.特殊注解

@Transient、@Temporal

3.常用注解的使用

3.1.@Entity

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

@Entity
public class Customer {
    
    
}

3.2.@Table

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

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

name属性:

用于指定数据库表名称 ,若不指定则以实体类名称作为表名

@Table
@Entity
public class Customer {
 
    
}

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

catalog属性：
catalog属性用于指定数据库实例名，一般来说persistence.xml文件中必须指定数据库url，url中将包含数据库实例

<property name="javax.persistence.jdbc.url" value="jdbc:mysql://localhost:3306/jpa" />

当catalog属性不指定时，新创建的表将出现在url指定的数据库实例中
当catalog属性设置名称时，若数据库存在和指定名称一致的实例，新创建的表将出现在该实例中.该属性一般不需要设置.

@Entity //声明实体类
@Table(name="cst_customer",catalog = "jpa0729") //建立实体类和表的映射关系
public class Customer implements Serializable{
    
}

schema属性：
作用与catalog属性作用一致，可自行测试

uniqueConstraints 选项用于设置约束条件，通常不须设置.

@Entity //声明实体类
@Table(name="cst_customer",catalog = "jpa0729",uniqueConstraints={@UniqueConstraint(columnNames={"cust_name"})}) //建立实体类和表的映射关系
public class Customer implements Serializable{


}

数据库DDL：

Hibernate: 
    create table jpa0729.cst_customer (
        cust_id bigint not null auto_increment,
        cust_address varchar(255),
        cust_industry varchar(255),
        cust_level varchar(255),
        cust_name varchar(255),
        cust_phone varchar(255) not null,
        cust_source varchar(255),
        primary key (cust_id)
    )
Hibernate: 
    alter table jpa0729.cst_customer 
        add constraint UK14ctafs86r97xwblaca93janm unique (cust_name)

uniqueConstraints={@UniqueConstraint(columnNames={“cust_name”})} 表示name列的值不能重复

约束也可以是多列约束

@Entity //声明实体类
@Table(name="cst_customer",catalog = "jpa0729",uniqueConstraints={@UniqueConstraint(columnNames={"cust_name","cust_phone"})}) //建立实体类和表的映射关系
public class Customer implements Serializable{

}

数据库DDL：

Hibernate: 
    create table jpa0729.cst_customer (
        cust_id bigint not null auto_increment,
        cust_address varchar(255),
        cust_industry varchar(255),
        cust_level varchar(255),
        cust_name varchar(255),
        cust_phone varchar(255) not null,
        cust_source varchar(255),
        primary key (cust_id)
    )
Hibernate: 
    alter table jpa0729.cst_customer 
        add constraint UKhnugkln5rmg76kc9gh121p8bn unique (cust_name, cust_phone)

niqueConstraints={@UniqueConstraint(columnNames={“cust_name”,”cust_phone”}) 的意思是customer表中不同同时存在cust_name+cust_phone的相同记录 !!

####3.3.@Id

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

@Id//声明当前私有属性为主键,定义数据库的列名如果与字段名一样可以省略
private Long custId;

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

@Id//声明当前私有属性为主键,定义数据库的列名如果与字段名一样可以省略
@Column(name="cust_id")
public Long getCustId() {
     return custId;
}

####3.4.@GeneratedValue

@GeneratedValue 用于标注主键的生成策略，通过 strategy 属性指定。默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：SqlServer 对应 identity，MySQL 对应 auto increment。
在 javax.persistence.GenerationType 中定义了以下几种可供选择的策略：

IDENTITY：采用数据库 ID自增长的方式来自增主键字段，Oracle 不支持这种方式；适用于MySQL和SQLServer
AUTO：JPA自动选择合适的策略，是默认选项, 会自动生成一个序列表，通用性比较强。但是MySQL有自增，所以用的比较少
SEQUENCE(序列，适用于Oracle数据库)：通过序列产生主键，通过 @SequenceGenerator注解指定序列名，MySql 不支持这种方式 TABLE：通过表产生主键，框架借由表模拟序列产生主键，使用该策略可以使应用更易于数据库移植。

 @Id//声明当前私有属性为主键
 @GeneratedValue(strategy = GenerationType.IDENTITY) //配置主键的生成策略
 private Long custId;

3.5.@Column

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

• @Column 标注的常用属性是 name，用于设置映射数据库表的列名。此外，该标注还包含其它多个属性，如：unique 、nullable、length 等。
• @Column 标注的 columnDefinition 属性: 表示该字段在数据库中的实际类型.通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR, 如果要将 String 类型映射到特定数据库的 BLOB 或TEXT 字段类型.

@Column(name = "cust_name") //指定和表中cust_name字段的映射关系
private String custName;

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

@Column(name="cust_name") // 表示字段和属性之间的映射关系
public String getCustName() {
    return custName;
}

3.6.@Basic

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

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

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

@Basic(fetch= FetchType.LAZY,optional = true)
@Column(name="cust_industry")
private String custIndustry;

###4.特殊注解的使用

4.1.@Transient

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

@Transient
private String hobby;

public String getHobby() {
return hobby;
}

public void setHobby(String hobby) {
this.hobby = hobby;
}

####4.2 @Temporal

在核心的 Java API 中并没有定义 Date 类型的精度(temporal precision).

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

// 时间戳
@Temporal(TemporalType.TIMESTAMP)
public Date getCreateDate() {
    return createDate;
}
public void setCreateDate(Date createDate) {
    this.createDate = createDate;
}

//时间精确到天
@Temporal(TemporalType.DATE)
public Date getBirthday() {
    return birthday;
}
public void setBirthday(Date birthday) {
    this.birthday = birthday;
}