【WEEK12】【DAY2】整合Druid数据源【中文版】

2024.5.14 Tuesday

12.整合Druid数据源
- 12.1.Druid简介
- 12.2.配置数据源
- - 12.2.1.添加Druid数据源依赖
  - 12.2.2.切换数据源
  - 12.2.3.运行Springboot04DataApplicationTests.java
  - 12.2.4.尝试使用Druid数据源的专有配置
  - 12.2.5.导入Log4j 的依赖
  - 12.2.6.新建config文件夹
  - 12.2.7.修改测试类并运行检查配置参数是否生效
- 12.3.配置Druid数据源监控
- - 12.3.1.修改DruidConfig.java
  - 12.3.2.重启并访问http://localhost:8080/druid
  - 12.3.3.配置Druid web监控filter过滤器

12.整合Druid数据源

12.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 基本配置参数如下：
在这里插入图片描述

12.2.配置数据源

12.2.1.添加Druid数据源依赖

https://mvnrepository.com/artifact/com.alibaba/druid/1.1.21
在这里插入图片描述
修改pom.xml，在dependencies中添加这段依赖

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.13</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.example</groupId><artifactId>springboot-04-data</artifactId><version>0.0.1-SNAPSHOT</version><name>springboot-04-data</name><description>springboot-04-data</description><properties><java.version>8</java.version></properties><dependencies><!--Druid--><!-- https://mvnrepository.com/artifact/com.alibaba/druid --><dependency><groupId>com.alibaba</groupId><artifactId>druid</artifactId><version>1.1.21</version></dependency><!--JDBC--><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><!--MySQL--><dependency><groupId>com.mysql</groupId><artifactId>mysql-connector-j</artifactId><scope>runtime</scope></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

重启maven进行下载，可以点开源码查看
在这里插入图片描述

12.2.2.切换数据源

修改application.yaml

spring:datasource:username: rootpassword: 123456#假如时区报错，就增加一个时区的配置，和其他配置用&连接，如：serverTimezone=UTCurl: jdbc:mysql://localhost:3306/p37jdbc?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8driver-class-name: com.mysql.cj.jdbc.Drivertype: com.alibaba.druid.pool.DruidDataSource

12.2.3.运行Springboot04DataApplicationTests.java

此时默认数据源已经改变，但是数据库底层仍然是JDBC：
在这里插入图片描述

12.2.4.尝试使用Druid数据源的专有配置

修改修改application.yaml

spring:datasource:username: rootpassword: 123456#假如时区报错，就增加一个时区的配置，和其他配置用&连接，如：serverTimezone=UTCurl: jdbc:mysql://localhost:3306/p37jdbc?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8driver-class-name: com.mysql.cj.jdbc.Drivertype: com.alibaba.druid.pool.DruidDataSource#Spring Boot 默认是不注入这些属性值的，需要自己绑定#druid 数据源专有配置initialSize: 5minIdle: 5maxActive: 20maxWait: 60000timeBetweenEvictionRunsMillis: 60000minEvictableIdleTimeMillis: 300000validationQuery: SELECT 1 FROM DUALtestWhileIdle: truetestOnBorrow: falsetestOnReturn: falsepoolPreparedStatements: true#配置监控统计拦截的filters，stat:监控统计; log4j：日志记录; wall：防御sql注入#如果允许时报错  java.lang.ClassNotFoundException: org.apache.log4j.Priority#则导入 log4j 依赖即可，Maven 地址：https://mvnrepository.com/artifact/log4j/log4jfilters: stat,wall,log4jmaxPoolPreparedStatementPerConnectionSize: 20useGlobalDataSourceStat: trueconnectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

12.2.5.导入Log4j 的依赖

在pom.xml中添加依赖

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

12.2.6.新建config文件夹

现在需要程序员自己为 DruidDataSource 绑定全局配置文件中的参数，再添加到容器中，而不再使用 Spring Boot 的自动生成了；我们需要自己添加 DruidDataSource 组件到容器中，并绑定属性；
新建DruidConfig.java
在这里插入图片描述

package com.P31.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;@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")  //绑定@Beanpublic DataSource druidDataSource(){return new DruidDataSource();}
}

12.2.7.修改测试类并运行检查配置参数是否生效

Springboot04DataApplicationTests.java

package com.P31;import com.alibaba.druid.pool.DruidDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;@SpringBootTest
class Springboot04DataApplicationTests {@AutowiredDataSource dataSource;@Testvoid 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();}}

在这里插入图片描述

12.3.配置Druid数据源监控

Druid数据源具有监控的功能，而且提供了一个web页面便于查看。

12.3.1.修改DruidConfig.java

package com.P31.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.util.HashMap;@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")  //绑定@Beanpublic DataSource druidDataSource(){return new DruidDataSource();}//后台监控//配置 Druid 监控管理后台的Servlet；//因为SpringBoot内置了Servlet容器，所以没有web.xml文件，所以使用Spring Boot的注册Servlet方式（ServletRegistrationBean）@Beanpublic ServletRegistrationBean statViewServlet(){ServletRegistrationBean<StatViewServlet> bean = new ServletRegistrationBean<>(new StatViewServlet(),"/druid/*");//后台需要有人登录，账号密码配置//点开setInitParameters查看源码，可以看到他需要的参数：public void setInitParameters(Map<String, String> initParameters)HashMap<String,String> initParameters = new HashMap<>();//这些参数可以在 com.alibaba.druid.support.http.StatViewServlet的父类 com.alibaba.druid.support.http.ResourceServlet 中找到//增加配置//loginUsername loginPassword是固定参数initParameters.put("loginUsername","admin");    //后台管理界面的登录账号initParameters.put("loginPassword","123456");   //后台管理界面的登录密码//允许可以访问的用户initParameters.put("allow",""); //为空则所有人都可以访问//initParams.put("allow", "localhost")：表示只有本机可以访问//initParams.put("allow", "")：为空或者为null时，表示允许所有访//禁止访问的用户//deny：Druid 后台拒绝谁访问//initParams.put("kuangshen", "192.168.1.20");表示禁止此ip访问bean.setInitParameters(initParameters);   //设置初始化参数return bean;}
}

12.3.2.重启并访问http://localhost:8080/druid

将自动跳转到http://localhost:8080/druid/login.html
在这里插入图片描述
登录参数错误：

成功登录：

跳转到：

运行http://localhost:8080/userList，点击导航栏中的“SQL监控”可见：

也可查看SQL防火墙：
在这里插入图片描述

12.3.3.配置Druid web监控filter过滤器

package com.P31.config;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;@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")  //绑定@Beanpublic DataSource druidDataSource(){return new DruidDataSource();}//后台监控//配置 Druid 监控管理后台的Servlet；//因为SpringBoot内置了Servlet容器，所以没有web.xml文件，所以使用Spring Boot的注册Servlet方式（ServletRegistrationBean）@Beanpublic ServletRegistrationBean statViewServlet(){ServletRegistrationBean<StatViewServlet> bean = new ServletRegistrationBean<>(new StatViewServlet(),"/druid/*");//后台需要有人登录，账号密码配置//点开setInitParameters查看源码，可以看到他需要的参数：public void setInitParameters(Map<String, String> initParameters)HashMap<String,String> initParameters = new HashMap<>();//这些参数可以在 com.alibaba.druid.support.http.StatViewServlet的父类 com.alibaba.druid.support.http.ResourceServlet 中找到//增加配置//loginUsername loginPassword是固定参数initParameters.put("loginUsername","admin");    //后台管理界面的登录账号initParameters.put("loginPassword","123456");   //后台管理界面的登录密码//允许可以访问的用户initParameters.put("allow",""); //为空则所有人都可以访问//initParams.put("allow", "localhost")：表示只有本机可以访问//initParams.put("allow", "")：为空或者为null时，表示允许所有访//禁止访问的用户//deny：Druid 后台拒绝谁访问//initParams.put("kuangshen", "192.168.1.20");表示禁止此ip访问bean.setInitParameters(initParameters);   //设置初始化参数return bean;}//filter//配置 Druid 监控 之  web 监控的 filter//WebStatFilter：用于配置Web和Druid数据源之间的管理关联监控统计@Beanpublic FilterRegistrationBean webStatFilter(){FilterRegistrationBean bean = new FilterRegistrationBean();bean.setFilter(new WebStatFilter());//exclusions：设置哪些请求被过滤（排除）->不进行统计Map<String,String> initParameters = new HashMap<>();initParameters.put("exclusions","*.js,*.css,/druid/*,/jdbc/*");bean.setInitParameters(initParameters);//"/*" 表示过滤所有请求bean.setUrlPatterns(Arrays.asList("/*"));return bean;}
}