JPA中间表(关系表)联合主键配置说明
程序员文章站
2022-04-24 22:33:11
...
问题场景
平时在开发中经常会出现多对多的关系,这个时候会创建一个关系表。但该关系表中并没有设置唯一主键字段而是联合主键,那么JPA下创建该关系表实体后运行项目会提示No identifier specified
或does not define an IdClass
的错误。
下面以用户部门关系进行举例说明,用户和部门是多对多的关系。
数据表结构
CREATE TABLE `mb_member_dept` (
`member_id` bigint(20) NOT NULL ,
`dept_id` bigint(20) NOT NULL ,
PRIMARY KEY (`member_id`, `dept_id`)
)
ENGINE=InnoDB
DEFAULT CHARACTER SET=utf8mb4 COLLATE=utf8mb4_general_ci
ROW_FORMAT=DYNAMIC;
实体代码
/**
* 用户部门实体
* @author lizebin
* @version 1.0
* @date 2021/2/18 12:48 上午
*
**/
@Getter
@Setter
@Entity
@Table(name = "mb_member_dept")
public class MemberDeptPO implements Serializable{
private static final long serialVersionUID = 1271571231859316736L;
/**
* 联合主键用户ID
*/
@Column(name = "member_id", length = 20)
private long memberId;
/**
* 联合主键部门ID
*/
@Column(name = "dept_id", length = 20)
private long deptId;
}
观察以上代码似乎并没有什么问题,但在启动项目时会提示以下错误:
Caused by: org.hibernate.AnnotationException: No identifier specified for entity: com.test.po.MemberDeptPO
此时需要在联合主键字段memberId
和deptId
上增加@Id
注解即可解决以上错误。这里需要注意的是,一般出现以上错误提示时只要在主键字段上增加@Id注解即可解决问题。
但再次启动项目时还是会提示一个does not define an IdClass
的错误:
Caused by: java.lang.IllegalArgumentException: This class [class com.test.po.MemberDeptPO] does not define an IdClass
这是因为联合主键时需要额外定义一个idClass
类作为实体的ID,idClass
类代码如下:
idClass类代码
/**
* 用户部门关系联合主键定义
* @author lizebin
* @version 1.0
* @date 2021/2/18 10:36 上午
*
**/
@Getter
@Setter
public class MemberDeptKey implements Serializable {
private static final long serialVersionUID = -5482200454871393530L;
/**联合主键,字段名称与MemberDeptPO 类中一致*/
private long memberId;
/**联合主键,字段名称与MemberDeptPO 类中一致*/
private long deptId;
public MemberDeptKey() { }
public MemberDeptKey(long memberId, long deptId) {
this.memberId = memberId;
this.deptId = deptId;
}
}
说明:MemberDeptKey
类中的字段必须为MemberDeptPO
类中的联合主键且字段名称需保持一致。
实体类最终正确代码
- 增加
@IdClass(value = MemberDeptKey.class)
和@Id
注解
/**
* 用户部门实体
* @author lizebin
* @version 1.0
* @date 2021/2/18 12:48 上午
*
**/
@Getter
@Setter
@Entity
@Table(name = "mb_member_dept")
@IdClass(value = MemberDeptKey.class) // 定义联合主键类
public class MemberDeptPO implements Serializable{
private static final long serialVersionUID = 1271571231859316736L;
/**
* 联合主键用户ID
*/
@Id // 定义该字段为主键
@Column(name = "member_id", length = 20)
private long memberId;
/**
* 联合主键部门ID
*/
@Id // 定义该字段为主键
@Column(name = "dept_id", length = 20)
private long deptId;
}
持久层配置
@Repository
public interface IMemberDeptRepository extends JpaRepository<T, ID>, JpaSpecificationExecutor<T> {
}
由于这里使用类联合主键,上面代码中的ID
不能在使用Long
而是需要使用MemberDeptKey
进行定义,最终代码如下:
@Repository
public interface IMemberDeptRepository extends JpaRepository<MemberDeptPO, MemberDeptKey>, JpaSpecificationExecutor<MemberDeptPO> {
/**通过ID获取数据信息*/
MemberDeptPO findById(MemberDeptKey id);
}
当需要通过ID获取数据时则如下调用即可:
@Autowired
private IMemberDeptRepository memberDeptRepository;
MemberDeptPO memberDeptPO = memberDeptRepository.findById(new MemberDeptKey(1l, 0l));
以上是JPA框架下联合主键的使用说明,希望对您有帮助。如有说得不清楚的地方还请评论留下问题,我再为您解答。
上一篇: 韩信和白起相比 两人谁更加优秀