HikariConfig配置解析

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

源代码版本2.4.5-SNAPSHOT

使用HikariConfig初始化 HikariCP

在《HikariCP源码分析之初始化分析一》中,我们解析了 HikariCP 的两种初始化方式,其中提到了使用HikariConfig的方式:

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其实就是 HikariCP 的配置类,我们前面介绍过的HikariDataSource继承了HikariConfig,所以我们也可以使用HikariDataSource直接初始化 HikariCP,但是这种方式性能比用HikariConfig稍差。

重要的配置

我们今天分析下 HikariCP 中的配置,几乎所有的配置都在HikariConfig中,是HikariConfig的成员变量。我们看一下:

/* 可以在运行期通过JMX修改的属性 */

   //从连接池获取连接时最大等待时间, 单位毫秒, 默认值 30秒, 至少 250ms
   private volatile long connectionTimeout;
   //检测连接是否有效的超时时间,单位毫秒, 默认 5000ms, 最小 250ms, 不能大于connectionTimeout
   //
   private volatile long validationTimeout;
   //连接可以在池中的最大闲置时间, 单位毫秒, 至少 10s, 默认 10 分钟, 0 表示永不超时, 该配置不能大于maxLifetime
   private volatile long idleTimeout;
   //连接泄露检测的最大时间, 默认 0, 最低 2000毫秒; 也就是说, 连接从拿出连接池到还回连接池的总时间, 不能超出这个时间,超出的话就判定为泄露
   private volatile long leakDetectionThreshold;
   //连接最大存活时间, 单位毫秒, 最小允许值30000 ms, 默认30分钟, 推荐设置的比数据库的 wait_timeout 小几分钟
   private volatile long maxLifetime;
   //连接池中可以保留连接的最大数量, 比如: 100, 则连接池中的连接不能超过 100 个
   private volatile int maxPoolSize;
   //最小空闲连接数量, 默认 10 个, 也就是说, 连接池中最多可以保留 10 个空闲的连接, 多的会被关闭
   private volatile int minIdle;

   /* 在运行期不能修改的属性 */

   //该属性设置一个SQL语句, 从连接池获取连接时, 先执行改 sql, 验证连接是否可用, 例子: select 1
   //如果是使用了 JDBC 4 那么不建议配置这个选项, 因为JDBC 4 使用 ping 命令, 更加高效
   private String connectionTestQuery;
   //数据库驱动的dataSource类名, 与jdbcUrl, 必须二选一, 都配置的话, 优先使用该属性, 例子 : org.postgresql.ds.PGSimpleDataSource
   private String dataSourceClassName;
   private String dataSourceJndiName;
   //数据库驱动类, 与dataSourceClassName不共存, 如果配置了这个属性, 那么jdbcUrl不能为空, 例子: com.mysql.jdbc.Driver
   private String driverClassName;
   //与dataSourceClassName, 必须二选一, 都配置的话, 忽略该属性, 例子: jdbc:mysql://localhost:3306/simpsons
   private String jdbcUrl;
   //必选, 数据库连接密码
   private String password;
   //连接池名称, 默认自动生成, Hikari 将它一般用于记录日志和 JMX 中, 如果有多个 Hikari 连接池, 建议配置一个有意义的名字
   private String poolName;
   private String transactionIsolationName;
   //必选, 数据库连接用户名
   private String username;
   //自动提交事务, 默认值true
   private boolean isAutoCommit;
   //控制从池中获取的连接是否是只读模式, 需要数据库支持只读模式
   private boolean isReadOnly;
   //默认值true,是否快速失败,即在启动期间创建连接来验证关键参数是否有错误,如果不能建立连接,立即抛出错误,方便用户及时发现问题
   private boolean isInitializationFailFast;
   //
   private boolean isIsolateInternalQueries;
   //是否自动注册 JMX 相关的 bean, 用于运行时可以修改连接池设置
   private boolean isRegisterMbeans;
   //是否允许JMX 将连接池挂起
   private boolean isAllowPoolSuspension;
   //用户直接指定dataSource实例, 不使用 Hikari 创建的实例
   private DataSource dataSource;

上面不是所有的属性,一些不太重要的属性我们忽略掉。

HikariConfig的配置可以分为两部分:可以在运行期修改的,不可以在运行期修改的。

运行期可修改

属性名 含义 备注
connectionTimeout 从连接池获取连接时最大等待时间 默认值 30秒, 至少 250ms
validationTimeout 检测连接是否有效的超时时间 默认 5000ms, 最小 250ms, 不能大于connectionTimeout
idleTimeout 连接可以在池中的最大闲置时间 至少 10s, 默认 10 分钟, 0 表示永不超时, 该配置不能大于maxLifetime
leakDetectionThreshold 连接泄露检测的最大时间 默认 0表示不启用, 最低 2000毫秒
maxLifetime 连接最大存活时间 最小允许值30000 ms, 默认30分钟, 推荐设置的比数据库的 wait_timeout 小几分钟
maxPoolSize 连接池中可以保留连接的最大数量
minIdle 最小空闲连接数量 默认 10 个

所谓的运行期可以修改的属性,就是可以使用 JMX 直接修改,我们再《HikariCP源码分析之获取连接流程二》中提到了作者推荐的用法,大家可以看一下。

运行期不可修改

属性名 含义 备注
connectionTestQuery 验证连接是否可用的 sql 例子: select 1,如果是使用了 JDBC 4 那么不建议配置这个选项, 因为JDBC 4 使用 ping 命令, 更加高效
dataSourceClassName 数据库驱动的dataSource类名 与jdbcUrl, 必须二选一, 都配置的话, 优先使用该属性, 例子 : org.postgresql.ds.PGSimpleDataSource
driverClassName 数据库驱动类 与dataSourceClassName不共存, 如果配置了这个属性, 那么jdbcUrl不能为空, 例子: com.mysql.jdbc.Driver
jdbcUrl url 与dataSourceClassName, 必须二选一, 都配置的话, 忽略该属性, 例子: jdbc:mysql://localhost:3306/simpsons
password 数据库连接密码
username 数据库连接用户名
isRegisterMbeans 是否自动注册 JMX 相关的 bean 用于运行时可以修改连接池设置
isAllowPoolSuspension 是否允许JMX 将连接池挂起

值得一提的是,如果要用 JMX 修改运行时配置,则必须配置isRegisterMbeansisAllowPoolSuspension

其实比较重要的是运行时可以修改的那几个配置,只要搞明白了他们的含义,大家就可以按照自己的情况修改。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350