SpringBoot-12-整合Druid

2020-03-31

字数统计: 2.3k字 | 阅读时长≈ 9分钟

SpringBoot-12-整合Druid

1. 简介

Java程序很大一部分要操作数据库，为了提高操作数据库时候的性能，又不得不适用数据库连接池。
Druid是阿里巴巴开源平台上的一个数据库连接池的实现，结合了C3P0，DBPC等优秀DB池的特点，同时又加入了日志监控的功能。
Druid已经在阿里巴巴部署了超过600个应用，经过一年多生产环境大规模部署的严苛考验。
Spring Boot 2.0 以上默认使用 Hikari数据源，可以说Hikari 与Driud都是当前Java Web 上最优秀的数据源，我们来重点介绍 Spring Boot 如何集成Druid 数据源，如何实现数据库监控。

注意：

之前我们的JDBC 整合使用的是Hikari数据源
- 现在是JDBC 整合了 Druid的数据源

Github地址：https://github.com/alibaba/druid/
Druid : 这个数据源最好的东西，就是有sql的后台监控日志，图形版本的

基本配置参数如下：yaml 中可以配置的选项

属性	说明	建议值
url	数据库的jdbc连接地址。一般为连接oracle/mysql。示例如下：
	mysql : jdbc:mysql://ip:port/dbname?option1&option2&…
	oracle : jdbc:oracle:thin:@ip:port:oracle_sid

username	登录数据库的用户名
password	登录数据库的用户密码
initialSize	启动程序时，在连接池中初始化多少个连接	10-50已足够
maxActive	连接池中最多支持多少个活动会话
maxWait	程序向连接池中请求连接时,超过maxWait的值后，认为本次请求失败，即连接池	100
	没有可用连接，单位毫秒，设置-1时表示无限等待
minEvictableIdleTimeMillis	池中某个连接的空闲时长达到 N 毫秒后, 连接池在下次检查空闲连接时，将	见说明部分
	回收该连接,要小于防火墙超时设置
	net.netfilter.nf_conntrack_tcp_timeout_established的设置
timeBetweenEvictionRunsMillis	检查空闲连接的频率，单位毫秒, 非正整数时表示不进行检查
keepAlive	程序没有close连接且空闲时长超过 minEvictableIdleTimeMillis,则会执	true
	行validationQuery指定的SQL,以保证该程序连接不会池kill掉,其范围不超
	过minIdle指定的连接个数。
minIdle	回收空闲连接时，将保证至少有minIdle个连接.	与initialSize相同
removeAbandoned	要求程序从池中get到连接后, N 秒后必须close,否则druid 会强制回收该	false,当发现程序有未
	连接,不管该连接中是活动还是空闲, 以防止进程不会进行close而霸占连接。	正常close连接时设置为true
removeAbandonedTimeout	设置druid 强制回收连接的时限，当程序从池中get到连接开始算起，超过此	应大于业务运行最长时间
	值后，druid将强制回收该连接，单位秒。
logAbandoned	当druid强制回收连接后，是否将stack trace 记录到日志中	true
testWhileIdle	当程序请求连接，池在分配连接时，是否先检查该连接是否有效。(高效)	true
validationQuery	检查池中的连接是否仍可用的 SQL 语句,drui会连接到数据库执行该SQL, 如果
	正常返回，则表示连接可用，否则表示连接不可用
testOnBorrow	程序申请连接时,进行连接有效性检查（低效，影响性能）	false
testOnReturn	程序返还连接时,进行连接有效性检查（低效，影响性能）	false
poolPreparedStatements	缓存通过以下两个方法发起的SQL:	true
	public PreparedStatement prepareStatement(String sql)
	public PreparedStatement prepareStatement(String sql,
	int resultSetType, int resultSetConcurrency)
maxPoolPrepareStatementPerConnectionSize	每个连接最多缓存多少个SQL	20
filters	这里配置的是插件,常用的插件有:	stat,wall,slf4j
	监控统计: filter:stat
	日志监控: filter:log4j 或者 slf4j
	防御SQL注入: filter:wall
connectProperties	连接属性。比如设置一些连接池统计方面的配置。
	druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
	比如设置一些数据库连接属性:

在Spring或者Spring Boot中的配置可参考下面博客：
- https://www.cnblogs.com/halberd-lee/p/11304790.html

2. SpringBoot 整合Druid

2.1 配置数据源

添加上Druid数据源依赖。

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

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

spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/springboot?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource # 自定义数据源

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

切换成功！既然切换成功，就可以设置数据源连接初始化大小、最大连接数、等待时间、最小连接数等设置项；可以查看源码(这个配置必须配有Config绑定才能生效)

spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource

    #Springboot 默认是不注入这些属性值的，需要自己绑定
    #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

导入log4j的依赖

<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

现在需要做的是自己为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();
    }

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

@SpringBootTest
class SpringbootDataJdbcApplicationTests {

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

    @Test
    public void contextLoads() throws SQLException {
        //1. 看一下默认数据源
        System.out.println(dataSource.getClass());
        //2. 获得JDBC连接
        Connection connection =   dataSource.getConnection();
        System.out.println(connection);

        DruidDataSource druidDataSource = (DruidDataSource) dataSource;
        System.out.println("druidDataSource 数据源最大连接数：" + druidDataSource.getMaxActive());
        System.out.println("druidDataSource 数据源初始化连接数：" + druidDataSource.getInitialSize());

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

2.2 配置数据源监控

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

@Configuration
public class DruidConfig{下面代码都应在这个类中}

//1. 配置 Druid 监控管理后台的Servlet；
//		1.1 内置 Servlet 容器时没有web.xml文件，所以使用 Spring Boot 的注册 Servlet的替代方式
@Bean
public ServletRegistrationBean statViewServlet() {
  	// 1.1 配置后台视图映射
    ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");

    // 这些参数可以在 com.alibaba.druid.support.http.StatViewServlet 
    // 的父类 com.alibaba.druid.support.http.ResourceServlet 中找到
  	// 2. 设置后台管理参数
    Map<String, String> initParams = new HashMap<>();
    initParams.put("loginUsername", "admin");           //后台管理界面的登录账号（loginUsername）不能改
    initParams.put("loginPassword", "123456");          //后台管理界面的登录密码（loginPassword）不能改

    // 3. 后台允许谁可以访问
    //initParams.put("allow", "localhost")：表示只有本机可以访问
    //initParams.put("allow", "")：为空或者为null时，表示允许所有访问
    initParams.put("allow", "");						           // 所有人可以访问
    //deny：Druid 后台拒绝谁访问
    //initParams.put("zhuuu", "192.168.1.20");     // 表示禁止此ip访问

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

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

sql 日志
- 可以查看sql 的黑白名单

2.3 配置过滤器

Druid web 监控 filter 过滤器:WebStatFilter

@Configuration
public class DuridConfig{
  下面的代码全在这个类中
}

//1. 配置 Druid 监控 之  web 监控的 filter
//   1.1 WebStatFilter：用于配置Web和Druid数据源之间的管理关联监控统计
@Bean
public FilterRegistrationBean webStatFilter() {
  	// 1. 创建出Web 监控Filter
    FilterRegistrationBean bean = new FilterRegistrationBean();
    bean.setFilter(new WebStatFilter());

    // 2. exclusions：设置哪些请求进行过滤排除掉，从而不进行统计
    Map<String, String> initParams = new HashMap<>();
    initParams.put("exclusions", "*.js,*.css,/druid/*,/jdbc/*");
    bean.setInitParameters(initParams);

    // 3. "/*" 表示过滤所有请求
    bean.setUrlPatterns(Arrays.asList("/*"));
    // 4. 返回这个Bean
  	return bean;
}

打赏

版权声明： 本博客所有文章除特别声明外，均采用 Apache License 2.0 许可协议。转载请注明出处！

SpringBoot-12-整合Druid

1. 简介

2. SpringBoot 整合Druid

2.1 配置 数据源

2.2 配置 数据源监控

2.3 配置 过滤器

2.1 配置数据源

2.2 配置数据源监控

2.3 配置过滤器