Оскільки це дуже поширене питання, я написав цю статтю , на якій ґрунтується ця відповідь.
Давайте припустимо , наше додаток використовує наступне 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;
//Getters and setters omitted for brevity
}
Клас 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<>();
//Getters and setters omitted for brevity
}
Суб'єкт 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;
//Getters and setters omitted for brevity
}
Усі атрибути сутності будуть представлені 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;
//Getters and setters omitted for brevity
}
І всі атрибути сутності представлені 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лінійку String при створенні Joinекземпляра, і ми використовували titleліній String при посиланні на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. Перегляньте цю статтю, щоб отримати докладніші відомості про плагін IDE Codota.
Або, скажімо , ми хочемо принести проекцію 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();
Класно, правда?
