Поскольку это очень частый вопрос, я написал эту статью , на которой основан этот ответ.
Давайте предположим , наше приложение использует следующее Post, PostComment, PostDetailsи Tagобъекты, которые образуют один-ко-многим, один-к-одному и многие-ко-многим отношений таблицы :
Как создать метамодель критериев JPA
hibernate-jpamodelgenИнструмент , предоставляемый Hibernate ORM может быть использован для сканирования объектов проекта и создания JPA Критерии метамодели. Все , что вам нужно сделать , это добавить следующее annotationProcessorPathк maven-compiler-pluginв Maven pom.xmlконфигурационном файле:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven-compiler-plugin.version}</version>
<configuration>
<annotationProcessorPaths>
<annotationProcessorPath>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-jpamodelgen</artifactId>
<version>${hibernate.version}</version>
</annotationProcessorPath>
</annotationProcessorPaths>
</configuration>
</plugin>
Теперь, когда проект скомпилирован, вы можете увидеть, что в targetпапке генерируются следующие классы Java:
> tree target/generated-sources/
target/generated-sources/
└── annotations
└── com
└── vladmihalcea
└── book
└── hpjp
└── hibernate
├── forum
│ ├── PostComment_.java
│ ├── PostDetails_.java
│ ├── Post_.java
│ └── Tag_.java
Метамодель объекта тега
Если Tagобъект отображается следующим образом:
@Entity
@Table(name = "tag")
public class Tag {
@Id
private Long id;
private String name;
}
Класс Tag_Metamodel создается следующим образом:
@Generated(value = "org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor")
@StaticMetamodel(Tag.class)
public abstract class Tag_ {
public static volatile SingularAttribute<Tag, String> name;
public static volatile SingularAttribute<Tag, Long> id;
public static final String NAME = "name";
public static final String ID = "id";
}
SingularAttributeИспользуется для основных idи name TagJPA атрибутов сущностей.
Метамодель объекта публикации
PostОбъект отображается следующим образом:
@Entity
@Table(name = "post")
public class Post {
@Id
private Long id;
private String title;
@OneToMany(
mappedBy = "post",
cascade = CascadeType.ALL,
orphanRemoval = true
)
private List<PostComment> comments = new ArrayList<>();
@OneToOne(
mappedBy = "post",
cascade = CascadeType.ALL,
fetch = FetchType.LAZY
)
@LazyToOne(LazyToOneOption.NO_PROXY)
private PostDetails details;
@ManyToMany
@JoinTable(
name = "post_tag",
joinColumns = @JoinColumn(name = "post_id"),
inverseJoinColumns = @JoinColumn(name = "tag_id")
)
private List<Tag> tags = new ArrayList<>();
}
PostПредприятие имеет два основных атрибутов, idи title, один-ко-многим commentsколлекции, один-к-одному detailsассоциации, и многие-ко-многим tagsколлекции.
Класс Post_Metamodel создается следующим образом:
@Generated(value = "org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor")
@StaticMetamodel(Post.class)
public abstract class Post_ {
public static volatile ListAttribute<Post, PostComment> comments;
public static volatile SingularAttribute<Post, PostDetails> details;
public static volatile SingularAttribute<Post, Long> id;
public static volatile SingularAttribute<Post, String> title;
public static volatile ListAttribute<Post, Tag> tags;
public static final String COMMENTS = "comments";
public static final String DETAILS = "details";
public static final String ID = "id";
public static final String TITLE = "title";
public static final String TAGS = "tags";
}
Основной idи titleатрибуты, а также один-к-одному detailsассоциации, которые представлены в SingularAttributeто время как commentsи tagsколлекции представлены JPA ListAttribute.
Метамодель сущности PostDetails
PostDetailsОбъект отображается следующим образом:
@Entity
@Table(name = "post_details")
public class PostDetails {
@Id
@GeneratedValue
private Long id;
@Column(name = "created_on")
private Date createdOn;
@Column(name = "created_by")
private String createdBy;
@OneToOne(fetch = FetchType.LAZY)
@MapsId
@JoinColumn(name = "id")
private Post post;
}
Все атрибуты сущности будут представлены JPA SingularAttributeв связанном PostDetails_классе Metamodel:
@Generated(value = "org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor")
@StaticMetamodel(PostDetails.class)
public abstract class PostDetails_ {
public static volatile SingularAttribute<PostDetails, Post> post;
public static volatile SingularAttribute<PostDetails, String> createdBy;
public static volatile SingularAttribute<PostDetails, Long> id;
public static volatile SingularAttribute<PostDetails, Date> createdOn;
public static final String POST = "post";
public static final String CREATED_BY = "createdBy";
public static final String ID = "id";
public static final String CREATED_ON = "createdOn";
}
Метамодель объекта PostComment
PostCommentОтображаются следующим образом :
@Entity
@Table(name = "post_comment")
public class PostComment {
@Id
private Long id;
@ManyToOne(fetch = FetchType.LAZY)
private Post post;
private String review;
}
И все атрибуты сущности представлены JPA SingularAttributeв связанном PostComments_классе Metamodel:
@Generated(value = "org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor")
@StaticMetamodel(PostComment.class)
public abstract class PostComment_ {
public static volatile SingularAttribute<PostComment, Post> post;
public static volatile SingularAttribute<PostComment, String> review;
public static volatile SingularAttribute<PostComment, Long> id;
public static final String POST = "post";
public static final String REVIEW = "review";
public static final String ID = "id";
}
Использование метамодели критериев JPA
Без метамодели JPA запрос API критериев, который должен получать PostCommentобъекты, отфильтрованные по их связанному Postзаголовку, выглядел бы следующим образом:
CriteriaBuilder builder = entityManager.getCriteriaBuilder();
CriteriaQuery<PostComment> query = builder.createQuery(PostComment.class);
Root<PostComment> postComment = query.from(PostComment.class);
Join<PostComment, Post> post = postComment.join("post");
query.where(
builder.equal(
post.get("title"),
"High-Performance Java Persistence"
)
);
List<PostComment> comments = entityManager
.createQuery(query)
.getResultList();
Обратите внимание, что мы использовали postстроковый литерал при создании Joinэкземпляра, и мы использовали titleстроковый литерал при ссылке на Post title.
Метамодель JPA позволяет нам избежать жесткого кодирования атрибутов сущности, как показано в следующем примере:
CriteriaBuilder builder = entityManager.getCriteriaBuilder();
CriteriaQuery<PostComment> query = builder.createQuery(PostComment.class);
Root<PostComment> postComment = query.from(PostComment.class);
Join<PostComment, Post> post = postComment.join(PostComment_.post);
query.where(
builder.equal(
post.get(Post_.title),
"High-Performance Java Persistence"
)
);
List<PostComment> comments = entityManager
.createQuery(query)
.getResultList();
Написание запросов API критериев JPA намного проще, если вы используете инструмент завершения кода, такой как Codota. Проверьте эту статью для более подробной информации о плагине Codota IDE.
Или, скажем , мы хотим принести проекцию DTO во время фильтрации Post titleи на PostDetails createdOnатрибуты.
Мы можем использовать метамодель при создании атрибутов соединения, а также при создании псевдонимов столбцов проекции DTO или при ссылке на атрибуты сущности, которые нам нужно фильтровать:
CriteriaBuilder builder = entityManager.getCriteriaBuilder();
CriteriaQuery<Object[]> query = builder.createQuery(Object[].class);
Root<PostComment> postComment = query.from(PostComment.class);
Join<PostComment, Post> post = postComment.join(PostComment_.post);
query.multiselect(
postComment.get(PostComment_.id).alias(PostComment_.ID),
postComment.get(PostComment_.review).alias(PostComment_.REVIEW),
post.get(Post_.title).alias(Post_.TITLE)
);
query.where(
builder.and(
builder.like(
post.get(Post_.title),
"%Java Persistence%"
),
builder.equal(
post.get(Post_.details).get(PostDetails_.CREATED_BY),
"Vlad Mihalcea"
)
)
);
List<PostCommentSummary> comments = entityManager
.createQuery(query)
.unwrap(Query.class)
.setResultTransformer(Transformers.aliasToBean(PostCommentSummary.class))
.getResultList();
Круто, правда?
