控制数据库连接

使用 DataSource

Spring 通过 DataSource 获取与数据库的连接。DataSource 是 JDBC 规范的一部分,是一个通用的连接工厂。它允许容器或框架将连接池和事务管理问题隐藏在应用程序代码之外。作为开发人员,您无需了解如何连接到数据库的详细信息。这是设置数据源的管理员的责任。您很可能在开发和测试代码时同时担任这两个角色,但您不一定需要知道生产数据源是如何配置的。

当您使用 Spring 的 JDBC 层时,您可以从 JNDI 获取数据源,也可以使用第三方提供的连接池实现配置自己的数据源。传统的选项是 Apache Commons DBCP 和 C3P0,它们使用 bean 样式的 DataSource 类;对于现代 JDBC 连接池,请考虑使用 HikariCP 及其构建器样式的 API。

您应该仅将 DriverManagerDataSourceSimpleDriverDataSource 类(如 Spring 发行版中所包含的)用于测试目的!这些变体不提供池,并且在进行多个连接请求时性能很差。

下一节使用 Spring 的 DriverManagerDataSource 实现。稍后将介绍其他几种 DataSource 变体。

要配置 DriverManagerDataSource

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

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

  3. 提供一个在 JDBC 驱动程序之间不同的 URL。(有关正确的值,请参阅驱动程序的文档。)

  4. 提供一个用户名和密码以连接到数据库。

以下示例展示了如何在 Java 中配置 DriverManagerDataSource

  • Java

  • Kotlin

DriverManagerDataSource dataSource = new DriverManagerDataSource();
dataSource.setDriverClassName("org.hsqldb.jdbcDriver");
dataSource.setUrl("jdbc:hsqldb:hsql://127.0.0.1:");
dataSource.setUsername("sa");
dataSource.setPassword("");
val dataSource = DriverManagerDataSource().apply {
	setDriverClassName("org.hsqldb.jdbcDriver")
	url = "jdbc:hsqldb:hsql://127.0.0.1:"
	username = "sa"
	password = ""
}

以下示例展示了相应的 XML 配置

<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 配置

<bean id="dataSource" class="org.apache.commons.dbcp.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 配置

<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 绑定到线程的 JDBC Connection,但也支持 JtaTransactionManagerJpaTransactionManager

请注意,JdbcTemplate 意味着使用 DataSourceUtils 连接访问,并在每次 JDBC 操作后使用它,隐式地参与正在进行的事务。

实现 SmartDataSource

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

扩展 AbstractDataSource

AbstractDataSource 是 Spring 的 DataSource 实现的抽象基类。它实现了所有 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 管理的事务。通常,最好使用资源管理的更高层抽象(如 JdbcTemplateDataSourceUtils)来编写自己的新代码。

有关更多详细信息,请参阅 TransactionAwareDataSourceProxy javadoc。

使用 DataSourceTransactionManager / JdbcTransactionManager

DataSourceTransactionManager 类是针对单个 JDBC DataSourcePlatformTransactionManager 实现。它将来自指定 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 Connection 的只读标志在每个事务的开始和结束时切换的开销(这可能很昂贵,具体取决于 JDBC 驱动程序)。

从 5.3 版本开始,Spring 提供了一个扩展的 JdbcTransactionManager 变体,它在提交/回滚时添加了异常转换功能(与 JdbcTemplate 一致)。DataSourceTransactionManager 仅抛出 TransactionSystemException(类似于 JTA),而 JdbcTransactionManager 会将数据库锁定失败等错误转换为相应的 DataAccessException 子类。请注意,应用程序代码需要为这些异常做好准备,而不仅仅是期望 TransactionSystemException。在需要这种情况下,JdbcTransactionManager 是推荐的选择。

在异常行为方面,JdbcTransactionManager 大致等同于 JpaTransactionManager 以及 R2dbcTransactionManager,它们可以作为彼此的直接伴侣/替代品。另一方面,DataSourceTransactionManager 等同于 JtaTransactionManager,可以作为其直接替代品。