JPA/Hibernate 中实体化连接表处理复杂多对多及多实体关系-java教程-PHP中文网

jpa/hibernate 中实体化连接表处理复杂多对多及多实体关系

本文深入探讨了在JPA/Hibernate中如何通过将连接表（Join Table）建模为独立实体来处理具有附加属性或涉及多个实体间的复杂关系。通过利用`@EmbeddedId`定义复合主键，并结合`@ManyToOne`和`@MapsId`注解来映射外键，我们能够灵活地在关系型数据库中表达和操作多对多关系，同时支持在连接关系上添加额外数据或扩展到多于两个实体间的关联，从而提供了比传统`@ManyToMany`更强大的解决方案。

1. 复杂关系建模的需求

在关系型数据库设计中，多对多（Many-to-Many）关系通常通过一个中间连接表（Join Table）来实现。例如，学生与课程之间存在多对多关系，一个学生可以选择多门课程，一门课程也可以被多个学生选择。传统的JPA @ManyToMany注解能够方便地映射这种关系。然而，当连接表本身需要存储额外的属性（例如，学生选修某门课程的成绩或评分），或者当关系涉及三个或更多实体时（例如，学生对特定老师所教授的某门课程进行评分），传统的@ManyToMany注解就显得力不从心了。

在这种情况下，将连接表明确地建模为一个独立的JPA实体，成为一种更灵活、更强大的解决方案。

2. 将连接表建模为实体

为了处理带有附加属性或涉及多实体的复杂关系，我们可以将连接表视为一个普通的实体。这个实体将包含构成其主键的字段，以及任何额外的属性。

核心思想：

创建复合主键类： 定义一个可嵌入（@Embeddable）的类，用于表示连接表的复合主键。
创建连接实体： 定义一个实体类来代表连接表，该实体使用@EmbeddedId来引用复合主键类。
映射外键： 在连接实体中，使用@ManyToOne注解来映射到参与关系的各个实体，并结合@MapsId注解将这些外键与复合主键的相应部分关联起来。

以下通过一个学生对课程进行评分的例子来具体说明：

假设我们有Student（学生）和Course（课程）两个实体，现在我们需要记录学生对每门课程的评分。这个评分是关系本身的属性，因此不能直接放在Student或Course实体中。我们需要一个CourseRating实体来表示这个连接表。

2.1 定义复合主键

首先，我们需要为CourseRating实体定义一个复合主键。这个主键将由studentId和courseId组成。

FreeCAD

使用参数化 JSON 操作在 FreeCAD 中创建或修改三维 CAD 模型。

下载

import java.io.Serializable;
import javax.persistence.Embeddable;

@Embeddable
public class CourseRatingKey implements Serializable {

    private Long studentId;
    private Long courseId;

    // 必须提供默认构造函数
    public CourseRatingKey() {}

    public CourseRatingKey(Long studentId, Long courseId) {
        this.studentId = studentId;
        this.courseId = courseId;
    }

    // getters and setters
    public Long getStudentId() {
        return studentId;
    }

    public void setStudentId(Long studentId) {
        this.studentId = studentId;
    }

    public Long getCourseId() {
        return courseId;
    }

    public void setCourseId(Long courseId) {
        this.courseId = courseId;
    }

    // 必须重写 equals 和 hashCode 方法
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        CourseRatingKey that = (CourseRatingKey) o;
        return studentId.equals(that.studentId) &&
               courseId.equals(that.courseId);
    }

    @Override
    public int hashCode() {
        return java.util.Objects.hash(studentId, courseId);
    }
}

注意事项：

复合主键类必须实现Serializable接口。
必须提供一个公共的无参构造函数。
必须重写equals()和hashCode()方法，以确保JPA能够正确地比较和管理实体标识符。

2.2 定义连接实体

接下来，我们定义CourseRating实体，它将使用CourseRatingKey作为其复合主键。

import javax.persistence.*;

@Entity
@Table(name = "course_rating") // 假设数据库表名为 course_rating
public class CourseRating {

    @EmbeddedId
    CourseRatingKey id; // 使用 @EmbeddedId 引用复合主键类

    @ManyToOne
    @MapsId("studentId") // 将复合主键中的 studentId 映射到 Student 实体的主键
    @JoinColumn(name = "student_id") // 对应数据库中的外键列名
    Student student;

    @ManyToOne
    @MapsId("courseId") // 将复合主键中的 courseId 映射到 Course 实体的主键
    @JoinColumn(name = "course_id") // 对应数据库中的外键列名
    Course course;

    @Column(name = "rating")
    int rating; // 连接表特有的额外属性

    // 必须提供默认构造函数
    public CourseRating() {}

    public CourseRating(Student student, Course course, int rating) {
        this.student = student;
        this.course = course;
        this.rating = rating;
        this.id = new CourseRatingKey(student.getId(), course.getId());
    }

    // standard getters and setters
    public CourseRatingKey getId() {
        return id;
    }

    public void setId(CourseRatingKey id) {
        this.id = id;
    }

    public Student getStudent() {
        return student;
    }

    public void setStudent(Student student) {
        this.student = student;
    }

    public Course getCourse() {
        return course;
    }

    public void setCourse(Course course) {
        this.course = course;
    }

    public int getRating() {
        return rating;
    }

    public void setRating(int rating) {
        this.rating = rating;
    }
}

关键点解释：

@EmbeddedId: 标记主键是CourseRatingKey类的实例。
@ManyToOne: CourseRating实体与Student和Course实体之间是多对一关系。
@MapsId("studentId"): 这个注解至关重要。它指示JPA将CourseRating实体的主键（id字段）中的studentId部分映射到student字段所引用的Student实体的主键。换句话说，CourseRatingKey中的studentId值将由关联的Student实体的主键提供。
@JoinColumn(name = "student_id"): 定义了在course_rating表中，哪个列是引用Student表的外键。

2.3 配置反向引用

为了能够从Student和Course实体导航到它们的CourseRating，我们需要在这些实体中配置反向引用，通常使用@OneToMany。

import javax.persistence.*;
import java.util.HashSet;
import java.util.Set;

@Entity
@Table(name = "student")
public class Student {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;

    @OneToMany(mappedBy = "student", cascade = CascadeType.ALL, orphanRemoval = true)
    private Set<courserating> ratings = new HashSet();

    // standard constructors, getters, and setters
    public Student() {}

    public Student(String name) {
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Set<courserating> getRatings() {
        return ratings;
    }

    public void setRatings(Set<courserating> ratings) {
        this.ratings = ratings;
    }

    // Helper method to add rating
    public void addRating(CourseRating rating) {
        ratings.add(rating);
        rating.setStudent(this);
    }

    public void removeRating(CourseRating rating) {
        ratings.remove(rating);
        rating.setStudent(null);
    }
}</courserating></courserating></courserating>

import javax.persistence.*;
import java.util.HashSet;
import java.util.Set;

@Entity
@Table(name = "course")
public class Course {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String title;

    @OneToMany(mappedBy = "course", cascade = CascadeType.ALL, orphanRemoval = true)
    private Set<courserating> ratings = new HashSet();

    // standard constructors, getters, and setters
    public Course() {}

    public Course(String title) {
        this.title = title;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public Set<courserating> getRatings() {
        return ratings;
    }

    public void setRatings(Set<courserating> ratings) {
        this.ratings = ratings;
    }

    // Helper method to add rating
    public void addRating(CourseRating rating) {
        ratings.add(rating);
        rating.setCourse(this);
    }

    public void removeRating(CourseRating rating) {
        ratings.remove(rating);
        rating.setCourse(null);
    }
}</courserating></courserating></courserating>

3. 这种方法的优势

支持附加属性： 最直接的优势是可以在连接实体中添加任意数量的额外属性，如上述CourseRating中的rating字段。这是传统@ManyToMany无法实现的。
支持多实体关系（N-ary Relationships）： 这种模式可以轻松扩展到涉及三个或更多实体间的关系。例如，如果学生对特定老师教授的特定课程进行评分，那么CourseRating实体可以包含Student、Course和Teacher三个实体的引用，以及相应的@MapsId配置。
- 示例场景： 一个学生（Student）给一个老师（Teacher）教授的特定课程（Course）打分。
  - CourseRatingKey可以包含studentId, courseId, teacherId。
  - CourseRating实体将包含@ManyToOne Student student, @ManyToOne Course course, @ManyToOne Teacher teacher，并分别使用@MapsId映射到复合主键。
更清晰的领域模型： 将连接表建模为实体，使得领域模型更准确地反映了数据库的实际结构，即将一个多对多关系分解为两个或多个多对一关系。这有助于理解数据流和业务逻辑。
更灵活的查询： 当连接表是一个实体时，您可以直接对这个实体进行查询，包括根据连接属性进行过滤、排序等操作，这比通过@ManyToMany关联进行复杂查询更加直观和高效。

4. 替代方案：@IdClass

除了@EmbeddedId，JPA还提供了@IdClass注解来处理复合主键。@IdClass的工作方式是，你需要在实体类中声明构成复合主键的所有字段，并在一个单独的类中定义这些字段的组合。

// 复合主键类 (与 @EmbeddedId 示例中的 CourseRatingKey 类似，但通常字段类型与实体中的主键字段类型一致)
public class CourseRatingId implements Serializable {
    private Long student; // 字段名需要与 CourseRating 实体中作为主键的字段名匹配
    private Long course;  // 字段名需要与 CourseRating 实体中作为主键的字段名匹配

    // constructors, equals, hashCode
}

@Entity
@IdClass(CourseRatingId.class)
public class CourseRating {

    @Id
    @ManyToOne
    @JoinColumn(name = "student_id")
    private Student student; // 这里的字段名 "student" 对应 CourseRatingId 中的 "student"

    @Id
    @ManyToOne
    @JoinColumn(name = "course_id")
    private Course course; // 这里的字段名 "course" 对应 CourseRatingId 中的 "course"

    private int rating;

    // getters and setters
}

与@EmbeddedId相比，@IdClass通常被认为在代码可读性上稍逊一筹，因为它将主键的定义分散在两个地方（实体类中的@Id字段和@IdClass引用的类）。而@EmbeddedId将所有主键字段封装在一个单独的@Embeddable类中，使得主键的定义更加集中和清晰。在大多数现代JPA应用中，@EmbeddedId是处理复合主键的首选方法。

5. 总结

在JPA/Hibernate中，当需要为多对多关系添加额外属性，或者关系涉及三个或更多实体时，将连接表建模为一个独立实体并结合@EmbeddedId和@MapsId注解是一种强大且灵活的解决方案。这种方法将复杂的N-ary关系分解为更简单的多对一关系，使得领域模型更贴近数据库结构，并提供了对关系属性的直接操作能力，极大地增强了JPA实体映射的表达能力。