> For the complete documentation index, see [llms.txt](https://potoyang.gitbook.io/spring-in-action-v4/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://potoyang.gitbook.io/spring-in-action-v4/untitled-4/untitled-1/untitled.md).

# 10.3.2　使用 JDBC 模板

Spring 的 JDBC 框架承担了资源管理和异常处理的工作，从而简化了 JDBC 代码，让我们只需编写从数据库读写数据的必需代码。

正如前面小节所介绍过的，Spring 将数据访问的样板代码抽象到模板类之中。Spring 为 JDBC 提供了三个模板类供选择：

* JdbcTemplate：最基本的 Spring JDBC 模板，这个模板支持简单的 JDBC 数据库访问功能以及基于索引参数的查询；
* NamedParameterJdbcTemplate：使用该模板类执行查询时可以将值以命名参数的形式绑定到 SQL 中，而不是使用简单的索引参数；
* SimpleJdbcTemplate：该模板类利用 Java 5 的一些特性如自动装箱、泛型以及可变参数列表来简化 JDBC 模板的使用。

以前，在选择哪一个 JDBC 模板的时候，我们需要仔细权衡。但是从 Spring 3.1 开始，做这个决定变得容易多了。SimpleJdbcTemplate 已经被废弃了，其 Java 5 的特性被转移到了 JdbcTemplate 中，并且只有在你需要使用命名参数的时候，才需要使 用 NamedParameterJdbcTemplate。这样的话，对于大多数的 JDBC 任务来说，JdbcTemplate 就是最好的可选方案，这也是本小节中所关注的方案。

**使用 JdbcTemplate 来插入数据**

为了让 JdbcTemplate 正常工作，只需要为其设置 DataSource 就可以了，这使得在 Spring 中配置 JdbcTemplate 非常容易，如下面的 @Bean 方法所示：

```java
@Bean
public JdbcTemplate jdbcTemplate(DataSource dataSource) {
  return new JdbcTemplate(dataSource);
}
```

在这里，DataSource 是通过构造器参数注入进来的。这里所引用的 dataSource bean 可以是 javax.sql.DataSource 的任意实现，包括我们在 10.2 小节中所创建的。

现在，我们可以将 jdbcTemplate 装配到 Repository 中并使用它来访问数据库。例如，SpitterRepository 使用了 JdbcTemplate：

```java
public class JdbcSpitterRepository implements SpitterRepository {
	
	private JdbcOperations jdbcOperations;

	public JdbcSpitterRepository(JdbcOperations jdbcOperations) {
		this.jdbcOperations= jdbcOperations;		
	}
	
	...
}
```

在这里，JdbcSpitterRepository 类上使用了 @Repository 注解，这表明它将会在组件扫描的时候自动创建。它的构造器上使用了 @Inject 注解，因此在创建的时候，会自动获得一个 JdbcOperations 对象。JdbcOperations 是一个接口，定义了 JdbcTemplate 所实现的操作。通过注入 JdbcOperations，而不是具体的 JdbcTemplate，能够保证 JdbcSpitterRepository 通过 JdbcOperations 接口达到与 JdbcTemplate 保持松耦合。

作为另外一种组件扫描和自动装配的方案，我们可以将 JdbcSpitterRepository 显式声明为 Spring 中的 bean，如下所示：

```java
@Bean
public SpitterRepository spitterRepository(JdbcTemplate jdbcTemplate) {
  return new jdbcSpitterRepository(jdbcTemplate);
}
```

在 Repository 中具备可用的 JdbcTemplate 后，我们可以极大地简化程序清单 10.4 中的 addSpitter() 方法。基于 JdbcTemplate 的 addSpitter() 方法如下：

{% code title="程序清单 10.7　基于 JdbcTemplate 的 addSpitter() 方法" %}

```java
private void insertSpitter(Spitter spitter) {
  jdbcTemplate.update(INSERT_SPITTER,
    spitter.getUsername(),
    spitter.getPassword(),
    spitter.getFullName(),
    spitter.getEmail(),
    spitter.isUpdateByEmail());
}
```

{% endcode %}

这个版本的 addSpitter() 方法简单多了。这里没有了创建连接和语句的代码，也没有异常处理的代码，只剩下单纯的数据插入代码。

不能因为你看不到这些样板代码，就意味着它们不存在。样板代码被巧妙地隐藏到 JDBC 模板类中了。当 update() 方法被调用的时候 JdbcTemplate 将会获取连接、创建语句并执行插入 SQL。

在这里，你也看不到对 SQLException 处理的代码。在内部，JdbcTemplate 将会捕获所有可能抛出的 SQLException，并将通用的 SQLException 转换为表 10.1 所列的那些更明确的数据访问异常，然后将其重新抛出。因为 Spring 的数据访问异常都是运行时异常，所以我们不必在 addSpitter() 方法中进行捕获。

**使用 JdbcTemplate 来读取数据**

JdbcTemplate 也简化了数据的读取操作。程序清单 10.8 展现了新版本的 findOne() 方法，它使用了 JdbcTemplate 的回调，实现根据 ID 查询 Spitter，并将结果集映射为  Spitter 对象。

{% code title="程序清单 10.8　使用 JdbcTemplate 查询 Spitter" %}

```java
public Spitter findOne(long id) {
  return jdbcTemplate.queryForObject(
    SELECT_SPITTER + " where id=?", new SpitterRowMapper(), id);
}

...

private static final class SpitterRowMapper implements RowMapper<Spitter> {
  public Spitter mapRow(ResultSet rs, int rowNum) throws SQLException {
	return new Spitter(
	  rs.getLong("id"),
	  rs.getString("username"),
	  rs.getString("password"),
	  rs.getString("fullname"),
	  rs.getString("email"),
	  rs.getBoolean("updateByEmail"));
  }		
}
```

{% endcode %}

在这个 findOne() 方法中使用了 JdbcTemplate 的 queryForObject() 方法来从数据库查询 Spitter。queryForObject() 方法有三个参数：

* String 对象，包含了要从数据库中查找数据的 SQL；
* RowMapper 对象，用来从 ResultSet 中提取数据并构建域对象（本例中为 Spitter）；
* 可变参数列表，列出了要绑定到查询上的索引参数值。

真正奇妙的事情发生在 SpitterRowMapper 对象中，它实现了 RowMapper 接口。对于查询返回的每一行数据，JdbcTemplate 将会调用 RowMapper 的 mapRow() 方法，并传入一个 ResultSet 和包含行号的整数。在 SpitterRowMapper 的 mapRow() 方法中，我们创建了 Spitter 对象并将 ResultSet 中的值填充进去。

就像 addSpitter() 那样，findOne() 方法也不用写 JDBC 模板代 码。不同于传统的 JDBC，这里没有资源管理或者异常处理代码。使用 JdbcTemplate 的方法只需关注于如何从数据库中获取 Spitter 对象即可。

**在 JdbcTemplate 中使用 Java 8 的 Lambda 表达式**

因为 RowMapper 接口只声明了 addRow() 这一个方法，因此它完全 符合函数式接口（functional interface）的标准。这意味着如果使用 Java 8 来开发应用的话，我们可以使用 Lambda 来表达 RowMapper 的实现，而不必再使用具体的实现类了。

例如，程序清单 10.8 中的 findOne() 方法可以使用 Java 8 的 Lambda 表达式改写，如下所示：

{% code title="程序清单 10.8　使用 JdbcTemplate 查询 Spitter" %}

```java
public Spitter findOne(long id) {
	return jdbcOperations.queryForObject(
	  SELECT_SPITTER_BY_ID,
	  (rs, rowNum) -> {
	    return new Spitter(
	      rs.getLong("id"),
	      rs.getString("username"),
    	  rs.getString("password"),
	      rs.getString("fullname"),
	      rs.getString("email"),
	      rs.getBoolean("updateByEmail"));
	},
	id);
}
```

{% endcode %}

我们可以看到，Lambda 表达式要比完整的 RowMapper 实现更为易读，不过它们的功能是相同的。Java 会限制 RowMapper 中的 Lambda 表达式，使其满足所传入的参数。

另外，我们还可以使用 Java 8 的方法引用，在单独的方法中定义映射逻辑：

{% code title="" %}

```java
public Spitter findOne(long id) {
  return jdbcOperations.queryForObejct(
    SELECT_SPITTER_BY_ID, this::mapSpitter, id);
}

private Spitter mapSpitter(ResultSet rs, int row) throws Exception {
  return new Spitter(
    rs.getLong("id"),
	rs.getString("username"),
    rs.getString("password"),
	rs.getString("fullname"),
	rs.getString("email"),
	rs.getBoolean("updateByEmail"));
}
```

{% endcode %}

不管采用哪种方式，我们都不必显式实现 RowMapper 接口，但是与实现 RowMapper 类似，我们所提供的 Lambda 表达式和方法必须要接受相同的参数，并返回相同的类型。

**使用命名参数**

在清单 10.7 的代码中，addSpitter() 方法使用了索引参数。这意味着我们需要留意查询中参数的顺序，在将值传递给 update() 方法的时候要保持正确的顺序。如果在修改 SQL 时更改了参数的顺序，那我们还需要修改参数值的顺序。

除了这种方法之外，我们还可以使用命名参数。命名参数可以赋予 SQL 中的每个参数一个明确的名字，在绑定值到查询语句的时候就通过该名字来引用参数。例如，假设 SQL\_INSERT\_SPITTER 查询语句是这样定义的：

```java
private static final Spitter SQL_INSERT_SPITTER = 
  "insert into spitter (username, password, fullname) " +
  "values (:username, :password, :fullname)";
```

使用命名参数查询，绑定值的顺序就不重要了，我们可以按照名字来绑定值。如果查询语句发生了变化导致参数的顺序与之前不一致，我们不需要修改绑定的代码。

NamedParameterJdbcTemplate 是一个特殊的 JDBC 模板类，它支持使用命名参数。在 Spring 中，NamedParameterJdbcTemplate 的声明方式与常规的 JdbcTemplate 几乎完全相同：

```java
@Bean
public NamedParameterJdbcTemplate jdbcTemplate(DataSource dataSource) {
  return new NamedParameterJdbcTemplate(dataSource);
}
```

在这里，我们将NamedParameterJdbcOperations（NamedParameter-JdbcTemplate 所实现的接口）注入到 Repository 中，用它来替代 JdbcOperations。现在的 addSpitter() 方法如下所示：

{% code title="程序清单 10.9 使用 Spring JDBC 模板的命名参数功能" %}

```java
private static final String INSERT_SPITTER =
  "insert into Spitter " +
  "  (username, password, fullname, email, updateByEmail) " +
  "values " +
  "  (:username, :password, :fullname, :email, :updateByEmail)";

private void addSpitter(Spitter spitter) {
  Map<String, Object> paramMap = new HashMap<String, Object>();
  paramMap.put("username", spitter.getUsername());
  paramMap.put("password", spitter.getPassword());
  paramMap.put("fullname", spitter.getFullName());
  paramMap.put("email", spitter.getEmail());
  paramMap.put("updateByEmail", spitter.isUpdateByEmail());
  jdbcOperations.update(INSERT_SPITTER, paramMap);
}
```

{% endcode %}

这个版本的 addSpitter() 比前一版本的代码要长一些。这是因为命名参数是通过 java.util.Map 来进行绑定的。不过，每行代码都关注于往数据库中插入 Spitter 对象。这个方法的核心功能并不会被资源管理或异常处理这样的代码所充斥。