Introduce update variant with KeyHolder and explicit key column names

Closes gh-31607
spring-projects · Nov 15, 2023 · 01fc1ee · 01fc1ee
1 parent 510caad
commit 01fc1ee
Show file tree

Hide file tree

Showing 5 changed files with 129 additions and 17 deletions.
diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/core/simple/DefaultJdbcClient.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/simple/DefaultJdbcClient.java
@@ -218,15 +218,15 @@ public void query(RowCallbackHandler rch) {
 				namedParamOps.query(this.sql, this.namedParamSource, rch);
 			}
 			else {
-				classicOps.query(getPreparedStatementCreatorForIndexedParams(), rch);
+				classicOps.query(statementCreatorForIndexedParams(), rch);
 			}
 		}
 
 		@Override
 		public <T> T query(ResultSetExtractor<T> rse) {
 			T result = (useNamedParams() ?
 					namedParamOps.query(this.sql, this.namedParamSource, rse) :
-					classicOps.query(getPreparedStatementCreatorForIndexedParams(), rse));
+					classicOps.query(statementCreatorForIndexedParams(), rse));
 			Assert.state(result != null, "No result from ResultSetExtractor");
 			return result;
 		}
@@ -235,14 +235,21 @@ public <T> T query(ResultSetExtractor<T> rse) {
 		public int update() {
 			return (useNamedParams() ?
 					namedParamOps.update(this.sql, this.namedParamSource) :
-					classicOps.update(getPreparedStatementCreatorForIndexedParams()));
+					classicOps.update(statementCreatorForIndexedParams()));
 		}
 
 		@Override
 		public int update(KeyHolder generatedKeyHolder) {
 			return (useNamedParams() ?
 					namedParamOps.update(this.sql, this.namedParamSource, generatedKeyHolder) :
-					classicOps.update(getPreparedStatementCreatorForIndexedParams(true), generatedKeyHolder));
+					classicOps.update(statementCreatorForIndexedParamsWithKeys(null), generatedKeyHolder));
+		}
+
+		@Override
+		public int update(KeyHolder generatedKeyHolder, String... keyColumnNames) {
+			return (useNamedParams() ?
+					namedParamOps.update(this.sql, this.namedParamSource, generatedKeyHolder, keyColumnNames) :
+					classicOps.update(statementCreatorForIndexedParamsWithKeys(keyColumnNames), generatedKeyHolder));
 		}
 
 		private boolean useNamedParams() {
@@ -257,14 +264,19 @@ private boolean useNamedParams() {
 			return hasNamedParams;
 		}
 
-		private PreparedStatementCreator getPreparedStatementCreatorForIndexedParams() {
-			return getPreparedStatementCreatorForIndexedParams(false);
+		private PreparedStatementCreator statementCreatorForIndexedParams() {
+			return new PreparedStatementCreatorFactory(this.sql).newPreparedStatementCreator(this.indexedParams);
 		}
 
-		private PreparedStatementCreator getPreparedStatementCreatorForIndexedParams(boolean returnGeneratedKeys) {
-			PreparedStatementCreatorFactory factory = new PreparedStatementCreatorFactory(this.sql);
-			factory.setReturnGeneratedKeys(returnGeneratedKeys);
-			return factory.newPreparedStatementCreator(this.indexedParams);
+		private PreparedStatementCreator statementCreatorForIndexedParamsWithKeys(@Nullable String[] keyColumnNames) {
+			PreparedStatementCreatorFactory pscf = new PreparedStatementCreatorFactory(this.sql);
+			if (keyColumnNames != null) {
+				pscf.setGeneratedKeysColumnNames(keyColumnNames);
+			}
+			else {
+				pscf.setReturnGeneratedKeys(true);
+			}
+			return pscf.newPreparedStatementCreator(this.indexedParams);
 		}
 
 

diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/core/simple/JdbcClient.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/simple/JdbcClient.java
@@ -288,6 +288,16 @@ interface StatementSpec {
 		 * @see java.sql.PreparedStatement#executeUpdate()
 		 */
 		int update(KeyHolder generatedKeyHolder);
+
+		/**
+		 * Execute the provided SQL statement as an update.
+		 * @param generatedKeyHolder a KeyHolder that will hold the generated keys
+		 * (typically a {@link org.springframework.jdbc.support.GeneratedKeyHolder})
+		 * @param keyColumnNames names of the columns that will have keys generated for them
+		 * @return the number of rows affected
+		 * @see java.sql.PreparedStatement#executeUpdate()
+		 */
+		int update(KeyHolder generatedKeyHolder, String... keyColumnNames);
 	}
 
 

diff --git a/...c/src/test/java/org/springframework/jdbc/core/simple/JdbcClientIndexedParameterTests.java b/...c/src/test/java/org/springframework/jdbc/core/simple/JdbcClientIndexedParameterTests.java
@@ -339,7 +339,7 @@ public void updateWithTypedParameters() throws SQLException {
 	}
 
 	@Test
-	public void updateAndGeneratedKeys() throws SQLException {
+	public void updateWithGeneratedKeys() throws SQLException {
 		given(resultSetMetaData.getColumnCount()).willReturn(1);
 		given(resultSetMetaData.getColumnLabel(1)).willReturn("1");
 		given(resultSet.getMetaData()).willReturn(resultSetMetaData);
@@ -362,4 +362,28 @@ public void updateAndGeneratedKeys() throws SQLException {
 		verify(connection).close();
 	}
 
+	@Test
+	public void updateWithGeneratedKeysAndKeyColumnNames() throws SQLException {
+		given(resultSetMetaData.getColumnCount()).willReturn(1);
+		given(resultSetMetaData.getColumnLabel(1)).willReturn("1");
+		given(resultSet.getMetaData()).willReturn(resultSetMetaData);
+		given(resultSet.next()).willReturn(true, false);
+		given(resultSet.getObject(1)).willReturn(11);
+		given(preparedStatement.executeUpdate()).willReturn(1);
+		given(preparedStatement.getGeneratedKeys()).willReturn(resultSet);
+		given(connection.prepareStatement(INSERT_GENERATE_KEYS, new String[] {"id"}))
+				.willReturn(preparedStatement);
+
+		KeyHolder generatedKeyHolder = new GeneratedKeyHolder();
+		int rowsAffected = client.sql(INSERT_GENERATE_KEYS).param("rod").update(generatedKeyHolder, "id");
+
+		assertThat(rowsAffected).isEqualTo(1);
+		assertThat(generatedKeyHolder.getKeyList()).hasSize(1);
+		assertThat(generatedKeyHolder.getKey()).isEqualTo(11);
+		verify(preparedStatement).setString(1, "rod");
+		verify(resultSet).close();
+		verify(preparedStatement).close();
+		verify(connection).close();
+	}
+
 }
diff --git a/...g-jdbc/src/test/java/org/springframework/jdbc/core/simple/JdbcClientIntegrationTests.java b/...g-jdbc/src/test/java/org/springframework/jdbc/core/simple/JdbcClientIntegrationTests.java
@@ -34,16 +34,18 @@
  * Integration tests for {@link JdbcClient} using an embedded H2 database.
  *
  * @author Sam Brannen
+ * @author Juergen Hoeller
  * @since 6.1
  * @see JdbcClientIndexedParameterTests
  * @see JdbcClientNamedParameterTests
  */
 class JdbcClientIntegrationTests {
 
+	private static final String INSERT_WITH_JDBC_PARAMS =
+			"INSERT INTO users (first_name, last_name) VALUES(?, ?)";
+
 	private static final String INSERT_WITH_NAMED_PARAMS =
 			"INSERT INTO users (first_name, last_name) VALUES(:firstName, :lastName)";
-	private static final String INSERT_WITH_POSITIONAL_PARAMS =
-			"INSERT INTO users (first_name, last_name) VALUES(?, ?)";
 
 
 	private final EmbeddedDatabase embeddedDatabase =
@@ -66,15 +68,16 @@ void shutdownDatabase() {
 		this.embeddedDatabase.shutdown();
 	}
 
+
 	@Test
-	void updateWithGeneratedKeysAndPositionalParameters() {
+	void updateWithGeneratedKeys() {
 		int expectedId = 2;
 		String firstName = "Jane";
 		String lastName = "Smith";
 
 		KeyHolder generatedKeyHolder = new GeneratedKeyHolder();
 
-		int rowsAffected = this.jdbcClient.sql(INSERT_WITH_POSITIONAL_PARAMS)
+		int rowsAffected = this.jdbcClient.sql(INSERT_WITH_JDBC_PARAMS)
 				.params(firstName, lastName)
 				.update(generatedKeyHolder);
 
@@ -85,7 +88,25 @@ void updateWithGeneratedKeysAndPositionalParameters() {
 	}
 
 	@Test
-	void updateWithGeneratedKeysAndNamedParameters() {
+	void updateWithGeneratedKeysAndKeyColumnNames() {
+		int expectedId = 2;
+		String firstName = "Jane";
+		String lastName = "Smith";
+
+		KeyHolder generatedKeyHolder = new GeneratedKeyHolder();
+
+		int rowsAffected = this.jdbcClient.sql(INSERT_WITH_JDBC_PARAMS)
+				.params(firstName, lastName)
+				.update(generatedKeyHolder, "id");
+
+		assertThat(rowsAffected).isEqualTo(1);
+		assertThat(generatedKeyHolder.getKey()).isEqualTo(expectedId);
+		assertNumUsers(2);
+		assertUser(expectedId, firstName, lastName);
+	}
+
+	@Test
+	void updateWithGeneratedKeysUsingNamedParameters() {
 		int expectedId = 2;
 		String firstName = "Jane";
 		String lastName = "Smith";
@@ -103,6 +124,26 @@ void updateWithGeneratedKeysAndNamedParameters() {
 		assertUser(expectedId, firstName, lastName);
 	}
 
+	@Test
+	void updateWithGeneratedKeysAndKeyColumnNamesUsingNamedParameters() {
+		int expectedId = 2;
+		String firstName = "Jane";
+		String lastName = "Smith";
+
+		KeyHolder generatedKeyHolder = new GeneratedKeyHolder();
+
+		int rowsAffected = this.jdbcClient.sql(INSERT_WITH_NAMED_PARAMS)
+				.param("firstName", firstName)
+				.param("lastName", lastName)
+				.update(generatedKeyHolder, "id");
+
+		assertThat(rowsAffected).isEqualTo(1);
+		assertThat(generatedKeyHolder.getKey()).isEqualTo(expectedId);
+		assertNumUsers(2);
+		assertUser(expectedId, firstName, lastName);
+	}
+
+
 	private void assertNumUsers(long count) {
 		long numUsers = this.jdbcClient.sql("select count(id) from users").query(Long.class).single();
 		assertThat(numUsers).isEqualTo(count);
@@ -113,6 +154,7 @@ private void assertUser(long id, String firstName, String lastName) {
 		assertThat(user).isEqualTo(new User(id, firstName, lastName));
 	}
 
+
 	record User(long id, String firstName, String lastName) {};
 
 }
diff --git a/...dbc/src/test/java/org/springframework/jdbc/core/simple/JdbcClientNamedParameterTests.java b/...dbc/src/test/java/org/springframework/jdbc/core/simple/JdbcClientNamedParameterTests.java
@@ -406,7 +406,7 @@ void updateWithTypedParameters() throws SQLException {
 	}
 
 	@Test
-	void updateAndGeneratedKeys() throws SQLException {
+	void updateWithGeneratedKeys() throws SQLException {
 		given(resultSetMetaData.getColumnCount()).willReturn(1);
 		given(resultSetMetaData.getColumnLabel(1)).willReturn("1");
 		given(resultSet.getMetaData()).willReturn(resultSetMetaData);
@@ -429,4 +429,28 @@ void updateAndGeneratedKeys() throws SQLException {
 		verify(connection).close();
 	}
 
+	@Test
+	public void updateWithGeneratedKeysAndKeyColumnNames() throws SQLException {
+		given(resultSetMetaData.getColumnCount()).willReturn(1);
+		given(resultSetMetaData.getColumnLabel(1)).willReturn("1");
+		given(resultSet.getMetaData()).willReturn(resultSetMetaData);
+		given(resultSet.next()).willReturn(true, false);
+		given(resultSet.getObject(1)).willReturn(11);
+		given(preparedStatement.executeUpdate()).willReturn(1);
+		given(preparedStatement.getGeneratedKeys()).willReturn(resultSet);
+		given(connection.prepareStatement(INSERT_GENERATE_KEYS_PARSED, new String[] {"id"}))
+				.willReturn(preparedStatement);
+
+		KeyHolder generatedKeyHolder = new GeneratedKeyHolder();
+		int rowsAffected = client.sql(INSERT_GENERATE_KEYS).param("name", "rod").update(generatedKeyHolder, "id");
+
+		assertThat(rowsAffected).isEqualTo(1);
+		assertThat(generatedKeyHolder.getKeyList()).hasSize(1);
+		assertThat(generatedKeyHolder.getKey()).isEqualTo(11);
+		verify(preparedStatement).setString(1, "rod");
+		verify(resultSet).close();
+		verify(preparedStatement).close();
+		verify(connection).close();
+	}
+
 }