SpringBoot-12 整合Druid数据源

参考地址：https://mp.weixin.qq.com/s?__biz=Mzg2NTAzMTExNg==&mid=2247483786&idx=1&sn=f5f4ca792611af105140752eb67ce820&scene=19#wechat_redirect

集成 Druid

1、Druid 简介

Java 程序很大一部分要操作数据库，为了提高性能操作数据库的时候，又不得不使用数据库连接池。

Druid 是阿里巴巴开源平台上一个数据库连接池实现，结合了 C3P0、DBCP 等 DB 池的优点，同时加入了日志监控。

Druid 可以很好的监控 DB 池连接和 SQL 的执行情况，天生就是针对监控而生的 DB 连接池。

Druid 已经在阿里巴巴部署了超过 600个 应用，经过一年多生产环境大规模部署的严苛考验。

Spring Boot 2.0 以上默认使用 Hikari 数据源，可以说 Hikari 与 Driud 都是当前 Java Web 上最优秀的数据源，我们来重点介绍 Spring Boot 如何集成 Druid 数据源，如何实现数据库监控。

Github地址：https://github.com/alibaba/druid/

com.alibaba.druid.pool.DruidDataSource 基本配置参数如下：

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

2、配置数据源

1. 添加上 Druid 数据源依赖

   <!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
   <dependency>
       <groupId>com.alibaba</groupId>
       <artifactId>druid</artifactId>
       <version>1.1.24</version>
   </dependency>
   

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

   spring:
     datasource:
       username: root
       password: root
       # 有可能会报错，需要设置时区，没报错不用管，设置时区：serverTimezone=UTC
       url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEnconding=utf-8
       driver-class-name: com.mysql.cj.jdbc.Driver
       # 自定义数据源
       type: com.alibaba.druid.pool.DruidDataSource
   

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

   

4. 切换成功！既然切换成功，就可以设置数据源连接初始化大小、最大连接数、等待时间、最小连接数 等设置项；可以查看源码

   spring:
     datasource:
       username: root
       password: root
       # 有可能会报错，需要设置时区，没报错不用管，设置时区：serverTimezone=UTC
       url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEnconding=utf-8
       driver-class-name: com.mysql.cj.jdbc.Driver
       # 自定义数据源
       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
   

5. 导入 Log4j 的依赖

   <!--log4j-->
   <dependency>
       <groupId>log4j</groupId>
       <artifactId>log4j</artifactId>
       <version>1.2.17</version>
   </dependency>
   

6. 现在需要程序员自己为 DruidDataSource 绑定全局配置文件中的参数，再添加到容器中，而不再使用 Spring Boot 的自动生成了；我们需要 自己添加 DruidDataSource 组件到容器中，并绑定属性

   @Configuration
   public class DruidConfig {
   
       /*
         将自定义的 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();
       }
   }
   

7. 去测试类中测试一下；看是否成功

   @SpringBootTest
   class Springboot06DataApplicationTests {
   
       //DI注入数据源
       @Autowired
       DataSource dataSource;
   
       @Test
       void contextLoads() throws SQLException {
           //看一下默认数据源
           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();
       }
   
   }
   

8. 查看输出结果 ：可见配置参数已经生效

   

3、配置 Druid 数据监控

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

所以第一步需要设置 Druid 的后台管理页面，比如 登录账号、密码 等；配置后台管理；

// 后台监控：web.xml，ServletRegistrationBean
// 因为 SpringBoot 内置了 servlet 容器，所以没有 web.xml，再所以就有了替代方法：ServletRegistrationBean
@Bean
public ServletRegistrationBean statViewServlet(){
    ServletRegistrationBean<StatViewServlet> bean = new ServletRegistrationBean<>(new StatViewServlet(), "/druid/*");

    // 后台需要有人登录账号和密码
    // 这些参数可以在 com.alibaba.druid.support.http.StatViewServlet
    // 的父类 com.alibaba.druid.support.http.ResourceServlet 中找到
    Map<String,String> initParameters = new HashMap<>();

    // 增添配置
    initParameters.put("loginUsername","admin"); // 登录的 key 是固定的，如 loginUsername 以及 loginPassword
    initParameters.put("loginPassword","123456");

    // 允许谁可以访问
    // initParams.put("allow", "localhost")：表示只有本机可以访问
    // initParams.put("allow", "")：为空或者为null时，表示允许所有访问
    initParameters.put("allow","");

    // 不允许谁访问   initParameters.put("不允许谁","ip地址"); 表示禁止此 ip 访问
    // deny：Druid 后台拒绝谁访问

    // 设置初始化参数
    bean.setInitParameters(initParameters);
    return bean;
}

配置完毕后，我们可以选择访问 ：http://localhost:8080/druid/login.html

登录设置的账号和密码后

配置 Druid web 监控 filter 过滤器

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