Spring Boot JPA如何获取含关联表额外字段的子实体列表？

当关联表（如ENTITY_BUTTONS）存在额外字段时，原生的@ManyToMany注解无法满足同时获取子实体及关联表字段的需求，必须将关联表转为独立实体类，通过@OneToMany与@ManyToOne的组合关联来实现。以下是具体实现方案：

1. 创建中间关联实体类 #

首先定义对应ENTITY_BUTTONS表的实体类EntityButton，包含复合主键、关联的Entity/Button实体，以及所有额外字段：

复合主键类（对应关联表的两个外键） #

@Embeddable
public class EntityButtonId implements Serializable {
    @Column(name = "ENTITY_ID")
    private Long entityId;

    @Column(name = "BUTTON_ID")
    private Long buttonId;

    public EntityButtonId() {}

    public EntityButtonId(Long entityId, Long buttonId) {
        this.entityId = entityId;
        this.buttonId = buttonId;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        EntityButtonId that = (EntityButtonId) o;
        return Objects.equals(entityId, that.entityId) && Objects.equals(buttonId, that.buttonId);
    }

    @Override
    public int hashCode() {
        return Objects.hash(entityId, buttonId);
    }

    // 省略getter、setter
}

中间关联实体类 #

@Entity
@Table(name = "ENTITY_BUTTONS")
@Where(clause = "active = true and is_deleted = false") // 原关联表过滤条件移至此处
public class EntityButton {
    @EmbeddedId
    private EntityButtonId id;

    @ManyToOne(fetch = FetchType.LAZY)
    @MapsId("entityId") // 关联复合主键中的entityId字段
    @JoinColumn(name = "ENTITY_ID")
    private Entity entity;

    @ManyToOne(fetch = FetchType.LAZY)
    @MapsId("buttonId") // 关联复合主键中的buttonId字段
    @JoinColumn(name = "BUTTON_ID")
    private Button button;

    // 关联表额外字段
    private Boolean active;
    private Boolean isDeleted;
    // 其他额外字段...

    public EntityButton() {}

    public EntityButton(Entity entity, Button button, Boolean active, Boolean isDeleted) {
        this.id = new EntityButtonId(entity.getId(), button.getId());
        this.entity = entity;
        this.button = button;
        this.active = active;
        this.isDeleted = isDeleted;
    }

    // 省略getter、setter
}

2. 修改原Entity实体类 #

将原来的List<Button>替换为List<EntityButton>，并建立@OneToMany关联：

@Entity
@Table(name = "ENTITIES")
public class Entity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @OneToMany(mappedBy = "entity", cascade = CascadeType.ALL, orphanRemoval = true)
    // 若需自动加载可设为FetchType.EAGER，但推荐结合JOIN FETCH查询优化性能
    private List<EntityButton> entityButtons = new ArrayList<>();

    // 便捷方法：维护双向关联关系
    public void addButton(Button button, Boolean active, Boolean isDeleted) {
        EntityButton entityButton = new EntityButton(this, button, active, isDeleted);
        entityButtons.add(entityButton);
        button.getEntityButtons().add(entityButton); // 需Button类支持双向关联
    }

    // 省略getter、setter
}

3. 可选：修改Button实体类（支持双向关联） #

如果需要从Button反向关联到Entity，可添加如下代码：

@Entity
@Table(name = "BUTTONS")
public class Button {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @OneToMany(mappedBy = "button", cascade = CascadeType.ALL, orphanRemoval = true)
    private List<EntityButton> entityButtons = new ArrayList<>();

    // 省略getter、setter
}

4. 实现完整层级自动加载 #

为避免N+1查询问题，推荐在Repository中使用JOIN FETCH语句一次性加载所有关联数据：

public interface EntityRepository extends JpaRepository<Entity, Long> {
    @Query("select e from Entity e join fetch e.entityButtons eb join fetch eb.button where e.id = :id")
    Entity findByIdWithButtons(Long id);
}

调用该方法即可获取包含所有关联数据的Entity：Entity -> EntityButton（含额外字段）-> Button。

注意事项 #

• 避免滥用FetchType.EAGER，否则可能引发性能问题，优先使用JOIN FETCH按需加载。
• 复合主键类必须实现Serializable接口，并正确重写equals和hashCode方法。
• 维护双向关联时，务必通过便捷方法（如addButton）同步两边的关联关系，防止持久化异常。

内容的提问来源于stack exchange，提问作者ivoronline