在Spring JDBC 中获取自动生成的Key

怼烎@ 2023-09-26 10:10 44阅读 0赞

### **1. 引言** ###

在这个快速教程中，我们将探讨在使用*Spring JDBC*时在插入实体后获取自动生成的密钥的可能性。

### **2. 专家依赖关系** ###

首先，我们需要在我们的 *pom* 中定义*弹簧启动器 jdbc* 和 *H2* 依赖项.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>

我们可以查看 Maven Central 上这两个依赖项的最新版本：[弹簧启动启动器 jdbc][jdbc] 和 *[h2][]*。

### **3. 获取自动生成的密钥** ###

#### **3.1. 场景** ####

让我们定义一个*sys\_message*表，其中包含 2 列：*id*（自动生成的键）和*消息*：

CREATE TABLE IF NOT EXISTS sys_message (
        id bigint(20) NOT NULL AUTO_INCREMENT,
        message varchar(100) NOT NULL,
        PRIMARY KEY (id)
    );

#### **3.2. 使用 *Jdbc 模板*** ####

现在，让我们实现一个方法，该方法将使用 *JDBCTemplate* 插入新记录并返回自动生成的 *id。*

因此，**我们将使用 *JDBC 模板**更新（）*** 方法，该方法支持检索数据库生成的主键。此方法将*准备语句创建器*接口的一个实例作为第一个参数，另一个参数是*密钥持有者。*

由于*准备语句创建器*接口是一个*功能接口，*其方法接受 *java.sql.连接的*实例并返回一个 *java.sql.准备语句*对象，为简单起见，我们可以使用 lambda 表达式：

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();
        }
    }

值得注意的是**，*键持有者*对象将包含从 *JDBCTemplate 更新（）* 方法自动生成的密钥返回**。

我们可以通过调用密钥*持有者.getKey（）* 来检索该密钥。

此外，我们可以验证该方法：

@Test
    public void 
      insertJDBC_whenLoadMessageByKey_thenGetTheSameMessage() {
        long key = messageRepositoryJDBCTemplate.insert(MESSAGE_CONTENT);
        String loadedMessage = messageRepositoryJDBCTemplate
          .getMessageById(key);
    
        assertEquals(MESSAGE_CONTENT, loadedMessage);
    }

#### **3.3. 使用*简单Jdbc插入*** ####

除了 *JDBC 模板之外*，我们还可以使用*简单的 Jdbc 导入*来实现相同的结果。

因此，我们需要初始化*简单 Jdbc 插入的*实例：

@Repository
    public class MessageRepositorySimpleJDBCInsert {
    
        SimpleJdbcInsert simpleJdbcInsert;
    
        @Autowired
        public MessageRepositorySimpleJDBCInsert(DataSource dataSource) {
            simpleJdbcInsert = new SimpleJdbcInsert(dataSource)
              .withTableName("sys_message").usingGeneratedKeyColumns("id");
        }
        
        //...
    }

因此，**我们可以调用*简单Jdbc插入*的*执行和返回键*方法，以插入一条新记录来*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. 结论** ###

我们已经探索了使用 *JDBC 模板*和*简单 Jdbc插入*插入新记录并取回自动生成的密钥的可能性。

与往常一样，我们可以在[Github上][Github]找到本文的实现。

[jdbc]: https://search.maven.org/classic/#search%7Cgav%7C1%7Cg%3A%22org.springframework.boot%22%20AND%20a%3A%22spring-boot-starter-jdbc%22
[h2]: https://search.maven.org/classic/#search%7Cgav%7C1%7Cg%3A%22com.h2database%22%20AND%20a%3A%22h2%22
[Github]: https://github.com/eugenp/tutorials/tree/master/persistence-modules/spring-jdbc