HHH-18633 Split Jandex-based scanning into new module/artifact

hibernate · Sep 27, 2024 · 1fd33a5 · 1fd33a5
1 parent 6078128
commit 1fd33a5
Show file tree

Hide file tree

Showing 26 changed files with 138 additions and 43 deletions.
diff --git a/hibernate-core/hibernate-core.gradle b/hibernate-core/hibernate-core.gradle
@@ -28,8 +28,6 @@ dependencies {
     api jakartaLibs.jta
 
     implementation libs.hibernateModels
-    implementation libs.hibernateModelsJandex
-    implementation libs.jandex
     implementation libs.classmate
     implementation libs.byteBuddy
 
@@ -50,8 +48,12 @@ dependencies {
 //    annotationProcessor project( ":annotation-descriptor-generator" )
     compileOnly project( ":annotation-descriptor-generator" )
 
+    runtimeOnly project(':hibernate-scan-jandex')
+
     testImplementation project(':hibernate-testing')
     testImplementation project(':hibernate-ant')
+    testImplementation project(':hibernate-scan-jandex')
+
     testImplementation testLibs.shrinkwrapApi
     testImplementation testLibs.shrinkwrap
     testImplementation testLibs.shrinkwrapDescriptors
@@ -71,6 +73,7 @@ dependencies {
     testRuntimeOnly libs.byteBuddy
     testRuntimeOnly testLibs.weld
     testRuntimeOnly testLibs.wildFlyTxnClient
+    testImplementation libs.jandex
     testImplementation jakartaLibs.jsonb
     testImplementation libs.jackson
     testRuntimeOnly libs.jacksonXml

diff --git a/hibernate-core/src/main/java/org/hibernate/boot/archive/scan/internal/DisabledScanner.java b/hibernate-core/src/main/java/org/hibernate/boot/archive/scan/internal/DisabledScanner.java
@@ -5,7 +5,11 @@
 package org.hibernate.boot.archive.scan.internal;
 
 import java.util.Collections;
+import java.util.Set;
 
+import org.hibernate.boot.archive.scan.spi.ClassDescriptor;
+import org.hibernate.boot.archive.scan.spi.MappingFileDescriptor;
+import org.hibernate.boot.archive.scan.spi.PackageDescriptor;
 import org.hibernate.boot.archive.scan.spi.ScanEnvironment;
 import org.hibernate.boot.archive.scan.spi.ScanOptions;
 import org.hibernate.boot.archive.scan.spi.ScanParameters;
@@ -19,11 +23,22 @@
  * @author Petteri Pitkanen
  */
 public class DisabledScanner implements Scanner {
-	private static final ScanResult emptyScanResult = new ScanResultImpl(
-		Collections.emptySet(),
-		Collections.emptySet(),
-		Collections.emptySet()
-	);
+	private static final ScanResult emptyScanResult = new ScanResult() {
+		@Override
+		public Set<PackageDescriptor> getLocatedPackages() {
+			return Collections.emptySet();
+		}
+
+		@Override
+		public Set<ClassDescriptor> getLocatedClasses() {
+			return Collections.emptySet();
+		}
+
+		@Override
+		public Set<MappingFileDescriptor> getLocatedMappingFiles() {
+			return Collections.emptySet();
+		}
+	};
 
 	@Override
 	public ScanResult scan(final ScanEnvironment environment, final ScanOptions options, final ScanParameters parameters) {

diff --git a/hibernate-core/src/main/java/org/hibernate/boot/archive/scan/spi/Scanner.java b/hibernate-core/src/main/java/org/hibernate/boot/archive/scan/spi/Scanner.java
@@ -4,6 +4,8 @@
  */
 package org.hibernate.boot.archive.scan.spi;
 
+import org.hibernate.boot.archive.spi.ArchiveDescriptorFactory;
+
 /**
  * Defines the contract for Hibernate to be able to scan for classes, packages and resources inside a
  * persistence unit.
@@ -29,4 +31,8 @@ public interface Scanner {
 	 * @param params The parameters for scanning
 	 */
 	ScanResult scan(ScanEnvironment environment, ScanOptions options, ScanParameters params);
+
+	default void setArchiveDescriptorFactory(ArchiveDescriptorFactory archiveDescriptorFactory){
+		throw new UnsupportedOperationException();
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/archive/scan/spi/ScannerFactory.java b/hibernate-core/src/main/java/org/hibernate/boot/archive/scan/spi/ScannerFactory.java
@@ -0,0 +1,12 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.boot.archive.scan.spi;
+
+import org.hibernate.boot.archive.spi.ArchiveDescriptorFactory;
+import org.hibernate.service.Service;
+
+public interface ScannerFactory extends Service {
+	Scanner getScanner(ArchiveDescriptorFactory archiveDescriptorFactory);
+}
diff --git a/...ate-core/src/main/java/org/hibernate/boot/model/process/internal/ScanningCoordinator.java b/...ate-core/src/main/java/org/hibernate/boot/model/process/internal/ScanningCoordinator.java
@@ -8,20 +8,22 @@
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.HashSet;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
 
 import org.hibernate.boot.MappingException;
 import org.hibernate.boot.archive.internal.StandardArchiveDescriptorFactory;
 import org.hibernate.boot.archive.internal.UrlInputStreamAccess;
+import org.hibernate.boot.archive.scan.internal.DisabledScanner;
 import org.hibernate.boot.archive.scan.internal.StandardScanParameters;
-import org.hibernate.boot.archive.scan.internal.StandardScanner;
 import org.hibernate.boot.archive.scan.spi.ClassDescriptor;
 import org.hibernate.boot.archive.scan.spi.MappingFileDescriptor;
 import org.hibernate.boot.archive.scan.spi.PackageDescriptor;
 import org.hibernate.boot.archive.scan.spi.ScanEnvironment;
 import org.hibernate.boot.archive.scan.spi.ScanResult;
 import org.hibernate.boot.archive.scan.spi.Scanner;
+import org.hibernate.boot.archive.scan.spi.ScannerFactory;
 import org.hibernate.boot.archive.spi.ArchiveDescriptorFactory;
 import org.hibernate.boot.internal.ClassLoaderAccessImpl;
 import org.hibernate.boot.jaxb.Origin;
@@ -86,11 +88,18 @@ private static Scanner buildScanner(BootstrapContext bootstrapContext, ClassLoad
 
 		if ( scannerSetting == null ) {
 			// No custom Scanner specified, use the StandardScanner
-			if ( archiveDescriptorFactory == null ) {
-				return new StandardScanner();
+			final Iterator<ScannerFactory> iterator = bootstrapContext.getServiceRegistry()
+					.requireService( ClassLoaderService.class )
+					.loadJavaServices( ScannerFactory.class )
+					.iterator();
+			if ( iterator.hasNext() ) {
+				// todo: check for multiple scanner and in case raise a warning?
+				final ScannerFactory factory = iterator.next();
+				return factory.getScanner( archiveDescriptorFactory );
 			}
 			else {
-				return new StandardScanner( archiveDescriptorFactory );
+				// todo: add a debug message that there is no Scanner?
+				return new DisabledScanner();
 			}
 		}
 		else {

diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/CustomScanner.java b/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/CustomScanner.java
@@ -4,7 +4,7 @@
  */
 package org.hibernate.orm.test.bootstrap.scanning;
 
-import org.hibernate.boot.archive.scan.internal.StandardScanner;
+import org.hibernate.archive.scan.internal.StandardScanner;
 import org.hibernate.boot.archive.scan.spi.ScanEnvironment;
 import org.hibernate.boot.archive.scan.spi.ScanOptions;
 import org.hibernate.boot.archive.scan.spi.ScanParameters;

diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/JarVisitorTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/JarVisitorTest.java
@@ -16,17 +16,17 @@
 import java.util.Collections;
 import java.util.List;
 
+import org.hibernate.archive.scan.internal.ClassDescriptorImpl;
+import org.hibernate.archive.scan.internal.ScanResultCollector;
+import org.hibernate.archive.scan.internal.StandardScanner;
+import org.hibernate.archive.scan.spi.AbstractScannerImpl;
 import org.hibernate.boot.archive.internal.ArchiveHelper;
 import org.hibernate.boot.archive.internal.ExplodedArchiveDescriptor;
 import org.hibernate.boot.archive.internal.JarFileBasedArchiveDescriptor;
 import org.hibernate.boot.archive.internal.JarProtocolArchiveDescriptor;
 import org.hibernate.boot.archive.internal.StandardArchiveDescriptorFactory;
-import org.hibernate.boot.archive.scan.internal.ClassDescriptorImpl;
-import org.hibernate.boot.archive.scan.internal.ScanResultCollector;
 import org.hibernate.boot.archive.scan.internal.StandardScanOptions;
 import org.hibernate.boot.archive.scan.internal.StandardScanParameters;
-import org.hibernate.boot.archive.scan.internal.StandardScanner;
-import org.hibernate.boot.archive.scan.spi.AbstractScannerImpl;
 import org.hibernate.boot.archive.scan.spi.ClassDescriptor;
 import org.hibernate.boot.archive.scan.spi.MappingFileDescriptor;
 import org.hibernate.boot.archive.scan.spi.ScanEnvironment;

diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/ScannerTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/ScannerTest.java
@@ -14,9 +14,9 @@
 import jakarta.persistence.EntityManagerFactory;
 import jakarta.persistence.Persistence;
 
+import org.hibernate.archive.scan.internal.StandardScanner;
 import org.hibernate.boot.archive.scan.internal.StandardScanOptions;
 import org.hibernate.boot.archive.scan.internal.StandardScanParameters;
-import org.hibernate.boot.archive.scan.internal.StandardScanner;
 import org.hibernate.boot.archive.scan.spi.ClassDescriptor;
 import org.hibernate.boot.archive.scan.spi.MappingFileDescriptor;
 import org.hibernate.boot.archive.scan.spi.ScanEnvironment;

diff --git a/...core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/ScanningCoordinatorTest.java b/...core/src/test/java/org/hibernate/orm/test/bootstrap/scanning/ScanningCoordinatorTest.java
@@ -9,13 +9,13 @@
 import java.util.Arrays;
 import java.util.Collections;
 
+import org.hibernate.archive.scan.internal.ClassDescriptorImpl;
+import org.hibernate.boot.archive.scan.internal.DisabledScanner;
+import org.hibernate.archive.scan.internal.MappingFileDescriptorImpl;
+import org.hibernate.archive.scan.internal.PackageDescriptorImpl;
+import org.hibernate.archive.scan.internal.ScanResultImpl;
 import org.hibernate.boot.MetadataSources;
 import org.hibernate.boot.archive.internal.ByteArrayInputStreamAccess;
-import org.hibernate.boot.archive.scan.internal.ClassDescriptorImpl;
-import org.hibernate.boot.archive.scan.internal.DisabledScanner;
-import org.hibernate.boot.archive.scan.internal.MappingFileDescriptorImpl;
-import org.hibernate.boot.archive.scan.internal.PackageDescriptorImpl;
-import org.hibernate.boot.archive.scan.internal.ScanResultImpl;
 import org.hibernate.boot.archive.scan.spi.ClassDescriptor;
 import org.hibernate.boot.archive.scan.spi.MappingFileDescriptor;
 import org.hibernate.boot.archive.scan.spi.PackageDescriptor;

diff --git a/hibernate-integrationtest-java-modules/hibernate-integrationtest-java-modules.gradle b/hibernate-integrationtest-java-modules/hibernate-integrationtest-java-modules.gradle
@@ -20,6 +20,7 @@ checkstyleMain.exclude '**/module-info.java'
 dependencies {
 	api project( ':hibernate-core' )
 	api project( ':hibernate-envers' )
+	implementation project( ':hibernate-scan-jandex' )
 	//Provide the jakarta.cdi module, as it's required by module jakarta.transaction
 	//but not provided as transitive dependency of Narayana.
 	testRuntimeOnly( jakartaLibs.cdi )

diff --git a/...modules/src/test/java/org/hibernate/orm/integrationtest/java/module/test/ScannerTest.java b/...modules/src/test/java/org/hibernate/orm/integrationtest/java/module/test/ScannerTest.java
@@ -10,7 +10,7 @@
 import org.hibernate.boot.archive.internal.StandardArchiveDescriptorFactory;
 import org.hibernate.boot.archive.scan.internal.StandardScanOptions;
 import org.hibernate.boot.archive.scan.internal.StandardScanParameters;
-import org.hibernate.boot.archive.scan.internal.StandardScanner;
+import org.hibernate.archive.scan.internal.StandardScanner;
 import org.hibernate.boot.archive.scan.spi.ClassDescriptor;
 import org.hibernate.boot.archive.scan.spi.ScanResult;
 import org.hibernate.orm.integrationtest.java.module.test.entity.Author;

diff --git a/hibernate-scan-jandex/hibernate-scan-jandex.gradle b/hibernate-scan-jandex/hibernate-scan-jandex.gradle
@@ -0,0 +1,18 @@
+description = 'Integrate support for Jandex into Hibernate O/RM'
+
+apply from: rootProject.file( 'gradle/published-java-module.gradle' )
+
+
+dependencies {
+	api project( ':hibernate-core' )
+	api jakartaLibs.jpa
+
+	implementation libs.jandex
+
+	testImplementation project( ':hibernate-testing' )
+
+}
+
+sourceSets.test.resources {
+	setSrcDirs( ['src/test/resources'] )
+}
diff --git a/...ve/scan/internal/ClassDescriptorImpl.java → ...ve/scan/internal/ClassDescriptorImpl.java b/...ve/scan/internal/ClassDescriptorImpl.java → ...ve/scan/internal/ClassDescriptorImpl.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.internal;
+package org.hibernate.archive.scan.internal;
 
 import java.io.Serializable;
 

diff --git a/...n/internal/MappingFileDescriptorImpl.java → ...n/internal/MappingFileDescriptorImpl.java b/...n/internal/MappingFileDescriptorImpl.java → ...n/internal/MappingFileDescriptorImpl.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.internal;
+package org.hibernate.archive.scan.internal;
 
 import java.io.Serializable;
 

diff --git a/...chive/scan/internal/NoopEntryHandler.java → ...chive/scan/internal/NoopEntryHandler.java b/...chive/scan/internal/NoopEntryHandler.java → ...chive/scan/internal/NoopEntryHandler.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.internal;
+package org.hibernate.archive.scan.internal;
 
 import org.hibernate.boot.archive.spi.ArchiveContext;
 import org.hibernate.boot.archive.spi.ArchiveEntry;

diff --git a/.../scan/internal/PackageDescriptorImpl.java → .../scan/internal/PackageDescriptorImpl.java b/.../scan/internal/PackageDescriptorImpl.java → .../scan/internal/PackageDescriptorImpl.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.internal;
+package org.hibernate.archive.scan.internal;
 
 import java.io.Serializable;
 

diff --git a/...ve/scan/internal/ScanResultCollector.java → ...ve/scan/internal/ScanResultCollector.java b/...ve/scan/internal/ScanResultCollector.java → ...ve/scan/internal/ScanResultCollector.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.internal;
+package org.hibernate.archive.scan.internal;
 
 import java.util.Collections;
 import java.util.HashSet;

diff --git a/...archive/scan/internal/ScanResultImpl.java → ...archive/scan/internal/ScanResultImpl.java b/...archive/scan/internal/ScanResultImpl.java → ...archive/scan/internal/ScanResultImpl.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.internal;
+package org.hibernate.archive.scan.internal;
 
 import java.io.Serializable;
 import java.util.Set;

diff --git a/...rchive/scan/internal/StandardScanner.java → ...rchive/scan/internal/StandardScanner.java b/...rchive/scan/internal/StandardScanner.java → ...rchive/scan/internal/StandardScanner.java
@@ -2,10 +2,10 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.internal;
+package org.hibernate.archive.scan.internal;
 
+import org.hibernate.archive.scan.spi.AbstractScannerImpl;
 import org.hibernate.boot.archive.internal.StandardArchiveDescriptorFactory;
-import org.hibernate.boot.archive.scan.spi.AbstractScannerImpl;
 import org.hibernate.boot.archive.spi.ArchiveDescriptorFactory;
 
 /**

diff --git a/...scan-jandex/src/main/java/org/hibernate/archive/scan/internal/StandardScannerFactory.java b/...scan-jandex/src/main/java/org/hibernate/archive/scan/internal/StandardScannerFactory.java
@@ -0,0 +1,19 @@
+/*
+ * SPDX-License-Identifier: LGPL-2.1-or-later
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.archive.scan.internal;
+
+import org.hibernate.boot.archive.scan.spi.Scanner;
+import org.hibernate.boot.archive.scan.spi.ScannerFactory;
+import org.hibernate.boot.archive.spi.ArchiveDescriptorFactory;
+
+public class StandardScannerFactory implements ScannerFactory {
+	@Override
+	public Scanner getScanner(ArchiveDescriptorFactory archiveDescriptorFactory) {
+		if ( archiveDescriptorFactory == null ) {
+			return new StandardScanner();
+		}
+		return new StandardScanner( archiveDescriptorFactory );
+	}
+}
diff --git a/...archive/scan/spi/AbstractScannerImpl.java → ...archive/scan/spi/AbstractScannerImpl.java b/...archive/scan/spi/AbstractScannerImpl.java → ...archive/scan/spi/AbstractScannerImpl.java
@@ -2,14 +2,19 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.spi;
+package org.hibernate.archive.scan.spi;
 
 import java.net.URL;
 import java.util.HashMap;
 import java.util.Map;
 
-import org.hibernate.boot.archive.scan.internal.NoopEntryHandler;
-import org.hibernate.boot.archive.scan.internal.ScanResultCollector;
+import org.hibernate.archive.scan.internal.NoopEntryHandler;
+import org.hibernate.archive.scan.internal.ScanResultCollector;
+import org.hibernate.boot.archive.scan.spi.ScanEnvironment;
+import org.hibernate.boot.archive.scan.spi.ScanOptions;
+import org.hibernate.boot.archive.scan.spi.ScanParameters;
+import org.hibernate.boot.archive.scan.spi.ScanResult;
+import org.hibernate.boot.archive.scan.spi.Scanner;
 import org.hibernate.boot.archive.spi.ArchiveContext;
 import org.hibernate.boot.archive.spi.ArchiveDescriptor;
 import org.hibernate.boot.archive.spi.ArchiveDescriptorFactory;

diff --git a/...can/spi/ClassFileArchiveEntryHandler.java → ...can/spi/ClassFileArchiveEntryHandler.java b/...can/spi/ClassFileArchiveEntryHandler.java → ...can/spi/ClassFileArchiveEntryHandler.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.spi;
+package org.hibernate.archive.scan.spi;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -11,8 +11,9 @@
 import jakarta.persistence.Entity;
 import jakarta.persistence.MappedSuperclass;
 
-import org.hibernate.boot.archive.scan.internal.ClassDescriptorImpl;
-import org.hibernate.boot.archive.scan.internal.ScanResultCollector;
+import org.hibernate.archive.scan.internal.ClassDescriptorImpl;
+import org.hibernate.archive.scan.internal.ScanResultCollector;
+import org.hibernate.boot.archive.scan.spi.ClassDescriptor;
 import org.hibernate.boot.archive.spi.ArchiveContext;
 import org.hibernate.boot.archive.spi.ArchiveEntry;
 import org.hibernate.boot.archive.spi.ArchiveEntryHandler;

diff --git a/.../spi/NonClassFileArchiveEntryHandler.java → .../spi/NonClassFileArchiveEntryHandler.java b/.../spi/NonClassFileArchiveEntryHandler.java → .../spi/NonClassFileArchiveEntryHandler.java
@@ -2,10 +2,10 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.boot.archive.scan.spi;
+package org.hibernate.archive.scan.spi;
 
-import org.hibernate.boot.archive.scan.internal.MappingFileDescriptorImpl;
-import org.hibernate.boot.archive.scan.internal.ScanResultCollector;
+import org.hibernate.archive.scan.internal.MappingFileDescriptorImpl;
+import org.hibernate.archive.scan.internal.ScanResultCollector;
 import org.hibernate.boot.archive.spi.ArchiveContext;
 import org.hibernate.boot.archive.spi.ArchiveEntry;
 import org.hibernate.boot.archive.spi.ArchiveEntryHandler;