Move Sequence to RelationalPersistentProperty.

Sequence details are now maintained on the property level instead of using the entity level. This is a more accurate representation of the underlying model and that properties are annotated and not entities. It also allows future extension of expanding sequence support to general properties.

Extract abstract support class for sequence generation. Move types to org.springframework.data.jdbc.core.convert to resolve package cycles.

See #2003
Original pull request: #2005

Author: mp911de

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/IdGeneratingBeforeSaveCallback.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.core.convert;
+
+import org.springframework.data.mapping.PersistentPropertyAccessor;
+import org.springframework.data.mapping.context.MappingContext;
+import org.springframework.data.relational.core.conversion.MutableAggregateChange;
+import org.springframework.data.relational.core.dialect.Dialect;
+import org.springframework.data.relational.core.mapping.RelationalPersistentEntity;
+import org.springframework.data.relational.core.mapping.RelationalPersistentProperty;
+import org.springframework.data.relational.core.mapping.event.BeforeSaveCallback;
+import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations;
+import org.springframework.util.Assert;
+
+/**
+ * Callback for generating identifier values through a database sequence.
+ *
+ * @author Mikhail Polivakha
+ * @author Mark Paluch
+ * @since 3.5
+ */
+public class IdGeneratingBeforeSaveCallback extends SequenceEntityCallbackSupport
+		implements BeforeSaveCallback<Object> {
+
+	private final MappingContext<RelationalPersistentEntity<?>, ? extends RelationalPersistentProperty> context;
+
+	public IdGeneratingBeforeSaveCallback(
+			MappingContext<RelationalPersistentEntity<?>, ? extends RelationalPersistentProperty> context, Dialect dialect,
+			NamedParameterJdbcOperations operations) {
+
+		super(dialect, operations);
+		this.context = context;
+	}
+
+	@Override
+	public Object onBeforeSave(Object aggregate, MutableAggregateChange<Object> aggregateChange) {
+
+		Assert.notNull(aggregate, "aggregate must not be null");
+
+		RelationalPersistentEntity<?> entity = context.getRequiredPersistentEntity(aggregate.getClass());
+
+		if (!entity.hasIdProperty()) {
+			return aggregate;
+		}
+
+		RelationalPersistentProperty property = entity.getRequiredIdProperty();
+		PersistentPropertyAccessor<Object> accessor = entity.getPropertyAccessor(aggregate);
+
+		if (!entity.isNew(aggregate) || hasValue(property, accessor) || !property.hasSequence()) {
+			return aggregate;
+		}
+
+		generateSequenceValue(property, accessor);
+
+		return accessor.getBean();
+	}
+
+}

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/convert/SequenceEntityCallbackSupport.java

@@ -0,0 +1,102 @@
+/*
+ * Copyright 2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.jdbc.core.convert;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+import org.springframework.data.mapping.PersistentProperty;
+import org.springframework.data.mapping.PersistentPropertyAccessor;
+import org.springframework.data.relational.core.dialect.Dialect;
+import org.springframework.data.relational.core.mapping.RelationalPersistentProperty;
+import org.springframework.data.relational.core.sql.SqlIdentifier;
+import org.springframework.data.util.ReflectionUtils;
+import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
+import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations;
+import org.springframework.lang.Nullable;
+import org.springframework.util.ClassUtils;
+import org.springframework.util.NumberUtils;
+
+/**
+ * Support class for generating identifier values through a database sequence.
+ *
+ * @author Mikhail Polivakha
+ * @author Mark Paluch
+ * @since 3.5
+ * @see org.springframework.data.relational.core.mapping.Sequence
+ */
+public abstract class SequenceEntityCallbackSupport {
+
+	private static final Log LOG = LogFactory.getLog(SequenceEntityCallbackSupport.class);
+	private final static MapSqlParameterSource EMPTY_PARAMETERS = new MapSqlParameterSource();
+
+	private final Dialect dialect;
+	private final NamedParameterJdbcOperations operations;
+
+	public SequenceEntityCallbackSupport(Dialect dialect, NamedParameterJdbcOperations operations) {
+		this.dialect = dialect;
+		this.operations = operations;
+	}
+
+	@SuppressWarnings("unchecked")
+	protected void generateSequenceValue(RelationalPersistentProperty property,
+			PersistentPropertyAccessor<Object> accessor) {
+
+		Object sequenceValue = getSequenceValue(property);
+
+		if (sequenceValue == null) {
+			return;
+		}
+
+		Class<?> targetType = ClassUtils.resolvePrimitiveIfNecessary(property.getType());
+		if (sequenceValue instanceof Number && Number.class.isAssignableFrom(targetType)) {
+			sequenceValue = NumberUtils.convertNumberToTargetClass((Number) sequenceValue,
+					(Class<? extends Number>) targetType);
+		}
+
+		accessor.setProperty(property, sequenceValue);
+	}
+
+	protected boolean hasValue(PersistentProperty<?> property, PersistentPropertyAccessor<Object> propertyAccessor) {
+
+		Object identifier = propertyAccessor.getProperty(property);
+
+		if (property.getType().isPrimitive()) {
+
+			Object primitiveDefault = ReflectionUtils.getPrimitiveDefault(property.getType());
+			return !primitiveDefault.equals(identifier);
+		}
+
+		return identifier != null;
+	}
+
+	private @Nullable Object getSequenceValue(RelationalPersistentProperty property) {
+
+		SqlIdentifier sequence = property.getSequence();
+
+		if (sequence != null && !dialect.getIdGeneration().sequencesSupported()) {
+			LOG.warn("""
+					Aggregate type '%s' is marked for sequence usage but configured dialect '%s'
+					does not support sequences. Falling back to identity columns.
+					""".formatted(property.getOwner().getType(), ClassUtils.getQualifiedName(dialect.getClass())));
+			return null;
+		}
+
+		String sql = dialect.getIdGeneration().createSequenceQuery(sequence);
+		return operations.queryForObject(sql, EMPTY_PARAMETERS, (rs, rowNum) -> rs.getObject(1));
+	}
+
+}

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/core/mapping/IdGeneratingBeforeSaveCallback.java

@@ -25,6 +25,7 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.context.ApplicationContext;
@@ -38,7 +39,6 @@
 import org.springframework.data.jdbc.core.JdbcAggregateTemplate;
 import org.springframework.data.jdbc.core.convert.*;
 import org.springframework.data.jdbc.core.dialect.JdbcDialect;
-import org.springframework.data.jdbc.core.mapping.IdGeneratingBeforeSaveCallback;
 import org.springframework.data.jdbc.core.mapping.JdbcMappingContext;
 import org.springframework.data.jdbc.core.mapping.JdbcSimpleTypes;
 import org.springframework.data.mapping.model.SimpleTypeHolder;

spring-data-jdbc/src/main/java/org/springframework/data/jdbc/repository/config/AbstractJdbcConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024-2025 the original author or authors.
+ * Copyright 2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.springframework.data.jdbc.core.mapping;
+package org.springframework.data.jdbc.core.convert;
 
 import static org.assertj.core.api.Assertions.*;
 import static org.mockito.ArgumentMatchers.*;

…/IdGeneratingBeforeSaveCallbackTest.java …/IdGeneratingBeforeSaveCallbackTest.javaspring-data-jdbc/src/test/java/org/springframework/data/jdbc/core/mapping/IdGeneratingBeforeSaveCallbackTest.java renamed to spring-data-jdbc/src/test/java/org/springframework/data/jdbc/core/convert/IdGeneratingBeforeSaveCallbackTest.java spring-data-jdbc/src/test/java/org/springframework/data/jdbc/core/mapping/IdGeneratingBeforeSaveCallbackTest.java renamed to spring-data-jdbc/src/test/java/org/springframework/data/jdbc/core/convert/IdGeneratingBeforeSaveCallbackTest.java

@@ -35,7 +35,7 @@
 import org.springframework.data.annotation.PersistenceCreator;
 import org.springframework.data.annotation.Transient;
 import org.springframework.data.domain.Persistable;
-import org.springframework.data.jdbc.core.mapping.IdGeneratingBeforeSaveCallback;
+import org.springframework.data.jdbc.core.convert.IdGeneratingBeforeSaveCallback;
 import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories;
 import org.springframework.data.jdbc.repository.support.SimpleJdbcRepository;
 import org.springframework.data.jdbc.testing.IntegrationTest;

spring-data-jdbc/src/test/java/org/springframework/data/jdbc/repository/JdbcRepositoryIdGenerationIntegrationTests.java

@@ -24,6 +24,7 @@
 
 import org.apache.ibatis.session.SqlSessionFactory;
 import org.mockito.Mockito;
+
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
@@ -37,15 +38,13 @@
 import org.springframework.data.convert.CustomConversions;
 import org.springframework.data.jdbc.core.convert.*;
 import org.springframework.data.jdbc.core.dialect.JdbcDialect;
-import org.springframework.data.jdbc.core.mapping.IdGeneratingBeforeSaveCallback;
 import org.springframework.data.jdbc.core.mapping.JdbcMappingContext;
 import org.springframework.data.jdbc.core.mapping.JdbcSimpleTypes;
 import org.springframework.data.jdbc.repository.config.DialectResolver;
 import org.springframework.data.jdbc.repository.support.JdbcRepositoryFactory;
 import org.springframework.data.mapping.callback.EntityCallback;
 import org.springframework.data.mapping.callback.EntityCallbacks;
 import org.springframework.data.mapping.model.SimpleTypeHolder;
-import org.springframework.data.relational.RelationalManagedTypes;
 import org.springframework.data.relational.core.dialect.Dialect;
 import org.springframework.data.relational.core.mapping.DefaultNamingStrategy;
 import org.springframework.data.relational.core.mapping.NamingStrategy;

spring-data-jdbc/src/test/java/org/springframework/data/jdbc/testing/TestConfiguration.java

@@ -49,12 +49,13 @@ public enum IdValueSource {
 	 */
 	public static <T> IdValueSource forInstance(Object instance, RelationalPersistentEntity<T> persistentEntity) {
 
-		if (persistentEntity.getIdSequence().isPresent()) {
+		RelationalPersistentProperty idProperty = persistentEntity.getIdProperty();
+
+		if (idProperty != null && idProperty.hasSequence()) {
 			return IdValueSource.PROVIDED;
 		}
 
 		Object idValue = persistentEntity.getIdentifierAccessor(instance).getIdentifier();
-		RelationalPersistentProperty idProperty = persistentEntity.getIdProperty();
 		if (idProperty == null) {
 			return IdValueSource.NONE;
 		}