Spring Boot中如何控制JPA关联子实体的抓取

我在Spring Boot项目中定义了如下实体关联关系：

Clazz实体 #

public class Clazz {

    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Id
    @Column(name = "id")
    private Integer id;

    @Column(name = "lesson_id")
    @NotNull(message = "{lesson.is_required}")
    private Integer lessonId;

    @Column(name = "level_id")
    @NotNull(message = "{level.is_required}")
    private Integer levelId;

    @Column(name = "name")
    @NotEmpty(message = "{name.is_required}")
    private String name;

    @OneToOne
    @JoinColumn(name = "lesson_id", referencedColumnName = "id", insertable = false, updatable = false)
    private Lesson lesson;

    @OneToOne
    @JoinColumn(name = "level_id", referencedColumnName = "id", insertable = false, updatable = false)
    private Level level;
}

Lesson实体 #

public class Lesson {
    @Id
    @Column(name = "id")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @Column(name = "name")
    @NotEmpty(message = "{name.is_required}")
    private String name;

    @Column(name = "description")
    private String description = "";

    @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER)
    @JoinColumn(name = "lesson_id")
    Collection<Level> levels = new ArrayList<>();
}

Level实体 #

public class Level {
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Id
    @Column(name = "id", insertable = false, updatable = false)
    private Integer id;

    @Column(name = "lesson_id")
    private Integer lessonId;

    @Column(name = "name")
    private String name;

    @Column(name = "step")
    private Integer step;

    @Column(name = "description")
    private String description="";
}

抓取数据时返回的结果包含了额外信息，尤其是lesson字段里的levels数据：

[
    {
        "id": 2,
        "lessonId": 1,
        "levelId": 1,
        "name": "English Class March",
        "branch": {
            "id": 1,
            "name": "3 mikr branch",
            "email": "",
            "phone": "",
            "address": "3 mikr, foo, bar"
        },
        "lesson": {
            "id": 1,
            "name": "math",
            "description": "math lesson",
            "levels": [
                {
                    "id": 1,
                    "lessonId": 1,
                    "name": "First level",
                    "step": 1,
                    "description": "1st level descr"
                }
            ]
        },
        "level": {
            "id": 1,
            "lessonId": 1,
            "name": "First level",
            "step": 1,
            "description": "1st level descr"
        }
    }
]

我该如何配置JPA使其不抓取子实体？尤其不希望返回结果中lesson字段包含levels数据。

1. 修改关联抓取策略为LAZY #

当前Lesson类中levels关联使用了FetchType.EAGER，这会导致加载Lesson时主动抓取levels集合。将其改为FetchType.LAZY后，JPA仅在显式调用lesson.getLevels()时才加载该集合：

@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.LAZY)
@JoinColumn(name = "lesson_id")
Collection<Level> levels = new ArrayList<>();

2. 用DTO过滤冗余字段 #

若不想修改JPA抓取策略，或需要更精细的字段控制，可定义DTO（数据传输对象），仅保留所需属性，查询时将实体转换为DTO返回。

例如定义LessonDTO：

public class LessonDTO {
    private Integer id;
    private String name;
    private String description;

    public LessonDTO(Lesson lesson) {
        this.id = lesson.getId();
        this.name = lesson.getName();
        this.description = lesson.getDescription();
    }

    // getter/setter方法
}

对应ClazzDTO：

public class ClazzDTO {
    private Integer id;
    private Integer lessonId;
    private Integer levelId;
    private String name;
    private LessonDTO lesson;
    private Level level;

    // 构造方法及getter/setter
}

在Service层查询后，将实体转换为DTO返回，即可避免返回levels字段。

3. 用JSON注解忽略字段 #

若仅需在JSON返回时隐藏levels，可在Lesson类的levels字段上添加@JsonIgnore注解（Spring Boot默认集成Jackson，无需额外依赖）：

@JsonIgnore
@OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER)
@JoinColumn(name = "lesson_id")
Collection<Level> levels = new ArrayList<>();

此方法仅在序列化JSON时忽略字段，JPA仍会抓取数据，但不会返回给前端。

4. 自定义JPQL查询 #

在Repository中编写自定义JPQL查询，仅选择所需字段，避免关联加载：

@Query("SELECT new com.yourpackage.ClazzDTO(c.id, c.lessonId, c.levelId, c.name, new com.yourpackage.LessonDTO(l.id, l.name, l.description), lv) FROM Clazz c JOIN c.lesson l JOIN c.level lv")
List<ClazzDTO> findAllWithoutLessonLevels();

通过投影到DTO，精准控制返回的字段内容，彻底避免加载levels数据。

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