JPA注解详解与多对一关联映射

快来打我* 2022-05-05 10:57 300阅读 0赞

### 基于 hibernate-jpa-2.1-api ，mysql数据库 ###

import javax.persistence.\*;

### 一、JPA 基本注解:    ###

@Entity
    @Table(name="t_user")
    public class User {
    	@Id
    	@GeneratedValue(generator="h-uuid2") 
    	@GenericGenerator(name = "h-uuid2",strategy="uuid2") 
    	private String id;
    
    	@Column(name="user_name")
    	private String username;
    
    	private String password;
    	
    	@Temporal(TemporalType.DATE)  //表中类型： date
    	private Date regDate;
    
            @Transient
    	private String temp;
      ...
    }
    ----
        create table t_user (
           id varchar(255) not null,
            password varchar(255),
            regDate date,
            user_name varchar(255),
            primary key (id)
        ) engine=InnoDB

**1、@Entity  \-- 表示实体类**

说明这个类是实体类，并且使用默认的orm规则（类名即表名，类属性名即表字段名）。如果改变这种默认就使用：

@Table 改变class名与表名的映射规则，@Column 改变class中字段名与db中表的字段名的映射规则。

**2、@Table** **-- 标识实体类表名**

**      ** 当实体类名和数据库表名不一致时使用 @Table 标注说明，即使表名一致，也推荐使用，提高程序的可读性 。该标注与 @Entity 标注并列使用。

**3、@Id ** **--  标记属性的主键**

一旦标注了主键，该实体属性的值可以指定，也可以根据一些特定的规则自动生成。（一个实体中可以出现多个@Id注解，但需要@IdClass配合使用，以表示联合主键（不推荐））。

**3.1  @Id -- 标识数据类型**

<table> 
 <tbody> 
 <tr> 
 <td style="width:356px;"> 分类 </td> 
 <td style="width:491px;"> 类型 </td> 
 </tr> 
 <tr> 
 <td style="width:356px;"> Java基本数据类型 </td> 
 <td style="width:491px;"> byte、int、short、long、char </td> 
 </tr> 
 <tr> 
 <td style="width:356px;"> Java基本数据类型对应的封装类 </td> 
 <td style="width:491px;"> Byte、Integer、Short、Long、Character </td> 
 </tr> 
 <tr> 
 <td style="width:356px;"> 大数值型类 </td> 
 <td style="width:491px;"> java.math.BigInteger </td> 
 </tr> 
 <tr> 
 <td style="width:356px;"> 字符串类型 </td> 
 <td style="width:491px;"> String </td> 
 </tr> 
 <tr> 
 <td style="width:356px;"> 时间日期型 </td> 
 <td style="width:491px;"> java.util.Date、java.sql.Date </td> 
 </tr> 
 </tbody> 
</table>

double 和 float浮点类型和它们对应的封装类不能作为主键，因为判断是否唯一是通过equals方法来判断的，不能够准确的匹配。

**   3.2  @GeneratedValue \-- 标注主键的生成策略**

<table> 
 <tbody> 
 <tr> 
 <td> 属性名 </td> 
 <td style="width:74px;"> 释义 </td> 
 <td style="width:532px;"> 值 </td> 
 <td> 默认值 </td> 
 </tr> 
 <tr> 
 <td> strategy </td> 
 <td style="width:74px;"> 主键的生成策略 </td> 
 <td style="width:532px;"> GenerationType.TABLE 通过表产生主键，框架借由表模拟序列产生主键 GenerationType.SEQUENCE 通过序列产生主键(不支持MySql) GenerationType.IDENTITY 自增长(不支持Oracle) GenerationType.AUTO 自动选择合适的策略 </td> 
 <td> GenerationType.AUTO </td> 
 </tr> 
 <tr> 
 <td> generator </td> 
 <td style="width:74px;"> 自定义生成策略 </td> 
 <td style="width:532px;"> 字符串(对应@GenericGenerator注解的name属性值) </td> 
 <td> “” </td> 
 </tr> 
 </tbody> 
</table>

需要注意的是,同一张表中自增列最多只能有一列，GenerationType.SEQUENCE在oracle数据库时使用，配合@SequenceGenerator指定使用哪个序列名（后续使用）

@Id
    	@GeneratedValue(strategy=GenerationType.IDENTITY) //针对mysql数据库：自增长
    	private int id;
    ----
    	@Id
    	@GeneratedValue(strategy=GenerationType.AUTO) //根据数据库，自动选择合适的策略
    	private int id;

**3.3  @GenericGenerator  --  自定义主键生成策略**

<table> 
 <tbody> 
 <tr> 
 <td style="width:113px;"> 属性名 </td> 
 <td style="width:239px;"> 释义 </td> 
 <td style="width:421px;"> 值 </td> 
 <td> 默认值 </td> 
 </tr> 
 <tr> 
 <td style="width:113px;"> name </td> 
 <td style="width:239px;"> 生成器名称 </td> 
 <td style="width:421px;"> 字符串(对应@GeneratedValue注解的generator属性值) </td> 
 <td> 无 </td> 
 </tr> 
 <tr> 
 <td style="width:113px;"> strategy </td> 
 <td style="width:239px;"> 具体生成器的类名 </td> 
 <td style="width:421px;"> 见该表下的代码块 </td> 
 <td> 无 </td> 
 </tr> 
 <tr> 
 <td style="width:113px;"> parameters </td> 
 <td style="width:239px;"> strategy生成器用到的参数 </td> 
 <td style="width:421px;">&nbsp;</td> 
 <td> {} </td> 
 </tr> 
 </tbody> 
</table>

@Id
    	@GeneratedValue(generator="h-uuid2") //自定义str: 和name值对应 
    	@GenericGenerator(name = "h-uuid2",strategy="uuid2") //自定义策略： uuid2
    	private String id;

主键生成策略和各自的具体生成器之间的关系,在org.hibernate.id.factory.internal.DefaultIdentifierGeneratorFactory中指定如下：

![70][]

四种数据库的支持情况如下：

<table> 
 <tbody> 
 <tr> 
 <td> 数据库名称 </td> 
 <td> 支持的id策略 </td> 
 </tr> 
 <tr> 
 <td> mysql </td> 
 <td> GenerationType.TABLE GenerationType.AUTO GenerationType.IDENTITY 不支持GenerationType.SEQUENCE </td> 
 </tr> 
 <tr> 
 <td> oracle </td> 
 <td> strategy=GenerationType.AUTO GenerationType.SEQUENCE GenerationType.TABLE 不支持GenerationType.IDENTITY </td> 
 </tr> 
 <tr> 
 <td> postgreSQL </td> 
 <td> GenerationType.TABLE GenerationType.AUTO GenerationType.IDENTITY GenerationType.SEQUENCE 都支持 </td> 
 </tr> 
 <tr> 
 <td> kingbase </td> 
 <td> GenerationType.TABLE GenerationType.SEQUENCE GenerationType.IDENTITY GenerationType.AUTO 都支持 </td> 
 </tr> 
 </tbody> 
</table>

**4、@Column ** **--  标识实体类中属性与数据表中字段的对应关系。**

<table> 
 <tbody> 
 <tr> 
 <td> 属性名 </td> 
 <td> 释义 </td> 
 <td> 值 </td> 
 <td> 默认值 </td> 
 </tr> 
 <tr> 
 <td> name </td> 
 <td> 所对应表字段的名称 </td> 
 <td> 字符串 </td> 
 <td> “” </td> 
 </tr> 
 <tr> 
 <td> unique </td> 
 <td> 是否为唯一标识(亦可在@Table注解中设置) </td> 
 <td> 布尔值 </td> 
 <td> false </td> 
 </tr> 
 <tr> 
 <td> nullable </td> 
 <td> 是否可为null值 </td> 
 <td> 布尔值 </td> 
 <td> true </td> 
 </tr> 
 <tr> 
 <td> insertable </td> 
 <td> 在使用’insert’时，是否插入该字段的值 </td> 
 <td> 布尔值 </td> 
 <td> true </td> 
 </tr> 
 <tr> 
 <td> updatable </td> 
 <td> 在使用’update’时，是否更新该字段的值 </td> 
 <td> 布尔值 </td> 
 <td> true </td> 
 </tr> 
 <tr> 
 <td> columnDefinition </td> 
 <td> 通过Entity生成DDL语句 </td> 
 <td> 字符串 </td> 
 <td> “” </td> 
 </tr> 
 <tr> 
 <td> table </td> 
 <td> 包含当前字段的表名 </td> 
 <td> 字符串 </td> 
 <td> “” </td> 
 </tr> 
 <tr> 
 <td> length </td> 
 <td> 字段长度(类型仅为varchar时生效) </td> 
 <td> 正整数或零 </td> 
 <td> 255 </td> 
 </tr> 
 <tr> 
 <td> precision </td> 
 <td> 数值的总长度(类型仅为double时生效) </td> 
 <td> 正整数或零 </td> 
 <td> 0 </td> 
 </tr> 
 <tr> 
 <td> scale </td> 
 <td> 保留小数点后数值位数(类型仅为double时生效) </td> 
 <td> 正整数或零 </td> 
 <td> 0 </td> 
 </tr> 
 </tbody> 
</table>

提示：此注解可以标注在getter方法或属性前。

**5、 @Temporal** **-- 指明该属性获取时间精度**

默认为 TemporalType.TIMESTAMP 类型。

<table> 
 <tbody> 
 <tr> 
 <td> 类型 </td> 
 <td> 说明 </td> 
 </tr> 
 <tr> 
 <td> java.sql.Date </td> 
 <td> 日期型，精确到年月日，例如“2008-08-08” </td> 
 </tr> 
 <tr> 
 <td> java.sql.Time </td> 
 <td> 时间型，精确到时分秒，例如“20:00:00” </td> 
 </tr> 
 <tr> 
 <td> java.sql.Timestamp </td> 
 <td> 时间戳，精确到纳秒，例如“2008-08-08 20:00:00.000000001” </td> 
 </tr> 
 </tbody> 
</table>

//@Temporal(TemporalType.DATE)  //表中类型： date
    	//@Temporal(TemporalType.TIMESTAMP)  //表中类型： datetime
    	@Temporal(TemporalType.TIME)  //表中类型： time
    	private Date regDate;

**6、@Transient** **-- 属性不与表字段映射**

一旦变量被transient修饰，属性将不再是对象持久化的一部分，该变量内容在序列化后无法获得访问(即：不与表字段映射)。 常用于某属性仅为临时变量时。

**7、@Basic **

表示一个简单的属性到数据库表的字段的映射，对于没有任何标注的属性，默认即为 @Basic。

<table> 
 <tbody> 
 <tr> 
 <td> 属性名 </td> 
 <td> 释义 </td> 
 <td> 值 </td> 
 <td> 默认值 </td> 
 </tr> 
 <tr> 
 <td> fetch </td> 
 <td> 加载方式 </td> 
 <td> FetchType.EAGER 即时加载&nbsp; FetchType.LAZY 延迟加载 </td> 
 <td> FetchType.EAGER </td> 
 </tr> 
 <tr> 
 <td> strategy </td> 
 <td> 是否可为null </td> 
 <td> 布尔值 </td> 
 <td> true </td> 
 </tr> 
 </tbody> 
</table>

hibernate 的xml配置默认为：懒加载， JPA 注释配置默认为：立即加载。

对于一些特殊的属性，比如长文本型text、字节流型blob型的数据，在加载Entity时，这些属性对应的数据量比较大，有时创建实体时如果也加载的话，可能严重造成资源的占用。要想解决这些问题，此时就可设置实体属性的加载方式为延迟加载（LAZY）

### 二、JPA 映射注解:    ###

**1、单向多对一关联**

多个角色对应一个用户。 多：添加一的类对象关联属性；一：不做变化

**注意：注解 @ManyToOne(fetch=FetchType.EAGER) 默认的是立即加载，需要懒加载的时候，修改fetch参数 **

@Entity
    @Table(name="t_role")
    public class Role {
    	@Id
    	@GeneratedValue(strategy=GenerationType.IDENTITY)
    	private int id;
    	@Column(name="role_name")
    	private String roleName;
    	private String state;
    	
    	@ManyToOne(fetch=FetchType.LAZY)
    	@JoinColumn(name="user_id")
    	private User user; //关联属性
        ...
    }
    -----
    @Entity
    @Table(name="t_user")
    public class User {
    	@Id
    	@GeneratedValue(strategy=GenerationType.IDENTITY)
    	private int id;
    	private String username;
    	private String password;
    	@Temporal(TemporalType.DATE)  //表中类型： date
    	private Date regDate;
        ...
    }

![70 1][]

**2、单向一对多的关联**

一个用户对应多个角色。 一：添加多的类对象集合关联属性；多：不做变化

**注意：注解@OneToMany(fetch=FetchType.LAZY)默认的是懒加载，需要立即加载的时候，修改fetch参数**

**删除1这端的记录时，可以删除，然后会把多端的外键设置为null，需要级联删除可以设置@OneToMany（设置cascade属性）**

![70 2][]    ![70 3][]

### 3、双向的一对多（多对一）的关联 ###

一这端：user，多这端：role

**注意：**

1）双向关联关系，两遍默认都会维护关系，可能冲突，也影响效率，正常情况关系**交给“多”这端维护**，一这端配置mappedBy属性则放弃@OneToMany(mappedBy="user"）值为多这端关联属性的属性名

2）一旦**一这端**使用 mappedBy 属性，那么@JoinColumn这个注解就不能使用了，用了会出错

3）**需要级联操作可以设置@OneToMany（设置cascade属性），不设置放弃维护的这端删除不了**

@Entity
 @Table(name="t_user")
 public class User {
 	@Id
 	@GeneratedValue(strategy=GenerationType.IDENTITY)
 	private int id;
 	private String username;
 	private String password;
 	@Temporal(TemporalType.DATE) //表中类型： date
 	private Date regDate;
 	//mappedBy="user" 一这端放弃维护关联关系， 值为多这端关联属性的属性名 
 	@OneToMany(fetch=FetchType.LAZY,cascade= {CascadeType.ALL},mappedBy="user") 
 	private Set<Role> roles = new HashSet<>();
 ...}
 ----
 @Entity
 @Table(name="t_role")
 public class Role {
 	@Id
 	@GeneratedValue(strategy=GenerationType.IDENTITY)
 	private int id;
 	@Column(name="role_name")
 	private String roleName;
 	private String state;
 	
 	@ManyToOne(fetch=FetchType.EAGER,cascade={CascadeType.PERSIST,CascadeType.MERGE})
 	@JoinColumn(name="user_id")
 	private User user;
 ...}

![70 4][]

**4、双向的一对一的关联**

双向关联，需要一边要放弃关系维护

**注意：**

**   ** 1）负责维护关系的一端，要配置唯一约束  unique=true，因为一对一关联，两边都是唯一的

2） 默认关联策略是：立即加载

3）**需要级联操作可以设置@OneToOne（设置cascade属性），不设置放弃维护的这端删除不了**

![70 5][]

**5、双向多对多的关联**

双向关联，需要一边要放弃关系维护

**注意：**

**   ** 1） 默认关联策略是：立即加载

2）**需要级联操作可以设置@ManyToMany（设置cascade属性），不设置放弃维护的这端删除不了**

**    3） 关联中间表，无法自定义字段，不灵活，**

@Entity
 @Table(name="t_user")
 public class User {
 	@Id
 	@GeneratedValue(strategy=GenerationType.IDENTITY)
 	private int id;
 	private String username;
 	private String password;
 	@Temporal(TemporalType.DATE) //表中类型： date
 	private Date regDate;
 	
 	@ManyToMany(mappedBy="users",cascade=CascadeType.ALL)
 	private Set<Role> roles = new HashSet<>();
 ...}
 ----
 @Entity
 @Table(name="t_role")
 public class Role {
 	@Id
 	@GeneratedValue(strategy=GenerationType.IDENTITY)
 	private int id;
 	@Column(name="role_name")
 	private String roleName;
 	private String state;
 	
 	@ManyToMany
 	@JoinTable(name="t_user_role",
 			joinColumns = {@JoinColumn(name="t_user",referencedColumnName="id")},
 			inverseJoinColumns = {@JoinColumn(name="t_role",referencedColumnName="id")}
 			)
 	private Set<User> users = new HashSet<>();
 ...}

![70 6][]

**注意：**在真项目开发中，处理双向多对多的关联，一般变通来处理，将对对多关联，转换为两个一对多的关联，中间表可以自定义字段。

### 转换为两个双向一对多实例 ###

@Entity
 @Table(name="t_user")
 public class User {
 	@Id
 	@GeneratedValue(strategy=GenerationType.IDENTITY)
 	private int id;
 	private String username;
 	private String password;
 	@Temporal(TemporalType.DATE) //表中类型： date
 	private Date regDate;
 	
 	@OneToMany(mappedBy="user",cascade=CascadeType.ALL)
 	private Set<UserRole> userRoles = new HashSet<>();
 ...}
 ----
 @Entity
 @Table(name="t_role")
 public class Role {
 	@Id
 	@GeneratedValue(strategy=GenerationType.IDENTITY)
 	private int id;
 	@Column(name="role_name")
 	private String roleName;
 	private String state;
 	
 	@OneToMany(mappedBy="role",cascade=CascadeType.ALL)
 	private Set<UserRole> userRoles = new HashSet<>();
 ...}
 --中间表--
 @Entity
 @Table(name="t_user_role")
 public class UserRole {
 	@Id
 	@GeneratedValue(strategy=GenerationType.IDENTITY)
 	private int id;
 	private Date createDate;
 	
 	@ManyToOne(cascade=CascadeType.ALL)
 	@JoinColumn(name="user_id")
 	private User user;
 	@ManyToOne
 	@JoinColumn(name="role_id")
 	private Role role;
 ...}

![70 7][]

**注意：**

**   ** 1） **需要级联操作可以设置@OneToMany（设置cascade属性），不设置放弃维护的这端删除不了**

**    2） 关联中间表，可自定定义字段，**

end...

[70]: /images/20220505/4fe0d019057648578eb569f43a936d99.png
[70 1]: /images/20220505/11d6f8a1971b49dd8ee968195c9949c5.png
[70 2]: https://img-blog.csdn.net/2018101822120573?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNDAyODU0/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70
[70 3]: /images/20220505/5c0699c2b511486db7ac6e283f22cde8.png
[70 4]: /images/20220505/f6a660cf6f9740b6b106d3634c9dd270.png
[70 5]: /images/20220505/66362f0d598246ae850b17cfbfc4484b.png
[70 6]: /images/20220505/b92cfe5c171b4086883311177f888154.png
[70 7]: /images/20220505/db248dabfc8c4e59a03ddc0f16b99400.png