Spring-JdbcTemplate详解，这都看不懂就安心去当个咸鱼吧！

jdbc.url=jdbc:mysql://localhost:3306/springjdbc?characterEncoding=utf-8&serverTimezone=GMT%2B8&useSSL=false

jdbc.user=root
jdbc.password=1234

可以通过HSQLDB自带的工具来初始化数据库表，这里我们写一个Bean，在Spring容器启动时自动创建一个users表：

@Component
public class DatabaseInitializer {
@Autowired
JdbcTemplate jdbcTemplate;

@PostConstruct
public void init() {
jdbcTemplate.update(“CREATE TABLE IF NOT EXISTS users (” //

• "id BIGINT IDENTITY NOT NULL PRIMARY KEY, " //
• "email VARCHAR(100) NOT NULL, " //
• "password VARCHAR(100) NOT NULL, " //
• "name VARCHAR(100) NOT NULL, " //
• “UNIQUE (email))”);
  }
  }

现在，所有准备工作都已完毕。我们只需要在需要访问数据库的Bean中，注入JdbcTemplate即可：

@Component
public class UserService {
@Autowired
JdbcTemplate jdbcTemplate;
…
}

JdbcTemplate 用法

Spring提供的JdbcTemplate采用Template模式，提供了一系列以回调为特点的工具方法，目的是避免繁琐的try...catch语句。

我们以具体的示例来说明JdbcTemplate的用法。

首先我们看T execute(ConnectionCallback action)方法，它提供了Jdbc的Connection供我们使用：

public User getUserById(long id) {
// 注意传入的是ConnectionCallback:
return jdbcTemplate.execute((Connection conn) -> {
// 可以直接使用conn实例，不要释放它，回调结束后JdbcTemplate自动释放:
// 在内部手动创建的PreparedStatement、ResultSet必须用try(…)释放:
try (var ps = conn.prepareStatement(“SELECT * FROM users WHERE id = ?”)) {
ps.setObject(1, id);
try (var rs = ps.executeQuery()) {
if (rs.next()) {
return new User( // new User object:
rs.getLong(“id”), // id
rs.getString(“email”), // email
rs.getString(“password”), // password
rs.getString(“name”)); // name
}
throw new RuntimeException(“user not found by id.”);
}
}
});
}
`
也就是说，上述回调方法允许获取Connection，然后做任何基于Connection的操作。

我们再看T execute(String sql, PreparedStatementCallback<‘T’> action)的用法：

public User getUserByName(String name) {
// 需要传入SQL语句，以及PreparedStatementCallback:
return jdbcTemplate.execute(“SELECT * FROM users WHERE name = ?”, (PreparedStatement ps) -> {
// PreparedStatement实例已经由JdbcTemplate创建，并在回调后自动释放:
ps.setObject(1, name);
try (var rs = ps.executeQuery()) {
if (rs.next()) {
return new User( // new User object:
rs.getLong(“id”), // id
rs.getString(“email”), // email
rs.getString(“password”), // password
rs.getString(“name”)); // name
}
throw new RuntimeException(“user not found by id.”);
}
});
}

最后，我们看T queryForObject(String sql, Object[] args, RowMapper<'T'> rowMapper)方法：

public User getUserByEmail(String email) {
// 传入SQL，参数和RowMapper实例:
return jdbcTemplate.queryForObject(“SELECT * FROM users WHERE email = ?”, new Object[] { email },
(ResultSet rs, int rowNum) -> {
// 将ResultSet的当前行映射为一个JavaBean:
return new User( // new User object:
rs.getLong(“id”), // id
rs.getString(“email”), // email
rs.getString(“password”), // password
rs.getString(“name”)); // name
});
}

RowMapper定义:

@FunctionalInterface
public interface RowMapper {
@Nullable
T mapRow(ResultSet var1, int var2) throws SQLException;
}

方法getUserByEmail中(ResultSet rs, int rowNum) -> {}语句实现一个RowMapper继承类的对象

在queryForObject()方法中，传入SQL以及SQL参数后，JdbcTemplate会自动创建PreparedStatement，自动执行查询并返回ResultSet，我们提供的RowMapper需要做的事情就是把ResultSet的当前行映射成一个JavaBean并返回。整个过程中，使用Connection、PreparedStatement和ResultSet都不需要我们手动管理。

RowMapper不一定返回JavaBean，实际上它可以返回任何Java对象。例如，使用SELECT COUNT(*)查询时，可以返回Long：

public long getUsers() {
return jdbcTemplate.queryForObject("SELECT COUNT() FROM users", null, (ResultSet rs, int rowNum) -> {
// SELECT COUNT()查询只有一列，取第一列数据:
return rs.getLong(1);
});
}

如果我们期望返回多行记录，而不是一行，可以用query()方法：

public List getUsers(int pageIndex) {
int limit = 100;
int offset = limit * (pageIndex - 1);
return jdbcTemplate.query(“SELECT * FROM users LIMIT ? OFFSET ?”, new Object[] { limit, offset },
new BeanPropertyRowMapper<>(User.class));
}

上述query()方法传入的参数仍然是SQL、SQL参数以及RowMapper实例。这里我们直接使用Spring提供的BeanPropertyRowMapper。如果数据库表的结构恰好和JavaBean的属性名称一致，那么BeanPropertyRowMapper就可以直接把一行记录按列名转换为JavaBean。

如果我们执行的不是查询，而是插入、更新和删除操作，那么需要使用update()方法：

public void updateUser(User user) {
// 传入SQL，SQL参数，返回更新的行数:
if (1 != jdbcTemplate.update(“UPDATE user SET name = ? WHERE id=?”, user.getName(), user.getId())) {
throw new RuntimeException(“User not found by id”);
}
}

只有一种INSERT操作比较特殊，那就是如果某一列是自增列（例如自增主键），通常，我们需要获取插入后的自增值。JdbcTemplate提供了一个KeyHolder来简化这一操作：

public User register(String email, String password, String name) {
// 创建一个KeyHolder:
KeyHolder holder = new GeneratedKeyHolder();
if (1 != jdbcTemplate.update(
// 参数1:PreparedStatementCreator
(conn) -> {
// 创建PreparedStatement时，必须指定RETURN_GENERATED_KEYS:
var ps = conn.prepareStatement(“INSERT INTO users(email,password,name) VALUES(?,?,?)”,
Statement.RETURN_GENERATED_KEYS);
ps.setObject(1, email);
ps.setObject(2, password);
ps.setObject(3, name);
return ps;
},
// 参数2:KeyHolder
holder)
) {
throw new RuntimeException(“Insert failed.”);
}
// 从KeyHolder中获取返回的自增值:
return new User(holder.getKey().longValue(), email, password, name);
}

JdbcTemplate还有许多重载方法，这里我们不一一介绍。需要强调的是，JdbcTemplate只是对JDBC操作的一个简单封装，它的目的是尽量减少手动编写try(resource) {...}的代码，对于查询，主要通过RowMapper实现了JDBC结果集到Java对象的转换。

我们总结一下JdbcTemplate的用法，那就是：

• 针对简单查询，优选query()和queryForObject()，因为只需提供SQL语句、参数和RowMapper；
• 针对更新操作，优选update()，因为只需提供SQL语句和参数；
• 任何复杂的操作，最终也可以通过execute(ConnectionCallback)实现，因为拿到Connection就可以做任何JDBC操作。

实际上我们使用最多的仍然是各种查询。如果在设计表结构的时候，能够和JavaBean的属性一一对应，那么直接使用BeanPropertyRowMapper就很方便。如果表结构和JavaBean不一致怎么办？那就需要稍微改写一下查询，使结果集的结构和JavaBean保持一致。

例如，表的列名是office_address，而JavaBean属性是workAddress，就需要指定别名，改写查询如下：

SELECT id, email, office_address AS workAddress, name FROM users WHERE email = ?

RowMapper 的基本使用

使用过原生JDBC的朋友应该知道，从数据库查询出来的记录全都被保存在ResultSet结果集中，我们需要将结果集中的数据一条条地获取并设置到具体的实体类上，如此，该实体类才能在接下来的程序中使用。然而问题是，每次都要这么操作实在是太麻烦了，Spring就不应该提供什么功能来替我们做这些事情吗？答案当然是有的，那就是本文的主角——RowMapper。

Spring JDBC中目前有两个主要的RowMapper实现，使用它们应该能解决大部分的场景了。

SingleColumnRowMapper

通过名字我们就能大概了解，在查询返回单列数据的时候，就该使用这个RowMapper，下面我们来看看具体的代码：

@Override
public String getStudentNameById(String id) {
String sql = “select name from test_student where id = ?”;
return this.jdbcTemplate.queryForObject(sql, new Object[]{id},
new SingleColumnRowMapper<>(String.class));
}

@Override
public List getStudentNamesByGrade(Integer grade) {
String sql = “select name from test_student where grade = ?”;
return this.jdbcTemplate.query(sql, new Object[]{grade},
new SingleColumnRowMapper<>(String.class));
}

测试：

@Test
public void getStudentNameById(){
String name = studentService.getStudentNameById(“3”);
assertEquals(“李清照”, name);
}

@Test
public void getStudentNamesByGrade(){
List names = studentService.getStudentNamesByGrade(1);
assertTrue(2 == names.size());
}

BeanPropertyRowMapper

当查询数据库返回的是多列数据，且你需要将这些多列数据映射到某个具体的实体类上，那么就该使用这个RowMapper，下面是具体的使用代码：

@Override
public Student getStudentByName2(String name) {
String sql = “select name, gender from test_student where name = ?”;
return this.jdbcTemplate.queryForObject(sql, new Object[]{name},
new BeanPropertyRowMapper<>(Student.class));
}

写在最后

可能有人会问我为什么愿意去花时间帮助大家实现求职梦想，因为我一直坚信时间是可以复制的。我牺牲了自己的大概十个小时写了这片文章，换来的是成千上万的求职者节约几天甚至几周时间浪费在无用的资源上。

上面的这些（算法与数据结构）+（Java多线程学习手册）+（计算机网络顶级教程）等学习资源

可能有人会问我为什么愿意去花时间帮助大家实现求职梦想，因为我一直坚信时间是可以复制的。我牺牲了自己的大概十个小时写了这片文章，换来的是成千上万的求职者节约几天甚至几周时间浪费在无用的资源上。

[外链图片转存中…(img-RleN9qgM-1725987348374)]

[外链图片转存中…(img-64hIrlYm-1725987348375)]

上面的这些（算法与数据结构）+（Java多线程学习手册）+（计算机网络顶级教程）等学习资源