控制数据库连接

使用 DataSource

Spring 通过 DataSource 获取数据库连接。DataSource 是 JDBC 规范的一部分，是一个通用的连接工厂。它允许容器或框架向应用代码隐藏连接池和事务管理问题。作为开发者，你无需知道如何连接数据库的详细信息。这是设置数据源的管理员的责任。在你开发和测试代码时，你很可能同时扮演这两种角色，但你不一定非要知道生产环境中的数据源是如何配置的。

当你使用 Spring 的 JDBC 层时，你可以从 JNDI 获取数据源，或者使用第三方提供的连接池实现来配置你自己的数据源。传统的选择是 Apache Commons DBCP 和 C3P0，它们提供 Bean 风格的 DataSource 类；对于现代 JDBC 连接池，可以考虑使用 HikariCP，它提供构建器风格的 API。

你应该仅将 Spring 发行版中包含的 DriverManagerDataSource 和 SimpleDriverDataSource 类用于测试目的！这些变体不提供连接池，并且在多次请求连接时性能很差。

以下部分使用 Spring 的 DriverManagerDataSource 实现。其他几种 DataSource 变体将在后面介绍。

配置 DriverManagerDataSource

  1. 使用 DriverManagerDataSource 获取连接，就像你通常获取 JDBC 连接一样。

  2. 指定 JDBC 驱动程序的完全限定类名，以便 DriverManager 可以加载驱动程序类。

  3. 提供一个在不同 JDBC 驱动程序之间变化的 URL。（请查阅你的驱动程序文档以获取正确的值。）

  4. 提供连接数据库的用户名和密码。

以下示例展示了如何配置 DriverManagerDataSource

  • Java

  • Kotlin

  • Xml

@Bean
DriverManagerDataSource dataSource() {
	DriverManagerDataSource dataSource = new DriverManagerDataSource();
	dataSource.setDriverClassName("org.hsqldb.jdbcDriver");
	dataSource.setUrl("jdbc:hsqldb:hsql://localhost:");
	dataSource.setUsername("sa");
	dataSource.setPassword("");
	return dataSource;
}
@Bean
fun dataSource() = DriverManagerDataSource().apply {
	setDriverClassName("org.hsqldb.jdbcDriver")
	url = "jdbc:hsqldb:hsql://localhost:"
	username = "sa"
	password = ""
}
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
	<property name="driverClassName" value="${jdbc.driverClassName}"/>
	<property name="url" value="${jdbc.url}"/>
	<property name="username" value="${jdbc.username}"/>
	<property name="password" value="${jdbc.password}"/>
</bean>

<context:property-placeholder location="jdbc.properties"/>

接下来两个示例展示了 DBCP 和 C3P0 的基本连接和配置。要了解有助于控制连接池功能的更多选项，请参阅相应连接池实现的产品文档。

以下示例展示了 DBCP 配置

  • Java

  • Kotlin

  • Xml

@Bean(destroyMethod = "close")
BasicDataSource dataSource() {
	BasicDataSource dataSource = new BasicDataSource();
	dataSource.setDriverClassName("org.hsqldb.jdbcDriver");
	dataSource.setUrl("jdbc:hsqldb:hsql://localhost:");
	dataSource.setUsername("sa");
	dataSource.setPassword("");
	return dataSource;
}
@Bean(destroyMethod = "close")
fun dataSource() = BasicDataSource().apply {
	driverClassName = "org.hsqldb.jdbcDriver"
	url = "jdbc:hsqldb:hsql://localhost:"
	username = "sa"
	password = ""
}
<bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource" destroy-method="close">
	<property name="driverClassName" value="${jdbc.driverClassName}"/>
	<property name="url" value="${jdbc.url}"/>
	<property name="username" value="${jdbc.username}"/>
	<property name="password" value="${jdbc.password}"/>
</bean>

<context:property-placeholder location="jdbc.properties"/>

以下示例展示了 C3P0 配置

  • Java

  • Kotlin

  • Xml

@Bean(destroyMethod = "close")
ComboPooledDataSource dataSource() throws PropertyVetoException {
	ComboPooledDataSource dataSource = new ComboPooledDataSource();
	dataSource.setDriverClass("org.hsqldb.jdbcDriver");
	dataSource.setJdbcUrl("jdbc:hsqldb:hsql://localhost:");
	dataSource.setUser("sa");
	dataSource.setPassword("");
	return dataSource;
}
@Bean(destroyMethod = "close")
fun dataSource() = ComboPooledDataSource().apply {
	driverClass = "org.hsqldb.jdbcDriver"
	jdbcUrl = "jdbc:hsqldb:hsql://localhost:"
	user = "sa"
	password = ""
}
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource" destroy-method="close">
	<property name="driverClass" value="${jdbc.driverClassName}"/>
	<property name="jdbcUrl" value="${jdbc.url}"/>
	<property name="user" value="${jdbc.username}"/>
	<property name="password" value="${jdbc.password}"/>
</bean>

<context:property-placeholder location="jdbc.properties"/>

使用 DataSourceUtils

DataSourceUtils 类是一个方便且功能强大的辅助类，它提供 static 方法来从 JNDI 获取连接，并在需要时关闭连接。它支持与 DataSourceTransactionManager 以及 JtaTransactionManager 和 JpaTransactionManager 配合使用的线程绑定 JDBC Connection。

请注意，JdbcTemplate 隐含地使用 DataSourceUtils 进行连接访问，在每个 JDBC 操作的背后都使用它，从而隐式地参与正在进行的事务。

实现 SmartDataSource

SmartDataSource 接口应由能够提供关系数据库连接的类实现。它扩展了 DataSource 接口，允许使用它的类查询在给定操作后是否应该关闭连接。当你知道需要重用连接时，这种用法是高效的。

扩展 AbstractDataSource

AbstractDataSource 是 Spring 的 DataSource 实现的 abstract 基类。它实现了所有 DataSource 实现共有的代码。如果你编写自己的 DataSource 实现，应该扩展 AbstractDataSource 类。

使用 SingleConnectionDataSource

SingleConnectionDataSource 类是 SmartDataSource 接口的一个实现，它包装了一个单一的 Connection，该连接在使用后不会关闭。这不具备多线程能力。

如果任何客户端代码基于连接池的假设调用 close（例如在使用持久化工具时），你应该将 suppressClose 属性设置为 true。此设置会返回一个阻止关闭的代理，该代理包装了物理连接。请注意，你将无法再将其转换为原生的 Oracle Connection 或类似对象。

SingleConnectionDataSource 主要是一个测试类。它通常与简单的 JNDI 环境结合使用，便于在应用服务器外部测试代码。与 DriverManagerDataSource 不同，它始终重用同一个连接，避免了过多物理连接的创建。

使用 DriverManagerDataSource

DriverManagerDataSource 类是标准 DataSource 接口的一个实现，它通过 Bean 属性配置一个普通的 JDBC 驱动程序，并且每次都返回一个新的 Connection。

此实现对于在 Jakarta EE 容器外部的测试和独立环境非常有用，既可以作为 Spring IoC 容器中的 DataSource Bean 使用，也可以与简单的 JNDI 环境结合使用。假定使用连接池的 Connection.close() 调用会关闭连接，因此任何感知 DataSource 的持久化代码都应该可以工作。然而，使用 JavaBean 风格的连接池（例如 commons-dbcp）非常容易，即使在测试环境中也是如此，因此几乎总是优先使用此类连接池而不是 DriverManagerDataSource。

使用 TransactionAwareDataSourceProxy

TransactionAwareDataSourceProxy 是目标 DataSource 的代理。该代理包装了目标 DataSource，以增加对 Spring 管理事务的感知。在这方面，它类似于 Jakarta EE 服务器提供的事务性 JNDI DataSource。

很少需要使用此类，除非必须调用现有代码并传入标准的 JDBC DataSource 接口实现。在这种情况下，你仍然可以使该代码可用，同时使该代码参与 Spring 管理的事务。通常更倾向于使用更高级的资源管理抽象来编写新的代码，例如 JdbcTemplate 或 DataSourceUtils。

有关更多详细信息，请参阅 TransactionAwareDataSourceProxy 的 Javadoc。

使用 DataSourceTransactionManager / JdbcTransactionManager

DataSourceTransactionManager 类是用于单个 JDBC DataSource 的 PlatformTransactionManager 实现。它将指定 DataSource 的 JDBC Connection 绑定到当前执行的线程，潜在地允许每个 DataSource 有一个线程绑定的 Connection。

应用代码需要通过 DataSourceUtils.getConnection(DataSource) 而不是 Java EE 标准的 DataSource.getConnection 来获取 JDBC Connection。它抛出未检查的 org.springframework.dao 异常，而不是检查的 SQLExceptions。所有框架类（例如 JdbcTemplate）都隐式地使用此策略。如果不与事务管理器一起使用，查找策略的行为与 DataSource.getConnection 完全相同，因此可以在任何情况下使用。

DataSourceTransactionManager 类支持保存点 (PROPAGATION_NESTED)、自定义隔离级别和作为相应 JDBC 语句查询超时应用的超时。为了支持后者，应用代码必须使用 JdbcTemplate 或为每个创建的语句调用 DataSourceUtils.applyTransactionTimeout(..) 方法。

在单资源情况下，你可以使用 DataSourceTransactionManager 代替 JtaTransactionManager，因为它不需要容器支持 JTA 事务协调器。只要你坚持使用所需的连接查找模式，在这些事务管理器之间切换只是配置问题。请注意，JTA 不支持保存点或自定义隔离级别，并且有不同的超时机制，但在 JDBC 资源和 JDBC 提交/回滚管理方面表现出类似的行为。

对于 JTA 风格的实际资源连接的延迟检索，Spring 为目标连接池提供了相应的 DataSource 代理类：请参阅 LazyConnectionDataSourceProxy。这对于潜在的空事务且没有实际语句执行的情况（在这种情况下永远不会获取实际资源）特别有用，也适用于路由 DataSource 前，这意味着要考虑事务同步的只读标志和/或隔离级别（例如，IsolationLevelDataSourceRouter）。

LazyConnectionDataSourceProxy 还为在只读事务期间使用的只读连接池提供了特殊支持，避免了从主连接池获取 JDBC 连接时在每个事务开始和结束时切换连接只读标志的开销（这可能取决于 JDBC 驱动程序而成本较高）。

自 5.3 版本起，Spring 提供了一个扩展的 JdbcTransactionManager 变体，它在提交/回滚时增加了异常转换能力（与 JdbcTemplate 对齐）。DataSourceTransactionManager 只会抛出 TransactionSystemException（类似于 JTA），而 JdbcTransactionManager 会将数据库锁定失败等转换为相应的 DataAccessException 子类。请注意，应用代码需要为这些异常做好准备，而不仅仅是预期 TransactionSystemException。在这种情况下，JdbcTransactionManager 是推荐的选择。

在异常行为方面，JdbcTransactionManager 大致等同于 JpaTransactionManager 和 R2dbcTransactionManager，它们可以作为彼此的直接配套或替代品。而 DataSourceTransactionManager 则等同于 JtaTransactionManager，并可以在该处作为直接替代品。