【SpringBoot 3.x】使用starter整合Druid

系统管理员 2023-10-12 10:13 20阅读 0赞

## Druid介绍 ##

`Druid`是阿里巴巴的一个开源项目，号称为监控而生的数据库连接池，在功能、性能、扩展性方面都超过其他例如`DBCP`、`C3P0`、`BoneCP`、`Proxool`、`JBoss DataSource`等连接池,而且`Druid`已经在阿里巴巴部署了超过`600`个应用，通过了极为严格的考验，这才收获了大家的青睐！

## 本地开发环境说明 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">开发依赖</th> 
   <th align="left">版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">Spring Boot</td> 
   <td align="left">3.0.6</td> 
  </tr> 
  <tr> 
   <td align="left">druid-spring-boot-3-starter</td> 
   <td align="left">1.2.18</td> 
  </tr> 
  <tr> 
   <td align="left">JDK</td> 
   <td align="left">20</td> 
  </tr> 
 </tbody> 
</table>

## SpringBoot集成Druid ##

如果是SpringBoot 2.x，使用以下依赖

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid-spring-boot-starter</artifactId>
        <version>${druid-spring-boot-starter.version}</version>
    </dependency>

如果是SpringBoot 3.x，使用以下依赖

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid-spring-boot-3-starter</artifactId>
        <version>${druid-spring-boot-starter.version}</version>
    </dependency>

## application.yml配置 ##

为了方便演示和直观，配置文件拆分成2个，`application.yml`和`application-druid.yml`

### application.yml ###

spring:
      profiles:
        active: druid
      datasource:
        driver-class-name: org.h2.Driver
        url: jdbc:h2:tcp://localhost/D:/ProgramFiles/h2database/data/test;MODE=MYSQL;
        username:
        password:

### application-druid.yml配置 ###

spring:
      datasource:
        type: com.alibaba.druid.pool.DruidDataSource
        # Druid的其他属性配置
        druid:
          # 初始化时建立物理连接的个数
          initial-size: 5
          # 连接池的最小空闲数量
          min-idle: 5
          # 连接池最大连接数量
          max-active: 20
          # 获取连接时最大等待时间，单位毫秒
          max-wait: 60000
          # 申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。
          test-while-idle: true
          # 既作为检测的间隔时间又作为testWhileIdel执行的依据
          time-between-eviction-runs-millis: 60000
          # 销毁线程时检测当前连接的最后活动时间和当前时间差大于该值时，关闭当前连接(配置连接在池中的最小生存时间)
          min-evictable-idle-time-millis: 30000
          # 用来检测数据库连接是否有效的sql 必须是一个查询语句(oracle中为 select 1 from dual)
          validation-query: select 'x'
          # 申请连接时会执行validationQuery检测连接是否有效,开启会降低性能,默认为true
          test-on-borrow: false
          # 归还连接时会执行validationQuery检测连接是否有效,开启会降低性能,默认为true
          test-on-return: false
          # 是否缓存preparedStatement, 也就是PSCache,PSCache对支持游标的数据库性能提升巨大，比如说oracle,在mysql下建议关闭。
          pool-prepared-statements: false
          # 置监控统计拦截的filters，去掉后监控界面sql无法统计，stat: 监控统计、Slf4j:日志记录、waLL: 防御sqL注入
          filters: stat,wall,slf4j
          # 要启用PSCache，必须配置大于0，当大于0时，poolPreparedStatements自动触发修改为true。在Druid中，不会存在Oracle下PSCache占用内存过多的问题，可以把这个数值配置大一些，比如说100
          max-pool-prepared-statement-per-connection-size: -1
          # 合并多个DruidDataSource的监控数据
          use-global-data-source-stat: true
          # 通过connectProperties属性来打开mergeSql功能；慢SQL记录
          connect-properties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
    
          web-stat-filter:
            # 是否启用StatFilter默认值true
            enabled: true
            # 添加过滤规则
            url-pattern: /*
            # 忽略过滤的格式
            exclusions: /druid/*,*.js,*.gif,*.jpg,*.png,*.css,*.ico
    
          stat-view-servlet:
            # 是否启用StatViewServlet默认值true
            enabled: true
            # 访问路径为/druid时，跳转到StatViewServlet
            url-pattern: /druid/*
            # 是否能够重置数据
            reset-enable: false
            # 需要账号密码才能访问控制台，默认为root
            login-username: druid
            login-password: druid
            # IP白名单
            allow: 127.0.0.1
            # IP黑名单（共同存在时，deny优先于allow）
            deny:

## 集成过程出现的问题 ##

由于本文使用`SpringBoot 3.x`版本，启动后，在浏览器输入

http://localhost:8080/druid

>  *  但会报404的错误，首先要确保`pom.xml`引用的是`druid-spring-boot-3-starter`而不是`druid-spring-boot-starter`
>  *  通过源码分析，`druid-spring-boot-3-starter`目前最新版本是`1.2.18`，虽然适配了`SpringBoot3`，但缺少自动装配的配置文件，需要手动在`resources`目录下创建`META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports`，文件内容如下

com.alibaba.druid.spring.boot3.autoconfigure.DruidDataSourceAutoConfigure

>  *  本来想针对这个问题提个`issue`和`PR`，无奈`github`在国内访问太不稳定了

## 浏览器访问 ##

*  在浏览器输入: `http://localhost:8080/druid`
 *  登录账号密码是配置文件中指定的: `druid/druid`  
    ![在这里插入图片描述][fa05745e49a54e9095031882270a7c1b.png]

## 在线文档 ##

*  官网: `https://github.com/alibaba/druid/tree/master/druid-spring-boot-starter`

[fa05745e49a54e9095031882270a7c1b.png]: https://img-blog.csdnimg.cn/fa05745e49a54e9095031882270a7c1b.png