Spring Boot--Hikari连接池的配置方法

ゝ一纸荒年。 2023-09-29 17:14 17阅读 0赞

原文网址：[Spring Boot--Hikari连接池的配置方法\_IT利刃出鞘的博客-CSDN博客][Spring Boot--Hikari_IT_-CSDN]

## 简介 ##

**说明**

本文介绍Spring Boot的Hikari连接池的配置方法。

**官网网址**

SpringBoot官网（无解析）：[Common Application Properties][]

Hikari的github（有解析）：[https://github.com/brettwooldridge/HikariCP\#gear-configuration-knobs-baby][https_github.com_brettwooldridge_HikariCP_gear-configuration-knobs-baby]

## 配置概述 ##

在Spring Boot自动化配置中，对于数据源的配置可以分为两类：

**通用配置**

以spring.datasource.\*的形式存在，主要是配置一些常规内容。比如：数据库链接地址、用户名、密码等。这里就不做过多说明了，通常就这些配置：

spring:
      datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/test
        username: root
        password: 222333

**数据源连接池配置**

以spring.datasource.<数据源名称>.\*的形式存在，比如：Hikari的配置参数就是spring.datasource.hikari.\*形式。下面这个是我们最常用的几个配置项及对应说明：

spring:
      datasource:
        hikari:
      		connection-timeout: 10000
     		validation-timeout: 3000
     		idle-timeout: 60000
     		login-timeout: 5	
     		max-lifetime: 60000
      		maximum-pool-size: 10
      		minimum-idle: 5
      		read-only: false

## 配置示例 ##

下边是推荐使用的配置

## 配置详解 ##

### autoCommit ###

此属性控制从池返回的连接的默认自动提交行为。它是一个布尔值。 默认值：true

### connectionTimeout ###

此属性控制客户端（即您）等待来自池的连接的最大毫秒数。如果超过此时间而没有可用的连接，则会抛出SQLException。可接受的最低连接超时为250 ms。 默认值：30000（30秒）

### idleTimeout ###

此属性控制允许连接在池中保持空闲状态的最长时间。 仅当minimumIdle定义为小于时，此设置才适用maximumPoolSize。池达到连接后， 空闲连接将不会退出minimumIdle。连接是否以空闲状态退役，最大变化为+30秒，平均变化为+15秒。在此超时之前，连接永远不会因为闲置而退役。值必须比maxLifetime小。值为0表示永远不会从池中删除空闲连接。最小允许值为10000ms（10秒）。 默认值：600000（10分钟）

### maxLifetime ###

此属性控制池中连接的最大生存期。使用中的连接永远不会停止使用，只有在关闭连接后才将其删除。在逐个连接的基础上，应用较小的负衰减以避免池中的质量消灭。 我们强烈建议设置此值，它应该比任何数据库或基础结构施加的连接时间限制短几秒钟。 值0表示没有最大寿命（无限寿命），当然要遵守该idleTimeout设置。最小允许值为30000ms（30秒）。 默认值：1800000（30分钟）

### connectionTestQuery ###

如果您的驱动程序支持JDBC4，我们强烈建议不要设置此属性。这是针对不支持JDBC4的“旧版”驱动程序的Connection.isValid() API。这是将在从池中为您提供连接之前执行的查询，以验证与数据库的连接仍然有效。同样，尝试运行不带该属性的池，如果驱动程序不兼容JDBC4，HikariCP将记录错误。 默认值：无

### minimumIdle ###

此属性控制HikariCP尝试在池中维护的最小空闲连接数。如果空闲连接下降到该值以下，并且池中的总连接数少于maximumPoolSize，则HikariCP将尽最大努力快速而有效地添加其他连接。但是，为了获得最佳性能和对峰值需求的响应能力，我们建议不要设置此值，而应让HikariCP充当固定大小的连接池。 默认值：与maximumPoolSize相同

### maximumPoolSize ###

此属性控制允许池达到的最大大小，包括空闲和使用中的连接。基本上，此值将确定到数据库后端的最大实际连接数。合理的值最好由您的执行环境确定。当池达到此大小并且没有空闲连接可用时，对getConnection（）的调用将connectionTimeout在超时之前最多阻塞毫秒。请阅读有关池大小的信息。 默认值：10

### metricRegistry ###

此属性仅可通过编程配置或IoC容器使用。此属性允许您指定池将用于记录各种指标的Codahale / Dropwizard 的实例MetricRegistry。有关 详细信息，请参见Metrics Wiki页面。 默认值：无

### healthCheckRegistry ###

此属性仅可通过编程配置或IoC容器使用。此属性允许您指定池将用于报告当前健康信息的Codahale / Dropwizard 的实例HealthCheckRegistry。有关 详细信息，请参见运行状况检查 Wiki页面。 默认值：无

### poolName ###

该属性表示连接池的用户定义名称，主要出现在日志记录和JMX管理控制台中，以识别池和池配置。 默认值：自动生成

### 很少使用的配置 ###

**initializationFailTimeout**

此属性控制如果无法为初始连接成功播种池，则池是否将“快速失败”。任何正数都是尝试获取初始连接的毫秒数；在此期间，应用程序线程将被阻止。如果在此超时发生之前无法获取连接，则将引发异常。此超时被应用后的connectionTimeout 期。如果该值为零（0），则HikariCP将尝试获取并验证连接。如果获得连接，但验证失败，则将引发异常并且池不启动。但是，如果无法获得连接，则池将启动，但是以后获得连接的努力可能会失败。小于零的值将绕过任何初始连接尝试，并且池将在尝试在后台获取连接时立即启动。因此，以后获得连接的努力可能会失败。 默认值：1

**isolateInternalQueries**

此属性确定HikariCP是否在其自己的事务中隔离内部池查询，例如连接活动测试。由于这些通常是只读查询，因此几乎没有必要将它们封装在自己的事务中。此属性仅在autoCommit禁用时适用。 默认值：false

**allowPoolSuspension**

此属性控制是否可以通过JMX暂停和恢复池。这对于某些故障转移自动化方案很有用。当池被暂停，调用 getConnection()将不会超时，将一直保持到池恢复。 默认值：false

**readOnly**

此属性控制默认情况下从池获得的连接是否处于只读模式。请注意，某些数据库不支持只读模式的概念，而另一些数据库在将Connection设置为只读时提供查询优化。是否需要此属性在很大程度上取决于您的应用程序和数据库。 默认值：false

**registerMbeans**

此属性控制是否注册JMX管理Bean（“ MBean”）。 默认值：false

**catalog**

该属性设置默认目录为支持目录的概念数据库。如果未指定此属性，则使用JDBC驱动程序定义的默认目录。 默认值：驱动程序默认值

**connectionInitSql**

此属性设置一个SQL语句，该语句将在每次创建新连接后执行，然后再将其添加到池中。如果此SQL无效或引发异常，它将被视为连接失败，并且将遵循标准的重试逻辑。 默认值：无

**driverClassName**

HikariCP将尝试仅通过来通过DriverManager解析驱动程序jdbcUrl，但对于某些较旧的驱动程序，driverClassName也必须指定。除非获得明显的错误消息，表明未找到驱动程序，否则请忽略此属性。 默认值：无

**transactionIsolation**

此属性控制从池返回的连接的默认事务隔离级别。如果未指定此属性，则使用JDBC驱动程序定义的默认事务隔离级别。仅当您具有所有查询通用的特定隔离要求时，才使用此属性。此属性的值是从不断的名称Connection 类，如TRANSACTION\_READ\_COMMITTED，TRANSACTION\_REPEATABLE\_READ等 默认值：驱动程序默认

**validationTimeout**

此属性控制将测试连接的活动性的最长时间。此值必须小于connectionTimeout。可接受的最低验证超时为250毫秒。 默认值：5000

**leakDetectionThreshold**

此属性控制在记录表示可能的连接泄漏的消息之前，连接可以离开池的时间。值为0表示禁用泄漏检测。启用泄漏检测的最低可接受值为2000（2秒）。 默认值：0

**dataSource**

此属性仅可通过编程配置或IoC容器使用。通过此属性，您可以直接设置DataSource要由池包装的的实例，而不必让HikariCP通过反射来构造它。这在某些依赖项注入框架中可能很有用。指定此属性后，dataSourceClassName将忽略该属性和所有特定于DataSource的属性。 默认值：无

**schema**

该属性设置的默认模式为支持模式的概念数据库。如果未指定此属性，则使用JDBC驱动程序定义的默认模式。 默认值：驱动程序默认值

**threadFactory**

此属性仅可通过编程配置或IoC容器使用。此属性允许您设置的实例，该实例java.util.concurrent.ThreadFactory将用于创建池使用的所有线程。在某些只能通过ThreadFactory应用程序容器提供的线程创建线程的受限执行环境中，需要使用它。 默认值：无

**scheduledExecutor**

此属性仅可通过编程配置或IoC容器使用。此属性允许您设置的实例，该实例java.util.concurrent.ScheduledExecutorService将用于各种内部计划的任务。如果向HikariCP提供ScheduledThreadPoolExecutor 实例，则建议使用该实例setRemoveOnCancelPolicy(true)。 默认值：无

[Spring Boot--Hikari_IT_-CSDN]: https://knife.blog.csdn.net/article/details/126830576
[Common Application Properties]: https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.data-migration
[https_github.com_brettwooldridge_HikariCP_gear-configuration-knobs-baby]: https://github.com/brettwooldridge/HikariCP#gear-configuration-knobs-baby