Using Blaze-Persistence
Blaze-Persistence offers a fluent query builder API on top of Jakarta Persistence with a deep Hibernate ORM integration that enables the use of advanced SQL features like Common Table Expressions while staying in the realm of the Jakarta Persistence model.
On top of that, the Blaze-Persistence Entity-View module allows for DTO definitions that can be applied to business logic queries which are then transformed to optimized queries that only fetch the data that is needed to construct the DTO instances. The same DTO definitions can further be used for applying database updates, leading to a great reduction in boilerplate code and removing the need for object mapping tools.
|
This extension is developed by a third party and is part of the Quarkus Platform. |
Setting up and configuring Blaze-Persistence
The extension comes with default producers for CriteriaBuilderFactory and EntityViewManager that work out of the
box given a working Hibernate ORM configuration. For customization, overriding of the default producers is possible via the
standard mechanism as documented in the Quarkus CDI reference.
This is needed if you need to set custom Blaze-Persistence properties.
In Quarkus, you just need to:
-
@InjectCriteriaBuilderFactoryorEntityViewManagerand use it -
annotate your entity views with
@EntityViewand any other mapping annotation as usual
Add the following dependencies to your project:
-
the Blaze-Persistence extension:
com.blazebit:blaze-persistence-integration-quarkus-3 -
further Blaze-Persistence integrations as needed:
-
blaze-persistence-integration-jackson-jakartafor Jackson -
blaze-persistence-integration-jsonb-jakartafor JSONB -
blaze-persistence-integration-jaxrsfor Jakarta REST -
blaze-persistence-integration-jaxrs-jackson-jakartafor Jakarta REST with Jackson -
blaze-persistence-integration-jaxrs-jsonb-jakartafor Jakarta REST with JSONB
-
<!-- Blaze-Persistence specific dependencies -->
<dependency>
<groupId>com.blazebit</groupId>
<artifactId>blaze-persistence-integration-quarkus-3</artifactId>
</dependency>
<dependency>
<groupId>com.blazebit</groupId>
<artifactId>blaze-persistence-integration-hibernate-6.2</artifactId>
<scope>runtime</scope>
</dependency>implementation("com.blazebit:blaze-persistence-integration-quarkus-3")
runtimeOnly("com.blazebit:blaze-persistence-integration-hibernate-6.2")The use in native images requires a dependency on the entity view annotation processor that may be extracted into a separate native profile:
<profiles>
<profile>
<id>native</id>
<dependencies>
<dependency>
<groupId>com.blazebit</groupId>
<artifactId>blaze-persistence-entity-view-processor-jakarta</artifactId>
<scope>provided</scope>
</dependency>
</dependencies>
</profile>
</profiles>A CriteriaBuilderFactory and an EntityViewManager will be created based on the configured EntityManagerFactory as provided by the Hibernate-ORM extension.
You can then access these beans via injection:
@ApplicationScoped
public class SantaClausService {
@Inject
EntityManager em; (1)
@Inject
CriteriaBuilderFactory cbf; (2)
@Inject
EntityViewManager evm; (3)
@Transactional (4)
public List<GiftView> findAllGifts() {
CriteriaBuilder<Gift> cb = cbf.create(em, Gift.class);
return evm.applySetting(EntityViewSetting.create(GiftView.class), cb).getResultList();
}
}| 1 | Inject the EntityManager |
| 2 | Inject the CriteriaBuilderFactory |
| 3 | Inject the EntityViewManager |
| 4 | Mark your CDI bean method as @Transactional so that a transaction is started or joined. |
@Entity
public class Gift {
private Long id;
private String name;
private String description;
@Id @GeneratedValue(strategy = GenerationType.SEQUENCE, generator="giftSeq")
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
}@EntityView(Gift.class)
public interface GiftView {
@IdMapping
Long getId();
String getName();
}@UpdatableEntityView
@CreatableEntityView
@EntityView(Gift.class)
public interface GiftUpdateView extends GiftView {
void setName(String name);
}@Path("/gifts")
public class GiftResource {
@Inject
EntityManager entityManager;
@Inject
EntityViewManager entityViewManager;
@Inject
SantaClausService santaClausService;
@POST
@Transactional
public Response createGift(GiftUpdateView view) {
entityViewManager.save(entityManager, view);
return Response.created(URI.create("/gifts/" + view.getId())).build();
}
@GET
@Produces(MediaType.APPLICATION_JSON)
public List<GiftView> getGifts() {
return santaClausService.findAllGifts();
}
@PUT
@Path("{id}")
@Transactional
public GiftView updateGift(@EntityViewId("id") GiftUpdateView view) {
entityViewManager.save(entityManager, view);
return entityViewManager.find(entityManager, GiftView.class, view.getId());
}
@GET
@Path("{id"})
@Produces(MediaType.APPLICATION_JSON)
public GiftView getGift(Long id) {
return return entityViewManager.find(entityManager, GiftView.class, view.getId());
}
}Blaze-Persistence configuration properties
There are various optional properties useful to refine your EntityViewManager and CriteriaBuilderFactory or guide guesses of Quarkus.
There are no required properties, as long as the Hibernate ORM extension is configured properly.
When no property is set, the Blaze-Persistence defaults apply.
The configuration properties listed here allow you to override such defaults, and customize and tune various aspects.
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Type |
Default |
|
|---|---|---|
A boolean flag to make it possible to prepare all view template caches on startup. By default, the eager loading of the view templates is disabled to have a better startup performance. Valid values for this property are Show more |
boolean |
|
An integer value that defines the default batch size for entity view attributes. By default, the value is 1 and can be overridden either via Show more |
int |
|
A mode specifying if correlation value, view root or embedded view batching is expected. By default, the value is Show more |
string |
|
A boolean flag to make it possible to prepare the entity view updater cache on startup. By default, the eager loading of entity view updates is disabled to have a better startup performance. Valid values for this property are Show more |
boolean |
|
A boolean flag to make it possible to disable the strict validation that disallows the use of an updatable entity view type for owned relationships. By default, the use is disallowed i.e. the default value is Show more |
boolean |
|
A boolean flag to make it possible to disable the strict cascading check that disallows setting updatable or creatable entity views on non-cascading attributes before being associated with a cascading attribute. When disabled, it is possible, like in Jakarta Persistence, that the changes done to an updatable entity view are not flushed when it is not associated with an attribute that cascades updates. By default, the use is enabled i.e. the default value is Show more |
boolean |
|
A boolean flag that allows to switch from warnings to boot time validation errors when invalid plural attribute setters are encountered while the strict cascading check is enabled. When Show more |
boolean |
|
A boolean flag that allows to specify if empty flat views should be created by default if not specified via Show more |
boolean |
|
The full qualified expression cache implementation class name. Show more |
string |
|
If set to true, the CTE queries are inlined by default. Valid values for this property are Show more |
boolean |
Apart from these configuration options, further configuration and customization can be applied by observing a CriteriaBuilderConfiguration or EntityViewConfiguration events and applying customizations on these objects. The various customization use cases can be found in the Quarkus section of the entity-view documentation.
@ApplicationScoped
public class BlazePersistenceConfigurer {
public void configure(@Observes CriteriaBuilderConfiguration config) {
config.setProperty("...", "...");
}
public void configure(@Observes EntityViewConfiguration config) {
// Register custom BasicUserType or register type test values
config.registerBasicUserType(MyClass.class, MyClassBasicUserType.class);
}
}
