14Spring Boot整合第三方Druid数据源(通过starter整合 Druid )

布满荆棘的人生 2024-04-06 14:11 72阅读 0赞

Spring Boot 2.x 默认使用 HikariCP 作为数据源，我们只要在项目中导入了 Spring Boot 的JDBC 场景启动器，便可以使用 HikariCP 数据源获取数据库连接，对数据库进行增删改查等操作。  
HikariCP 是目前市面上性能最好的数据源产品，但在实际的开发过程中，企业往往更青睐于另一款数据源产品：Druid，它是目前国内使用范围最广的数据源产品。  
Druid 是阿里巴巴推出的一款开源的高性能数据源产品，Druid 支持所有 JDBC 兼容的数据库，包括 Oracle、MySQL、SQL Server 和 H2 等等。Druid 不仅结合了 C3P0、DBCP 和 PROXOOL 等数据源产品的优点，同时还加入了强大的监控功能。通过 Druid 的监控功能，可以实时观察数据库连接池和 SQL 的运行情况，帮助用户及时排查出系统中存在的问题。

Druid 不是 Spring Boot 内部提供的技术，它属于第三方技术，我们可以通过以下两种方式进行整合：

*  自定义整合 Druid
 *  通过 starter 整合 Druid

**本章介绍通过 starter 整合 Druid 。通过 starter 整合 Druid**

### 通过 starter 整合 Druid ###

Druid 可以说是国内使用最广泛的数据源连接池产品，但到目前为止 Spring Boot 官方只对 Hikari、Tomcat、Dbcp2 和 OracleUcp 等 4 种数据源产品提供了自动配置支持，对于其他的数据源连接池产品（包括 Druid），则并没有提供自动配置支持。这就导致用户只能通过自定义的方式（第一种整合方式）整合 Druid，非常繁琐。

为了解决这一问题，于是阿里官方提供了 [Druid Spring Boot Starter][]，它可以帮助我们在 Spring Boot 项目中，轻松地整合 Druid 的数据库连接池和监控功能。

整合步骤如下：

#### 1. 引入 Druid Spring Boot Starter 依赖 ####

在 Spring Boot 项目的 pom.xml 中添加以下依赖，引入 Druid Spring Boot Starter（[点击查询最新版本][Link 1]），示例代码如下。

<dependency>
       <groupId>com.alibaba</groupId>
       <artifactId>druid-spring-boot-starter</artifactId>
       <version>1.1.17</version>
    </dependency>

#### 2. 配置属性 ####

Druid Spring Boot Starter 已经将 Druid 数据源中的所有模块都进行默认配置，我们也可以通过 Spring Boot 配置文件（application.properties/yml）来修改 Druid 各个模块的配置，否则将使用默认配置。  
  
在 Spring Boot 配置文件中配置以下内容：

*  JDBC 通用配置
 *  Druid 数据源连接池配置
 *  Druid 监控配置
 *  Druid 内置 Filter 配置

> 这些配置内容既可以在 application.properties 中进行配置，也可以在 application.yml 中尽心配置，当配置内容较多时，我们通常推荐使用 application.yml（示例中使用的是 application.yml）。

**JDBC 通用配置**

在 Spring Boot 的配置文件中对 JDBC 进行通用配置，例如，数据库用户名、数据库密码、数据库 URL 以及 数据库驱动等等，示例代码如下。

################# JDBC 通用配置  ##################
    spring:
      datasource:
        username: root                                                 #数据库登陆用户名
        password: root                                                 #数据库登陆密码
        url: jdbc:mysql://127.0.0.1:3306/tyut                          #数据库url
        driver-class-name: com.mysql.cj.jdbc.Driver                    #数据库驱动

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

在 Spring Boot 的配置文件中对 Druid 数据源连接池进行配置，示例代码如下。

################################################## Druid连接池的配置 ##########################################
    spring:
      datasource:
        druid:
          initial-size: 5                                                                 #初始化连接大小
          min-idle: 5                                                                     #最小连接池数量
          max-active: 20                                                                  #最大连接池数量
          max-wait: 60000                                                                 #获取连接时最大等待时间，单位毫秒
          time-between-eviction-runs-millis: 60000                                        #配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
          min-evictable-idle-time-millis: 300000                                          #配置一个连接在池中最小生存的时间，单位是毫秒
          validation-query: SELECT 1 FROM DUAL                                            #测试连接
          test-while-idle: true                                                           #申请连接的时候检测，建议配置为true，不影响性能，并且保证安全性
          test-on-borrow: false                                                           #获取连接时执行检测，建议关闭，影响性能
          test-on-return: false                                                           #归还连接时执行检测，建议关闭，影响性能
          pool-prepared-statements: false                                                 #是否开启PSCache，PSCache对支持游标的数据库性能提升巨大，oracle建议开启，mysql下建议关闭
          max-pool-prepared-statement-per-connection-size: 20                             #开启poolPreparedStatements后生效
          filters: stat,wall                                                              #配置扩展插件，常用的插件有=>stat:监控统计  wall:防御sql注入
          connection-properties: 'druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000' #通过connectProperties属性来打开mergeSql功能;慢SQL记录

**Druid 监控配置**

在 Spring Boot 的配置文件中对 Druid 内置监控页面、Web-JDBC 关联监控和 Spring 监控等功能进行配置，示例代码如下。

###################################################### Druid 监控配置信息  ##########################################
    spring:
      datasource:
        druid:
          # StatViewServlet配置，说明请参考Druid Wiki，配置_StatViewServlet配置
          stat-view-servlet:
            enabled: true                                                                 #是否开启内置监控页面，默认值为 false
            url-pattern: '/druid/*'                                                       #StatViewServlet 的映射路径，即内置监控页面的访问地址
            reset-enable: true                                                            #是否启用重置按钮
            login-username: admin                                                         #内置监控页面的登录页用户名 username
            login-password: admin                                                         #内置监控页面的登录页密码 password
          # WebStatFilter配置，说明请参考Druid Wiki，配置_配置WebStatFilter
          web-stat-filter:
            enabled: true                                                                 #是否开启内置监控中的 Web-jdbc 关联监控的数据
            url-pattern: '/*'                                                             #匹配路径
            exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*'                     #排除路径
            session-stat-enable: true                                                     #是否监控session
          # Spring监控配置，说明请参考Druid Github Wiki，配置_Druid和Spring关联监控配置
          aop-patterns: net.biancheng.www.*                                               #Spring监控AOP切入点，如x.y.z.abc.*,配置多个英文逗号分隔

**Druid 内置 Filter 配置**

Druid Spring Boot Starter 对以下 Druid 内置 Filter，都提供了默认配置：

*  StatFilter
 *  WallFilter
 *  ConfigFilter
 *  EncodingConvertFilter
 *  Slf4jLogFilter
 *  Log4jFilter
 *  Log4j2Filter
 *  CommonsLogFilter

我们可以通过 spring.datasource.druid.filters=stat,wall ... 的方式来启用相应的内置 Filter，不过这些 Filter 使用的都是默认配置。如果默认配置不能满足我们的需求，我们还可以在配置文件使用 spring.datasource.druid.filter.\* 对这些 Filter 进行配置，示例代码如下。

#  ####################################################### Druid 监控配置信息  ##########################################
    spring:
      datasource:
        druid:
         # 对配置已开启的 filters 即 stat(sql 监控)  wall（防火墙）
          filter:
            #配置StatFilter (SQL监控配置)
            stat:
              enabled: true                                                               #开启 SQL 监控
              slow-sql-millis: 1000                                                       #慢查询
              log-slow-sql: true                                                          #记录慢查询 SQL
            #配置WallFilter (防火墙配置)
            wall:
              enabled: true                                                               #开启防火墙
              config:
                update-allow: true                                                        #允许更新操作
                drop-table-allow: false                                                   #禁止删表操作
                insert-allow:  true                                                       #允许插入操作
                delete-allow: true                                                        #删除数据操作

在配置 Druid 内置 Filter 时，需要先将对应 Filter 的 enabled 设置为 true，否则内置 Filter 的配置不会生效。  
  
以上所有内容都只是示例配置，Druid Spring Boot Starter 并不是只支持以上属性，它支持 DruidDataSource 内所有具有 setter 方法的属性。  
  
至此，我们就完成了使用 Druid Spring Boot Starter 整合 Druid 的全部过程，至于验证步骤请参考自定义整合。

### 总结 ###

无论是自定义整合还是通过 Druid Spring Boot Starter 整合，都能实现 Spring Boot 整合 Druid 数据源的目的，它们都各有利弊。

*  根据官方文档，自定义整合 Druid 数据源能够更加清晰地了解 Druid 的各种功能及其实现方式，但整合过程繁琐。
 *  通过 Druid Spring Boot Starter 整合 Druid 数据源，则更加方便快捷，大大简化了整合过程，但无法清晰地了解 Druid 的功能内部的实现方式和原理。

这里，我们更加推荐使用 Druid Spring Boot Starter 进行整合，毕竟这种整合方式大大简化了整个整合的过程。

## [15Spring Boot整合MyBatis][15Spring Boot_MyBatis] ##

[https://blog.csdn.net/qq\_41946216/article/details/127100048?spm=1001.2014.3001.5502][15Spring Boot_MyBatis]

##  ##

[Druid Spring Boot Starter]: https://github.com/alibaba/druid/tree/master/druid-spring-boot-starter
[Link 1]: https://mvnrepository.com/artifact/com.alibaba/druid-spring-boot-starter
[15Spring Boot_MyBatis]: https://blog.csdn.net/qq_41946216/article/details/127100048?spm=1001.2014.3001.5502