SpringJDBCで自動生成されたキーを取得する
1. 序章
このクイックチュートリアルでは、 Spring JDBC を使用しているときに、エンティティを挿入した後に自動生成されたキーを取得する可能性について説明します。
2. Mavenの依存関係
最初に、spring-boot-starter-jdbcおよびH2の依存関係をpom.xmlで定義する必要があります。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
MavenCentralの2つの依存関係の最新バージョンspring-boot-starter-jdbcとh2を確認できます。
3. 自動生成されたキーの取得
3.1. シナリオ
sys_message テーブルを定義しましょう。このテーブルには、 id (自動生成されたキー)とmessageの2つの列があります。
CREATE TABLE IF NOT EXISTS sys_message (
id bigint(20) NOT NULL AUTO_INCREMENT,
message varchar(100) NOT NULL,
PRIMARY KEY (id)
);
3.2. JdbcTemplateを使用する
それでは、を使用するメソッドを実装しましょう JDBCTemplate 新しいレコードを挿入し、自動生成されたものを返します
したがって、データベースによって生成された主キーの取得をサポートするJDBCTemplate update()メソッドを使用します。 このメソッドは、 PrepareStatementCreator 最初の引数としてのインターフェースと他の引数は
PrepareStatementCreatorインターフェースはFunctionalInterfaceであるため、そのメソッドは java.sql.Connection のインスタンスを受け入れ、java.sql.PreparedStatementを返します。 ]オブジェクト、簡単にするために、ラムダ式を使用できます。
String INSERT_MESSAGE_SQL
= "insert into sys_message (message) values(?) ";
public long insertMessage(String message) {
KeyHolder keyHolder = new GeneratedKeyHolder();
jdbcTemplate.update(connection -> {
PreparedStatement ps = connection
.prepareStatement(INSERT_MESSAGE_SQL);
ps.setString(1, message);
return ps;
}, keyHolder);
return (long) keyHolder.getKey();
}
}
keyHolderオブジェクトには、JDBCTemplate update()メソッドからの自動生成されたキーリターンが含まれることに注意してください。
keyHolder.getKey()。を呼び出すことで、そのキーを取得できます。
さらに、メソッドを検証できます。
@Test
public void
insertJDBC_whenLoadMessageByKey_thenGetTheSameMessage() {
long key = messageRepositoryJDBCTemplate.insert(MESSAGE_CONTENT);
String loadedMessage = messageRepositoryJDBCTemplate
.getMessageById(key);
assertEquals(MESSAGE_CONTENT, loadedMessage);
}
3.3. SimpleJdbcInsertを使用する
JDBCTemplate に加えて、SimpleJdbcInsertを使用して同じ結果を得ることができます。
したがって、SimpleJdbcInsertのインスタンスを初期化する必要があります。
@Repository
public class MessageRepositorySimpleJDBCInsert {
SimpleJdbcInsert simpleJdbcInsert;
@Autowired
public MessageRepositorySimpleJDBCInsert(DataSource dataSource) {
simpleJdbcInsert = new SimpleJdbcInsert(dataSource)
.withTableName("sys_message").usingGeneratedKeyColumns("id");
}
//...
}
したがって、 SimpleJdbcInsertのexecuteAndReturnKeyメソッドを呼び出して、新しいレコードをsys_messageテーブルに挿入し、自動生成されたキーを取得できます。
public long insert(String message) {
Map<String, Object> parameters = new HashMap<>(1);
parameters.put("message", message);
Number newId = simpleJdbcInsert.executeAndReturnKey(parameters);
return (long) newId;
}
さらに、その方法を非常に簡単に検証できます。
@Test
public void
insertSimpleInsert_whenLoadMessageKey_thenGetTheSameMessage() {
long key = messageRepositorySimpleJDBCInsert.insert(MESSAGE_CONTENT);
String loadedMessage = messageRepositoryJDBCTemplate.getMessageById(key);
assertEquals(MESSAGE_CONTENT, loadedMessage);
}
4. 結論
JDBCTemplateおよびSimpleJdbcInsertを使用して、新しいレコードを挿入し、自動生成されたキーを元に戻す可能性を検討しました。
いつものように、この記事の実装はGithubにあります。