jpa 实体图查询_JPA实体图

jpa 实体图查询

JPA 2.1的最新功能之一是可以使用实体图指定获取计划。这很有用，因为它允许您自定义使用查询或查找操作检索的数据。在使用中大型应用程序时，通常以不同的方式显示来自同一实体的数据。在其他情况下，您只想选择最小的信息集即可优化应用程序的性能。

您没有很多机制可以控制JPA实体中加载或不加载的内容。您可以使用EAGER / LAZY提取，但是这些定义几乎是静态的。您在检索数据时无法更改其行为，这意味着您受制于实体中定义的内容。在开发中更改这些内容是一场噩梦，因为这可能会导致查询行为异常。控制加载的另一种方法是编写特定的JPQL查询。通常，您最终会得到非常相似的查询和以下方法： findEntityWithX ， findEntityWithY ， findEntityWithXandY等。

在JPA 2.1之前，实现已经支持一种类似于实体图的非标准方式来加载数据。您具有Hibernate Fetch配置文件， OpenJPA Fetch组和EclipseLink Fetch组。在规范中具有这种行为是合乎逻辑的。它允许您使用标准API对需要加载的内容进行更精细和详细的控制。

例

考虑以下实体图：

电影实体图

（关系应该是N到N，但让它保持简单）。

电影实体具有以下定义：

电影.java

@Entity
@Table(name = "MOVIE_ENTITY_GRAPH")
@NamedQueries({@NamedQuery(name = "Movie.findAll", query = "SELECT m FROM Movie m")
})
@NamedEntityGraphs({@NamedEntityGraph(name = "movieWithActors",attributeNodes = {@NamedAttributeNode("movieActors")}),@NamedEntityGraph(name = "movieWithActorsAndAwards",attributeNodes = {@NamedAttributeNode(value = "movieActors", subgraph = "movieActorsGraph")},subgraphs = {@NamedSubgraph(name = "movieActorsGraph",attributeNodes = {@NamedAttributeNode("movieActorAwards")})})
})
public class Movie implements Serializable {@Idprivate Integer id;@NotNull@Size(max = 50)private String name;@OneToMany@JoinColumn(name = "ID")private Set<MovieActor> movieActors;@OneToMany(fetch = FetchType.EAGER)@JoinColumn(name = "ID")private Set<MovieDirector> movieDirectors;@OneToMany@JoinColumn(name = "ID")private Set<MovieAward> movieAwards;
}

靠近实体，我们可以看到我们有3个1到N的关系，并且movieDirectors设置为Eagerly加载。其他关系设置为默认的延迟加载策略。如果要更改此行为，可以使用批注@NamedEntityGraph定义不同的加载模型。只需设置一个名称即可识别它，然后使用@NamedAttributeNode指定要加载的根实体的哪些属性。对于关系，您需要为子图设置一个名称，然后使用@NamedSubgraph 。详细地：

注解

实体图movieWithActors

@NamedEntityGraph(name = "movieWithActors",attributeNodes = {@NamedAttributeNode("movieActors")}) )

这定义了一个名称为movieWithActors的实体图，并指定了应加载关系movieActors 。

实体图movieWithActorsAndAwards

@NamedEntityGraph(name = "movieWithActorsAndAwards",attributeNodes = {@NamedAttributeNode(value = "movieActors", subgraph = "movieActorsGraph")},subgraphs = {@NamedSubgraph(name = "movieActorsGraph",attributeNodes = {@NamedAttributeNode("movieActorAwards")})})

这将定义一个名称为movieWithActorsAndAwards的实体图，并指定应加载关系movieActors 。此外，它还指定关系movieActors应该加载movieActorAwards 。

请注意，我们没有在实体图中指定id属性。这是因为无论指定什么内容，总是会获取主键。版本属性也是如此。

提示

要使用查询中定义的实体图，您需要将它们设置为提示。您可以使用两个提示属性，它们也会影响数据的加载方式。

您可以使用javax.persistence.fetchgraph ，此提示会将Entity Graph中所有指定的属性视为FetchType.EAGER 。未指定的属性被视为FetchType.LAZY 。

另一个属性提示是javax.persistence.loadgraph 。这会将Entity Graph中所有指定的属性视为FetchType.EAGER 。未指定的属性将被视为其指定的或默认的FetchType 。

为了简化，并基于我们的示例，当应用实体图movieWithActors ：

	默认/指定	javax.persistence.fetchgraph	javax.persistence.loadgraph
电影演员	懒	急于	急于
电影导演	急于	懒	急于
电影奖	懒	懒	懒

从理论上讲，这应该是获取不同关系的方式。实际上，它可能无法以这种方式工作，因为JPA 2.1规范还指出，JPA提供程序始终可以获取除实体图中指定的状态之外的其他状态。这是因为提供程序可以优化要获取的数据并最终加载更多的数据。您需要检查提供商的行为。例如，即使使用javax.persistence.fetchgraph提示，Hibernate始终会获取指定为EAGER的所有内容。在此处检查问题。

询问

执行查询很容易。您可以setHint进行操作，但是只需对Query对象调用setHint ：

提示实体图

@PersistenceContextprivate EntityManager entityManager;public List<Movie> listMovies(String hint, String graphName) {return entityManager.createNamedQuery("Movie.findAll").setHint(hint, entityManager.getEntityGraph(graphName)).getResultList();}

要获取要在查询中使用的实体图，您需要在EntityManager上调用getEntityGraph方法并传递名称。然后在提示中使用参考。提示必须是javax.persistence.fetchgraph或javax.persistence.loadgraph 。

程式化

注释可能变得冗长，尤其是当您有大图或许多实体图时。您可以以编程方式定义实体图，而不必使用注释。让我们看看如何：

首先添加一个静态元模型实体类：

Movie_.java

@StaticMetamodel(Movie.class)
public abstract class Movie_ {public static volatile SingularAttribute<Movie, Integer> id;public static volatile SetAttribute<Movie, MovieAward> movieAwards;public static volatile SingularAttribute<Movie, String> name;public static volatile SetAttribute<Movie, MovieActor> movieActors;public static volatile SetAttribute<Movie, MovieDirector> movieDirectors;
}

确实不是必需的，您可以通过字符串名称来引用属性，但这将使您键入安全。

程序实体图

EntityGraph<Movie> fetchAll = entityManager.createEntityGraph(Movie.class);fetchAll.addSubgraph(Movie_.movieActors);fetchAll.addSubgraph(Movie_.movieDirectors);fetchAll.addSubgraph(Movie_.movieAwards);

该实体图指定必须加载该实体的所有关系。现在，您可以调整自己的用例。