Move to Spring Data Commons' association abstraction.

odrotbohm · schauder · commit 32d79cce59f7 · 2021-03-12T11:22:28.000+01:00
Deprecated Spring Data JDBC's custom PersistentProperty.isReference() in favor of the already existing ….isAssociation() with the same semantics to benefit from association definitions implemented in Spring Data Commons. Make use of the newly introduced PersistentEntity.doWithAll(…) to apply the previously existing property handling to both properties and now associations, too. Original pull request #938
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/BasicJdbcConverter.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/BasicJdbcConverter.java
@@ -183,7 +183,7 @@ public Class<?> getColumnType(RelationalPersistentProperty property) {
 
 	private Class<?> doGetColumnType(RelationalPersistentProperty property) {
 
-		if (property.isReference()) {
+		if (property.isAssociation()) {
 			return getReferenceColumnType(property);
 		}
 
@@ -419,23 +419,23 @@ private T populateProperties(T instance, @Nullable Object idValue) {
 			PersistentPropertyAccessor<T> propertyAccessor = getPropertyAccessor(entity, instance);
 			PreferredConstructor<T, RelationalPersistentProperty> persistenceConstructor = entity.getPersistenceConstructor();
 
-			for (RelationalPersistentProperty property : entity) {
+			entity.doWithAll(property -> {
 
 				if (persistenceConstructor != null && persistenceConstructor.isConstructorParameter(property)) {
-					continue;
+					return;
 				}
 
 				// skip absent simple properties
 				if (isSimpleProperty(property)) {
 
 					if (!propertyValueProvider.hasProperty(property)) {
-						continue;
+						return;
 					}
 				}
 
 				Object value = readOrLoadProperty(idValue, property);
 				propertyAccessor.setProperty(property, value);
-			}
+			});
 
 			return propertyAccessor.getBean();
 		}
@@ -513,7 +513,7 @@ private boolean hasInstanceValues(@Nullable Object idValue) {
 			for (RelationalPersistentProperty embeddedProperty : persistentEntity) {
 
 				// if the embedded contains Lists, Sets or Maps we consider it non-empty
-				if (embeddedProperty.isQualified() || embeddedProperty.isReference()) {
+				if (embeddedProperty.isQualified() || embeddedProperty.isAssociation()) {
 					return true;
 				}
 
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/DefaultDataAccessStrategy.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/DefaultDataAccessStrategy.java
@@ -36,7 +36,6 @@
 import org.springframework.data.mapping.PersistentProperty;
 import org.springframework.data.mapping.PersistentPropertyAccessor;
 import org.springframework.data.mapping.PersistentPropertyPath;
-import org.springframework.data.mapping.PropertyHandler;
 import org.springframework.data.relational.core.dialect.IdGeneration;
 import org.springframework.data.relational.core.mapping.PersistentPropertyPathExtension;
 import org.springframework.data.relational.core.mapping.RelationalMappingContext;
@@ -424,7 +423,7 @@ private <S, T> SqlIdentifierParameterSource getParameterSource(@Nullable S insta
 		PersistentPropertyAccessor<S> propertyAccessor = instance != null ? persistentEntity.getPropertyAccessor(instance)
 				: NoValuePropertyAccessor.instance();
 
-		persistentEntity.doWithProperties((PropertyHandler<RelationalPersistentProperty>) property -> {
+		persistentEntity.doWithAll(property -> {
 
 			if (skipProperty.test(property) || !property.isWritable()) {
 				return;
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlGenerator.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SqlGenerator.java
@@ -19,7 +19,6 @@
 import org.springframework.data.domain.Sort;
 import org.springframework.data.jdbc.repository.support.SimpleJdbcRepository;
 import org.springframework.data.mapping.PersistentPropertyPath;
-import org.springframework.data.mapping.PropertyHandler;
 import org.springframework.data.mapping.context.MappingContext;
 import org.springframework.data.relational.core.dialect.Dialect;
 import org.springframework.data.relational.core.dialect.RenderContextFactory;
@@ -818,7 +817,7 @@ static class Columns {
 
 		private void populateColumnNameCache(RelationalPersistentEntity<?> entity, String prefix) {
 
-			entity.doWithProperties((PropertyHandler<RelationalPersistentProperty>) property -> {
+			entity.doWithAll(property -> {
 
 				// the referencing column of referenced entity is expected to be on the other side of the relation
 				if (!property.isEntity()) {
diff --git a/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/mapping/BasicJdbcPersistentProperty.java b/spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/mapping/BasicJdbcPersistentProperty.java
@@ -60,9 +60,21 @@ public BasicJdbcPersistentProperty(Property property, PersistentEntity<?, Relati
 		super(property, owner, simpleTypeHolder, namingStrategy);
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mapping.model.AnnotationBasedPersistentProperty#isAssociation()
+	 */
 	@Override
-	public boolean isReference() {
-		return AggregateReference.class.isAssignableFrom(getRawType());
+	public boolean isAssociation() {
+		return super.isAssociation() || AggregateReference.class.isAssignableFrom(getRawType());
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.relational.core.mapping.BasicRelationalPersistentProperty#isReference()
+	 */
+	@Override
+	public boolean isReference() {
+		return isAssociation();
+	}
 }
diff --git a/spring-data-jdbc/src/test/java/org/springframework/data/jdbc/core/mapping/BasicJdbcPersistentPropertyUnitTests.java b/spring-data-jdbc/src/test/java/org/springframework/data/jdbc/core/mapping/BasicJdbcPersistentPropertyUnitTests.java
@@ -95,6 +95,15 @@ public void detectsKeyColumnOverrideNameFromMappedCollectionAnnotation() {
 		assertThat(listProperty.getReverseColumnName(path)).isEqualTo(quoted("override_id"));
 	}
 
+	@Test // #938
+	void considersAggregateReferenceAnAssociation() {
+
+		RelationalPersistentEntity<?> entity = context.getRequiredPersistentEntity(WithAssociations.class);
+		RelationalPersistentProperty property = entity.getRequiredPersistentProperty("association");
+
+		assertThat(property.isAssociation()).isTrue();
+	}
+
 	private PersistentPropertyPathExtension getPersistentPropertyPath(Class<?> type, String propertyName) {
 		PersistentPropertyPath<RelationalPersistentProperty> path = context
 				.findPersistentPropertyPaths(type, p -> p.getName().equals(propertyName)).getFirst()
@@ -149,4 +158,8 @@ private static class WithCollections {
 		@MappedCollection(idColumn = "override_id", keyColumn = "override_key") //
 		List<Integer> overrideList;
 	}
+
+	static class WithAssociations {
+		AggregateReference<Object, Long> association;
+	}
 }
diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/BasicRelationalPersistentProperty.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/BasicRelationalPersistentProperty.java
@@ -124,7 +124,7 @@ private SqlIdentifier createDerivedSqlIdentifier(String name) {
 	 */
 	@Override
 	protected Association<RelationalPersistentProperty> createAssociation() {
-		throw new UnsupportedOperationException();
+		return new Association<>(this, null);
 	}
 
 	public boolean isForceQuote() {
@@ -137,7 +137,7 @@ public void setForceQuote(boolean forceQuote) {
 
 	@Override
 	public boolean isEntity() {
-		return super.isEntity() && !isReference();
+		return super.isEntity() && !isAssociation();
 	}
 
 	@Override
diff --git a/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/RelationalPersistentProperty.java b/spring-data-relational/src/main/java/org/springframework/data/relational/core/mapping/RelationalPersistentProperty.java
@@ -28,6 +28,11 @@
  */
 public interface RelationalPersistentProperty extends PersistentProperty<RelationalPersistentProperty> {
 
+	/**
+	 * @deprecated since 2.2, in favor of {@link #isAssociation()}
+	 * @return
+	 */
+	@Deprecated
 	boolean isReference();
 
 	/**

Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ public Class<?> getColumnType(RelationalPersistentProperty property) {`
`183`	`183`
`184`	`184`	`private Class<?> doGetColumnType(RelationalPersistentProperty property) {`
`185`	`185`
`186`		`- if (property.isReference()) {`
	`186`	`+ if (property.isAssociation()) {`
`187`	`187`	`return getReferenceColumnType(property);`
`188`	`188`	`}`
`189`	`189`
`@@ -419,23 +419,23 @@ private T populateProperties(T instance, @Nullable Object idValue) {`
`419`	`419`	`PersistentPropertyAccessor<T> propertyAccessor = getPropertyAccessor(entity, instance);`
`420`	`420`	`PreferredConstructor<T, RelationalPersistentProperty> persistenceConstructor = entity.getPersistenceConstructor();`
`421`	`421`
`422`		`- for (RelationalPersistentProperty property : entity) {`
	`422`	`+ entity.doWithAll(property -> {`
`423`	`423`
`424`	`424`	`if (persistenceConstructor != null && persistenceConstructor.isConstructorParameter(property)) {`
`425`		`- continue;`
	`425`	`+ return;`
`426`	`426`	`}`
`427`	`427`
`428`	`428`	`// skip absent simple properties`
`429`	`429`	`if (isSimpleProperty(property)) {`
`430`	`430`
`431`	`431`	`if (!propertyValueProvider.hasProperty(property)) {`
`432`		`- continue;`
	`432`	`+ return;`
`433`	`433`	`}`
`434`	`434`	`}`
`435`	`435`
`436`	`436`	`Object value = readOrLoadProperty(idValue, property);`
`437`	`437`	`propertyAccessor.setProperty(property, value);`
`438`		`- }`
	`438`	`+ });`
`439`	`439`
`440`	`440`	`return propertyAccessor.getBean();`
`441`	`441`	`}`
`@@ -513,7 +513,7 @@ private boolean hasInstanceValues(@Nullable Object idValue) {`
`513`	`513`	`for (RelationalPersistentProperty embeddedProperty : persistentEntity) {`
`514`	`514`
`515`	`515`	`// if the embedded contains Lists, Sets or Maps we consider it non-empty`
`516`		`- if (embeddedProperty.isQualified() \|\| embeddedProperty.isReference()) {`
	`516`	`+ if (embeddedProperty.isQualified() \|\| embeddedProperty.isAssociation()) {`
`517`	`517`	`return true;`
`518`	`518`	`}`
`519`	`519`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ private SqlIdentifier createDerivedSqlIdentifier(String name) {`
`124`	`124`	`*/`
`125`	`125`	`@Override`
`126`	`126`	`protected Association<RelationalPersistentProperty> createAssociation() {`
`127`		`- throw new UnsupportedOperationException();`
	`127`	`+ return new Association<>(this, null);`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`public boolean isForceQuote() {`
`@@ -137,7 +137,7 @@ public void setForceQuote(boolean forceQuote) {`
`137`	`137`
`138`	`138`	`@Override`
`139`	`139`	`public boolean isEntity() {`
`140`		`- return super.isEntity() && !isReference();`
	`140`	`+ return super.isEntity() && !isAssociation();`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`@Override`