HikariCP连接池-springboot1.0x~2.0x

HikariCP连接池

springboot1.0x

SpringBoot2默认的数据库连接池已经是HikariCP，所以不需要再配置，SpringBoot2版本之前的则需要配置

1.添加maven依赖

<!-- JDBC连接数据库，因为要用HikariCP，所以需要将SpringBoot中的tomcat-jdbc排除 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.apache.tomcat</groupId>
            <artifactId>tomcat-jdbc</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<!-- HikariCP 连接池依赖，从父依赖获取额版本 -->
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <!-- <scope>runtime</scope> -->
</dependency> 

2.配置数据源

# 数据源
spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/dbtrial?useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.jdbc.Driver
    hikari:
      # 连接池最大连接数
      maximum-pool-size: 12
      # 空闲时保持最小连接数
      minimum-idle: 5
      # 空闲连接存活时间
      idle-timeout: 300000
      # 连接超时时间
      connection-timeout: 20000
      # 测试sql
      connection-test-query: select 1

3.创建配置类

import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
import javax.sql.DataSource;
 
 
/**
 * HikariCP连接池配置
 */
@Configuration
public class DataSourceConfig {
 
    @Value("${spring.datasource.url}")
    private String dataSourceUrl;
 
    @Value("${spring.datasource.username}")
    private String user;
 
    @Value("${spring.datasource.password}")
    private String password;
 
    @Bean
    public DataSource dataSource() {
        HikariConfig config = new HikariConfig();
        /** 数据源 */
        config.setJdbcUrl(dataSourceUrl); 
        /** 用户名 */
        config.setUsername(user); 
        /** 密码 */
        config.setPassword(password); 
        /** 是否自定义配置，为true时下面两个参数才生效 */
        config.addDataSourceProperty("cachePrepStmts", "true");
        /** 连接池大小默认25，官方推荐250-500 */
        config.addDataSourceProperty("prepStmtCacheSize", "250"); 
        /** 单条语句最大长度默认256，官方推荐2048 */
        config.addDataSourceProperty("prepStmtCacheSqlLimit", "2048");
        /** 新版本MySQL支持服务器端准备，开启能够得到显著性能提升 */
        config.addDataSourceProperty("useServerPrepStmts", "true"); 
        config.addDataSourceProperty("useLocalSessionState", "true");
        config.addDataSourceProperty("useLocalTransactionState", "true");
        config.addDataSourceProperty("rewriteBatchedStatements", "true");
        config.addDataSourceProperty("cacheResultSetMetadata", "true");
        config.addDataSourceProperty("cacheServerConfiguration", "true");
        config.addDataSourceProperty("elideSetAutoCommits", "true");
        config.addDataSourceProperty("maintainTimeStats", "false");
 
        HikariDataSource ds = new HikariDataSource(config);
        return ds;
    }
}

springboot2.0 及更高版本

在使用HikariCP之前，我们需要确保已经解决了HikariCP依赖关系。如果我们使用Maven，我们可以使用以下依赖项

<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>3.1.0</version>
</dependency>

如果我们使用的是Spring Boot 2.0或者之后的版本，我们不需要去单独在pom.xml文件中引入HikariCP依赖。因为默认情况下spring-boot-starter-jdbc 或者 spring-boot-starter-data-jpa 会依赖进来。这意味着我们是否也在使用依赖项

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
    <version>2.0.3.RELEASE</version>
</dependency> 

或者

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
    <version>2.0.3.RELEASE</version>
</dependency> 

HikariCP配置

对于Hikari连接池配置，我们通过使用spring.datasource.type并在application.properties文件中为其分配连接池实现的完全限定名称来启用它，如下所示。

spring.datasource.type = com.zaxxer.hikari.HikariDataSource 

如果我们使用的是Spring Boot 2.0及以上版本，Spring Boot会HikariDataSource默认选择，我们不需要配置上面的行。
现在要配置Hikari特定的连接池设置，Spring Boot提供了spring.datasource.hikari.*在application.properties文件中使用的前缀。我们将在这里讨论一些常用的配置。

1. connectionTimeout
   connectionTimeout是客户端等待连接池连接的最大毫秒数。我们需要将其配置如下。

 spring.datasource.hikari.connection-timeout=20000 

2. minimumIdle
   minimumIdle是HikariCP在连接池中维护的最小空闲连接数。它配置如下。

 spring.datasource.hikari.minimum-idle=5 

3. maximumPoolSize
   maximumPoolSize配置最大池大小。它配置如下。

 spring.datasource.hikari.maximum-pool-size=12 

4. idleTimeout
   idleTimeout是允许连接在连接池中空闲的最长时间（以毫秒为单位）。它配置如下。

 spring.datasource.hikari.idle-timeout=300000 

5. maxLifetime
   maxLifetime是池中连接关闭后的最长生命周期（以毫秒为单位）。它配置如下。

 spring.datasource.hikari.max-lifetime=1200000 

使用中的连接永远不会退役，只有当它关闭时才会在最长生命周期后删除。

6. autoCommit
   autoCommit配置从池返回的连接的默认自动提交行为。默认值为true。

 spring.datasource.hikari.auto-commit=true 

HikariCP配置示例

• application.properties

spring.datasource.url=jdbc:mysql://localhost:3306/concretepage
spring.datasource.username=root
spring.datasource.password=cp

#Spring Boot 2.0 includes HikariDataSource by default
#spring.datasource.type = com.zaxxer.hikari.HikariDataSource

spring.datasource.hikari.connection-timeout=20000
spring.datasource.hikari.minimum-idle=5
spring.datasource.hikari.maximum-pool-size=12
spring.datasource.hikari.idle-timeout=300000
spring.datasource.hikari.max-lifetime=1200000
spring.datasource.hikari.auto-commit=true

spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQLDialect
spring.jpa.properties.hibernate.id.new_generator_mappings=false
spring.jpa.properties.hibernate.format_sql=true 

• yml

# 数据源
spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/dbtrial?useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.jdbc.Driver
    hikari:
      # 连接池最大连接数
      maximum-pool-size: 12
      # 空闲时保持最小连接数
      minimum-idle: 5
      # 空闲连接存活时间
      idle-timeout: 300000
      # 连接超时时间
      connection-timeout: 20000
      # 测试sql
      connection-test-query: select 1