Merge pull request #47792 from ayagmar/issues/46843_hibernate_orm_cdi

Add CDI support for additional JPA/Hibernate components

Author: geoand

.gitignore

@@ -14,12 +14,9 @@ lib
 bin
 !devtools/cli/distribution/java-binary/bin
 dependency-reduced-pom.xml
-derby.log
-hotspot.log
 .directory
 .java-version
 .graal-install
-hs_err_pid*.log
 dumps
 *.orig
 *.rej
@@ -31,9 +28,8 @@ ObjectStore
 .gradle
 docker/distroless/bazel-*
 /.apt_generated_tests/
-quarkus.log
-quarkus.log*
-replay_*.logß
+*.log
+*.log*
 nbactions.xml
 nb-configuration.xml
 .cache

docs/src/main/asciidoc/hibernate-orm.adoc

@@ -501,6 +501,47 @@ You can inject the `EntityManagerFactory` of a named persistence unit using the
 EntityManagerFactory entityManagerFactory;
 ----
 
+In addition to `EntityManager` and `EntityManagerFactory`, Quarkus also supports injecting the following JPA/Hibernate components:
+
+[source,java]
+----
+@Inject
+CriteriaBuilder criteriaBuilder;
+
+@Inject
+HibernateCriteriaBuilder hibernateCriteriaBuilder;
+
+@Inject
+Metamodel metamodel;
+
+@Inject
+org.hibernate.Metamodel metamodel;
+
+@Inject
+JpaMetamodel jpaMetamodel;
+
+@Inject
+Cache cache;
+
+@Inject
+org.hibernate.Cache cache;
+
+@Inject
+jakarta.persistence.PersistenceUnitUtil persistenceUnitUtil;
+
+@Inject
+org.hibernate.relational.SchemaManager schemaManager;
+----
+
+These components can also be injected with a specific persistence unit qualifier:
+
+[source,java]
+----
+@Inject
+@PersistenceUnit("users")
+CriteriaBuilder criteriaBuilder;
+----
+
 [[persistence-unit-active]]
 === Activate/deactivate persistence units
 

extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/ClassNames.java

@@ -53,6 +53,16 @@ private static DotName createConstant(String fqcn) {
     public static final DotName ENTITY_MANAGER = createConstant("jakarta.persistence.EntityManager");
     public static final DotName SESSION = createConstant("org.hibernate.Session");
     public static final DotName STATELESS_SESSION = createConstant("org.hibernate.StatelessSession");
+    public static final DotName CRITERIA_BUILDER = createConstant("jakarta.persistence.criteria.CriteriaBuilder");
+    public static final DotName HIBERNATE_CRITERIA_BUILDER = createConstant(
+            "org.hibernate.query.criteria.HibernateCriteriaBuilder");
+    public static final DotName METAMODEL = createConstant("jakarta.persistence.metamodel.Metamodel");
+    public static final DotName HIBERNATE_METAMODEL = createConstant("org.hibernate.Metamodel");
+    public static final DotName JPA_METAMODEL = createConstant("org.hibernate.metamodel.model.domain.JpaMetamodel");
+    public static final DotName SCHEMA_MANAGER = createConstant("org.hibernate.relational.SchemaManager");
+    public static final DotName CACHE = createConstant("jakarta.persistence.Cache");
+    public static final DotName HIBERNATE_CACHE = createConstant("org.hibernate.Cache");
+    public static final DotName PERSISTENCE_UNIT_UTIL = createConstant("jakarta.persistence.PersistenceUnitUtil");
 
     public static final DotName INTERCEPTOR = createConstant("org.hibernate.Interceptor");
     public static final DotName STATEMENT_INSPECTOR = createConstant("org.hibernate.resource.jdbc.spi.StatementInspector");

extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/HibernateOrmCdiProcessor.java

@@ -1,10 +1,13 @@
 package io.quarkus.hibernate.orm.deployment;
 
+import static org.apache.commons.lang3.BooleanUtils.isFalse;
+
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Locale;
 import java.util.Set;
+import java.util.function.Function;
 import java.util.stream.Collectors;
 
 import jakarta.enterprise.context.ApplicationScoped;
@@ -18,8 +21,11 @@
 import org.hibernate.Session;
 import org.hibernate.SessionFactory;
 import org.hibernate.StatelessSession;
+import org.hibernate.query.criteria.HibernateCriteriaBuilder;
+import org.hibernate.relational.SchemaManager;
 import org.jboss.jandex.AnnotationInstance;
 import org.jboss.jandex.AnnotationTarget.Kind;
+import org.jboss.jandex.AnnotationTransformation;
 import org.jboss.jandex.AnnotationValue;
 import org.jboss.jandex.ClassType;
 import org.jboss.jandex.DotName;
@@ -64,6 +70,13 @@ public class HibernateOrmCdiProcessor {
             ClassNames.SESSION_FACTORY);
     private static final List<DotName> SESSION_EXPOSED_TYPES = Arrays.asList(ClassNames.ENTITY_MANAGER, ClassNames.SESSION);
     private static final List<DotName> STATELESS_SESSION_EXPOSED_TYPES = List.of(ClassNames.STATELESS_SESSION);
+    private static final List<DotName> CRITERIA_BUILDER_EXPOSED_TYPES = List.of(ClassNames.CRITERIA_BUILDER,
+            ClassNames.HIBERNATE_CRITERIA_BUILDER);
+    private static final List<DotName> METAMODEL_EXPOSED_TYPES = List.of(ClassNames.METAMODEL, ClassNames.JPA_METAMODEL,
+            ClassNames.HIBERNATE_METAMODEL);
+    private static final List<DotName> SCHEMA_MANAGER_EXPOSED_TYPES = List.of(ClassNames.SCHEMA_MANAGER);
+    private static final List<DotName> CACHE_EXPOSED_TYPES = List.of(ClassNames.CACHE, ClassNames.HIBERNATE_CACHE);
+    private static final List<DotName> PERSISTENCE_UNIT_UTIL_EXPOSED_TYPES = List.of(ClassNames.PERSISTENCE_UNIT_UTIL);
 
     private static final Set<DotName> PERSISTENCE_UNIT_EXTENSION_VALID_TYPES = Set.of(
             ClassNames.TENANT_RESOLVER,
@@ -76,7 +89,7 @@ public class HibernateOrmCdiProcessor {
     AnnotationsTransformerBuildItem convertJpaResourceAnnotationsToQualifier(
             List<PersistenceUnitDescriptorBuildItem> persistenceUnitDescriptors,
             ImpliedBlockingPersistenceUnitTypeBuildItem impliedBlockingPersistenceUnitType) {
-        AnnotationsTransformer transformer = new AnnotationsTransformer() {
+        AnnotationTransformation transformer = new AnnotationsTransformer() {
 
             @Override
             public boolean appliesTo(Kind kind) {
@@ -178,34 +191,22 @@ void generateDataSourceBeans(HibernateOrmRecorder recorder,
             return;
         }
 
+        Function<String, AnnotationInstance> createPersistenceUnitQualifier = (puName) -> AnnotationInstance
+                .builder(PersistenceUnit.class).add("value", puName).build();
+        AnnotationInstance defaultQualifierInstance = AnnotationInstance.builder(Default.class).build();
+
         // we have only one persistence unit defined in a persistence.xml: we make it the default even if it has a name
         // NOTE: In this case we know we're not using Hibernate Reactive, because it doesn't support persistence.xml.
         if (persistenceUnitDescriptors.size() == 1 && persistenceUnitDescriptors.get(0).isFromPersistenceXml()) {
             String persistenceUnitName = persistenceUnitDescriptors.get(0).getPersistenceUnitName();
 
-            syntheticBeanBuildItemBuildProducer
-                    .produce(createSyntheticBean(persistenceUnitName,
-                            true, true,
-                            SessionFactory.class, SESSION_FACTORY_EXPOSED_TYPES, true)
-                            .createWith(recorder.sessionFactorySupplier(persistenceUnitName))
-                            .addInjectionPoint(ClassType.create(DotName.createSimple(JPAConfig.class)))
-                            .done());
-
-            syntheticBeanBuildItemBuildProducer
-                    .produce(createSyntheticBean(persistenceUnitName,
-                            true, true,
-                            Session.class, SESSION_EXPOSED_TYPES, false)
-                            .createWith(recorder.sessionSupplier(persistenceUnitName))
-                            .addInjectionPoint(ClassType.create(DotName.createSimple(TransactionSessions.class)))
-                            .done());
-
-            syntheticBeanBuildItemBuildProducer
-                    .produce(createSyntheticBean(persistenceUnitName,
-                            true, true,
-                            StatelessSession.class, STATELESS_SESSION_EXPOSED_TYPES, false)
-                            .createWith(recorder.statelessSessionSupplier(persistenceUnitName))
-                            .addInjectionPoint(ClassType.create(DotName.createSimple(TransactionSessions.class)))
-                            .done());
+            produceSessionFactoryBean(syntheticBeanBuildItemBuildProducer, recorder, persistenceUnitName, true, true);
+
+            produceSessionBeans(syntheticBeanBuildItemBuildProducer, recorder, persistenceUnitName, true, true);
+
+            produceFactoryDependentBeans(syntheticBeanBuildItemBuildProducer, recorder, persistenceUnitName,
+                    true, true, defaultQualifierInstance);
+
             return;
         }
 
@@ -223,34 +224,22 @@ void generateDataSourceBeans(HibernateOrmRecorder recorder,
             // We will need to fix this at some point, see https://github.com/quarkusio/quarkus/issues/21110
             String persistenceUnitConfigName = persistenceUnitDescriptor.getConfigurationName();
             boolean isDefaultPU = PersistenceUnitUtil.isDefaultPersistenceUnit(persistenceUnitConfigName);
-            boolean isNamedPU = !isDefaultPU;
-
-            syntheticBeanBuildItemBuildProducer
-                    .produce(createSyntheticBean(persistenceUnitName,
-                            isDefaultPU,
-                            isNamedPU,
-                            SessionFactory.class,
-                            SESSION_FACTORY_EXPOSED_TYPES,
-                            true)
-                            .createWith(recorder.sessionFactorySupplier(persistenceUnitName))
-                            .addInjectionPoint(ClassType.create(DotName.createSimple(JPAConfig.class)))
-                            .done());
-
-            syntheticBeanBuildItemBuildProducer
-                    .produce(createSyntheticBean(persistenceUnitName,
-                            isDefaultPU, isNamedPU,
-                            Session.class, SESSION_EXPOSED_TYPES, false)
-                            .createWith(recorder.sessionSupplier(persistenceUnitName))
-                            .addInjectionPoint(ClassType.create(DotName.createSimple(TransactionSessions.class)))
-                            .done());
-
-            syntheticBeanBuildItemBuildProducer
-                    .produce(createSyntheticBean(persistenceUnitName,
-                            isDefaultPU, isNamedPU,
-                            StatelessSession.class, STATELESS_SESSION_EXPOSED_TYPES, false)
-                            .createWith(recorder.statelessSessionSupplier(persistenceUnitName))
-                            .addInjectionPoint(ClassType.create(DotName.createSimple(TransactionSessions.class)))
-                            .done());
+            boolean isNamedPU = isFalse(isDefaultPU);
+            AnnotationInstance sessionFactoryQualifier;
+            if (isDefaultPU) {
+                sessionFactoryQualifier = defaultQualifierInstance;
+            } else {
+                sessionFactoryQualifier = createPersistenceUnitQualifier.apply(persistenceUnitName);
+            }
+
+            produceSessionFactoryBean(syntheticBeanBuildItemBuildProducer, recorder, persistenceUnitName, isDefaultPU,
+                    isNamedPU);
+
+            produceSessionBeans(syntheticBeanBuildItemBuildProducer, recorder, persistenceUnitName, isDefaultPU, isNamedPU);
+
+            produceFactoryDependentBeans(syntheticBeanBuildItemBuildProducer, recorder, persistenceUnitName,
+                    isDefaultPU, isNamedPU, sessionFactoryQualifier);
+
         }
     }
 
@@ -352,4 +341,98 @@ private static <T> ExtendedBeanConfigurator createSyntheticBean(String persisten
 
         return configurator;
     }
+
+    private void produceSessionBeans(
+            BuildProducer<SyntheticBeanBuildItem> producer,
+            HibernateOrmRecorder recorder,
+            String persistenceUnitName,
+            boolean isDefaultPU,
+            boolean isNamedPU) {
+
+        // Create Session bean
+        producer.produce(createSyntheticBean(persistenceUnitName,
+                isDefaultPU, isNamedPU,
+                Session.class, SESSION_EXPOSED_TYPES, false)
+                .createWith(recorder.sessionSupplier(persistenceUnitName))
+                .addInjectionPoint(ClassType.create(DotName.createSimple(TransactionSessions.class)))
+                .done());
+
+        // Create StatelessSession bean
+        producer.produce(createSyntheticBean(persistenceUnitName,
+                isDefaultPU, isNamedPU,
+                StatelessSession.class, STATELESS_SESSION_EXPOSED_TYPES, false)
+                .createWith(recorder.statelessSessionSupplier(persistenceUnitName))
+                .addInjectionPoint(ClassType.create(DotName.createSimple(TransactionSessions.class)))
+                .done());
+    }
+
+    private void produceSessionFactoryBean(
+            BuildProducer<SyntheticBeanBuildItem> producer,
+            HibernateOrmRecorder recorder,
+            String persistenceUnitName,
+            boolean isDefaultPU,
+            boolean isNamedPU) {
+
+        producer.produce(createSyntheticBean(persistenceUnitName,
+                isDefaultPU, isNamedPU,
+                SessionFactory.class, SESSION_FACTORY_EXPOSED_TYPES, true)
+                .createWith(recorder.sessionFactorySupplier(persistenceUnitName))
+                .addInjectionPoint(ClassType.create(DotName.createSimple(JPAConfig.class)))
+                .done());
+    }
+
+    private void produceFactoryDependentBeans(
+            BuildProducer<SyntheticBeanBuildItem> producer,
+            HibernateOrmRecorder recorder,
+            String persistenceUnitName,
+            boolean isDefaultPU,
+            boolean isNamedPU,
+            AnnotationInstance sessionFactoryQualifier) {
+
+        // Create CriteriaBuilder bean
+        producer.produce(createSyntheticBean(persistenceUnitName,
+                isDefaultPU, isNamedPU,
+                HibernateCriteriaBuilder.class, CRITERIA_BUILDER_EXPOSED_TYPES, false)
+                .createWith(recorder.criteriaBuilderSupplier(persistenceUnitName))
+                .addInjectionPoint(ClassType.create(DotName.createSimple(SessionFactory.class)),
+                        sessionFactoryQualifier)
+                .done());
+
+        // Create Metamodel bean
+        producer.produce(createSyntheticBean(persistenceUnitName,
+                isDefaultPU, isNamedPU,
+                org.hibernate.Metamodel.class, METAMODEL_EXPOSED_TYPES, false)
+                .createWith(recorder.metamodelSupplier(persistenceUnitName))
+                .addInjectionPoint(ClassType.create(DotName.createSimple(SessionFactory.class)),
+                        sessionFactoryQualifier)
+                .done());
+
+        // Create SchemaManager bean
+        producer.produce(createSyntheticBean(persistenceUnitName,
+                isDefaultPU, isNamedPU,
+                SchemaManager.class, SCHEMA_MANAGER_EXPOSED_TYPES, false)
+                .createWith(recorder.schemaManagerSupplier(persistenceUnitName))
+                .addInjectionPoint(ClassType.create(DotName.createSimple(SessionFactory.class)),
+                        sessionFactoryQualifier)
+                .done());
+
+        // Create Cache bean
+        producer.produce(createSyntheticBean(persistenceUnitName,
+                isDefaultPU, isNamedPU,
+                org.hibernate.Cache.class, CACHE_EXPOSED_TYPES, false)
+                .createWith(recorder.cacheSupplier(persistenceUnitName))
+                .addInjectionPoint(ClassType.create(DotName.createSimple(SessionFactory.class)),
+                        sessionFactoryQualifier)
+                .done());
+
+        // Create PersistenceUnitUtil bean
+        producer.produce(createSyntheticBean(persistenceUnitName,
+                isDefaultPU, isNamedPU,
+                jakarta.persistence.PersistenceUnitUtil.class, PERSISTENCE_UNIT_UTIL_EXPOSED_TYPES, false)
+                .createWith(recorder.persistenceUnitUtilSupplier(persistenceUnitName))
+                .addInjectionPoint(ClassType.create(DotName.createSimple(SessionFactory.class)),
+                        sessionFactoryQualifier)
+                .done());
+    }
+
 }