JPA(二）常用基本注解

我会带着你远行 2023-06-08 15:00 56阅读 0赞

1、常用基本注解

@Entity

@Table

@Basic

@Column

@GeneratedValue

@Id

**2、特殊注解**

@Transient

@Temporal

用 table 来生成主键

**3、常用注解的使用**

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

2、**@Table**

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

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

uniqueConstraints 选项用于设置约束条件，通常不须设置。如下代码：

*      @Table(name="JPA_CUSTOMERS")//主要是映射表名对应的数据库表名JPA_CUSTOMER默认情况下可以不写表名与持久化类名相同
        @Entity //表明这是一个持久化类
        
        public class Customer {

3、**@Id**

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

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

//定义主键，生成主键的策略AUTO自动的根据数据的类型生成主键
        @GeneratedValue(strategy=GenerationType.AUTO)
        @Id //定义数据列
    //    @Column(name="ID")//定义数据库的列名如果与字段名一样可以省略
        public Integer getId() {
            return id;
        }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

4、**@GeneratedValue**

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

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

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

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

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

5、**@Basic**

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

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

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

6、@Column

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

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

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

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

**4、特殊注解的使用**

1、**@Transient**

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

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

//工具方法，不需要映射为数据表的一列
        @Transient
        public String getInfo(){
            return "lastName:"+lastName+",email:"+email;
        }

2、@Temporal

在核心的 Java API 中并没有定义 Date 类型的精度(temporal precision). 而在数据库中,表示 Date 类型的数据有 DATE, TIME, 和 TIMESTAMP 三种精度(即单纯的日期,时间,或者两者 兼备).

**在进行属性映射时可使用@Temporal注解来调整精度.**

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

@Temporal(TemporalType.TIMESTAMP)// 时间戳
        public Date getCreatedTime() {
            return createdTime;
            }
    
    @Temporal(TemporalType.DATE) //时间精确到天
        public Date getBirth() {
            return birth;
        }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

**3、table生成主键的使用（用的比较少）**

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

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

//使用table生成主键
        @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")
        @Id
        public Integer getId() {
            return id;
        }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

其中：

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

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

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

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

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

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

关系图：

![format_png][]

[aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]: /images/20230531/96025a6ddf7446de8cb1312c60b0942a.png
[format_png]: /images/20230531/db4fa3893eae49c4acddac45998158ab.png