13Spring Boot整合第三方Druid数据源(自定义整合Druid了解)

ゝ一世哀愁。 2024-04-06 14:10 108阅读 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

**本章只介绍 自定义整合 Druid，下一章介绍通过 starter 整合 Druid 。**

### 通过自定义方式 整合 Druid ###

自定义整合 Druid 是指：根据 [Druid 官方文档][Druid]和自身的需求，通过手动创建 Druid 数据源的方式，将 Druid 整合到 Spring Boot 中。

#### 1. 引入 Druid 依赖 ####

在项目的 pom.xml 中引入 Druid 的依赖（dependency ），即可将 Druid 导入到 Spring Boot 项目中。添加以下依赖，引入 JDBC 场景启动器、MySql 数据库驱动 和 Druid 依赖。

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jdbc</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.2.6</version>
    </dependency>

#### 2. 创建数据源 ####

我们知道，Spring Boot 使用 HikariCP 作为其默认数据源，当容器中没有 DataSource（数据源类）时，Spring Boot 才会使用 HikariCP 作为其默认数据源。 也就是说，若我们向容器中添加 Druid 数据源类（DruidDataSource，继承自 DataSource）的对象时，Spring Boot 就会使用 Druid 作为其数据源，而不再使用 HikariCP。如下图。

![5302e666f4b54b08822e67eb8fab63af.png][]

**创建数据源配置类**

可以使用配置类来创数据源，此配置类向IOC容器中添加了 Druid 数据源对象。

我们一般不建议使用下面方式 将数据源属性**硬编码**到代码中：  
druidDataSource.setUrl("jdbc:mysql://127.0.0.1:3306/tyut");  
druidDataSource.setUsername("root");  
druidDataSource.setPassword("root");  
druidDataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");  
建议使用**注解**@ConfigurationProperties与**配置文件**进行绑定，此注解将application.yml配置文件中spring.datasource 开头的配置与数据源中的属性进行绑定。代码如下：

package cn.edu.tyut.springboot.config;
    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;
    import java.sql.SQLException;
    
    @Configuration
    public class DataSourceConfig {
        /** 
         * 使用此配置类向容器中添加了 Druid 数据源对象。
         * 
         * 我们一般不建议使用下面方式 将数据源属性硬编码到代码中
         *   druidDataSource.setUrl("jdbc:mysql://127.0.0.1:3306/tyut");
         *   druidDataSource.setUsername("root");
         *   druidDataSource.setPassword("root");
         *   druidDataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
         * 建议使用注解@ConfigurationProperties与配置文件中进行绑定
         * 它将配置文件中 spring.datasource 开头的配置与数据源中的属性进行绑定
         * 
         */
        @ConfigurationProperties("spring.datasource")
        @Bean
        public DataSource dataSource() throws SQLException {
            DruidDataSource druidDataSource = new DruidDataSource();
            return druidDataSource;
        }
    }

**配置数据源**

在配置文件 application.yml 中添加以下数据源配置，它们会与与 Druid 数据源中的属性进行绑定，代码如下。

#数据源连接信息
    spring:
      datasource:
        username: root
        password: root
        url: jdbc:mysql://127.0.0.1:3306/bianchengbang_jdbc
        driver-class-name: com.mysql.cj.jdbc.Driver

> 至此，我们就已经将数据源从 HikariCP 切换到了 Druid 了
> 
> 注：配置类创建 Druid 数据源对象时，应该尽量避免将数据源信息（例如 url、username 和 password 等）硬编码到代码中，而应该通过 @ConfigurationProperties("spring.datasource") 注解，将 Druid 数据源对象的属性与配置文件中的以“spring.datasource”开头的配置进行绑定。

import org.junit.jupiter.api.Test;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.jdbc.core.JdbcTemplate;
    import javax.sql.DataSource;
    import java.sql.SQLException;
    @SpringBootTest
    class TyutSpringbootApplicationTests{
        //数据源组件
        @Autowired
        DataSource dataSource;
        //用于访问数据库的组件
        @Autowired
        JdbcTemplate jdbcTemplate;
        @Test
        void contextLoads() throws SQLException {
            System.out.println("默认数据源为：" + dataSource.getClass());
            System.out.println("数据库连接实例：" + dataSource.getConnection());
            //访问数据库
            Integer i = jdbcTemplate.queryForObject("SELECT count(*) from `user`", Integer.class);
            System.out.println("user 表中共有" + i + "条数据。");
        }
    }

#### 3. 开启 Druid 内置监控页面 ####

Druid 内置提供了一个名为 StatViewServlet 的 Servlet，这个 Servlet 可以开启 Druid 的内置监控页面功能， 展示 Druid 的统计信息，它的主要用途如下：

*  提供监控信息展示的 html 页面
 *  提供监控信息的 JSON API

> 注意：使用 StatViewServlet，建议使用 Druid 0.2.6 以上版本。

根据 [Druid 官方文档-配置\_StatViewServlet 配置][Druid _-_StatViewServlet]，StatViewServlet 是一个标准的 javax.servlet.http.HttpServlet，想要开启 Druid 的内置监控页面，需要将该 Servlet 配置在 Web 应用中的 WEB-INF/web.xml 中，web.xml 中配置如下。

<servlet>
        <servlet-name>DruidStatView</servlet-name>
        <servlet-class>com.alibaba.druid.support.http.StatViewServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>DruidStatView</servlet-name>
        <url-pattern>/druid/*</url-pattern>
    </servlet-mapping>

但Spring Boot 项目中是没有 WEB-INF/web.xml 的，因此我们可以 自定义一个类继承StatViewServlet，在自定义的类上使用注解，且在启动类上使用@ServletComponentScan。（不推荐）

自定义类
    package cn.edu.tyut.springboot.config;
    import com.alibaba.druid.support.http.StatViewServlet;
    import javax.servlet.annotation.WebServlet;
    
    @WebServlet(name = "myDruidStatView", urlPatterns = "/durid/*")
    public class MyDruidStatView extends StatViewServlet {
    }
    
    启动类
    @ServletComponentScan
    @SpringBootTest
    class TyutSpringbootApplicationTests {

**推荐方式：**我们可以在自定义配置类DataSourceConfig中，通过 ServletRegistrationBean 将 StatViewServlet 注册到容器中，来开启 Druid 的内置监控页面。

package cn.edu.tyut.springboot.config;
    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.sql.SQLException;
    
    @Configuration
    public class DataSourceConfig {
        /**
         * 使用此配置类向容器中添加了 Druid 数据源对象。
         *
         * 我们一般不建议使用下面方式 将数据源属性硬编码到代码中
         *   druidDataSource.setUrl("jdbc:mysql://127.0.0.1:3306/tyut");
         *   druidDataSource.setUsername("root");
         *   druidDataSource.setPassword("root");
         *   druidDataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
         * 建议使用注解@ConfigurationProperties与配置文件中进行绑定
         * 它将配置文件中 spring.datasource 开头的配置与数据源中的属性进行绑定
         *
         */
        @ConfigurationProperties("spring.datasource")
        @Bean
        public DataSource dataSource() throws SQLException {
            DruidDataSource druidDataSource = new DruidDataSource();
            return druidDataSource;
        }
    
        /**
         * 开启 Druid 数据源内置监控页面
         *
         * @return
         */
        @Bean
        public ServletRegistrationBean statViewServlet() {
            StatViewServlet statViewServlet = new StatViewServlet();
            //向容器中注入 StatViewServlet，并将其路径映射设置为 /druid/*
            ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(statViewServlet, "/druid/*");
            //配置监控页面访问的账号和密码（选配）
            servletRegistrationBean.addInitParameter("loginUsername", "admin");
            servletRegistrationBean.addInitParameter("loginPassword", "123456");
            return servletRegistrationBean;
        }
    }

启动 Spring Boot，浏览器访问“http://localhost:8080/druid”，即可访问 Druid 的内置监控页面的登陆页，结果如下。

![ebbd2ed5503149b7bfc32706044d96ea.png][]

在登陆页输入框内，分别输入自定义的用户名（loginUsername）和密码（loginPassword），如下图。

![755bb0ebcf054dc5b2ea998798bb4384.png][]

#### 4. 开启 SQL 监控 ####

Druid 内置提供了一个 StatFilter，通过它可以开启 Druid 的 SQL 监控功能，对 SQL 进行监控。StatFilter 的别名是 stat，这个别名的映射配置信息保存在 druid-xxx.jar!/META-INF/druid-filter.properties 中。[Druid 官方文档-配置\_StatFilter ][Druid _-_StatFilter]中给出了在 Spring 中配置该别名（stat）开启 Druid SQL 监控的方式，配置如下。

根据以上配置我们可以看出，只要自定义配置类DataSourceConfig中 dataSource 的 Bean 中添加一个取值为“stat”的“filters”属性，就能开启 Druid SQL 监控，因此我们只要将该配置转换为在配置类中进行即可，代码如下。

@ConfigurationProperties("spring.datasource")
    @Bean
    public DataSource dataSource() throws SQLException {
        DruidDataSource druidDataSource = new DruidDataSource();
        //设置 filters 属性值为 stat，开启 SQL 监控
        druidDataSource.setFilters("stat");
        return druidDataSource; 
    }

执行下面代码进行测试，并访问 Druid 的内置监控页面，切换到 SQL 监控模块，可以看到 Druid SQL 监控已经开启。

![8a15b85305304df981e4542c505a339f.png][]

#### 5. 开启防火墙 ####

Druid 内置提供了一个 WallFilter，使用它可以开启防火墙功能，防御 SQL 注入攻击。  
WallFilter 的别名是 wall，这个别名映射配置信息保存在 druid-xxx.jar!/META-INF/druid-filter.properties 中。[Druid 官方文档-配置 wallfilter][Druid _-_ wallfilter] 中给出了在 Spring 中使用该别名（wall）开启防火墙的方式，配置如下。

WallFilter 可以结合其他 Filter 一起使用，例如：

根据以上配置我们可以看出，只要在 dataSource 的 Bean 中添加一个取值为“wall”的“filters”属性，就能开启 Druid 的防火墙功能，因此我们只需要在配置类中为 dataSource 的 filters 属性再添加一个“wall”即可（多个属性值之间使用逗号“，”隔开），代码如下。

@ConfigurationProperties("spring.datasource")
    @Bean
    public DataSource dataSource() throws SQLException {
        DruidDataSource druidDataSource = new DruidDataSource();
        //同时开启 sql 监控(stat) 和防火墙(wall)，中间用逗号隔开。
        //开启防火墙能够防御 SQL 注入攻击
        druidDataSource.setFilters("stat,wall");
        return druidDataSource;
    }

执行下面代码进行测试，并访问 Druid 的内置监控页面，切换到 SQL 监控模块，可以看到 Druid SQL 监控已经开启。

![c7f9722d8d4f4a5ab1985843eeecaaf3.png][]

#### 6. 开启 Web-JDBC 关联监控 ####

Druid 还内置提供了一个名为 WebStatFilter 的过滤器，它可以用来监控与采集 web-jdbc 关联监控的数据。  
  
根据 [Druid 官方文档-配置\_配置WebStatFilter][Druid _-_WebStatFilter]，想要开启 Druid 的 Web-JDBC 关联监控，只需要将 WebStatFilter 配置在 Web 应用中的 WEB-INF/web.xml 中即可，web.xml 配置如下。

<filter>
        <filter-name>DruidWebStatFilter</filter-name>
        <filter-class>com.alibaba.druid.support.http.WebStatFilter</filter-class>
        <init-param>
            <param-name>exclusions</param-name>
            <param-value>*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>DruidWebStatFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

Spring Boot 项目中是没有 WEB-INF/web.xml 的，但是我们可以在配置类中，通过 [FilterRegistrationBean][] 将 WebStatFilter 注入到容器中，来开启 Druid 的 Web-JDBC 关联监控。

配置类中示例代码如下。

/**
    * 向容器中添加 WebStatFilter
    * 开启内置监控中的 Web-jdbc 关联监控的数据
    * @return
    */
    @Bean
    public FilterRegistrationBean druidWebStatFilter() {
        WebStatFilter webStatFilter = new WebStatFilter();
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(webStatFilter);
        // 监控所有的访问
        filterRegistrationBean.setUrlPatterns(Arrays.asList("/*"));
        // 监控访问不包括以下路径
        filterRegistrationBean.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*");
        return filterRegistrationBean;
    }

执行下面代码进行测试，并访问 Druid 的内置监控页面，切换到 SQL 监控模块，可以看到 Druid SQL 监控已经开启。

![c5597a38dfeb49b5886bd277bf653f1a.png][]

与此同时，URI 监控和 Session 监控也都被开启，如下图。

![d1a241de75ed445eba852af72e7ce156.png][]

##  ##

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

[14Spring Boot整合第三方Druid数据源(通过starter整合 Druid )\_爱吃面的猫的博客-CSDN博客][14Spring Boot_Druid_starter_ Druid]

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

[15Spring Boot整合MyBatis\_爱吃面的猫的博客-CSDN博客][15Spring Boot_MyBatis]

[Druid]: https://github.com/alibaba/druid/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98
[5302e666f4b54b08822e67eb8fab63af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/90d6a86c3e0e47a5b98e20eb74f2e641.png
[Druid _-_StatViewServlet]: http://github.com/alibaba/druid/wiki/%E9%85%8D%E7%BD%AE_StatViewServlet%E9%85%8D%E7%BD%AE
[ebbd2ed5503149b7bfc32706044d96ea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/a005225e2e97493c8988cfdb25590e9a.png
[755bb0ebcf054dc5b2ea998798bb4384.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/7b5a8b42ab754d5298e1bd144ede3302.png
[Druid _-_StatFilter]: https://github.com/alibaba/druid/wiki/%E9%85%8D%E7%BD%AE_StatFilter
[8a15b85305304df981e4542c505a339f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/ab52298b7e8947a5b2045b21fe1a2296.png
[Druid _-_ wallfilter]: https://github.com/alibaba/druid/wiki/%E9%85%8D%E7%BD%AE-wallfilter
[c7f9722d8d4f4a5ab1985843eeecaaf3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/c996476eb1cb41df9cba09eb2b90dc10.png
[Druid _-_WebStatFilter]: http://github.com/alibaba/druid/wiki/%E9%85%8D%E7%BD%AE_%E9%85%8D%E7%BD%AEWebStatFilter
[FilterRegistrationBean]: http://c.biancheng.net/spring_boot/servlet-filter-listener.html
[c5597a38dfeb49b5886bd277bf653f1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/4d7ddd06c8244a6dae06822869faaee8.png
[d1a241de75ed445eba852af72e7ce156.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/c2169c9fcfaf4bc1aca66d616ef6abed.png
[14Spring Boot_Druid_starter_ Druid]: https://blog.csdn.net/qq_41946216/article/details/127095367?spm=1001.2014.3001.5502
[15Spring Boot_MyBatis]: https://blog.csdn.net/qq_41946216/article/details/127100048?spm=1001.2014.3001.5502