Allow JpaParametersParameterAccessor to extract dates from parameters.

The Hibernate-specific version can then leverage TypedParameterValue.

Resolves #2857.

Author: gregturn

spring-data-jpa/src/main/java/org/springframework/data/jpa/provider/HibernateJpaParametersParameterAccessor.java

@@ -17,6 +17,8 @@
 
 import jakarta.persistence.EntityManager;
 
+import java.util.Date;
+
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.query.TypedParameterValue;
 import org.hibernate.type.BasicTypeRegistry;
@@ -36,6 +38,7 @@
  * @author Cedomir Igaly
  * @author Robert Wilson
  * @author Oliver Drotbohm
+ * @author Greg Turnquist
  * @since 2.7
  */
 class HibernateJpaParametersParameterAccessor extends JpaParametersParameterAccessor {
@@ -53,9 +56,9 @@ class HibernateJpaParametersParameterAccessor extends JpaParametersParameterAcce
 
 		super(parameters, values);
 
-		this.typeHelper = em.getEntityManagerFactory()
-				.unwrap(SessionFactoryImplementor.class)
-				.getTypeConfiguration()
+		this.typeHelper = em.getEntityManagerFactory() //
+				.unwrap(SessionFactoryImplementor.class) //
+				.getTypeConfiguration() //
 				.getBasicTypeRegistry();
 	}
 
@@ -78,4 +81,12 @@ public Object getValue(Parameter parameter) {
 
 		return new TypedParameterValue<>(type, null);
 	}
+
+	@Override
+	public Date extractDate(Object extractedValue) {
+
+		return (extractedValue instanceof TypedParameterValue<?> typedParameterValue)
+				? (Date) typedParameterValue.getValue()
+				: (Date) extractedValue;
+	}
 }

spring-data-jpa/src/main/java/org/springframework/data/jpa/provider/PersistenceProvider.java

@@ -15,8 +15,7 @@
  */
 package org.springframework.data.jpa.provider;
 
-import static org.springframework.data.jpa.provider.JpaClassUtils.isEntityManagerOfType;
-import static org.springframework.data.jpa.provider.JpaClassUtils.isMetamodelOfType;
+import static org.springframework.data.jpa.provider.JpaClassUtils.*;
 import static org.springframework.data.jpa.provider.PersistenceProvider.Constants.*;
 
 import jakarta.persistence.EntityManager;
@@ -25,14 +24,20 @@
 import jakarta.persistence.metamodel.Metamodel;
 import jakarta.persistence.metamodel.SingularAttribute;
 
-import java.util.*;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Date;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.Set;
 
 import org.eclipse.persistence.config.QueryHints;
 import org.eclipse.persistence.jpa.JpaQuery;
 import org.eclipse.persistence.queries.ScrollableCursor;
 import org.hibernate.ScrollMode;
 import org.hibernate.ScrollableResults;
 import org.hibernate.proxy.HibernateProxy;
+import org.hibernate.query.TypedParameterValue;
 import org.springframework.data.jpa.repository.query.JpaParameters;
 import org.springframework.data.jpa.repository.query.JpaParametersParameterAccessor;
 import org.springframework.data.util.CloseableIterator;
@@ -338,6 +343,27 @@ public static Object condense(Object value) {
 		return value;
 	}
 
+	/**
+	 * If Hibernate is on the classpath, potentially extract it's {@link TypedParameterValue}.
+	 * 
+	 * @param extractedValue
+	 * @return either the {@link TypedParameterValue#getValue()} or the original value as a {@link Date}.
+	 * @since 3.1
+	 */
+	public static Date extractDate(Object extractedValue) {
+
+		ClassLoader classLoader = PersistenceProvider.class.getClassLoader();
+
+		if (ClassUtils.isPresent("org.hibernate.query.TypedParameterValue", classLoader)) {
+
+			return (extractedValue instanceof TypedParameterValue<?> typedParameterValue)
+					? (Date) typedParameterValue.getValue()
+					: (Date) extractedValue;
+		}
+
+		return (Date) extractedValue;
+	}
+
 	/**
 	 * Holds the PersistenceProvider specific interface names.
 	 *

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/JpaParametersParameterAccessor.java

@@ -15,6 +15,8 @@
  */
 package org.springframework.data.jpa.repository.query;
 
+import java.util.Date;
+
 import org.springframework.data.jpa.repository.query.JpaParameters.JpaParameter;
 import org.springframework.data.repository.query.Parameter;
 import org.springframework.data.repository.query.Parameters;
@@ -27,6 +29,7 @@
  *
  * @author Jens Schauder
  * @author Mark Paluch
+ * @author Greg Turnquist
  */
 public class JpaParametersParameterAccessor extends ParametersParameterAccessor {
 
@@ -49,4 +52,9 @@ public <T> T getValue(Parameter parameter) {
 	public Object[] getValues() {
 		return super.getValues();
 	}
+
+	public Date extractDate(Object extractedValue) {
+		return (Date) extractedValue;
+	}
+
 }

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/query/QueryParameterSetter.java

@@ -15,7 +15,7 @@
  */
 package org.springframework.data.jpa.repository.query;
 
-import static org.springframework.data.jpa.repository.query.QueryParameterSetter.ErrorHandling.LENIENT;
+import static org.springframework.data.jpa.repository.query.QueryParameterSetter.ErrorHandling.*;
 
 import jakarta.persistence.Parameter;
 import jakarta.persistence.Query;
@@ -32,7 +32,6 @@
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.hibernate.query.TypedParameterValue;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
@@ -82,11 +81,9 @@ public void setParameter(BindableQuery query, JpaParametersParameterAccessor acc
 
 			if (temporalType != null) {
 
-				var extractedValue = valueExtractor.apply(accessor);
+				Object extractedValue = valueExtractor.apply(accessor);
 
-				final Date value = (extractedValue instanceof TypedParameterValue<?> typedParameterValue)
-						? (Date) typedParameterValue.getValue()
-						: (Date) extractedValue;
+				final Date value = accessor.extractDate(extractedValue);
 
 				// One would think we can simply use parameter to identify the parameter we want to set.
 				// But that does not work with list valued parameters. At least Hibernate tries to bind them by name.

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/NamedOrIndexedQueryParameterSetterUnitTests.java

@@ -15,12 +15,16 @@
  */
 package org.springframework.data.jpa.repository.query;
 
-import static java.util.Arrays.*;
 import static jakarta.persistence.TemporalType.*;
+import static java.util.Arrays.*;
 import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 import static org.springframework.data.jpa.repository.query.QueryParameterSetter.ErrorHandling.*;
 
+import jakarta.persistence.Parameter;
+import jakarta.persistence.Query;
+import jakarta.persistence.TemporalType;
+import jakarta.persistence.criteria.ParameterExpression;
 import lombok.Value;
 
 import java.util.Arrays;
@@ -29,11 +33,6 @@
 import java.util.List;
 import java.util.function.Function;
 
-import jakarta.persistence.Parameter;
-import jakarta.persistence.Query;
-import jakarta.persistence.TemporalType;
-import jakarta.persistence.criteria.ParameterExpression;
-
 import org.assertj.core.api.SoftAssertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -65,7 +64,9 @@ class NamedOrIndexedQueryParameterSetterUnitTests {
 	void before() {
 
 		JpaParametersParameterAccessor accessor = mock(JpaParametersParameterAccessor.class);
-		when(accessor.getValues()).thenReturn(new Object[] { new Date() });
+		Date date = new Date();
+		when(accessor.getValues()).thenReturn(new Object[] { date });
+		when(accessor.extractDate(date)).thenReturn(date);
 
 		this.methodArguments = accessor;
 	}