Spring JDBC 源码学习
DataSource
上一节在粗略地了解了 JdbcTemplate 提供的方法之后,下面先来对 DataSource 做一点了解。
Java 提供的 DataSource 定义
DataSource 是 Java 核心库提供的接口。位于 javax.sql package 下。
DataSource 接口可以被视作是一个提供物理 DB 实例连接(Connection) 的工厂,通过 DataSource 持有的各种属性(包括 DB Url, Username, Password 等)来获取一个连接(Connection) 。DataSource 接口有三种不同的实现方案:
- 最基本的实现——生产一个标准连接(Connection) 对象
- 连接池方案——生产会被自动添加到连接池的对象
- 分布式事物实现——生产一个可以支持分布式事物,并默认被添加到连接池的连接对象
包括两个对外提供连接(Connection) 对象的方法,
Connection getConnection() throws SQLException;
Connection getConnection(String username, String password) throws SQLException;
其父接口 CommonDataSource 提供设置/获取 LogWriter,登录 DB 超时时间和获取父 Logger 的方法。
Spring-JDBC 扩展的 DataSource 定义
在 Spring-jdbc 下,DataSources 最顶级的类是 AbstractDataSource ,对 DataSource 的所有父接口方法做了实现。但保留 getConnection() 方法由子类实现。
在 AbstractDriverBasedDataSource 中,定义了大量的参数,诸如 url, username 等,这些都被用来定位并定义与数据库实例的连接。
public abstract class AbstractDriverBasedDataSource extends AbstractDataSource {
@Nullable
private String url;
@Nullable
private String username;
@Nullable
private String password;
@Nullable
private String catalog;
@Nullable
private String schema;
@Nullable
// 可以看到此处有一个 Properties 类
private Properties connectionProperties;
// 省略若干方法
@Override
public Connection getConnection() throws SQLException {
// 调用内部方法 getConnectionFromDriver()
return getConnectionFromDriver(getUsername(), getPassword());
}
@Override
public Connection getConnection(String username, String password) throws SQLException {
// 调用内部方法 getConnectionFromDriver()
return getConnectionFromDriver(username, password);
}
// 定义了一个获取 Connection 的方法,由 getConnection() 方法调用,
// 此方法主要是将属性做了一个整合
// 具体获取 Connection 的逻辑仍然下放到子类实现 见 40 行
protected Connection getConnectionFromDriver(@Nullable String username, @Nullable String password) throws SQLException {
Properties mergedProps = new Properties();
Properties connProps = getConnectionProperties();
if (connProps != null) {
mergedProps.putAll(connProps);
}
if (username != null) {
mergedProps.setProperty("user", username);
}
if (password != null) {
mergedProps.setProperty("password", password);
}
// 获取 Connection 逻辑下放
Connection con = getConnectionFromDriver(mergedProps);
if (this.catalog != null) {
con.setCatalog(this.catalog);
}
if (this.schema != null) {
con.setSchema(this.schema);
}
return con;
}
// 该类中获取 Connection 的方法是抽象方法
protected abstract Connection getConnectionFromDriver(Properties props) throws SQLException;
}
整合方案为将除 url 外的所有参数整合在同一个 Properties 对象中 (其中,Properties 可以被认为是一个线程安全的 Hash Map) 。最终调用 Connection getConnectionFromDriver(Properties props)
获取连接。
AbstractDriverBasedDataSource 抽象类的两个子类 DriverManagerDataSource 和 SimpleDriverDataSource 都以不同方式获得了连接(Connection),但总结而言,获取连接(Connection) 的任务被委托给了 Driver 来实现。
// ----------------------------
// SimpleDriverDataSource 的实现
// ----------------------------
@Override
protected Connection getConnectionFromDriver(Properties props) throws SQLException {
Driver driver = getDriver();
String url = getUrl();
Assert.notNull(driver, "Driver must not be null");
if (logger.isDebugEnabled()) {
logger.debug("Creating new JDBC Driver Connection to [" + url + "]");
}
// 哈哈,重点在这... driver 在该类中被预先注入
return driver.connect(url, props);
}
// -----------------------------
// DriverManagerDataSource 的实现
// -----------------------------
@Override
protected Connection getConnectionFromDriver(Properties props) throws SQLException {
String url = getUrl();
Assert.state(url != null, "'url' not set");
if (logger.isDebugEnabled()) {
logger.debug("Creating new JDBC DriverManager Connection to [" + url + "]");
}
// 调了个内部函数
return getConnectionFromDriverManager(url, props);
}
protected Connection getConnectionFromDriverManager(String url, Properties props) throws SQLException {
// 委托给 DriverManager 类来获取连接
// DriverManager 的主要操作是遍历在该管理类中注册的 Driver
// 每个 Driver 实例都去尝试一下,能不能获得一个连接
// 第一次在某个 Driver 中拿到一个连接即返回连接 (Connection)
return DriverManager.getConnection(url, props);
}
简要的类图如下: