前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >六、HikariConfig的配置解析

六、HikariConfig的配置解析

原创
作者头像
用户1422411
发布2022-06-25 17:53:42
2.8K0
发布2022-06-25 17:53:42
举报
文章被收录于专栏:HikariCP源码解析系列

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

源代码版本2.4.5-SNAPSHOT

使用HikariConfig初始化 HikariCP

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

代码语言:java
复制
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的成员变量。我们看一下:

代码语言:java
复制
/* 可以在运行期通过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

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

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

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

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

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

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 使用HikariConfig初始化 HikariCP
  • 重要的配置
  • 运行期可修改
  • 运行期不可修改
相关产品与服务
数据库
云数据库为企业提供了完善的关系型数据库、非关系型数据库、分析型数据库和数据库生态工具。您可以通过产品选择和组合搭建,轻松实现高可靠、高可用性、高性能等数据库需求。云数据库服务也可大幅减少您的运维工作量,更专注于业务发展,让企业一站式享受数据上云及分布式架构的技术红利!
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档