1. 概述
本文，我们来分享 MyBatis 的数据源模块，对应 datasource 包。如下图所示：
在 《精尽 MyBatis 源码解析 —— 项目结构一览》 中，简单介绍了这个模块如下：
数据源是实际开发中常用的组件之一。现在开源的数据源都提供了比较丰富的功能，例如，连接池功能、检测连接状态等，选择性能优秀的数据源组件对于提升 ORM 框架乃至整个应用的性能都是非常重要的。
MyBatis 自身提供了相应的数据源实现，当然 MyBatis 也提供了与第三方数据源集成的接口，这些功能都位于数据源模块之中。
本文涉及的类如下图所示：
下面，我们就一起来看看具体的源码实现。
2. DataSourceFactory
org.apache.ibatis.datasource.DataSourceFactory ，javax.sql.DataSource 工厂接口。代码如下：
public interface DataSourceFactory {
|
2.1 UnpooledDataSourceFactory
org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory ，实现 DataSourceFactory 接口，非池化的 DataSourceFactory 实现类。
FROM 《MyBatis 文档 —— XML 映射配置文件》
UNPOOLED– 这个数据源的实现只是每次被请求时打开和关闭连接。虽然有点慢，但对于在数据库连接可用性方面没有太高要求的简单应用程序来说，是一个很好的选择。 不同的数据库在性能方面的表现也是不一样的，对于某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：
driver– 这是 JDBC 驱动的 Java 类的完全限定名（并不是 JDBC 驱动中可能包含的数据源类）。url– 这是数据库的 JDBC URL 地址。username– 登录数据库的用户名。password– 登录数据库的密码。defaultTransactionIsolationLevel– 默认的连接事务隔离级别。作为可选项，你也可以传递属性给数据库驱动。要这样做，属性的前缀为“driver.”，例如：
driver.encoding=UTF8这将通过
DriverManager.getConnection(url,driverProperties)方法传递值为UTF8的encoding属性给数据库驱动。
2.1.1 构造方法
// UnpooledDataSourceFactory.java
|
- 默认创建了 UnpooledDataSource 对象。
2.1.2 getDataSource
#getDataSource() 方法，返回 DataSource 对象。代码如下：
// UnpooledDataSourceFactory.java
|
2.1.3 setProperties
#setProperties(Properties properties) 方法，将 properties 的属性，初始化到 dataSource 中。代码如下：
// UnpooledDataSourceFactory.java
|
- 代码比较简单，胖友直接看下代码。
<1>处，调用#convertValue(MetaObject metaDataSource, String propertyName, String value)方法，将字符串转化成对应属性的类型。代码如下：
// UnpooledDataSourceFactory.java
|
2.2 PooledDataSourceFactory
org.apache.ibatis.datasource.pooled.PooledDataSourceFactory ，继承 UnpooledDataSourceFactory 类，池化的 DataSourceFactory 实现类。
FROM 《MyBatis 文档 —— XML 映射配置文件》
POOLED– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这是一种使得并发 Web 应用快速响应请求的流行处理方式。
除了上述提到 UNPOOLED 下的属性外，还有更多属性用来配置 POOLED 的数据源：
poolMaximumActiveConnections– 在任意时间可以存在的活动（也就是正在使用）连接数量，默认值：10poolMaximumIdleConnections– 任意时间可能存在的空闲连接数。poolMaximumCheckoutTime– 在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）poolTimeToWait– 这是一个底层设置，如果获取连接花费了相当长的时间，连接池会打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直安静的失败），默认值：20000 毫秒（即 20 秒）。poolMaximumLocalBadConnectionTolerance– 这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程. 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过poolMaximumIdleConnections与poolMaximumLocalBadConnectionTolerance之和。 默认值：3 (新增于 3.4.5)poolPingQuery– 发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动失败时带有一个恰当的错误消息。poolPingEnabled– 是否启用侦测查询。若开启，需要设置poolPingQuery属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false。poolPingConnectionsNotUsedFor– 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。
- PooledDataSource 比 UnpooledDataSource 的配置项多很多。
代码如下：
// PooledDataSourceFactory.java
|
- 默认创建了 PooledDataSource 对象。
其它方法，在父类中 UnpooledDataSourceFactory 中已经实现。所以，真正的池化逻辑，在 PooledDataSource 对象中。
2.3 JndiDataSourceFactory
org.apache.ibatis.datasource.jndi.JndiDataSourceFactory ，实现 DataSourceFactory 接口，基于 JNDI 的 DataSourceFactory 实现类。
FROM 《MyBatis 文档 —— XML 映射配置文件》
JNDI – 这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。这种数据源配置只需要两个属性：
initial_context– 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么 data_source 属性将会直接从 InitialContext 中寻找。data_source– 这是引用数据源实例位置的上下文的路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。和其他数据源配置类似，可以通过添加前缀“env.”直接把属性传递给初始上下文。比如：
env.encoding=UTF8这就会在初始上下文（InitialContext）实例化时往它的构造方法传递值为
UTF8的encoding属性。
2.3.1 构造方法
// JndiDataSourceFactory.java
|
- 不同于 UnpooledDataSourceFactory 和 PooledDataSourceFactory ，
dataSource不在构造方法中创建，而是在#setProperties(Properties properties)中。
2.3.2 getDataSource
#getDataSource() 方法，返回 DataSource 对象。代码如下：
// JndiDataSourceFactory.java
|
2.3.3 setProperties
#setProperties(Properties properties) 方法，从上下文中，获得 DataSource 对象。代码如下：
// JndiDataSourceFactory.java
|
- 目前已经很少使用 JNDI 功能了，所以胖友简单了解下就好。
-
<1>处，调用#getEnvProperties(Properties allProps)方法，获得系统 Properties 对象。代码如下：// JndiDataSourceFactory.java
private static Properties getEnvProperties(Properties allProps) {
final String PREFIX = ENV_PREFIX;
Properties contextProperties = null;
for (Entry<Object, Object> entry : allProps.entrySet()) {
String key = (String) entry.getKey();
String value = (String) entry.getValue();
if (key.startsWith(PREFIX)) {
if (contextProperties == null) {
contextProperties = new Properties();
}
contextProperties.put(key.substring(PREFIX.length()), value);
}
}
return contextProperties;
}
3. DataSource
javax.sql.DataSource 是个神奇的接口，在其上可以衍生出数据连接池、分库分表、读写分离等等功能。
如果你对 DataSource 如何实现分库分表的功能，可以看看 《Sharding-JDBC 源码分析 —— JDBC实现与读写分离》 。
3.1 UnpooledDataSource
org.apache.ibatis.datasource.unpooled.UnpooledDataSource ，实现 DataSource 接口，非池化的 DataSource 对象。
3.1.1 构造方法
// UnpooledDataSource.java
|
- 比较简单，就是属性的赋值。
3.1.2 getConnection
#getConnection(...) 方法，获得 Connection 连接。代码如下：
// UnpooledDataSource.java
|
-
都是调用
#doGetConnection(String username, String password)方法，获取 Connection 连接。代码如下：// UnpooledDataSource.java
private Connection doGetConnection(String username, String password) throws SQLException {
// 创建 Properties 对象
Properties props = new Properties();
// 设置 driverProperties 到 props 中
if (driverProperties != null) {
props.putAll(driverProperties);
}
// 设置 user 和 password 到 props 中
if (username != null) {
props.setProperty("user", username);
}
if (password != null) {
props.setProperty("password", password);
}
// 执行获得 Connection 连接
return doGetConnection(props);
}
private Connection doGetConnection(Properties properties) throws SQLException {
// <1> 初始化 Driver
initializeDriver();
// <2> 获得 Connection 对象
Connection connection = DriverManager.getConnection(url, properties);
// <3> 配置 Connection 对象
configureConnection(connection);
return connection;
}<1>处，调用#initializeDriver()方法，初始化 Driver 。详细解析，见 「3.1.2.1 initializeDriver」 。<2>处，调用java.sql.DriverManager#getConnection(String url, Properties info)方法，获得 Connection 对象。<3>处，调用#configureConnection(Connection conn)方法，配置 Connection 对象。详细解析，见 「3.1.2.2 configureConnection」 。
3.1.2.1 initializeDriver
#initializeDriver() 方法，初始化 Driver 。代码如下：
// UnpooledDataSource.java
|
- 总体逻辑比较简单，判断
registeredDrivers是否已经存在该driver？若不存在，进行初始化。 <1>处，synchronized锁的粒度太大，可以减小到基于registeredDrivers来同步，并且很多时候，不需要加锁。<2>处，获得driver类，实际上，就是我们常见的"Class.forName("com.mysql.jdbc.Driver")"。-
<3>处，创建 Driver 对象，并注册到 DriverManager 中，以及添加到registeredDrivers中。为什么此处会有使用 DriverProxy 呢？DriverProxy 的代码如下：// UnpooledDataSource.java 的内部私有静态类
private static class DriverProxy implements Driver {
private Driver driver;
DriverProxy(Driver d) {
this.driver = d;
}
- 因为
<4>处，使用 MyBatis 自定义的 Logger 对象。 - 其他方法，实际就是直接调用
driver对应的方法。
- 因为
3.1.2.2 configureConnection
#configureConnection(Connection conn) 方法，配置 Connection 对象。代码如下：
// UnpooledDataSource.java
|
3.1.3 其它方法
UnpooledDataSource 还实现了 DataSource 的其它方法，感兴趣的胖友，可以自己看。实际上，不看也行。哈哈哈哈。
3.2 PooledDataSource
org.apache.ibatis.datasource.pooled.PooledDataSource ，实现 DataSource 接口，池化的 DataSource 实现类。
FROM PooledDataSource 类上的注释
This is a simple, synchronous, thread-safe database connection pool.
- 实际场景下，我们基本不用 MyBatis 自带的数据库连接池的实现。所以，本文更多的目的，是让胖友们对数据库连接池的实现，有个大体的理解。
3.2.1 构造方法
// PooledDataSource.java
|
- 属性都比较简单，看起来虽然多，主要是可选的配置属性。我们就看几个重点的。
dataSource属性，UnpooledDataSource 对象。这样，就能重用 UnpooledDataSource 的代码了。说白了，获取真正连接的逻辑，还是在 UnpooledDataSource 中实现。-
expectedConnectionTypeCode属性，调用#assembleConnectionTypeCode(ClassLoader driverClassLoader, String driver, String url, Properties driverProperties)方法，计算expectedConnectionTypeCode的值。代码如下：// PooledDataSource.java
private int assembleConnectionTypeCode(String url, String username, String password) {
return ("" + url + username + password).hashCode();
}
state属性，PoolState 对象，记录池化的状态。这是一个非常重要的类，下文也会花一定的篇幅，详细解析。
3.2.2 getConnection
#getConnection(...) 方法，获得 Connection 连接。代码如下：
// PooledDataSource.java
|
- 调用
#popConnection(String username, String password)方法，获取org.apache.ibatis.datasource.pooled.PooledConnection对象，这是一个池化的连接。非常关键的一个方法，详细解析，见 「3.2.2.1 popConnection」 。 - 调用
PooledConnection#getProxyConnection()方法，返回代理的 Connection 对象。这样，每次对数据库的操作，才能被 PooledConnection 的 「5.2 invoke」 代理拦截。
3.2.2.1 popConnection
#popConnection(String username, String password) 方法，获取 PooledConnection 对象。
整体流程如下图：
FROM 《MyBatis 技术内幕》
代码如下：
// PooledDataSource.java |