JPA 实体图的目标是什么?
What's the goal of the JPA Entity Graph?
我一直在学习 JPA
,我发现从 JPA
2.1 开始我们就可以使用实体图。
但我还没有理解实体图的优点。
我知道使用实体图的优点之一是我们可以只指定我们想要在整个实体中获取的数据,但是如果我们想要整个实体,还有其他原因吗?使用实体图?
或者只有当我们想要检索部分数据时才应该使用实体图?
如果我们使用实体图还有其他的目的或优点,我想知道。
在 JPA/Hibernate 中获取具有关联的实体一直是
性能问题。
- 在事务中一次又一次延迟加载关联会导致 n+1 select 个问题,为了避免此类问题,JPQL
使用 join fetch 和 Criteria api 连接。但是获取数据
这两个也会导致交叉连接问题意味着交叉连接所有
table 休眠将记录返回给应用程序。
- 此外,更改实体级别注释中定义的获取变量也不是用例到用例基础的好选择。
- 因此为了解决以上两个问题引入了实体图。实体图中定义的所有节点总是渴望的
无论它们在实体级别上的定义如何,都可以获取。这些
图表作为查询的提示传递。
- 通过将图形作为提示传递,交叉连接问题也得到解决,注释级别指定的关联提取行为也可以解决
也被改变了。
代码你可以查看my Github repository。
JPA Entity Graph
允许您覆盖默认的获取计划。
默认获取计划
正如我在 this article 中解释的那样,每个实体都有一个在实体映射期间定义的默认获取计划,并指示 Hibernate 如何获取实体关联。
默认情况下,@ManyToOne
和 @OneToOne
关联使用 FetchTyp.EAGER 策略,从性能角度来看,这是一个糟糕的选择。因此,出于这个原因,最好将所有 @ManyToOne
和 @OneToOne
关联设置为使用 FetchType.LAZY
策略,如以下示例所示:
@Entity(name = "PostComment")
@Table(name = "post_comment")
public class PostComment {
@Id
private Long id;
@ManyToOne(fetch = FetchType.LAZY)
private Post post;
private String review;
//Getters and setters omitted for brevity
}
使用 find
方法获取 PostComment
实体时:
PostComment comment = entityManager.find(PostComment.class, 1L);
Hibernate 执行以下 SQL 查询:
SELECT pc.id AS id1_1_0_,
pc.post_id AS post_id3_1_0_,
pc.review AS review2_1_0_
FROM post_comment pc
WHERE pc.id = 1
post
关联被提取为 Proxy,它只有 id
由上述 [=89 加载的 post_id
外键列设置=] 查询.
访问 post
代理的任何非 ID 属性 时:
LOGGER.info("The comment post title is '{}'", comment.getPost().getTitle());
执行辅助 SQL 查询,按需获取 Post
实体:
SELECT p.id AS id1_0_0_,
p.title AS title2_0_0_
FROM post p
WHERE p.id = 1
-- The comment post title is 'High-Performance Java Persistence, part 1'
覆盖默认的获取计划
如果我们想覆盖默认的获取计划并在查询执行时急切地获取 post
关联,我们可以使用 JPQL 查询指示 Hibernate 使用 FETCH JOIN 子句获取惰性关联:
PostComment comment = entityManager.createQuery("""
select pc
from PostComment pc
left join fetch pc.post
where pc.id = :id
""", PostComment.class)
.setParameter("id", 1L)
.getSingleResult();
LOGGER.info("The comment post title is '{}'", comment.getPost().getTitle());
然后,默认的抓取计划将被覆盖,post
关联将被急切抓取:
SELECT pc.id AS id1_1_0_,
p.id AS id1_0_1_,
pc.post_id AS post_id3_1_0_,
pc.review AS review2_1_0_,
p.title AS title2_0_1_
FROM post_comment pc
LEFT JOIN post p ON pc.post_id = p.id
WHERE pc.id = 1
声明式 JPA 实体图
也可以使用 JPA 实体图覆盖默认获取计划。例如,我们可以使用以下 JPA @EntityGraph
注释定义特定的获取计划:
@Entity(name = "PostComment")
@Table(name = "post_comment")
@NamedEntityGraph(
name = "PostComment.post",
attributeNodes = @NamedAttributeNode("post")
)
public class PostComment {
//Code omitted for brevity
}
有了 PostComment.post
实体图,我们现在可以加载 PostComment
实体及其关联的 post
实体,如下所示:
PostComment comment = entityManager.find(
PostComment.class,
1L,
Collections.singletonMap(
"javax.persistence.loadgraph",
entityManager.getEntityGraph("PostComment.post")
)
);
并且,当执行上述 find
方法时,Hibernate 生成以下 SQL SELECT 查询:
SELECT pc.id AS id1_1_0_,
pc.post_id AS post_id3_1_0_,
pc.review AS review2_1_0_,
p.id AS id1_0_1_,
p.title AS title2_0_1_
FROM post_comment pc
LEFT OUTER JOIN post p ON pc.post_id = p.id
WHERE pc.id = 1
如果您正在使用 Spring,那么您可以使用 @EntityGraph
注释在 Repository 方法中引用 JPA 实体图:
@Repository
public interface PostCommentRepository
extends CrudRepository<PostComment, Long> {
@EntityGraph(
value = "PostComment.post",
type = EntityGraphType.LOAD
)
PostComment findById(Long id);
}
程序化 JPA 实体图
如果您不喜欢注释,那么您也可以使用 JPA EntityManager
的 createEntityGraph
方法以编程方式构建 JPA 实体图,如下例所示:
EntityGraph<PostComment> postCommentGraph = entityManager
.createEntityGraph(PostComment.class);
postCommentGraph.addAttributeNodes("post");
PostComment comment = entityManager.find(
PostComment.class,
1L,
Collections.singletonMap(
"javax.persistence.loadgraph",
postCommentGraph
)
);
我一直在学习 JPA
,我发现从 JPA
2.1 开始我们就可以使用实体图。
但我还没有理解实体图的优点。
我知道使用实体图的优点之一是我们可以只指定我们想要在整个实体中获取的数据,但是如果我们想要整个实体,还有其他原因吗?使用实体图?
或者只有当我们想要检索部分数据时才应该使用实体图?
如果我们使用实体图还有其他的目的或优点,我想知道。
在 JPA/Hibernate 中获取具有关联的实体一直是 性能问题。
- 在事务中一次又一次延迟加载关联会导致 n+1 select 个问题,为了避免此类问题,JPQL 使用 join fetch 和 Criteria api 连接。但是获取数据 这两个也会导致交叉连接问题意味着交叉连接所有 table 休眠将记录返回给应用程序。
- 此外,更改实体级别注释中定义的获取变量也不是用例到用例基础的好选择。
- 因此为了解决以上两个问题引入了实体图。实体图中定义的所有节点总是渴望的 无论它们在实体级别上的定义如何,都可以获取。这些 图表作为查询的提示传递。
- 通过将图形作为提示传递,交叉连接问题也得到解决,注释级别指定的关联提取行为也可以解决 也被改变了。
代码你可以查看my Github repository。
JPA Entity Graph
允许您覆盖默认的获取计划。
默认获取计划
正如我在 this article 中解释的那样,每个实体都有一个在实体映射期间定义的默认获取计划,并指示 Hibernate 如何获取实体关联。
默认情况下,@ManyToOne
和 @OneToOne
关联使用 FetchTyp.EAGER 策略,从性能角度来看,这是一个糟糕的选择。因此,出于这个原因,最好将所有 @ManyToOne
和 @OneToOne
关联设置为使用 FetchType.LAZY
策略,如以下示例所示:
@Entity(name = "PostComment")
@Table(name = "post_comment")
public class PostComment {
@Id
private Long id;
@ManyToOne(fetch = FetchType.LAZY)
private Post post;
private String review;
//Getters and setters omitted for brevity
}
使用 find
方法获取 PostComment
实体时:
PostComment comment = entityManager.find(PostComment.class, 1L);
Hibernate 执行以下 SQL 查询:
SELECT pc.id AS id1_1_0_,
pc.post_id AS post_id3_1_0_,
pc.review AS review2_1_0_
FROM post_comment pc
WHERE pc.id = 1
post
关联被提取为 Proxy,它只有 id
由上述 [=89 加载的 post_id
外键列设置=] 查询.
访问 post
代理的任何非 ID 属性 时:
LOGGER.info("The comment post title is '{}'", comment.getPost().getTitle());
执行辅助 SQL 查询,按需获取 Post
实体:
SELECT p.id AS id1_0_0_,
p.title AS title2_0_0_
FROM post p
WHERE p.id = 1
-- The comment post title is 'High-Performance Java Persistence, part 1'
覆盖默认的获取计划
如果我们想覆盖默认的获取计划并在查询执行时急切地获取 post
关联,我们可以使用 JPQL 查询指示 Hibernate 使用 FETCH JOIN 子句获取惰性关联:
PostComment comment = entityManager.createQuery("""
select pc
from PostComment pc
left join fetch pc.post
where pc.id = :id
""", PostComment.class)
.setParameter("id", 1L)
.getSingleResult();
LOGGER.info("The comment post title is '{}'", comment.getPost().getTitle());
然后,默认的抓取计划将被覆盖,post
关联将被急切抓取:
SELECT pc.id AS id1_1_0_,
p.id AS id1_0_1_,
pc.post_id AS post_id3_1_0_,
pc.review AS review2_1_0_,
p.title AS title2_0_1_
FROM post_comment pc
LEFT JOIN post p ON pc.post_id = p.id
WHERE pc.id = 1
声明式 JPA 实体图
也可以使用 JPA 实体图覆盖默认获取计划。例如,我们可以使用以下 JPA @EntityGraph
注释定义特定的获取计划:
@Entity(name = "PostComment")
@Table(name = "post_comment")
@NamedEntityGraph(
name = "PostComment.post",
attributeNodes = @NamedAttributeNode("post")
)
public class PostComment {
//Code omitted for brevity
}
有了 PostComment.post
实体图,我们现在可以加载 PostComment
实体及其关联的 post
实体,如下所示:
PostComment comment = entityManager.find(
PostComment.class,
1L,
Collections.singletonMap(
"javax.persistence.loadgraph",
entityManager.getEntityGraph("PostComment.post")
)
);
并且,当执行上述 find
方法时,Hibernate 生成以下 SQL SELECT 查询:
SELECT pc.id AS id1_1_0_,
pc.post_id AS post_id3_1_0_,
pc.review AS review2_1_0_,
p.id AS id1_0_1_,
p.title AS title2_0_1_
FROM post_comment pc
LEFT OUTER JOIN post p ON pc.post_id = p.id
WHERE pc.id = 1
如果您正在使用 Spring,那么您可以使用 @EntityGraph
注释在 Repository 方法中引用 JPA 实体图:
@Repository
public interface PostCommentRepository
extends CrudRepository<PostComment, Long> {
@EntityGraph(
value = "PostComment.post",
type = EntityGraphType.LOAD
)
PostComment findById(Long id);
}
程序化 JPA 实体图
如果您不喜欢注释,那么您也可以使用 JPA EntityManager
的 createEntityGraph
方法以编程方式构建 JPA 实体图,如下例所示:
EntityGraph<PostComment> postCommentGraph = entityManager
.createEntityGraph(PostComment.class);
postCommentGraph.addAttributeNodes("post");
PostComment comment = entityManager.find(
PostComment.class,
1L,
Collections.singletonMap(
"javax.persistence.loadgraph",
postCommentGraph
)
);