四、HikariCP源码分析之初始化分析一

原创

用户1422411

发布于 2022-06-25 17:51:39

6560

发布于 2022-06-25 17:51:39

文章被收录于专栏：HikariCP源码解析系列

欢迎访问我的博客，同步更新: 枫山别院

源代码版本2.4.5-SNAPSHOT

HikariDataSource的初始化

HikariDataSource是 HikariCP 开放给用户使用连接池的主要操作类。所以，我们创建一个 HikariCP 的连接池，其实就是构造一个HikariDataSource。

两个构造函数

它有两个构造函数：

第一个无参构造：

public HikariDataSource() {
   super();
   fastPathPool = null;
}

第二个有参构造:

public HikariDataSource(HikariConfig configuration) {
  configuration.validate();
  configuration.copyState(this);
  LOGGER.info("{} - Started.", configuration.getPoolName());
  pool = fastPathPool = new HikariPool(this);
}

两种初始化方式

既然有两个构造函数，那么就应该有两种初始化方式，对吧。

使用无参构造初始化

HikariDataSource dataSource = new HikariDataSource();
dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/test");
dataSource.setUsername("root");
dataSource.setPassword("123");
//设置数据库独有的属性
dataSource.addDataSourceProperty("cachePrepStmts", "true");
//从连接池获取连接
Connection connection = dataSource.getConnection();

使用有参构造初始化

HikariConfig config = new HikariConfig();
config.setJdbcUrl("jdbc:mysql://localhost:3306/test");
config.setUsername("root");
config.setPassword("123");
//设置数据库独有的属性
config.addDataSourceProperty("cachePrepStmts", "true");
//使用HikariConfig构造HikariDataSource
HikariDataSource dataSource = new HikariDataSource(config);
//从连接池获取连接
Connection connection = dataSource.getConnection();

这两种方式的区别就是，有参构造使用的是HikariConfig来设置参数的，有同学会问：既然HikariDataSource能直接设置参数，为什么还要用HikariConfig？这不是更麻烦吗？

其实 HikariCP 官方更推荐使用HikariConfig的方式，为什么呢？我们来具体分析下。

无参构造代码分析

我们先来分析第一种无参构造初始化的方式，代码只有两行：

super();
fastPathPool = null;

super();方法是调用了HikariDataSource父类的无参构造，它的父类是哪个？是HikariConfig，这就是为什么HikariDataSource也能直接设置参数的原因，它继承了HikariConfig。那么这个super();肯定就是HikariConfig的无参构造了，我们看看：

public HikariConfig() {
  //①
  dataSourceProperties = new Properties();
  healthCheckProperties = new Properties();

  minIdle = -1;
  maxPoolSize = -1;
  //MAX_LIFETIME=30分钟
  maxLifetime = MAX_LIFETIME;
  //CONNECTION_TIMEOUT=30 秒
  connectionTimeout = CONNECTION_TIMEOUT;
  //VALIDATION_TIMEOUT=5 秒
  validationTimeout = VALIDATION_TIMEOUT;
  //IDLE_TIMEOUT=10分钟
  idleTimeout = IDLE_TIMEOUT;

  isAutoCommit = true;
  isInitializationFailFast = true;
  //②
  String systemProp = System.getProperty("hikaricp.configurationFile");
  if (systemProp != null) {
     loadProperties(systemProp);
  }
}

此处的代码，看起来就是执行了一些参数的初始化，给这些参数赋予默认值。具体的默认值，我已经在注释中写出来了。

此处的代码有点意思，System.getProperty是一个获取系统属性的方法，从字面看，它要获取一个叫做hikaricp.configurationFile的属性值，然后加载它。那么hikaricp.configurationFile配置的是什么东西呢？其实，这个是一个Properties配置文件的路径，它这是要从这个路径加载配置文件对吧。那么，我们又知道了一种 HikariCP 的配置方式：写一个Properties配置文件，然后将文件路径配置到hikaricp.configurationFile系统属性，就可以了。

又如何配置系统属性呢？很简单的，在应用启动的时候，使用-Dhikaricp.configurationFile=xxxxx.properties就可以了吧。

至于loadProperties如何加载配置文件并set 到对应的配置中，这个没有什么特殊的设计，在这里不展开了，后面给大家分析下HikariConfig的几种初始化方式，大家也可以看下我的代码注释，非常详细。

构造函数的最后一句fastPathPool = null;，如果大家看了《HikariCP源码分析之获取连接流程一》那么你一定明白的。

有参构造代码分析

我们继续看一下有参构造的代码：

configuration.validate();
configuration.copyState(this);
LOGGER.info("{} - Started.", configuration.getPoolName());
pool = fastPathPool = new HikariPool(this);

第一句configuration.validate();，是验证配置的参数。为了避免文章过长，我们另起章节介绍，毕竟文章不是越长越好，技术文章太长没人看，现在是流行碎片化阅读。

第二句configuration.copyState(this);我们要详细介绍下，这个跟本节关系密切。

从字面来看，是复制状态之类的操作。不知道configuration.copyState(this);方法中的参数的this大家注意了没有，它代表的是HikariDataSource对吧，而configuration代表的是HikariConfig。我们大胆猜测一下：应该是把HikariConfig中的配置复制到HikariDataSource中。

对不对呢？进去看下copyState代码：

public void copyState(HikariConfig other) {
  for (Field field : HikariConfig.class.getDeclaredFields()) {
     if (!Modifier.isFinal(field.getModifiers())) {
        field.setAccessible(true);
        try {
           field.set(other, field.get(this));
        } catch (Exception e) {
           throw new RuntimeException("Failed to copy HikariConfig state: " + e.getMessage(), e);
        }
     }
  }
}

果然不出所料，这是一段反射代码，目的就是把HikariConfig中的值复制到this代表的HikariDataSource实例中。为什么可以直接反射复制？因为HikariDataSource继承了HikariConfig啊，这个大家没有忘记吧！具体复制逻辑我就不说了，如果有同学看不懂这段反射，请补习Java反射的内容，这是 Java 基础，不是框架的内容。

略过第三句记录日志，我们直接看第四句pool = fastPathPool = new HikariPool(this);。

为什么要pool = fastPathPool，请大家看《HikariCP源码分析之获取连接流程一》，你会明白的。我们直接看new HikariPool(this)，这是创建HikariPool，HikariPool是连接池的抽象，它提供了操作连接池的方法。

感觉已经够长了，换阵地，请看下一篇。

原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。

如有侵权，请联系 cloudcommunity@tencent.com 删除。

数据库