SpringBoot：整合Druid数据源

谁践踏了优雅 2023-10-05 20:51 4阅读 0赞

> **我是 ABin-阿斌：写一生代码，创一世佳话，筑一揽芳华。 如果小伙伴们觉得我的文章有点 feel ，那就点个赞再走哦。**  
> ![在这里插入图片描述][01244a35a05f9070bf77418374331efc.png_pic_center]

## 一、Druid的具体介绍 ##

*  在我们实际开发当中我们需要频繁地去操作数据库，为了**提高性能**操作数据库的时候，又不得不**使用数据库连接池**。
 *  **Druid** **是阿里巴巴开源平台上一个数据库连接池实现**，结合了 **C3P0**、**DBCP** 等 **DB** 池的优点，同时加入了**日志监控**。
 *  **Druid可以很好的监控 DB 池连接和 SQL的执行情况，天生就是针对监控而生的 DB连接池。** **Druid** 可以很好的监控 **DB** 池连接和 **SQL** 的执行情况，天生就是针对监控而生的 **DB** 连接池。**(阿里巴巴 Druid项目开源地址：https://github.com/alibaba/druid/)**
 *  **Spring Boot 2.0** 以上默认使用 **Hikari** 数据源，可以说 **Hikari** 与 **Driud** 都是当前 **Java Web** 上最优秀的数据源，我们来重点介绍 **Spring Boot** 如何集成 **Druid** 数据源，如何实现数据库监控。

## 二、Druid基本配置参数 ##

<table> 
 <tbody> 
  <tr> 
   <td>配置</td> 
   <td>缺省值</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>name</td> 
   <td>&nbsp;</td> 
   <td>配置这个属性的意义在于，如果存在多个数据源，监控的时候可以通过名字来区分开来。&nbsp;<br>如果没有配置，将会生成一个名字，格式是："DataSource-" + System.identityHashCode(this)</td> 
  </tr> 
  <tr> 
   <td>jdbcUrl</td> 
   <td>&nbsp;</td> 
   <td>连接数据库的url，不同数据库不一样。例如：&nbsp;<br>mysql : jdbc:mysql://10.20.153.104:3306/druid2&nbsp;<br>oracle : jdbc:oracle:thin:@10.20.149.85:1521:ocnauto</td> 
  </tr> 
  <tr> 
   <td>username</td> 
   <td>&nbsp;</td> 
   <td>连接数据库的用户名</td> 
  </tr> 
  <tr> 
   <td>password</td> 
   <td>&nbsp;</td> 
   <td>连接数据库的密码。如果你不希望密码直接写在配置文件中，可以使用ConfigFilter。详细看这里：https://github.com/alibaba/druid/wiki/%E4%BD%BF%E7%94%A8ConfigFilter</td> 
  </tr> 
  <tr> 
   <td>driverClassName</td> 
   <td>根据url自动识别</td> 
   <td>这一项可配可不配，如果不配置druid会根据url自动识别dbType，然后选择相应的driverClassName(建议配置下)</td> 
  </tr> 
  <tr> 
   <td>initialSize</td> 
   <td>0</td> 
   <td>初始化时建立物理连接的个数。初始化发生在显示调用init方法，或者第一次getConnection时</td> 
  </tr> 
  <tr> 
   <td>maxActive</td> 
   <td>8</td> 
   <td>最大连接池数量</td> 
  </tr> 
  <tr> 
   <td>maxIdle</td> 
   <td>8</td> 
   <td>已经不再使用，配置了也没效果</td> 
  </tr> 
  <tr> 
   <td>minIdle</td> 
   <td>&nbsp;</td> 
   <td>最小连接池数量</td> 
  </tr> 
  <tr> 
   <td>maxWait</td> 
   <td>&nbsp;</td> 
   <td>获取连接时最大等待时间，单位毫秒。配置了maxWait之后，缺省启用公平锁，并发效率会有所下降，如果需要可以通过配置useUnfairLock属性为true使用非公平锁。</td> 
  </tr> 
  <tr> 
   <td>poolPreparedStatements</td> 
   <td>false</td> 
   <td>是否缓存preparedStatement，也就是PSCache。PSCache对支持游标的数据库性能提升巨大，比如说oracle。在mysql下建议关闭。</td> 
  </tr> 
  <tr> 
   <td>maxOpenPreparedStatements</td> 
   <td>-1</td> 
   <td>要启用PSCache，必须配置大于0，当大于0时，poolPreparedStatements自动触发修改为true。在Druid中，不会存在Oracle下PSCache占用内存过多的问题，可以把这个数值配置大一些，比如说100</td> 
  </tr> 
  <tr> 
   <td>validationQuery</td> 
   <td>&nbsp;</td> 
   <td>用来检测连接是否有效的sql，要求是一个查询语句。如果validationQuery为null，testOnBorrow、testOnReturn、testWhileIdle都不会其作用。</td> 
  </tr> 
  <tr> 
   <td>testOnBorrow</td> 
   <td>true</td> 
   <td>申请连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能。</td> 
  </tr> 
  <tr> 
   <td>testOnReturn</td> 
   <td>false</td> 
   <td>归还连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能</td> 
  </tr> 
  <tr> 
   <td>testWhileIdle</td> 
   <td>false</td> 
   <td>建议配置为true，不影响性能，并且保证安全性。申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。</td> 
  </tr> 
  <tr> 
   <td>timeBetweenEvictionRunsMillis</td> 
   <td>&nbsp;</td> 
   <td>有两个含义：&nbsp;<br>1) Destroy线程会检测连接的间隔时间2) testWhileIdle的判断依据，详细看testWhileIdle属性的说明</td> 
  </tr> 
  <tr> 
   <td>numTestsPerEvictionRun</td> 
   <td>&nbsp;</td> 
   <td>不再使用，一个DruidDataSource只支持一个EvictionRun</td> 
  </tr> 
  <tr> 
   <td>minEvictableIdleTimeMillis</td> 
   <td>&nbsp;</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>connectionInitSqls</td> 
   <td>&nbsp;</td> 
   <td>物理连接初始化的时候执行的sql</td> 
  </tr> 
  <tr> 
   <td>exceptionSorter</td> 
   <td>根据dbType自动识别</td> 
   <td>当数据库抛出一些不可恢复的异常时，抛弃连接</td> 
  </tr> 
  <tr> 
   <td>filters</td> 
   <td>&nbsp;</td> 
   <td>属性类型是字符串，通过别名的方式配置扩展插件，常用的插件有：&nbsp;<br>监控统计用的filter:stat日志用的filter:log4j防御sql注入的filter:wall</td> 
  </tr> 
  <tr> 
   <td>proxyFilters</td> 
   <td>&nbsp;</td> 
   <td><p>类型是List&lt;com.alibaba.druid.filter.Filter&gt;，如果同时配置了filters和proxyFilters，是组合关系，并非替换关系</p></td> 
  </tr> 
 </tbody> 
</table>

## 三、配置数据源 ##

**在上一篇文章项目模块中直接修改即可：**[整合JDBC][JDBC]

**3.1、添加上 Druid 数据源依赖。**

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

**3.2、切换数据源**

> **之前已经说过 Spring Boot 2.0 以上默认使用 com.zaxxer.hikari.HikariDataSource 数据源，但可以 通过 spring.datasource.type 指定数据源。**

**3.3、数据源切换之后，在测试类中注入 DataSource，然后获取到它，输出一看便知是否成功切换**

3.4、**设置数据源连接初始化大小、最大连接数、等待时间、最小连接数 等设置项**

spring:
      datasource:
        username: root
        password: 123456
        #如果出现时区报错提示在？后面加上这个：serverTimezone=UTC&
        url: jdbc:mysql://localhost:3306/test01?useUnicode=true&characterEncoding=utf-8
        #driver-class-name: com.mysql.cj.jdbc.Driver
    
        # 自定义数据源(Druid)
        type: com.alibaba.druid.pool.DruidDataSource
    
        #Spring Boot 默认是不注入这些属性值的，需要自己绑定
        #druid 数据源专有配置
        initialSize: 5
        minIdle: 5
        maxActive: 20
        maxWait: 60000
        timeBetweenEvictionRunsMillis: 60000
        minEvictableIdleTimeMillis: 300000
        validationQuery: SELECT 1 FROM DUAL
        testWhileIdle: true
        testOnBorrow: false
        testOnReturn: false
        poolPreparedStatements: true
    
        #配置监控统计拦截的filters，stat:监控统计、log4j：日志记录、wall：防御sql注入
        #如果允许时报错  java.lang.ClassNotFoundException: org.apache.log4j.Priority
        #则导入 log4j 依赖即可，Maven 地址：https://mvnrepository.com/artifact/log4j/log4j
        filters: stat,wall,log4j
        maxPoolPreparedStatementPerConnectionSize: 20
        useGlobalDataSourceStat: true
        connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

**3.4、导入 Log4j 的依赖**

**3.5、为 DruidDataSource 绑定全局配置文件中的参数，再添加到容器中，而不再使用 Spring Boot 的自动生成了。手动添加 DruidDataSource 组件到容器中，并绑定属性。**

/**	
           将自定义的 Druid数据源添加到容器中，不再让 Spring Boot 自动创建
           绑定全局配置文件中的 druid 数据源属性到 com.alibaba.druid.pool.DruidDataSource从而让它们生效
           @ConfigurationProperties(prefix = "spring.datasource")：将全局配置文件中前缀为 spring.datasource的属性值注入到 com.alibaba.druid.pool.DruidDataSource 的同名参数中
         */
        @ConfigurationProperties(prefix = "spring.datasource")
        @Bean
        public DataSource druidDataSource(){
        
            return new DruidDataSource();
        }

3.6、测试看看是否配置成功

@SpringBootTest
    class Springboot05JdbcApplicationTests {
        
        @Autowired
        DataSource dataSource;
    
        @Test
        void contextLoads() throws SQLException {
        
    
            //查看默认数据源：com.zaxxer.hikari.HikariDataSource（目前速度最快的）
            System.out.println(dataSource.getClass());
    
            //获取数据库连接
            Connection connection = dataSource.getConnection();
            System.out.println("数据库连接信息：" + connection);
    
            DruidDataSource druidDataSource = (DruidDataSource) dataSource;
            System.out.println("druidDataSource 数据源最大连接数：" + druidDataSource.getMaxActive());
            System.out.println("druidDataSource 数据源初始化连接数：" + druidDataSource.getInitialSize());
    
            //关闭连接
            connection.close();
        }
    }

**测试结果：可见配置参数已生效**

![在这里插入图片描述][b5040f125ee3b11ec077b46ac5c3a3d2.png_pic_center]

## 四、配置 Druid 数据源的监控 ##

**Druid** 数据源具有监控的功能，并提供了一个 **web** 界面方便用户查看，类似安装 路由器时，人家也提供了一个默认的 **web** 页面。

#### 4.1、设置后台管理页面的登录属性 ####

//配置 Druid 监控管理后台的Servlet；
        //内置 Servlet 容器时没有 web.xml 文件，所以使用 Spring Boot 的注册 Servlet 方式
        @Bean
        public ServletRegistrationBean statViewServlet(){
        
            ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");
    
            // 这些参数可以在 com.alibaba.druid.support.http.StatViewServlet的父类 com.alibaba.druid.support.http.ResourceServlet 中找到
            Map<String,String> initParams  = new HashMap<>(5);
            
            //设置后台管理界面的账号与密码
            initParams.put("loginUsername","admin");
            initParams.put("loginPassword","123456");
    
            //设置后台访问权限
            //initParams.put("allow", "localhost")：表示只有本机可以访问
            //initParams.put("allow", "")：为空或者为null时，表示允许所有访
            initParams.put("allow","");
    
            //deny：Druid 后台拒绝谁访问
            //initParams.put("kuangshen", "192.168.x.xx");表示禁止此ip访问
    
            //设置初始化参数
            bean.setInitParameters(initParams);
            return bean;
        }

**访问链接：http://localhost:8080/druid/login.html，我们可以看到 Druid 后台管理登录页面**

![在这里插入图片描述][452e10142c02d1b8b4d7b8bed8f28a65.png_pic_center]  
**登录进去我们可以看到丰富的控制面板**

![在这里插入图片描述][d2c8a14322165a5cd0ba8979ca0f25e7.png_pic_center]  
  
  
**当我们执行测试中 CRUD 的 demo 时它这里也有监控显示**  
  
  
![在这里插入图片描述][3dc30d89e1a0e92208bd680606a5f4da.png_pic_center]

## 五、配置 Druid web 监控 filter 过滤器 ##

> **在我们平时实际工作中，可根据公司需求进行配置，主要作用于监控管理。**

/**
         * 配置 Druid 监控 之  web 监控的 filter
         * WebStatFilter：用于配置 Web和 Druid 数据源之间的管理关联监控统计
         */
        @Bean
        public FilterRegistrationBean webStatFilter(){
        
            FilterRegistrationBean filterbean = new FilterRegistrationBean();
            filterbean.setFilter(new WebStatFilter());
    
            //exclusions：设置哪些请求进行过滤排除掉，从而不进行统计
            Map<String,String> initParams = new HashMap<>(2);
            initParams.put("exclusions", "*.js,*.css,/druid/*,/jdbc/*");
            filterbean.setInitParameters(initParams);
    
            //("/*")：表示过滤所有请求
            filterbean.setUrlPatterns(Arrays.asList("/*"));
            return filterbean;
        }

[01244a35a05f9070bf77418374331efc.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/01244a35a05f9070bf77418374331efc.png#pic_center
[JDBC]: https://blog.csdn.net/Mango_Bin/article/details/114140672
[b5040f125ee3b11ec077b46ac5c3a3d2.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/b5040f125ee3b11ec077b46ac5c3a3d2.png#pic_center
[452e10142c02d1b8b4d7b8bed8f28a65.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/452e10142c02d1b8b4d7b8bed8f28a65.png#pic_center
[d2c8a14322165a5cd0ba8979ca0f25e7.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/d2c8a14322165a5cd0ba8979ca0f25e7.png#pic_center
[3dc30d89e1a0e92208bd680606a5f4da.png_pic_center]: https://img-blog.csdnimg.cn/img_convert/3dc30d89e1a0e92208bd680606a5f4da.png#pic_center