HHH-4396 - Ability to patternize embedded column names

sebersole · sebersole · commit 5febfc59be40 · 2025-03-07T18:07:52.000-06:00
diff --git a/documentation/src/main/asciidoc/userguide/chapters/domain/embeddables.adoc b/documentation/src/main/asciidoc/userguide/chapters/domain/embeddables.adoc
@@ -176,7 +176,7 @@ Since this is such a common pattern, Hibernate offers a much simpler solution th
 which allows to "patternize" the column naming -
 
 [[embeddable-column-naming-example-basic]]
-.@EmbeddedColumnNaming example
+.Simple `@EmbeddedColumnNaming` example
 ====
 [source,java]
 ----
@@ -193,8 +193,47 @@ class Person {
 ----
 ====
 
-Here we'd end up with implicit column names `home_street`, `home_city`, `work_street`, `work_city`, etc.
+This mapping produces implicit column names `home_street`, `home_city`, `work_street`, `work_city`, etc.
 
+`@EmbeddedColumnNaming` also works in nested usages and plays nicely with explicit column names.
+
+
+[[embeddable-column-naming-example-advanced]]
+.More advanced `@EmbeddedColumnNaming` example
+====
+[source,java]
+----
+@Embeddable
+class Address {
+	String street;
+	String city;
+    @Embedded
+    private ZipPlus zip;
+	// ...
+}
+
+@Embeddable
+public static class ZipPlus {
+    @Column(name="zip_code")
+    private String code;
+    @Column(name="zip_plus4")
+    private String plus4;
+}
+
+@Entity
+class Person {
+	// ...
+    @Embedded
+	@EmbeddedColumnNaming("home_%s")
+    Address homeAddress;
+    @Embedded
+    @EmbeddedColumnNaming("work_%s")
+    Address workAddress;
+}
+----
+====
+
+This will produce implicit column names `home_street`, `home_city`, `home_zip_code`, `zip_plus4`, ...
 
 
 [[embeddable-collections]]
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/internal/AnnotatedColumn.java b/hibernate-core/src/main/java/org/hibernate/boot/model/internal/AnnotatedColumn.java
@@ -342,33 +342,38 @@ public boolean isNameDeferred() {
 	}
 
 	public void redefineColumnName(String columnName, String propertyName, boolean applyNamingStrategy) {
-		if ( isNotEmpty( columnName ) ) {
-			mappingColumn.setName( processColumnName( columnName, applyNamingStrategy ) );
+		if ( StringHelper.isEmpty( columnName ) && StringHelper.isEmpty( propertyName ) ) {
+			// nothing to do
+			return;
+		}
+		final String logicalColumnName = resolveLogicalColumnName( columnName, propertyName );
+		mappingColumn.setName( processColumnName( logicalColumnName, applyNamingStrategy ) );
+	}
+
+	private String resolveLogicalColumnName(String columnName, String propertyName) {
+		final String baseColumnName = StringHelper.isNotEmpty( columnName )
+				? columnName
+				: inferColumnName( propertyName );
+
+		if ( parent.getPropertyHolder() != null && parent.getPropertyHolder().isComponent() ) {
+			// see if we need to apply one-or-more @EmbeddedColumnNaming patterns
+			return applyEmbeddedColumnNaming( baseColumnName, (ComponentPropertyHolder) parent.getPropertyHolder() );
 		}
 		else {
-			if ( propertyName != null && applyNamingStrategy ) {
-				// the inferred name would be, e.g., `city`
-				final String inferredColumnName = inferColumnName( propertyName );
-				String realColumnName = inferredColumnName;
-				if ( parent.getPropertyHolder().isComponent() ) {
-					realColumnName = applyEmbeddedColumnNaming( realColumnName, (ComponentPropertyHolder) parent.getPropertyHolder() );
-					// we need to adjust the logical name to be picked up in `#addColumnBinding`
-					logicalColumnName = realColumnName;
-				}
-				mappingColumn.setName( realColumnName );
-			}
-			//Do nothing otherwise
+			return baseColumnName;
 		}
 	}
 
 	private String applyEmbeddedColumnNaming(String inferredColumnName, ComponentPropertyHolder propertyHolder) {
 		// code
 		String result = inferredColumnName;
+		boolean appliedAnyPatterns = false;
 
 		final String columnNamingPattern = propertyHolder.getComponent().getColumnNamingPattern();
 		if ( StringHelper.isNotEmpty( columnNamingPattern ) ) {
 			// zip_code
 			result = String.format( columnNamingPattern, result );
+			appliedAnyPatterns = true;
 		}
 
 		ComponentPropertyHolder tester = propertyHolder;
@@ -378,14 +383,20 @@ private String applyEmbeddedColumnNaming(String inferredColumnName, ComponentPro
 			if ( StringHelper.isNotEmpty( parentColumnNamingPattern ) ) {
 				// 	home_zip_code
 				result = String.format( parentColumnNamingPattern, result );
+				appliedAnyPatterns = true;
 			}
 			tester = parentHolder;
 		}
 
+		if ( appliedAnyPatterns ) {
+			// we need to adjust the logical name to be picked up in `#addColumnBinding`
+			this.logicalColumnName = result;
+		}
+
 		return result;
 	}
 
-	private String processColumnName(String columnName, boolean applyNamingStrategy) {
+	protected String processColumnName(String columnName, boolean applyNamingStrategy) {
 		if ( applyNamingStrategy ) {
 			final Database database = getBuildingContext().getMetadataCollector().getDatabase();
 			return getBuildingContext().getBuildingOptions().getPhysicalNamingStrategy()
@@ -398,7 +409,7 @@ private String processColumnName(String columnName, boolean applyNamingStrategy)
 
 	}
 
-	private String inferColumnName(String propertyName) {
+	protected String inferColumnName(String propertyName) {
 		final Database database = getBuildingContext().getMetadataCollector().getDatabase();
 		final ObjectNameNormalizer normalizer = getBuildingContext().getObjectNameNormalizer();
 		final ImplicitNamingStrategy implicitNamingStrategy = getBuildingContext().getBuildingOptions().getImplicitNamingStrategy();
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/internal/AnnotatedJoinColumn.java b/hibernate-core/src/main/java/org/hibernate/boot/model/internal/AnnotatedJoinColumn.java
@@ -13,6 +13,7 @@
 import org.hibernate.boot.spi.InFlightMetadataCollector;
 import org.hibernate.boot.spi.MetadataBuildingContext;
 import org.hibernate.boot.spi.PropertyData;
+import org.hibernate.internal.util.StringHelper;
 import org.hibernate.mapping.Column;
 import org.hibernate.mapping.PersistentClass;
 import org.hibernate.mapping.SimpleValue;
@@ -452,7 +453,9 @@ public void overrideFromReferencedColumnIfNecessary(Column column) {
 
 	@Override
 	public void redefineColumnName(String columnName, String propertyName, boolean applyNamingStrategy) {
-		super.redefineColumnName( columnName, null, applyNamingStrategy );
+		if ( StringHelper.isNotEmpty( columnName ) ) {
+			getMappingColumn().setName( processColumnName( columnName, applyNamingStrategy ) );
+		}
 	}
 
 	static AnnotatedJoinColumn buildImplicitJoinTableJoinColumn(
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/EmbeddedColumnNamingImplicitTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/EmbeddedColumnNamingImplicitTests.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.orm.test.embeddable;
+package org.hibernate.orm.test.embeddable.naming;
 
 import jakarta.persistence.Embeddable;
 import jakarta.persistence.Embedded;
@@ -18,7 +18,7 @@
 import org.hibernate.testing.orm.junit.SessionFactoryScope;
 import org.junit.jupiter.api.Test;
 
-import static org.hibernate.orm.test.embeddable.EmbeddedColumnNamingTests.verifyColumnNames;
+import static org.hibernate.orm.test.embeddable.naming.EmbeddedColumnNamingTests.verifyColumnNames;
 
 /**
  * @author Steve Ebersole
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/EmbeddedColumnNamingMixedTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/EmbeddedColumnNamingMixedTests.java
@@ -2,29 +2,25 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.orm.test.embeddable;
+package org.hibernate.orm.test.embeddable.naming;
 
 import jakarta.persistence.Column;
 import jakarta.persistence.Embeddable;
 import jakarta.persistence.Embedded;
 import jakarta.persistence.Entity;
 import jakarta.persistence.Id;
 import jakarta.persistence.Table;
-import org.hibernate.MappingException;
 import org.hibernate.annotations.EmbeddedColumnNaming;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.metamodel.spi.MappingMetamodelImplementor;
 import org.hibernate.persister.entity.EntityPersister;
 import org.hibernate.testing.orm.junit.DomainModel;
-import org.hibernate.testing.orm.junit.NotImplementedYet;
 import org.hibernate.testing.orm.junit.ServiceRegistry;
 import org.hibernate.testing.orm.junit.SessionFactory;
 import org.hibernate.testing.orm.junit.SessionFactoryScope;
 import org.junit.jupiter.api.Test;
 
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.hibernate.orm.test.embeddable.EmbeddedColumnNamingTests.verifyColumnNames;
-import static org.junit.jupiter.api.Assertions.fail;
+import static org.hibernate.orm.test.embeddable.naming.EmbeddedColumnNamingTests.verifyColumnNames;
 
 /**
  * Tests how {@code @EmbeddedColumnNaming} and {@code @Column} work together.
@@ -42,26 +38,6 @@ public class EmbeddedColumnNamingMixedTests {
 	@ServiceRegistry
 	@DomainModel(annotatedClasses = {Address.class, Person.class})
 	@SessionFactory
-	void smokeTest(SessionFactoryScope sfScope) {
-		// atm this mixing is not supported / implemented - tbd
-		try (SessionFactoryImplementor sessionFactory = sfScope.getSessionFactory()) {
-			fail( "Expecting an exception" );
-		}
-		catch (RuntimeException e) {
-			assertThat( e ).hasCauseExactlyInstanceOf( MappingException.class );
-			assertThat( e ).cause().hasMessageStartingWith( "Column 'zip_code' is duplicated in mapping for entity" );
-		}
-	}
-
-	/**
-	 * Test use of {@code @EmbeddedColumnNaming} one 2 separate embedded attributes with
-	 * a nested embeddable using explicit column names
-	 */
-	@Test
-	@ServiceRegistry
-	@DomainModel(annotatedClasses = {Address.class, Person.class})
-	@SessionFactory
-	@NotImplementedYet( reason = "this mixing is not supported / implemented - tbd" )
 	void testMixedNamingPattern(SessionFactoryScope sfScope) {
 		final SessionFactoryImplementor sessionFactory = sfScope.getSessionFactory();
 		final MappingMetamodelImplementor mappingMetamodel = sessionFactory.getMappingMetamodel();
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/EmbeddedColumnNamingNestedTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/EmbeddedColumnNamingNestedTests.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.orm.test.embeddable;
+package org.hibernate.orm.test.embeddable.naming;
 
 import jakarta.persistence.Embeddable;
 import jakarta.persistence.Embedded;
@@ -20,7 +20,7 @@
 import org.hibernate.testing.orm.junit.SessionFactoryScope;
 import org.junit.jupiter.api.Test;
 
-import static org.hibernate.orm.test.embeddable.EmbeddedColumnNamingTests.verifyColumnNames;
+import static org.hibernate.orm.test.embeddable.naming.EmbeddedColumnNamingTests.verifyColumnNames;
 
 /**
  * @author Steve Ebersole
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/EmbeddedColumnNamingTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/EmbeddedColumnNamingTests.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.orm.test.embeddable;
+package org.hibernate.orm.test.embeddable.naming;
 
 import org.hibernate.MappingException;
 import org.hibernate.annotations.EmbeddedColumnNaming;
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/package-info.java b/hibernate-core/src/test/java/org/hibernate/orm/test/embeddable/naming/package-info.java
@@ -0,0 +1,11 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+
+/**
+ * Tests for {@linkplain org.hibernate.annotations.EmbeddedColumnNaming @EmbeddedColumnNaming}
+ *
+ * @author Steve Ebersole
+ */
+package org.hibernate.orm.test.embeddable.naming;
