SpringBoot默认数据源 HikariDataSource使用和配置及DataSource自动装配、手动装配

jupiter
2024-06-16 / 0 评论 / 12 阅读 / 正在检测是否收录...

1.pom依赖

 <!-- springboot基础依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>3.3.0</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <version>3.3.0</version>
</dependency>
<!-- mysql数据库连接驱动-->
<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
</dependency>
<!-- 引入Spring封装的jdbc,内部默认依赖了 HikariDataSource  数据源-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jdbc</artifactId>
</dependency>

2.application.yml基本配置

spring:
  #配置数据源
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.124.10:3306/db1?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
    username: db1
    password: db1

3.连接测试

@SpringBootTest
class HikariDataSourceApplicationTests {
    @Resource
    DataSource dataSource;

    @Test
    void contextLoads() throws SQLException {
        Connection connection = dataSource.getConnection();
        DatabaseMetaData metaData = connection.getMetaData();

        System.out.println("数据源>>>>>>" + dataSource.getClass());
        System.out.println("连接>>>>>>>>" + connection);
        System.out.println("连接地址>>>>" + connection.getMetaData().getURL());
        System.out.println("驱动名称>>>>" + metaData.getDriverName());
        System.out.println("驱动版本>>>>" + metaData.getDriverVersion());
        System.out.println("数据库名称>>" + metaData.getDatabaseProductName());
        System.out.println("数据库版本>>" + metaData.getDatabaseProductVersion());
        System.out.println("连接用户名称>" + metaData.getUserName());
        connection.close();
    }
}
数据源>>>>>>class com.zaxxer.hikari.HikariDataSource
连接>>>>>>>>HikariProxyConnection@902348321 wrapping com.mysql.cj.jdbc.ConnectionImpl@14998e21
连接地址>>>>jdbc:mysql://192.168.124.10:3306/db1?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
驱动名称>>>>MySQL Connector/J
驱动版本>>>>mysql-connector-j-8.3.0 (Revision: 805f872a57875f311cb82487efcfb070411a3fa0)
数据库名称>>MySQL
数据库版本>>5.7.44-log
连接用户名称>db1@192.168.124.8

4.操作数据库测试

数据库内容

@SpringBootTest
class HikariDataSourceApplicationTests {
    @Resource
    JdbcTemplate jdbcTemplate;

    @Test
    void contextLoads() throws SQLException {
        String sql = "select * from user1";
        List<Map<String, Object>> selectRes =  jdbcTemplate.queryForList(sql);
        System.out.println("selectRes="+selectRes);
    }
}

5.数据源自动配置原理

  1. 引入spring-boot-starter-data-jdbcorg.springframework.boot.autoconfigure.jdbc下定义的AutoConfiguration相关的类会触发DataSourceJdbcTemplate等的默认装配行为,会读取spring.datasource下的配置执行相关bean的装配

    1. 引入spring-boot-starter-data-jdbc后不配置spring.datasource相关内容会导致如下异常

      ***************************
      APPLICATION FAILED TO START
      ***************************
      
      Description:
      
      Failed to configure a DataSource: 'url' attribute is not specified and no embedded datasource could be configured.
      
      Reason: Failed to determine a suitable driver class
      
      
      Action:
      
      Consider the following:
          If you want an embedded database (H2, HSQL or Derby), please put it on the classpath.
          If you have database settings to be loaded from a particular profile you may need to activate it (no profiles are currently active).
      
      
      Process finished with exit code 1
    2. 也可以通过在启动类来解除自动配置行为

      @SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
      public class HikariDataSourceApplication {
          public static void main(String[] args) {
              SpringApplication.run(HikariDataSourceApplication.class, args);
          }
      }
  2. org.springframework.boot.autoconfigure.jdbc.DataSourceConfiguration 数据源配置类作用是根据逻辑判断之后,添加数据源,内部配置了默认使用的数据源是类型是com.zaxxer.hikari.HikariDataSource
  3. 可以通过 spring.datasource.type 指定自定义的数据源类型,如DruidDataSource

    1. 对应的配置文件为

      spring:
        #配置数据源
        datasource:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://192.168.124.10:3306/db1?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
          username: db1
          password: db1
          type: com.alibaba.druid.pool.DruidDataSource
    2. 使用该数据源需要引入相关依赖

      <dependency>
           <groupId>com.alibaba</groupId>
          <artifactId>druid</artifactId>
          <version>1.1.22</version>
      </dependency>

6.HikariDataSource数据源配置参数

6.1 常用配置及含义

Hikari的配置参数配置为spring.datasource.hikari.*形式。最常用的配置及其参数说明如下

spring:
  #配置数据源
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.124.10:3306/db1?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
    username: db1
    password: db1
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      # 连接池最小空闲连接,默认值10,小于0或大于maximum-pool-size,都会重置为maximum-pool-size
      minimum-idle: 10
      # 连接池最大连接数,小于等于0会被重置为默认值10;大于零小于1会被重置为minimum-idle的值。
      maximum-pool-size: 20
      # 连接最大存活时间,不等于0且小于30秒,会被重置为默认值30分钟.设置应该比mysql设置的超时时间短
      max-lifetime: 600000
      # 空闲连接超时时间,默认值600000(10分钟),大于等于max-lifetime且max-lifetime>0,会被重置为0;不等于0且小于10秒,会被重置为10秒。
      idle-timeout: 600000
      #  连接超时时间:毫秒,小于250毫秒,否则被重置为默认值30秒,如果在这个时间内无法建立连接,将会抛出异常。
      connection-timeout: 30000

6.2 完整配置参数说明

name描述构造器默认值默认配置validate之后的值validate重置
autoCommit自动提交从池中返回的连接TRUETRUE
connectionTimeout等待来自池的连接的最大毫秒数SECONDS.toMillis(30) = 3000030000如果小于250毫秒,则被重置回30秒
idleTimeout连接允许在池中闲置的最长时间MINUTES.toMillis(10) = 600000600000如果idleTimeout+1秒>maxLifetime 且 maxLifetime>0,则会被重置为0(代表永远不会退出);如果idleTimeout!=0且小于10秒,则会被重置为10秒
maxLifetime池中连接最长生命周期MINUTES.toMillis(30) = 18000001800000如果不等于0且小于30秒则会被重置回30分钟
connectionTestQuery如果您的驱动程序支持JDBC4,我们强烈建议您不要设置此属性nullnull
minimumIdle池中维护的最小空闲连接数-110minIdle<0或者minIdle>maxPoolSize,则被重置为maxPoolSize
maximumPoolSize池中最大连接数,包括闲置和使用中的连接-110如果maxPoolSize小于1,则会被重置。当minIdle<=0被重置为DEFAULT\_POOL\_SIZE则为10;如果minIdle>0则重置为minIdle的值
metricRegistry该属性允许您指定一个 Codahale / Dropwizard MetricRegistry 的实例,供池使用以记录各种指标nullnull
healthCheckRegistry该属性允许您指定池使用的Codahale / Dropwizard HealthCheckRegistry的实例来报告当前健康信息nullnull
poolName连接池的用户定义名称,主要出现在日志记录和JMX管理控制台中以识别池和池配置nullHikariPool-1
initializationFailTimeout如果池无法成功初始化连接,则此属性控制池是否将 fail fast11
isolateInternalQueries是否在其自己的事务中隔离内部池查询,例如连接活动测试FALSEFALSE
allowPoolSuspension控制池是否可以通过JMX暂停和恢复FALSEFALSE
readOnly从池中获取的连接是否默认处于只读模式FALSEFALSE
registerMbeans是否注册JMX管理Bean(MBeans)FALSEFALSE
catalog为支持 catalog 概念的数据库设置默认 catalogdriver defaultnull
connectionInitSql该属性设置一个SQL语句,在将每个新连接创建后,将其添加到池中之前执行该语句。nullnull
driverClassNameHikariCP将尝试通过仅基于jdbcUrl的DriverManager解析驱动程序,但对于一些较旧的驱动程序,还必须指定driverClassNamenullnull
transactionIsolation控制从池返回的连接的默认事务隔离级别nullnull
validationTimeout连接将被测试活动的最大时间量SECONDS.toMillis(5) = 50005000如果小于250毫秒,则会被重置回5秒
leakDetectionThreshold记录消息之前连接可能离开池的时间量,表示可能的连接泄漏00如果大于0且不是单元测试,则进一步判断:(leakDetectionThreshold < SECONDS.toMillis(2) or (leakDetectionThreshold > maxLifetime && maxLifetime > 0),会被重置为0 . 即如果要生效则必须>0,而且不能小于2秒,而且当maxLifetime > 0时不能大于maxLifetime
dataSource这个属性允许你直接设置数据源的实例被池包装,而不是让HikariCP通过反射来构造它nullnull
schema该属性为支持模式概念的数据库设置默认模式driver defaultnull
threadFactory此属性允许您设置将用于创建池使用的所有线程的java.util.concurrent.ThreadFactory的实例。nullnull
scheduledExecutor此属性允许您设置将用于各种内部计划任务的java.util.concurrent.ScheduledExecutorService实例nullnull

7.通过Config文件手动创建数据源配置

  • 取消自动配置行为
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
public class HikariDataSourceApplication {
    public static void main(String[] args) {
        SpringApplication.run(HikariDataSourceApplication.class, args);
    }
}
  • 手动创建配置文件
package com.example.hikaridatasource.config;

import com.zaxxer.hikari.HikariDataSource;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.jdbc.core.JdbcTemplate;

import javax.sql.DataSource;

@Configuration
public class Db1DataSourceConfig {

    // jdbc连接信息
    @Value(value = "${spring.datasource.url:}")
    private String url;
    @Value(value = "${spring.datasource.username:}")
    private String username;
    @Value(value = "${spring.datasource.password:}")
    private String password;
    @Value(value = "${spring.datasource.driver-class-name:}")
    private String driveClassName;

    // HikariDataSource配置参数
    // 连接池最小空闲连接,默认值10
    @Value(value = "${spring.datasource.hikari.minimum-idle:10}")
    private int minimumIdle;
    // 连接池最大连接数,默认值10
    @Value(value = "${spring.datasource.hikari.maximum-pool-size:10}")
    private int maximumPoolSize;
    // 连接最大存活时间,默认值30分钟.设置应该比mysql设置的超时时间短,配置单位毫秒
    @Value(value = "${spring.datasource.hikari.max-lifetime:600000}")
    private long maxLifetime;
    // 空闲连接超时时间,默认值600000(10分钟)配置单位毫秒
    @Value(value = "${spring.datasource.hikari.idle-timeout:600000}")
    private long idleTimeout;
    // 连接超时时间,配置单位毫秒
    @Value(value = "${spring.datasource.hikari.connection-timeout:60000}")
    private long connectionTimeout;
    @Bean(name = "db1DataSource")
    @Primary
    public DataSource db1DataSource(){
        HikariDataSource dataSource = new HikariDataSource();

        // 设置jdbc连接信息
        dataSource.setJdbcUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        dataSource.setDriverClassName(driveClassName);

        // 设置HikariDataSource配置参数
        dataSource.setMinimumIdle(minimumIdle);
        dataSource.setMaximumPoolSize(maximumPoolSize);
        dataSource.setMaxLifetime(maxLifetime);
        dataSource.setIdleTimeout(idleTimeout);
        dataSource.setConnectionTimeout(connectionTimeout);
        return dataSource;
    }

    @Bean(name = "db1JdbcTemplate")
    @Primary
    public JdbcTemplate db1JdbcTemplate(@Qualifier("db1DataSource") DataSource dataSource){
        return new JdbcTemplate(dataSource);
    }
}
  • application.yml
spring:
  #配置数据源
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.124.10:3306/db1?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
    username: db1
    password: db1
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      # 连接池最小空闲连接,默认值10,小于0或大于maximum-pool-size,都会重置为maximum-pool-size
      minimum-idle: 10
      # 连接池最大连接数,小于等于0会被重置为默认值10;大于零小于1会被重置为minimum-idle的值。
      maximum-pool-size: 20
      # 空闲连接超时时间,默认值600000(10分钟),大于等于max-lifetime且max-lifetime>0,会被重置为0;不等于0且小于10秒,会被重置为10秒。
      idle-timeout: 600000
      # 连接最大存活时间,不等于0且小于30秒,会被重置为默认值30分钟.设置应该比mysql设置的超时时间短
      max-lifetime: 600000
      #  连接超时时间:毫秒,小于250毫秒,否则被重置为默认值30秒,如果在这个时间内无法建立连接,将会抛出异常。
      connection-timeout: 60000
  • 连接测试测试数据源
@SpringBootTest
class HikariDataSourceApplicationTests {
    @Resource
    DataSource dataSource;

    @Test
    void contextLoads() throws SQLException {
        Connection connection = dataSource.getConnection();
        DatabaseMetaData metaData = connection.getMetaData();

        System.out.println("数据源>>>>>>" + dataSource.getClass());
        System.out.println("连接>>>>>>>>" + connection);
        System.out.println("连接地址>>>>" + connection.getMetaData().getURL());
        System.out.println("驱动名称>>>>" + metaData.getDriverName());
        System.out.println("驱动版本>>>>" + metaData.getDriverVersion());
        System.out.println("数据库名称>>" + metaData.getDatabaseProductName());
        System.out.println("数据库版本>>" + metaData.getDatabaseProductVersion());
        System.out.println("连接用户名称>" + metaData.getUserName());
        System.out.println("连接超时时间>" + dataSource.getLoginTimeout() + "s");
        connection.close();
    }
}
数据源>>>>>>class com.zaxxer.hikari.HikariDataSource
连接>>>>>>>>HikariProxyConnection@42898626 wrapping com.mysql.cj.jdbc.ConnectionImpl@62b790a5
连接地址>>>>jdbc:mysql://192.168.124.10:3306/db1?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
驱动名称>>>>MySQL Connector/J
驱动版本>>>>mysql-connector-j-8.3.0 (Revision: 805f872a57875f311cb82487efcfb070411a3fa0)
数据库名称>>MySQL
数据库版本>>5.7.44-log
连接用户名称>db1@192.168.124.8
连接超时时间>60s
  • 操作数据源测试
@SpringBootTest
class HikariDataSourceApplicationTests {
    @Resource
    JdbcTemplate jdbcTemplate;

    @Test
    void contextLoads() throws SQLException {
        String sql = "select * from user1";
        List<Map<String, Object>> selectRes =  jdbcTemplate.queryForList(sql);
        System.out.println("selectRes="+selectRes);
    }
}
selectRes=[{username=username1, password=password1, id=1}, {username=username1, password=password1, id=2}, {username=username1, password=password1, id=3}, {username=username1, password=password1, id=4}, {username=username1, password=password1, id=5}]

参考资料

  1. Spring Boot 如何通过jdbc+HikariDataSource 完成对Mysql 操作_hikaridatasource mysql-CSDN博客
  2. Spring Boot 默认数据源 HikariDataSource 与 JdbcTemplate 初遇-CSDN博客
  3. SpringBoot - 数据源注入 及其 自动配置原理_springboot 注入datasource-CSDN博客
  4. Spring Boot 2.x基础教程:默认数据源Hikari的配置详解 - 程序猿DD - 博客园 (cnblogs.com)
  5. Spring Boot 如何通过jdbc+HikariDataSource 完成对Mysql 操作_hikaridatasource mysql-CSDN博客
0

评论 (0)

打卡
取消