使用org.springframework.jdbc.support.GeneratedKeyHolder 获取数据库自动生成的主键值

最新推荐文章于 2024-05-06 17:37:19 发布

因上精进，果上随缘

最新推荐文章于 2024-05-06 17:37:19 发布

阅读量293

点赞数 2

分类专栏： JavaEE 文章标签：数据库 java spring

本文链接：https://blog.csdn.net/anguang1973/article/details/137954494

版权

JavaEE 专栏收录该内容

88 篇文章 0 订阅

订阅专栏

本文介绍了Spring框架中的GeneratedKeyHolder如何在Java代码中配合JdbcTemplate使用，以获取在插入记录后数据库自动生成的主键值，包括自增字段、UUID和序列的应用实例。

摘要由CSDN通过智能技术生成

org.springframework.jdbc.support.GeneratedKeyHolder 是Spring框架提供的一个工具类，它允许在插入记录到数据库后获取数据库自动生成的主键值。这在很多场景中都非常有用，特别是当你使用自增字段、UUID或者序列来作为主键时。

以下是一个使用 GeneratedKeyHolder 的简单例子：

首先，假设你有一个名为 users 的表，其中 id 字段是自增的主键：

CREATE TABLE users (  
    id INT AUTO_INCREMENT PRIMARY KEY,  
    username VARCHAR(50) NOT NULL,  
    password VARCHAR(50) NOT NULL  
);

接下来，在你的Java代码中，你可以使用Spring的 JdbcTemplate 和 GeneratedKeyHolder 来插入一条新记录并获取生成的 id：

import org.springframework.jdbc.core.JdbcTemplate;  
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;  
import org.springframework.jdbc.support.GeneratedKeyHolder;  
import org.springframework.jdbc.support.KeyHolder;  
import java.sql.PreparedStatement;  
import java.sql.ResultSet;  
import java.sql.SQLException;  
  
public class UserService {  
    private final JdbcTemplate jdbcTemplate;  
  
    public UserService(JdbcTemplate jdbcTemplate) {  
        this.jdbcTemplate = jdbcTemplate;  
    }  
  
    public int insertUser(String username, String password) {  
        String sql = "INSERT INTO users (username, password) VALUES (?, ?)";  
          
        // 使用KeyHolder来存储生成的键  
        KeyHolder keyHolder = new GeneratedKeyHolder();  
  
        // 使用PreparedStatementCreator或NamedParameterJdbcTemplate执行SQL，并将keyHolder传递进去  
        jdbcTemplate.update(new PreparedStatementCreator() {  
            @Override  
            public PreparedStatement createPreparedStatement(Connection connection) throws SQLException {  
                PreparedStatement ps = connection.prepareStatement(sql, PreparedStatement.RETURN_GENERATED_KEYS);  
                ps.setString(1, username);  
                ps.setString(2, password);  
                return ps;  
            }  
        }, keyHolder);  
  
        // 从KeyHolder中获取生成的键  
        return keyHolder.getKey().intValue();  
    }  
}

在上面的例子中，我们使用了 PreparedStatementCreator 来手动构建 PreparedStatement，并设置了 PreparedStatement.RETURN_GENERATED_KEYS 标志来告诉JDBC驱动程序返回生成的键。然后，我们执行了更新操作，并通过 keyHolder.getKey() 获取了生成的键。

注意，你也可以使用 NamedParameterJdbcTemplate 来简化参数绑定的过程，但这取决于你的具体需求和偏好。

最后，请确保你的 JdbcTemplate 已经配置好，并且连接到了正确的数据库。通常，在Spring应用程序中，JdbcTemplate 会作为一个bean注入到你的服务类中。