Skip to content

10.2 整合 Druid 数据源

10.2.1Druid 简介

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 基本配置参数如下:

10.2.2 配置数据源

1、添加上 Druid 数据源依赖

xml
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.21</version>
</dependency>

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

java
spring:
  datasource:
    username: root
    password: "000000"
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT%2B8&useSSL=false&useUnicode=true&characterEncoding=UTF-8&allowPublicKeyRetrieval=true
    type: com.alibaba.druid.pool.DruidDataSource

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

image-20220711043557994

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

==在 application.yaml 中添加如下代码:==

yaml
#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

这些配置是核心:

image-20220711043942855

5.看到需要用到 log4j,所以需要在 pom 中==导入 log4j 的依赖==

xml
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

最好再增加一个 log4j.properties,放在 resources 根文件夹下:

properties
log4j.rootLogger=DEBUG, stdout
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =  %d{yyyy-MM-dd HH:mm:ss.SSS}[%-5p] method:%l%n%m%n

6、现在==需要程序员自己为 DruidDataSource 类 绑定全局配置文件中的参数(没有自动配置了)==,再添加到容器中,而不再使用 Spring Boot 自动生成的 Hikari 了;我们需要 自己添加 DruidDataSource 组件到容器中,并绑定属性;

我们自己在 config 文件夹下新建文件 DruidConfig.java

java
@Configuration
public class DruidConfig {
    /*
       将自定义的 Druid数据源添加到容器中,不再让 Spring Boot 自动创建
       绑定全局配置文件中的 druid 数据源属性到 com.alibaba.druid.pool.DruidDataSource从而让它们生效
       @ConfigurationProperties(prefix = "spring.datasource"):作用就是将 全局配置文件application.yaml中
       前缀为 spring.datasource的属性值注入到 com.alibaba.druid.pool.DruidDataSource 的同名参数中
     */
    @ConfigurationProperties(prefix = "spring.datasource")
    @Bean //注入到IOC容器中
    public DataSource druidDataSource() {

        return new DruidDataSource();
    }


}

7、去测试类中测试一下;看是否成功!

java
@SpringBootTest
class SpringbootDataJdbcApplicationTests {

    //DI注入数据源
    @Autowired
    DataSource dataSource;

    @Test
    public void contextLoads() throws SQLException {

        //看一下默认数据源
        System.out.println(dataSource.getClass());
        //获得连接
        Connection connection = dataSource.getConnection();
        System.out.println(connection);

        DruidDataSource druidDataSource = (DruidDataSource) dataSource; //改变类型为Druid
        System.out.println("druidDataSource 数据源最大连接数:" + druidDataSource.getMaxActive());
        System.out.println("druidDataSource 数据源初始化连接数:" + druidDataSource.getInitialSize());

        //关闭连接
        connection.close();
    }
}

img

完整的 druid 在 yml 中的配置:

yml
spring:
  datasource:
    username: root
    password: "123456"
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=GMT%2B8&useSSL=false&useUnicode=true&characterEncoding=UTF-8&allowPublicKeyRetrieval=true
    type: com.alibaba.druid.pool.DruidDataSource

    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

10.2.3 配置 Druid 后台监控

在 DruidConfig.java 中添加:基本都是死配置!

java
//配置 Druid 监控管理后台的Servlet!
//内置 Servlet 容器时没有web.xml文件,所以使用 Spring Boot 提供的注册 Servlet 的方式:ServletRegistrationBean
@Bean
public ServletRegistrationBean viewServlet() {

    //只要访问这个链接,就会进入后台监控页面!这个页面是帮我们写好的!
    ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");

    Map<String, String> initParams = new HashMap<>();
    //管理员账号密码配置
    initParams.put("loginUsername", "admin"); //后台管理界面的登录账号
    initParams.put("loginPassword", "123456"); //后台管理界面的登录密码

    //设置访问权限
    //allow:后台允许谁可以访问
    //initParams.put("allow", "localhost"):表示只有本机可以访问
    //initParams.put("allow", ""):为空或者为null时,表示允许所有访问
    initParams.put("allow", "");
    //deny:后台拒绝谁可以访问,名字我们自定义
    //initParams.put("kuangshen", "192.168.1.20");表示禁止此ip访问

    //设置初始化参数
    // 这些参数可以在 com.alibaba.druid.support.http.StatViewServlet
    // 的父类 com.alibaba.druid.support.http.ResourceServlet 中找到
    bean.setInitParameters(initParams);
    return bean;
}

配置完毕后,我们可以选择访问 :localhost:8080/druid/login.html,只要是/durid/都可以,默认跳转到 login.html 页面

image-20220711045939554

在访问 localhost:8080/userList 后:

image-20220711050334365

10.2.4 配置 Druid 后台监控 filter 过滤器

在 DruidConfig.java 中添加:基本都是死配置!

意义:就是哪些资源不进行后台统计!

java
//配置 Druid 监控 之  web 监控的 filter :类似地用FilterRegistrationBean注册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;
}

注意点:==DruidConfig 文件==一定要添加配置注解,==在里面配置的一些 servlet 和 filter 都要添加@Bean 注解==