Support converting underscores column name to camel case property name for projecting native query

> By default, Spring Boot configures the physical naming strategy with CamelCaseToUnderscoresNamingStrategy.

Then we should convert underscores back to camel case.

Fix spring-projectsGH-3462

Author: quaff

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

@@ -26,6 +26,7 @@
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -47,6 +48,7 @@
 import org.springframework.data.repository.query.ResultProcessor;
 import org.springframework.data.repository.query.ReturnedType;
 import org.springframework.data.util.Lazy;
+import org.springframework.jdbc.support.JdbcUtils;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
@@ -62,6 +64,7 @@
  * @author Сергей Цыпанов
  * @author Wonchul Heo
  * @author Julia Lee
+ * @author Yanming Zhou
  */
 public abstract class AbstractJpaQuery implements RepositoryQuery {
 
@@ -149,7 +152,7 @@ private Object doExecute(JpaQueryExecution execution, Object[] values) {
 		Object result = execution.execute(this, accessor);
 
 		ResultProcessor withDynamicProjection = method.getResultProcessor().withDynamicProjection(accessor);
-		return withDynamicProjection.processResult(result, new TupleConverter(withDynamicProjection.getReturnedType()));
+		return withDynamicProjection.processResult(result, new TupleConverter(withDynamicProjection.getReturnedType(), method.isNativeQuery()));
 	}
 
 	private JpaParametersParameterAccessor obtainParameterAccessor(Object[] values) {
@@ -304,16 +307,30 @@ static class TupleConverter implements Converter<Object, Object> {
 
 		private final ReturnedType type;
 
+		private final boolean nativeQuery;
+
 		/**
 		 * Creates a new {@link TupleConverter} for the given {@link ReturnedType}.
 		 *
 		 * @param type must not be {@literal null}.
 		 */
 		public TupleConverter(ReturnedType type) {
 
+			this(type, false);
+		}
+
+		/**
+		 * Creates a new {@link TupleConverter} for the given {@link ReturnedType}.
+		 *
+		 * @param type must not be {@literal null}.
+		 * @param nativeQuery is this converter for native query?
+		 */
+		public TupleConverter(ReturnedType type, boolean nativeQuery) {
+
 			Assert.notNull(type, "Returned type must not be null");
 
 			this.type = type;
+			this.nativeQuery = nativeQuery;
 		}
 
 		@Override
@@ -334,7 +351,7 @@ public Object convert(Object source) {
 				}
 			}
 
-			return new TupleBackedMap(tuple);
+			return new TupleBackedMap(tuple, nativeQuery);
 		}
 
 		/**
@@ -350,12 +367,20 @@ private static class TupleBackedMap implements Map<String, Object> {
 
 			private final Tuple tuple;
 
-			TupleBackedMap(Tuple tuple) {
+			private final boolean nativeQuery;
+
+			TupleBackedMap(Tuple tuple, boolean nativeQuery) {
 				this.tuple = tuple;
+				this.nativeQuery = nativeQuery;
 			}
 
 			@Override
 			public int size() {
+
+				if (nativeQuery) {
+					return keySet().size();
+				}
+
 				return tuple.getElements().size();
 			}
 
@@ -378,6 +403,14 @@ public boolean containsKey(Object key) {
 					tuple.get((String) key);
 					return true;
 				} catch (IllegalArgumentException e) {
+					if (nativeQuery) {
+						try {
+							tuple.get(JdbcUtils.convertPropertyNameToUnderscoreName((String) key));
+							return true;
+						} catch (IllegalArgumentException ignored) {
+							return false;
+						}
+					}
 					return false;
 				}
 			}
@@ -405,6 +438,13 @@ public Object get(Object key) {
 				try {
 					return tuple.get((String) key);
 				} catch (IllegalArgumentException e) {
+					if (nativeQuery) {
+						try {
+							return tuple.get(JdbcUtils.convertPropertyNameToUnderscoreName((String) key));
+						} catch (IllegalArgumentException ignored) {
+							return null;
+						}
+					}
 					return null;
 				}
 			}
@@ -432,19 +472,40 @@ public void clear() {
 			@Override
 			public Set<String> keySet() {
 
-				return tuple.getElements().stream() //
+				Set<String> keys = tuple.getElements().stream() //
 						.map(TupleElement::getAlias) //
 						.collect(Collectors.toSet());
+
+				if (nativeQuery) {
+					Set<String> camelCasedKeys = keys.stream() //
+							.map(JdbcUtils::convertUnderscoreNameToPropertyName) //
+							.collect(Collectors.toSet());
+					keys = new HashSet<>(keys);
+					keys.addAll(camelCasedKeys);
+				}
+
+				return keys;
 			}
 
 			@Override
 			public Collection<Object> values() {
+
+				if (nativeQuery) {
+					return keySet().stream().map(this::get).collect(Collectors.toList());
+				}
+
 				return Arrays.asList(tuple.toArray());
 			}
 
 			@Override
 			public Set<Entry<String, Object>> entrySet() {
 
+				if (nativeQuery) {
+					return keySet().stream() //
+							.map(e -> new HashMap.SimpleEntry<>(e, get(e))) //
+							.collect(Collectors.toSet());
+				}
+
 				return tuple.getElements().stream() //
 						.map(e -> new HashMap.SimpleEntry<String, Object>(e.getAlias(), tuple.get(e))) //
 						.collect(Collectors.toSet());

spring-data-jpa/src/test/java/org/springframework/data/jpa/domain/sample/User.java

@@ -33,6 +33,7 @@
  * @author Jeff Sheets
  * @author JyotirmoyVS
  * @author Greg Turnquist
+ * @author Yanming Zhou
  */
 @Entity
 @NamedEntityGraphs({ @NamedEntityGraph(name = "User.overview", attributeNodes = { @NamedAttributeNode("roles") }),
@@ -101,6 +102,8 @@ public class User {
 
 	@Column(nullable = false, unique = true) private String emailAddress;
 
+	@Column(name = "secondary_email_address") private String secondaryEmailAddress;
+
 	@ManyToMany(cascade = { CascadeType.PERSIST, CascadeType.MERGE }) private Set<User> colleagues;
 
 	@ManyToMany private Set<Role> roles;
@@ -173,6 +176,14 @@ public void setEmailAddress(String emailAddress) {
 		this.emailAddress = emailAddress;
 	}
 
+	public String getSecondaryEmailAddress() {
+		return secondaryEmailAddress;
+	}
+
+	public void setSecondaryEmailAddress(String secondaryEmailAddress) {
+		this.secondaryEmailAddress = secondaryEmailAddress;
+	}
+
 	public void setActive(boolean active) {
 		this.active = active;
 	}

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

@@ -95,6 +95,7 @@
  * @author Simon Paradies
  * @author Geoffrey Deremetz
  * @author Krzysztof Krason
+ * @author Yanming Zhou
  */
 @ExtendWith(SpringExtension.class)
 @ContextConfiguration("classpath:application-context.xml")
@@ -2970,6 +2971,24 @@ void supportsProjectionsWithNativeQueriesAndCamelCaseProperty() {
 				.isNotNull();
 	}
 
+	@Test // DATAJPA-3462
+	void supportsProjectionsWithNativeQueriesAndUnderscoresColumnNameToCamelCaseProperty() {
+
+		User user = new User();
+		user.setEmailAddress("primary@something");
+		user.setSecondaryEmailAddress("secondary@something");
+		em.persist(user);
+
+		UserRepository.EmailOnly result = repository.findEmailOnlyByNativeQuery(user.getId());
+
+		String secondaryEmailAddress = result.getSecondaryEmailAddress();
+
+		assertThat(secondaryEmailAddress) //
+				.isEqualTo(user.getSecondaryEmailAddress()) //
+				.as("ensuring secondary email is actually not null") //
+				.isNotNull();
+	}
+
 	@Test // DATAJPA-1235
 	void handlesColonsFollowedByIntegerInStringLiteral() {
 

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/sample/UserRepository.java

@@ -62,6 +62,7 @@
  * @author Simon Paradies
  * @author Diego Krupitza
  * @author Geoffrey Deremetz
+ * @author Yanming Zhou
  */
 public interface UserRepository extends JpaRepository<User, Integer>, JpaSpecificationExecutor<User>,
 		UserRepositoryCustom, ListQuerydslPredicateExecutor<User> {
@@ -555,7 +556,7 @@ List<User> findUsersByFirstnameForSpELExpressionWithParameterIndexOnlyWithEntity
 	NameOnly findByNativeQuery(Integer id);
 
 	// DATAJPA-1248
-	@Query(value = "SELECT emailaddress FROM SD_User WHERE id = ?1", nativeQuery = true)
+	@Query(value = "SELECT emailaddress, secondary_email_address FROM SD_User WHERE id = ?1", nativeQuery = true)
 	EmailOnly findEmailOnlyByNativeQuery(Integer id);
 
 	// DATAJPA-1235
@@ -721,6 +722,8 @@ interface NameOnly {
 
 	interface EmailOnly {
 		String getEmailAddress();
+
+		String getSecondaryEmailAddress();
 	}
 
 	interface IdOnly {