HikariCP源码阅读（一）基础概念及核心配置

程序猿阿越
3,565 阅读3分钟

前言

HikariCP是SpringBoot2默认的数据库连接池，号称最快的连接池。

一、基础概念

DataSource

DataSource继承了Wrapper和CommonDataSource接口。

  • Wrapper：当前DataSource如果是代理实现，提供获取目标实例的能力。unwrap获取目标实例，isWrapperFor判断能否获取指定Class的目标实例。
public interface Wrapper {
    <T> T unwrap(java.lang.Class<T> iface) throws java.sql.SQLException;
    boolean isWrapperFor(java.lang.Class<?> iface) throws java.sql.SQLException;
}
  • CommonDataSource：获取输出日志的Logger/PrintWriter，设置登录数据库超时时长。
public interface CommonDataSource {
    java.io.PrintWriter getLogWriter() throws SQLException;
    void setLogWriter(java.io.PrintWriter out) throws SQLException;
    void setLoginTimeout(int seconds) throws SQLException;
    int getLoginTimeout() throws SQLException;
    public Logger getParentLogger() throws SQLFeatureNotSupportedException;
}
  • DataSource：获取Connection。
public interface DataSource  extends CommonDataSource, Wrapper {
  Connection getConnection() throws SQLException;
  Connection getConnection(String username, String password)
    throws SQLException;
}

HikariConfig

HikariConfig保存了所有连接池配置，另外实现了HikariConfigMXBean接口，有些配置可以利用JMX运行时变更。在第二小节介绍核心配置。

HikariDataSource

操作HikariPool获取连接。可以看到HikariDataSource有两个HikariPool的成员变量。

  • fastPathPool：final修饰，构造时决定。如果使用无参构造为null，使用有参构造和pool一样。
  • pool：volatile修饰。无参构造不会设置pool，在getConnection时构造pool，有参构造和fastPathPool一样。

作者这样写的目的可能是因为，volatile修饰pool导致每次读pool都要从主存加载，每次写也要写回主存，性能不如没volatile修饰的fastPathPool。

public class HikariDataSource extends HikariConfig implements DataSource, Closeable {
   private final AtomicBoolean isShutdown = new AtomicBoolean();
   private final HikariPool fastPathPool;
   private volatile HikariPool pool;
   
   public HikariDataSource() {
      super();
      fastPathPool = null;
   }
   public HikariDataSource(HikariConfig configuration) {
      configuration.validate();
      configuration.copyStateTo(this);

      pool = fastPathPool = new HikariPool(this);

      this.seal();
   }
}

PoolBase

PoolBase是HikariPool的父类，主要负责操作实际的DataSource获取Connection，并设置Connection的一些属性。

abstract class PoolBase {
	// DriverDataSource
	private DataSource dataSource;
}

DriverDataSource

DriverDataSource实现了DataSource接口，实际操作java.sql.Driver获取Connection。

public final class DriverDataSource implements DataSource {
   private Driver driver;
}

HikariPool

This is the primary connection pool class that provides the basic pooling behavior for HikariCP.

主要的连接池类，为HikariCP提供基本的池化行为。

public final class HikariPool extends PoolBase implements HikariPoolMXBean, IBagStateListener {
   // 连接池状态
   public volatile int poolState;
   // 实现Callable，负责创建连接
   private final PoolEntryCreator poolEntryCreator = new PoolEntryCreator(null);
   private final PoolEntryCreator postFillPoolEntryCreator = new PoolEntryCreator("After adding ");
   // addConnectionExecutor的阻塞等待队列只读视图
   private final Collection<Runnable> addConnectionQueueReadOnlyView;
   // 创建连接的线程池
   private final ThreadPoolExecutor addConnectionExecutor;
   // 关闭连接的线程池
   private final ThreadPoolExecutor closeConnectionExecutor;
   // Hikari为连接池设计的一个并发类，类比LinkedBlockingQueue
   private final ConcurrentBag<PoolEntry> connectionBag;
   // 创建ProxyLeakTask工厂（ProxyLeakTask用于检测连接泄露）
   private final ProxyLeakTaskFactory leakTaskFactory;
   // 为连接池挂起和恢复封装的信号量
   private final SuspendResumeLock suspendResumeLock;
   // 执行HouseKeeper任务的线程池，HouseKeeper用于维持最小连接数
   private final ScheduledExecutorService houseKeepingExecutorService;
}

ConcurrentBag

ConcurrentBag是HikariCP为连接池设计的一个并发类。

public class ConcurrentBag<T extends IConcurrentBagEntry> implements AutoCloseable {
   // 保存所有元素
   private final CopyOnWriteArrayList<T> sharedList;
   // 是否开启ThreadLocal保存元素
   private final boolean weakThreadLocals;
   // 当前线程持有的元素
   private final ThreadLocal<List<Object>> threadList;
   // IBagStateListener（HikariPool）
   private final IBagStateListener listener;
   // 等待者数量
   private final AtomicInteger waiters;
   // 交接队列
   private final SynchronousQueue<T> handoffQueue;
   
   // 用于通知外部，ConcurrentBag需要添加元素了
   public interface IBagStateListener {
      // waiting表示需要添加几个元素
      void addBagItem(int waiting);
   }
   // ConcurrentBag中的元素
   public interface IConcurrentBagEntry {
      int STATE_NOT_IN_USE = 0;
      int STATE_IN_USE = 1;
      int STATE_REMOVED = -1;
      int STATE_RESERVED = -2;
      boolean compareAndSet(int expectState, int newState);
      void setState(int newState);
      int getState();
   }
}

PoolEntry

PoolEntry实际拥有Connection的实例，并且实现IConcurrentBagEntry接口，可以放入ConcurrentBag容器。

final class PoolEntry implements IConcurrentBagEntry {
   Connection connection;
   private final HikariPool hikariPool;
}

二、核心配置

HikariConfig的成员变量涵盖了所有Hikari连接池的配置。

public class HikariConfig implements HikariConfigMXBean {
   // 运行时可修改 HikariConfigMXBean
   // 从连接池获取连接的超时时间，默认30s
   private volatile long connectionTimeout;
   // 校验连接是否有效的超时时间，默认5s
   private volatile long validationTimeout;
   // 连接空闲时间，当最小连接数<最大连接数生效，默认10min
   private volatile long idleTimeout;
   // 连接泄露检测时长，默认0不开启，不能超过maxLifetime
   private volatile long leakDetectionThreshold;
   // 连接最大存活时间，默认30min，需要小于数据库wait_timeout，超过这个时间未使用的连接都会被关闭
   private volatile long maxLifetime;
   // 最大连接数 默认10
   private volatile int maxPoolSize;
   // 最小连接数 默认10
   private volatile int minIdle;

   // 运行时不可修改
   // 初始化检查与数据库连接是否ok的超时时间，默认1，为0代表不做初始化检查
   private long initializationFailTimeout;
   // 创建连接后，在放入连接池前，执行的sql
   private String connectionInitSql;
   // 校验连接是否可用的sql，如果为空使用ping，否则执行这个sql
   private String connectionTestQuery;
   // 是否自动提交，默认true
   private boolean isAutoCommit;
   // 是否只读，默认false
   private boolean isReadOnly;
   // 是否注册MBean，默认否，用于运行时修改连接池参数
   private boolean isRegisterMbeans;
   // 是否允许连接池挂起操作，默认否
   private boolean isAllowPoolSuspension;

总结

  • 掌握HikariCP类与类之间的关系。
  • 核心配置梳理。

后续

HikariCP contains many micro-optimizations that individually are barely measurable, but together combine as a boost to overall performance. Some of these optimizations are measured in fractions of a millisecond amortized over millions of invocations.

HikariCP包含许多微优化，这些优化几乎无法单独衡量，但结合起来可以提高整体性能。 这些优化中的一些优化以毫秒为单位的几百万分摊。

下一章学习HikariCP的ConcurrentBag（类比传统阻塞队列）和FastList（类比ArrayList）。

avatar
文章
阅读
粉丝