Add support for JPA 3.2 PersistenceConfiguration

See gh-35662

Author: jhoeller

spring-orm/src/main/java/org/springframework/orm/jpa/AbstractEntityManagerFactoryBean.java

@@ -71,7 +71,9 @@
  * making {@code EntityManager} available for dependency injection as well.
  *
  * <p>Encapsulates the common functionality between the different JPA bootstrap
- * contracts (standalone as well as container).
+ * contracts: standalone as well as container. Note that as of 7.0, the JPA 3.2
+ * {@link LocalEntityManagerFactoryBean#setPersistenceConfiguration PersistenceConfiguration}
+ * mechanism is supported as well, allowing for much richer standalone bootstrap options.
  *
  * <p>Implements support for standard JPA configuration conventions as well as
  * Spring's customizable {@link JpaVendorAdapter} mechanism, and controls the

spring-orm/src/main/java/org/springframework/orm/jpa/LocalContainerEntityManagerFactoryBean.java

@@ -21,6 +21,7 @@
 import javax.sql.DataSource;
 
 import jakarta.persistence.EntityManagerFactory;
+import jakarta.persistence.PersistenceConfiguration;
 import jakarta.persistence.PersistenceException;
 import jakarta.persistence.SharedCacheMode;
 import jakarta.persistence.ValidationMode;
@@ -166,6 +167,22 @@ public void setPersistenceUnitRootLocation(String defaultPersistenceUnitRootLoca
 		this.internalPersistenceUnitManager.setDefaultPersistenceUnitRootLocation(defaultPersistenceUnitRootLocation);
 	}
 
+	/**
+	 * Set a local JPA 3.2 {@link PersistenceConfiguration} to use for this
+	 * persistence unit.
+	 * <p>Note: {@link PersistenceConfiguration} includes a persistence unit name,
+	 * so this effectively overrides the {@link #setPersistenceUnitName} method.
+	 * In contrast, all other settings will be merged with the settings in the
+	 * {@code PersistenceConfiguration} instance.
+	 * @since 7.0
+	 * @see DefaultPersistenceUnitManager#setPersistenceConfiguration
+	 */
+	public void setPersistenceConfiguration(PersistenceConfiguration configuration) {
+		Assert.notNull(configuration, "PersistenceConfiguration must not be null");
+		super.setPersistenceUnitName(configuration.name());
+		this.internalPersistenceUnitManager.setPersistenceConfiguration(configuration);
+	}
+
 	/**
 	 * Set the {@link PersistenceManagedTypes} to use to build the list of managed types
 	 * as an alternative to entity scanning.
@@ -424,15 +441,16 @@ protected EntityManagerFactory createNativeEntityManagerFactory() throws Persist
 	 * Determine the PersistenceUnitInfo to use for the EntityManagerFactory
 	 * created by this bean.
 	 * <p>The default implementation reads in all persistence unit infos from
-	 * {@code persistence.xml}, as defined in the JPA specification.
-	 * If no entity manager name was specified, it takes the first info in the
-	 * array as returned by the reader. Otherwise, it checks for a matching name.
+	 * {@code persistence.xml}, as defined in the JPA specification, selecting a unit
+	 * by name. If no persistence unit name was specified, it takes the default one
+	 * if configured, or otherwise the first persistence unit as found by the reader.
 	 * @param persistenceUnitManager the PersistenceUnitManager to obtain from
 	 * @return the chosen PersistenceUnitInfo
 	 */
 	protected PersistenceUnitInfo determinePersistenceUnitInfo(PersistenceUnitManager persistenceUnitManager) {
-		if (getPersistenceUnitName() != null) {
-			return persistenceUnitManager.obtainPersistenceUnitInfo(getPersistenceUnitName());
+		String persistenceUnitName = getPersistenceUnitName();
+		if (persistenceUnitName != null) {
+			return persistenceUnitManager.obtainPersistenceUnitInfo(persistenceUnitName);
 		}
 		else {
 			return persistenceUnitManager.obtainDefaultPersistenceUnitInfo();

spring-orm/src/main/java/org/springframework/orm/jpa/LocalEntityManagerFactoryBean.java

@@ -20,10 +20,14 @@
 
 import jakarta.persistence.EntityManagerFactory;
 import jakarta.persistence.Persistence;
+import jakarta.persistence.PersistenceConfiguration;
 import jakarta.persistence.PersistenceException;
 import jakarta.persistence.spi.PersistenceProvider;
 import org.jspecify.annotations.Nullable;
 
+import org.springframework.orm.jpa.persistenceunit.DefaultPersistenceUnitManager;
+import org.springframework.util.Assert;
+
 /**
  * {@link org.springframework.beans.factory.FactoryBean} that creates a JPA
  * {@link jakarta.persistence.EntityManagerFactory} according to JPA's standard
@@ -62,6 +66,80 @@ public class LocalEntityManagerFactoryBean extends AbstractEntityManagerFactoryB
 
 	private static final String DATASOURCE_PROPERTY = "jakarta.persistence.dataSource";
 
+	private @Nullable PersistenceConfiguration configuration;
+
+
+	/**
+	 * Create a {@code LocalEntityManagerFactoryBean}.
+	 * <p>As of 7.0, This uses "default" for the default persistence unit name.
+	 * @see #setPersistenceUnitName
+	 * @see #setPersistenceConfiguration
+	 */
+	public LocalEntityManagerFactoryBean() {
+		setPersistenceUnitName(DefaultPersistenceUnitManager.ORIGINAL_DEFAULT_PERSISTENCE_UNIT_NAME);
+	}
+
+	/**
+	 * Create a {@code LocalEntityManagerFactoryBean} for the given persistence unit.
+	 * @param persistenceUnitName the name of the persistence unit
+	 * @since 7.0
+	 */
+	public LocalEntityManagerFactoryBean(String persistenceUnitName) {
+		setPersistenceUnitName(persistenceUnitName);
+	}
+
+	/**
+	 * Create a {@code LocalEntityManagerFactoryBean} for the given persistence unit.
+	 * @param configuration the configuration for the persistence unit
+	 * @since 7.0
+	 */
+	public LocalEntityManagerFactoryBean(PersistenceConfiguration configuration) {
+		setPersistenceConfiguration(configuration);
+	}
+
+
+	/**
+	 * Set a local JPA 3.2 {@link PersistenceConfiguration} to use for creating
+	 * the EntityManagerFactory. This can be a provider-specific subclass such as
+	 * {@link org.hibernate.jpa.HibernatePersistenceConfiguration}, exposing a
+	 * complete programmatic persistence unit configuration which replaces
+	 * {@code persistence.xml} (including provider-specific classpath scanning).
+	 * <p>Note: {@link PersistenceConfiguration} includes a persistence unit name,
+	 * so this effectively overrides the {@link #setPersistenceUnitName} method.
+	 * In contrast, locally specified JPA properties ({@link #setJpaProperties})
+	 * will get merged into the given {@code PersistenceConfiguration} instance.
+	 * @since 7.0
+	 * @see #getPersistenceConfiguration()
+	 * @see #getPersistenceUnitName()
+	 */
+	public void setPersistenceConfiguration(PersistenceConfiguration configuration) {
+		Assert.notNull(configuration, "PersistenceConfiguration must not be null");
+		this.configuration = configuration;
+		setPersistenceUnitName(configuration.name());
+	}
+
+	/**
+	 * Set a local JPA 3.2 {@link PersistenceConfiguration} to use for creating
+	 * the EntityManagerFactory. If none is in use yet, a new plain
+	 * {@link PersistenceConfiguration} for the configured persistence unit name
+	 * will be created and returned.
+	 * @since 7.0
+	 * @see #setPersistenceConfiguration
+	 * @see #setPersistenceUnitName
+	 */
+	public PersistenceConfiguration getPersistenceConfiguration() {
+		if (this.configuration == null) {
+			this.configuration = new PersistenceConfiguration(getPersistenceUnitName());
+		}
+		return this.configuration;
+	}
+
+	@Override
+	public void setPersistenceUnitName(@Nullable String persistenceUnitName) {
+		Assert.state(this.configuration == null || this.configuration.name().equals(persistenceUnitName),
+				"Cannot change setPersistenceUnitName when PersistenceConfiguration has been set");
+		super.setPersistenceUnitName(persistenceUnitName);
+	}
 
 	/**
 	 * Specify the JDBC DataSource that the JPA persistence provider is supposed
@@ -104,10 +182,17 @@ protected EntityManagerFactory createNativeEntityManagerFactory() throws Persist
 		if (logger.isDebugEnabled()) {
 			logger.debug("Building JPA EntityManagerFactory for persistence unit '" + getPersistenceUnitName() + "'");
 		}
+
+		if (this.configuration != null) {
+			this.configuration.properties(getJpaPropertyMap());
+		}
+
 		PersistenceProvider provider = getPersistenceProvider();
 		if (provider != null) {
 			// Create EntityManagerFactory directly through PersistenceProvider.
-			EntityManagerFactory emf = provider.createEntityManagerFactory(getPersistenceUnitName(), getJpaPropertyMap());
+			EntityManagerFactory emf = (this.configuration != null ?
+					provider.createEntityManagerFactory(this.configuration) :
+					provider.createEntityManagerFactory(getPersistenceUnitName(), getJpaPropertyMap()));
 			if (emf == null) {
 				throw new IllegalStateException(
 						"PersistenceProvider [" + provider + "] did not return an EntityManagerFactory for name '" +
@@ -117,7 +202,9 @@ protected EntityManagerFactory createNativeEntityManagerFactory() throws Persist
 		}
 		else {
 			// Let JPA perform its standard PersistenceProvider autodetection.
-			return Persistence.createEntityManagerFactory(getPersistenceUnitName(), getJpaPropertyMap());
+			return (this.configuration != null ?
+					Persistence.createEntityManagerFactory(this.configuration) :
+					Persistence.createEntityManagerFactory(getPersistenceUnitName(), getJpaPropertyMap()));
 		}
 	}
 

spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/DefaultPersistenceUnitManager.java

@@ -27,6 +27,7 @@
 
 import javax.sql.DataSource;
 
+import jakarta.persistence.PersistenceConfiguration;
 import jakarta.persistence.PersistenceException;
 import jakarta.persistence.SharedCacheMode;
 import jakarta.persistence.ValidationMode;
@@ -108,6 +109,8 @@ public class DefaultPersistenceUnitManager
 
 	private @Nullable String defaultPersistenceUnitName = ORIGINAL_DEFAULT_PERSISTENCE_UNIT_NAME;
 
+	private @Nullable PersistenceConfiguration persistenceConfiguration;
+
 	private @Nullable PersistenceManagedTypes managedTypes;
 
 	private String @Nullable [] packagesToScan;
@@ -179,9 +182,19 @@ public void setDefaultPersistenceUnitName(String defaultPersistenceUnitName) {
 		this.defaultPersistenceUnitName = defaultPersistenceUnitName;
 	}
 
+	/**
+	 * Set a JPA 3.2 {@link PersistenceConfiguration} to apply to the default
+	 * persistence unit. The contained configuration will be merged with the
+	 * common settings specified on this {@code DefaultPersistenceUnitManager}.
+	 * @since 7.0
+	 */
+	public void setPersistenceConfiguration(PersistenceConfiguration configuration) {
+		this.persistenceConfiguration = configuration;
+	}
+
 	/**
 	 * Set the {@link PersistenceManagedTypes} to use to build the list of managed types
-	 * as an alternative to entity scanning.
+	 * for the default persistence unit, as an alternative to entity scanning.
 	 * @param managedTypes the managed types
 	 * @since 6.0
 	 */
@@ -492,7 +505,8 @@ public void preparePersistenceUnitInfos() {
 	private List<SpringPersistenceUnitInfo> readPersistenceUnitInfos() {
 		List<SpringPersistenceUnitInfo> infos = new ArrayList<>(1);
 		String defaultName = this.defaultPersistenceUnitName;
-		boolean buildDefaultUnit = (this.managedTypes != null || this.packagesToScan != null || this.mappingResources != null);
+		boolean buildDefaultUnit = (this.persistenceConfiguration != null || this.managedTypes != null ||
+				this.packagesToScan != null || this.mappingResources != null);
 		boolean foundDefaultUnit = false;
 
 		PersistenceUnitReader reader = new PersistenceUnitReader(this.resourcePatternResolver, this.dataSourceLookup);
@@ -507,8 +521,9 @@ private List<SpringPersistenceUnitInfo> readPersistenceUnitInfos() {
 		if (buildDefaultUnit) {
 			if (foundDefaultUnit) {
 				if (logger.isWarnEnabled()) {
-					logger.warn("Found explicit default persistence unit with name '" + defaultName + "' in persistence.xml - " +
-							"overriding local default persistence unit settings ('managedTypes', 'packagesToScan' or 'mappingResources')");
+					logger.warn("Found explicit default persistence unit with name '" + defaultName +
+							"' in persistence.xml - overriding local default persistence unit settings " +
+							"(`persistenceConfiguration`, 'managedTypes', 'packagesToScan' or 'mappingResources')");
 				}
 			}
 			else {
@@ -523,33 +538,37 @@ private List<SpringPersistenceUnitInfo> readPersistenceUnitInfos() {
 	 * @see #setPackagesToScan
 	 */
 	private SpringPersistenceUnitInfo buildDefaultPersistenceUnitInfo() {
-		SpringPersistenceUnitInfo scannedUnit = new SpringPersistenceUnitInfo();
+		SpringPersistenceUnitInfo defaultUnit = new SpringPersistenceUnitInfo();
 		if (this.defaultPersistenceUnitName != null) {
-			scannedUnit.setPersistenceUnitName(this.defaultPersistenceUnitName);
+			defaultUnit.setPersistenceUnitName(this.defaultPersistenceUnitName);
+		}
+		defaultUnit.setExcludeUnlistedClasses(true);
+
+		if (this.persistenceConfiguration != null) {
+			defaultUnit.apply(this.persistenceConfiguration, this.dataSourceLookup);
 		}
-		scannedUnit.setExcludeUnlistedClasses(true);
 
 		if (this.managedTypes != null) {
-			applyManagedTypes(scannedUnit, this.managedTypes);
+			defaultUnit.apply(this.managedTypes);
 		}
 		else if (this.packagesToScan != null) {
 			PersistenceManagedTypesScanner scanner = new PersistenceManagedTypesScanner(
 					this.resourcePatternResolver, this.managedClassNameFilter);
-			applyManagedTypes(scannedUnit, scanner.scan(this.packagesToScan));
+			defaultUnit.apply(scanner.scan(this.packagesToScan));
 		}
 
 		if (this.mappingResources != null) {
 			for (String mappingFileName : this.mappingResources) {
-				scannedUnit.addMappingFileName(mappingFileName);
+				defaultUnit.addMappingFileName(mappingFileName);
 			}
 		}
 		else {
 			Resource ormXml = getOrmXmlForDefaultPersistenceUnit();
 			if (ormXml != null) {
-				scannedUnit.addMappingFileName(DEFAULT_ORM_XML_RESOURCE);
-				if (scannedUnit.getPersistenceUnitRootUrl() == null) {
+				defaultUnit.addMappingFileName(DEFAULT_ORM_XML_RESOURCE);
+				if (defaultUnit.getPersistenceUnitRootUrl() == null) {
 					try {
-						scannedUnit.setPersistenceUnitRootUrl(
+						defaultUnit.setPersistenceUnitRootUrl(
 								PersistenceUnitReader.determinePersistenceUnitRootUrl(ormXml));
 					}
 					catch (IOException ex) {
@@ -559,16 +578,7 @@ else if (this.packagesToScan != null) {
 			}
 		}
 
-		return scannedUnit;
-	}
-
-	private void applyManagedTypes(SpringPersistenceUnitInfo scannedUnit, PersistenceManagedTypes managedTypes) {
-		managedTypes.getManagedClassNames().forEach(scannedUnit::addManagedClassName);
-		managedTypes.getManagedPackages().forEach(scannedUnit::addManagedPackage);
-		URL persistenceUnitRootUrl = managedTypes.getPersistenceUnitRootUrl();
-		if (scannedUnit.getPersistenceUnitRootUrl() == null && persistenceUnitRootUrl != null) {
-			scannedUnit.setPersistenceUnitRootUrl(persistenceUnitRootUrl);
-		}
+		return defaultUnit;
 	}
 
 	/**

spring-orm/src/main/java/org/springframework/orm/jpa/persistenceunit/MutablePersistenceUnitInfo.java

@@ -60,16 +60,12 @@ public class MutablePersistenceUnitInfo {
 
 	private @Nullable String persistenceProviderClassName;
 
-	private @Nullable String scopeAnnotationName;
-
-	private final List<String> qualifierAnnotationNames = new ArrayList<>();
-
 	private @Nullable PersistenceUnitTransactionType transactionType;
 
-	private @Nullable DataSource nonJtaDataSource;
-
 	private @Nullable DataSource jtaDataSource;
 
+	private @Nullable DataSource nonJtaDataSource;
+
 	private final List<String> mappingFileNames = new ArrayList<>();
 
 	private final List<URL> jarFileUrls = new ArrayList<>();
@@ -109,22 +105,6 @@ public void setPersistenceProviderClassName(@Nullable String persistenceProvider
 		return this.persistenceProviderClassName;
 	}
 
-	public void setScopeAnnotationName(@Nullable String scopeAnnotationName) {
-		this.scopeAnnotationName = scopeAnnotationName;
-	}
-
-	public @Nullable String getScopeAnnotationName() {
-		return this.scopeAnnotationName;
-	}
-
-	public void addQualifierAnnotationName(String qualifierAnnotationName) {
-		this.qualifierAnnotationNames.add(qualifierAnnotationName);
-	}
-
-	public List<String> getQualifierAnnotationNames() {
-		return this.qualifierAnnotationNames;
-	}
-
 	public void setTransactionType(PersistenceUnitTransactionType transactionType) {
 		this.transactionType = transactionType;
 	}