Spring Data JDBC使用序列生成主键

迈不过友情╰ 2023-09-26 11:16 15阅读 0赞

默认情况下，弹簧数据 JDBC 期望数据库为每个新记录提供主键值。实现此目的的最简单方法是使用自动增量列。我们在[春季数据简介 JDBC][JDBC] 指南中使用了这一点。但是，如果您的表模型使用数据库序列，该怎么办？

当然，春季数据JDBC也可以处理这个问题。但它需要一些额外的代码。在将实体写入数据库之前，您需要从数据库序列中获取值并设置主键属性，而不是依赖于默认处理。最好的方法是实现*一个转换前回调*。

### 实现*转换前回调*以获取序列值 ###

您可能已经知道其他Spring数据模块的回调机制。实体回调API在2.2版的Spring Data Commons中引入，它是官方推荐的在某些生命周期事件之前或之后修改实体对象的方法。使用 Spring 数据 JDBC 时，可以使用该机制在持久保存新实体对象时自动检索序列值。

让我们使用此方法在持久化 *ChessGame* 聚合之前自动从数据库序列中获取主键值。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>public</code> <code>class</code> <code>ChessGame { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Id</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code> <code>Long id;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code> <code>String playerWhite;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code> <code>String playerBlack;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code> <code>List&lt;ChessMove&gt; moves = </code><code>new</code> <code>ArrayList&lt;&gt;();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

如果不进行任何其他更改，以下测试用例将保留 *ChessGame* 聚合，并期望数据库提供主键值。如前所述，这通常是通过将主键列建模为自动增量列来实现的。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>ChessGame game = </code><code>new</code> <code>ChessGame();</code> <code>game.setPlayerWhite(</code><code>"Thorben Janssen"</code><code>);</code> <code>game.setPlayerBlack(</code><code>"A strong player"</code><code>);</code> <code>ChessMove move1white = </code><code>new</code> <code>ChessMove();</code> <code>move1white.setMoveNumber(</code><code>1</code><code>);</code> <code>move1white.setColor(MoveColor.WHITE);</code> <code>move1white.setMove(</code><code>"e4"</code><code>);</code> <code>game.getMoves().add(move1white);</code> <code>ChessMove move1Black = </code><code>new</code> <code>ChessMove();</code> <code>move1Black.setMoveNumber(</code><code>1</code><code>);</code> <code>move1Black.setColor(MoveColor.BLACK);</code> <code>move1Black.setMove(</code><code>"e5"</code><code>);</code> <code>game.getMoves().add(move1Black);</code> <code>gameRepo.save(game);</code> </td> 
 </tr> 
 </tbody> 
</table>

如果要使用其他方法来生成主值，可以使用*“转换前回调”进行*设置。春季数据JDBC将在将*国际象棋游戏*聚合转换为数据库更改之前执行回调。

正如您在以下代码片段中看到的，这种回调的实现很简单。实现*“转换前回调”*接口，并将聚合根的类作为类型参数提供。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 </td> 
 <td> <code>@Component</code> <code>public</code> <code>class</code> <code>GetSequenceValueCallback </code><code>implements</code> <code>BeforeConvertCallback&lt;ChessGame&gt; { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code> <code>Logger log = LogManager.getLogger(GetSequenceValueCallback.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code> <code>final</code> <code>JdbcTemplate jdbcTemplate;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>GetSequenceValueCallback(JdbcTemplate jdbcTemplate) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>this</code><code>.jdbcTemplate = jdbcTemplate;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code> <code>ChessGame onBeforeConvert(ChessGame game) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(game.getId() == </code><code>null</code><code>) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"Get the next value from a database sequence and use it as the primary key"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Long id = jdbcTemplate.query(</code><code>"SELECT nextval('chessgame_seq')"</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>rs -&gt; { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(rs.next()) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>rs.getLong(</code><code>1</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} </code><code>else</code> <code>{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>throw</code> <code>new</code> <code>SQLException(</code><code>"Unable to retrieve value from sequence chessgame_seq."</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>});</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>game.setId(id);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>game;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

在实现接口时，您应该定义一个需要 *Jdbc 模板的*构造函数。Spring将使用与当前事务关联的模板来调用它。然后，您可以在“前*转换”*方法的实现中使用该 *Jdbc 模板*。

弹簧数据 JDBC 为所有插入和更新操作触发*转换前回调*。因此，在实现 *onBefore 方法*时，应检查主键属性是否为空。如果是这种情况，我们将保留一个新的聚合，并且需要生成一个唯一的主键值。为此，可以使用 *JdbcTemplate* 执行从数据库序列中获取下一个值的 SQL 语句，并将该值设置为主键。

这就是您需要做的所有事情。如果重新运行相同的测试用例，则可以看到由 *GetSequenceValueCallback* 编写的消息和 SQL 语句，用于从日志输出中的数据库序列中获取值。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>16:00:22.891&nbsp; INFO 6728 - – [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; main] c.t.j.model.GetSequenceValueCallback&nbsp;&nbsp;&nbsp;&nbsp; : Get the </code><code>next</code> <code>value </code><code>from</code> <code>a </code><code>database</code> <code>sequence</code> <code>and</code> <code>use it </code><code>as</code> <code>the </code><code>primary</code> <code>key</code> <code>16:00:22.892 DEBUG 6728 - – [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; main] o.s.jdbc.core.JdbcTemplate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : Executing SQL query [</code><code>SELECT</code> <code>nextval(</code><code>'chessgame_seq'</code><code>)]</code> <code>16:00:22.946 DEBUG 6728 - – [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; main] o.s.jdbc.core.JdbcTemplate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : Executing prepared SQL </code><code>update</code> <code>16:00:22.947 DEBUG 6728 - – [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; main] o.s.jdbc.core.JdbcTemplate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : Executing prepared SQL statement [</code><code>INSERT</code> <code>INTO</code> <code>"chess_game"</code> <code>(</code><code>"id"</code><code>, </code><code>"player_black"</code><code>, </code><code>"player_white"</code><code>) </code><code>VALUES</code> <code>(?, ?, ?)]</code> <code>16:00:22.969 DEBUG 6728 - – [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; main] o.s.jdbc.core.JdbcTemplate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : Executing SQL </code><code>update</code> <code>and</code> <code>returning generated keys</code> <code>16:00:22.970 DEBUG 6728 - – [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; main] o.s.jdbc.core.JdbcTemplate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : Executing prepared SQL statement [</code><code>INSERT</code> <code>INTO</code> <code>"chess_move"</code> <code>(</code><code>"chess_game"</code><code>, </code><code>"chess_game_key"</code><code>, </code><code>"color"</code><code>, </code><code>"move"</code><code>, </code><code>"move_number"</code><code>) </code><code>VALUES</code> <code>(?, ?, ?, ?, ?)]</code> <code>16:00:22.979 DEBUG 6728 - – [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; main] o.s.jdbc.core.JdbcTemplate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : Executing SQL </code><code>update</code> <code>and</code> <code>returning generated keys</code> <code>16:00:22.980 DEBUG 6728 - – [&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; main] o.s.jdbc.core.JdbcTemplate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; : Executing prepared SQL statement [</code><code>INSERT</code> <code>INTO</code> <code>"chess_move"</code> <code>(</code><code>"chess_game"</code><code>, </code><code>"chess_game_key"</code><code>, </code><code>"color"</code><code>, </code><code>"move"</code><code>, </code><code>"move_number"</code><code>) </code><code>VALUES</code> <code>(?, ?, ?, ?, ?)]</code> </td> 
 </tr> 
 </tbody> 
</table>

### 结论 ###

默认情况下，弹簧数据 JDBC 期望数据库为每个聚合提供唯一的主键值。大多数 DBA 为此使用自动增量列。

正如您在本文中所看到的，您可以通过实现*之前转换回调*来轻松提供自己的主键生成。春季数据 JDBC 在保留或更新聚合时会自动调用它。因此，您需要检查是否需要生成主键值。如果是这种情况，则可以使用 *Jdbc 模板*执行一个简单的 SQL 语句，该语句从数据库序列中获取下一个值。

[JDBC]: https://thorben-janssen.com/spring-data-jdbc-getting-started/