【SpringBoot】整合 Mybatis 实现 Druid数据源监控(Mysql)

秒速五厘米 2022-11-15 12:27 294阅读 0赞

### 文章目录 ###

*   *  一.前言
     *  二.Durid 数据源概述
     *  三.DruidDataSource基本配置
     *  四.自定义数据源 Druid
     *   *  1.引入 Druid 数据源依赖
         *  2.切换 Druid 数据源
         *  3.配置 Druid 数据源参数
     *  五.Druid 数据源监控
     *   *  1.配置 Druid 数据源监控
         *  2.配置 Druid web 监控 filter

## 一.前言 ##

本文介绍 Spring Boot 如何集成 Druid 数据源，如何实现数据库监控

## 二.Durid 数据源概述 ##

1.  Druid 是阿里巴巴的一个开源的数据库连接池实现，结合了 C3P0、DBCP、PROXOOL 等 DB 池的优点，同时加入了`日志监控`
2.  Druid 可以很好的监控`数据库池连接和 SQL 的执行情况`，天生就是针对监控而生的 数据库 连接池
3.  `Spring Boot 2.0`以上`默认使用 Hikari 数据源`，可以说 Hikari 与 Driud 都是当前 Java Web 上最优秀的数据源

## 三.DruidDataSource基本配置 ##

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

## 四.自定义数据源 Druid ##

### 1.引入 Druid 数据源依赖 ###

1、第一步需要在应用的 pom.xml 文件中添加上 Druid 数据源依赖

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
     
        <groupId>www.wmx.com.horse</groupId>
        <artifactId>horse</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
     
        <name>horse</name>
        <description>Demo project for Spring Boot</description>
     
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.4.RELEASE</version>
            <relativePath/>
            
        </parent>
     
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
     
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jdbc</artifactId>
            </dependency>
     
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
     
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
     
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.9</version>
            </dependency>
     
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
     
        <build>
            <plugins> </plugins>
            <resources>
                
                <resource>
                    <directory>src/main/resources</directory>
                    <filtering>true</filtering>
                </resource>
                
                <resource>
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.xml</include>
                    </includes>
                </resource>
            </resources>
        </build>
    </project>

### 2.切换 Druid 数据源 ###

Spring Boot 2.0 以上默认使用 `com.zaxxer.hikari.HikariDataSource` 数据源，所以需要通过 配置`spring.datasource.type`指定数据源

spring:
      datasource:
        username: root
        password: root
        url: jdbc:mysql://127.0.0.1:3306/test?characterEncoding=UTF-8
        driver-class-name: com.mysql.jdbc.Driver
        type: com.alibaba.druid.pool.DruidDataSource

> 高版本的 spring boot 搭配 mysql 驱动版本较高时，如 mysql-connector-java:8.0.16，
> 
>  *  此时 driver-class-name 的值要带 cj，如：driver-class-name: com.mysql.cj.jdbc.Driver
>  *  url 的值要带时区 serverTimezone，如：url: jdbc:mysql://127.0.0.1:3306/test?characterEncoding=UTF-8&serverTimezone=UTC

测试: Spring获取容器中的 DataSource ，然后输出

import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    import javax.annotation.Resource;
    import javax.sql.DataSource;
    import java.sql.Connection;
    import java.sql.SQLException;
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class HorseApplicationTests { 
        /** * Spring Boot 默认已经配置好了数据源，程序员可以直接 DI 注入然后使用即可 */
        @Resource
        DataSource dataSource;
        @Test
        public void contextLoads() throws SQLException { 
            System.out.println("数据源>>>>>>" + dataSource.getClass());
            Connection connection = dataSource.getConnection();
     
            System.out.println("连接>>>>>>>>>" + connection);
            System.out.println("连接地址>>>>>" + connection.getMetaData().getURL());
            connection.close();
        }
    }

### 3.配置 Druid 数据源参数 ###

和 c3p0、dbcp 数据源 一样，Druid也 也可以设置数据源连接初始化大小、最大连接数、等待时间、最小连接数等

*  Druid 数据源参数配置在`全局配置文件application.yaml`中即可，如下所示：

spring:
      datasource:
        username: root
        password: root
        url: jdbc:mysql://192.168.58.129:3307/horse?characterEncoding=UTF-8
        driver-class-name: com.mysql.jdbc.Driver
        type: com.alibaba.druid.pool.DruidDataSource
     
    #上半区公共部分对应的是 org.springframework.boot.autoconfigure.jdbc.DataSourceProperties 中的属性
     
    #下半区属性对应的是 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

下半区 Druid 数据源的专有属性对应的是`com.alibaba.druid.pool.DruidDataSource`中的属性，虽然切换为 Druid 数据源之后\*\*，Spring Boot 会自动生成 DruidDataSource 并放入容器中供程序员使用，但是它并不会自动绑定配置文件的配置\*\*

*  所以需要编写一个配置类为 `com.alibaba.druid.pool.DruidDataSource`绑定全局配置文件中的参数，再添加到容器中，而不再使用 Spring Boot 的自动生成了

**Druid配置类**

import com.alibaba.druid.pool.DruidDataSource;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import javax.sql.DataSource;
    @Configuration
    public class DruidConfig { 
        /** * 将自定义的 Druid 数据源添加到容器中，不再让 Spring Boot 自动创建 * 这样做的目的是：绑定全局配置文件中的 druid 数据源属性到 com.alibaba.druid.pool.DruidDataSource * 从而让它们生效 * @ConfigurationProperties(prefix = "spring.datasource")：作用就是将 全局配置文件中 前缀为 spring.datasource * 的属性值注入到 com.alibaba.druid.pool.DruidDataSource 的同名参数中 * * @return */
        @ConfigurationProperties(prefix = "spring.datasource")
        @Bean
        public DataSource druidDataSource() { 
            return new DruidDataSource();
        }
    }

测试: Spring获取容器中的 DataSource ，然后取值看配置文件中的参数是否已经生效

import com.alibaba.druid.pool.DruidDataSource;
    import org.junit.Test;
    import org.junit.runner.RunWith;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    import javax.annotation.Resource;
    import javax.sql.DataSource;
    import java.sql.Connection;
    import java.sql.SQLException;
    @RunWith(SpringRunner.class)
    @SpringBootTest
    public class HorseApplicationTests { 
        /** * Spring Boot 默认已经配置好了数据源，程序员可以直接 DI 注入然后使用即可 */
        @Resource
        DataSource dataSource;
        @Test
        public void contextLoads() throws SQLException { 
            System.out.println("数据源>>>>>>" + dataSource.getClass());
            Connection connection = dataSource.getConnection();
     
            System.out.println("连接>>>>>>>>>" + connection);
            System.out.println("连接地址>>>>>" + connection.getMetaData().getURL());
     
            DruidDataSource druidDataSource = (DruidDataSource) dataSource;
            System.out.println("druidDataSource 数据源最大连接数：" + druidDataSource.getMaxActive());
            System.out.println("druidDataSource 数据源初始化连接数：" + druidDataSource.getInitialSize());
     
            connection.close();
        }
    }

## 五.Druid 数据源监控 ##

### 1.配置 Druid 数据源监控 ###

1.  Druid 数据源具有监控的功能，并提供了一个 web 界面方便用户查看，类似安装 路由器 时，人家也提供了一个默认的 web 页面。
2.  所以第一步需要设置 Druid 的后台管理页面，比如 登录账号、密码 等
3.  配置一个管理后台的 Servlet，因为使用的是内置 Servlet 容器

import com.alibaba.druid.pool.DruidDataSource;
    import com.alibaba.druid.support.http.StatViewServlet;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.boot.web.servlet.ServletRegistrationBean;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import javax.sql.DataSource;
    import java.util.HashMap;
    import java.util.Map;
    /** * Created by Administrator on 2018/8/20 0020. * Druid 数据源配置类 */
    @Configuration
    public class DruidConfig { 
        /** * 将自定义的 Druid 数据源添加到容器中，不再让 Spring Boot 自动创建 * 这样做的目的是：绑定全局配置文件中的 druid 数据源属性到 com.alibaba.druid.pool.DruidDataSource * 从而让它们生效 * * @return * @ConfigurationProperties(prefix = "spring.datasource")：作用就是将 全局配置文件中 前缀为 spring.datasource * 的属性值注入到 com.alibaba.druid.pool.DruidDataSource 的同名参数中 */
        @ConfigurationProperties(prefix = "spring.datasource")
        @Bean
        public DataSource druidDataSource() { 
            return new DruidDataSource();
        }
        /** * 配置 Druid 监控 之 管理后台的 Servlet * 内置 Servler 容器时没有web.xml 文件，所以使用 Spring Boot 的注册 Servlet 方式 */
        @Bean
        public ServletRegistrationBean statViewServlet() { 
            ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(),
                    "/druid/*");
     
            /** * loginUsername：Druid 后台管理界面的登录账号 * loginPassword：Druid 后台管理界面的登录密码 * allow：Druid 后台允许谁可以访问 * initParams.put("allow", "localhost")：表示只有本机可以访问 * initParams.put("allow", "")：为空或者为null时，表示允许所有访问 * deny：Druid 后台拒绝谁访问 * initParams.put("deny", "192.168.1.20");表示禁止此ip访问 */
            Map<String, String> initParams = new HashMap<>();
            initParams.put("loginUsername", "admin");
            initParams.put("loginPassword", "123456");
            initParams.put("allow", "");
            /*initParams.put("deny", "192.168.1.20");*/
     
            /** 设置初始化参数*/
            bean.setInitParameters(initParams);
            return bean;
        }
    }

1.  这些参数可以在`com.alibaba.druid.support.http.StatViewServlet`的父类 `com.alibaba.druid.support.http.ResourceServlet` 中找到
2.  运行应用，测试结果  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxODc3NzI4NzE1_size_16_color_FFFFFF_t_70]

### 2.配置 Druid web 监控 filter ###

1.  这个过滤器的作用就是统计 web 应用请求中所有的数据库信息，比如 发出的 sql 语句，sql 执行的时间、请求次数、请求的 url 地址、以及seesion 监控、数据库表的访问次数 等等。

import com.alibaba.druid.pool.DruidDataSource;
    import com.alibaba.druid.support.http.StatViewServlet;
    import com.alibaba.druid.support.http.WebStatFilter;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.boot.web.servlet.FilterRegistrationBean;
    import org.springframework.boot.web.servlet.ServletRegistrationBean;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import javax.sql.DataSource;
    import java.util.Arrays;
    import java.util.HashMap;
    import java.util.Map;
    /** * Created by Administrator on 2018/8/20 0020. * Druid 数据源配置类 */
    @Configuration
    public class DruidConfig { 
        /** * 将自定义的 Druid 数据源添加到容器中，不再让 Spring Boot 自动创建 * 这样做的目的是：绑定全局配置文件中的 druid 数据源属性到 com.alibaba.druid.pool.DruidDataSource * 从而让它们生效 * * @return * @ConfigurationProperties(prefix = "spring.datasource")：作用就是将 全局配置文件中 前缀为 spring.datasource * 的属性值注入到 com.alibaba.druid.pool.DruidDataSource 的同名参数中 */
        @ConfigurationProperties(prefix = "spring.datasource")
        @Bean
        public DataSource druidDataSource() { 
            return new DruidDataSource();
        }
        /** * 配置 Druid 监控 之 管理后台的 Servlet * 内置 Servler 容器时没有web.xml 文件，所以使用 Spring Boot 的注册 Servlet 方式 */
        @Bean
        public ServletRegistrationBean statViewServlet() { 
            ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(),
                    "/druid/*");
     
            /** * loginUsername：Druid 后台管理界面的登录账号 * loginPassword：Druid 后台管理界面的登录密码 * allow：Druid 后台允许谁可以访问 * initParams.put("allow", "localhost")：表示只有本机可以访问 * initParams.put("allow", "")：为空或者为null时，表示允许所有访问 * deny：Druid 后台拒绝谁访问 * initParams.put("deny", "192.168.1.20");表示禁止此ip访问 */
            Map<String, String> initParams = new HashMap<>();
            initParams.put("loginUsername", "admin");
            initParams.put("loginPassword", "123456");
            initParams.put("allow", "");
            /*initParams.put("deny", "192.168.1.20");*/
     
            /** 设置初始化参数*/
            bean.setInitParameters(initParams);
            return bean;
        }
        /** * 配置 Druid 监控 之 web 监控的 filter * WebStatFilter：用于配置Web和Druid数据源之间的管理关联监控统计 */
        @Bean
        public FilterRegistrationBean webStatFilter() { 
            FilterRegistrationBean bean = new FilterRegistrationBean();
            bean.setFilter(new WebStatFilter());
     
            /** exclusions：设置哪些请求进行过滤排除掉，从而不进行统计*/
            Map<String, String> initParams = new HashMap<>();
            initParams.put("exclusions", "*.js,*.css,/druid/*");
            bean.setInitParameters(initParams);
            
            /** "/*" 表示过滤所有请求*/
            bean.setUrlPatterns(Arrays.asList("/*"));
            return bean;
        }
    }

2、运行应用，可以往后台发一些请求，同时进行一些 数据库 sql 操作，测试结果效果如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxODc3NzI4NzE1_size_16_color_FFFFFF_t_70 1]  
**`注意： 数据连接池是在我们第一次请求数据库的时候进行初始化的(懒加载)。`**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxODc3NzI4NzE1_size_16_color_FFFFFF_t_70 2]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxODc3NzI4NzE1_size_16_color_FFFFFF_t_70]: /images/20221022/f64ed861ce0d460caf626d004d326c15.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxODc3NzI4NzE1_size_16_color_FFFFFF_t_70 1]: /images/20221022/4ff42c70792f438f949bcb69d1240bcc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxODc3NzI4NzE1_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20210401144919194.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxODc3NzI4NzE1,size_16,color_FFFFFF,t_70