SpringBoot:spring boot使用Druid和监控配置

Posted jeremy2001

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot:spring boot使用Druid和监控配置相关的知识，希望对你有一定的参考价值。

Druid是Java语言中最好的数据库连接池，并且能够提供强大的监控和扩展功能。

Spring Boot默认的数据源是：org.apache.tomcat.jdbc.pool.DataSource

业界把 Druid 和 HikariCP 做对比后，虽说 HikariCP 的性能比 Druid 高，但是因为 Druid 包括很多维度的统计和分析功能，所以这也是大家都选择使用它的原因。

下面来说明如何在 spring Boot 中配置使用Druid

整体步骤：

(1)    ——   Druid简单介绍，具体看官网；

(2)     —— 在pom.xml配置druid依赖包；

(3)    ——  配置application.properties加入数据库源类型等参数；

(4)     —— 编写druid servlet和filter提供监控页面访问；

(5)     —— 输入地址进行测试； 

(1)添加Maven依赖 (或jar包)

1
2
3
4
5
<dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.0.18</version>
</dependency>

(2)、配置数据源相关信息

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 数据库访问配置
# 主数据源，默认的
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=123456
  
# 下面为连接池的补充设置，应用到上面所有数据源中
# 初始化大小，最小，最大
spring.datasource.initialSize=5
spring.datasource.minIdle=5
spring.datasource.maxActive=20
# 配置获取连接等待超时的时间
spring.datasource.maxWait=60000
# 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
spring.datasource.timeBetweenEvictionRunsMillis=60000
# 配置一个连接在池中最小生存的时间，单位是毫秒
spring.datasource.minEvictableIdleTimeMillis=300000
spring.datasource.validationQuery=SELECT 1 FROM DUAL
spring.datasource.testWhileIdle=true
spring.datasource.testOnBorrow=false
spring.datasource.testOnReturn=false
# 打开PSCache，并且指定每个连接上PSCache的大小
spring.datasource.poolPreparedStatements=true
spring.datasource.maxPoolPreparedStatementPerConnectionSize=20
# 配置监控统计拦截的filters，去掉后监控界面sql无法统计，‘wall‘用于防火墙
spring.datasource.filters=stat,wall,log4j
# 通过connectProperties属性来打开mergeSql功能；慢SQL记录
spring.datasource.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
# 合并多个DruidDataSource的监控数据
#spring.datasource.useGlobalDataSourceStat=true

需要注意的是：spring.datasource.type旧的spring boot版本是不能识别的

后话1（更新于2016年8月20日）：很抱歉的是新版本也废弃了这个属性，配置完之后启动就会报错，所以现在知道的情况是1.2版本不支持，1.3版本支持，1.4版本不支持。具体信息可以看链接：http://stackoverflow.com/questions/39032368/not-able-to-set-spring-datasource-type-in-spring-boot-1-4 ）

后话2（更新于2016年9月24日）：spring boot 1.4.1重新支持了spring.datasource.type属性，从1.4.0的启动报异常到1.4.1支持，个人觉得这个应该是官方在升级的时候，影响到了spring.datasource.type属性的使用。不管怎么样，希望spring boot做的越来越好。

这时候启动应用就可以看到看到打印信息就是使用我们配置的数据源了：

[main] com.alibaba.druid.pool.DruidDataSource   : dataSource-1 inited

(3) 配置监控统计功能

配置Servlet

如下是在SpringBoot项目中基于注解的配置，如果是web.xml配置，按规则配置即可。

com.kfit.base.servlet.DruidStatViewServlet :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package com.kfit.base.servlet;
  
import javax.servlet.annotation.WebInitParam;
import javax.servlet.annotation.WebServlet;
  
import com.alibaba.druid.support.http.StatViewServlet;
  
/**
 * druid数据源状态监控.
 * @author Administrator
 *
 */
  
@WebServlet(urlPatterns="/druid/*",
           initParams=
                   @WebInitParam(name="allow",value="192.168.1.72,127.0.0.1"),// IP白名单(没有配置或者为空，则允许所有访问)
                    @WebInitParam(name="deny",value="192.168.1.73"),// IP黑名单 (存在共同时，deny优先于allow)
                    @WebInitParam(name="loginUsername",value="admin"),// 用户名
                    @WebInitParam(name="loginPassword",value="123456"),// 密码
                    @WebInitParam(name="resetEnable",value="false")// 禁用html页面上的“Reset All”功能
           
)
public class DruidStatViewServlet extends StatViewServlet
    privatestaticfinallongserialVersionUID = 1L;
    

 

配置Filter

com.kfit.base.servlet.DruidStatFilter :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.kfit.base.servlet;
  
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;
  
import com.alibaba.druid.support.http.WebStatFilter;
  
/**
 * druid过滤器.
 * @author Administrator
 *
 */
@WebFilter(filterName="druidWebStatFilter",urlPatterns="/*",
    initParams=
            @WebInitParam(name="exclusions",value="*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*")//忽略资源
     
)
public class DruidStatFilter extends WebStatFilter
  

最后在App.java类上加上注解：@ServletComponentScan是的spring能够扫描到我们自己编写的servlet和filter。

注意不要忘记在 SpringBootSampleApplication.java 上添加 @ServletComponentScan 注解，不然就是404了。

然后启动项目后访问 http://127.0.0.1:8080/druid/index.html 即可查看数据源及SQL统计等。 

(4)配置监控系统方式二：

以上配置的监控方式是使用了原生的servlet，filter方式，然后通过@ServletComponentScan进行启动扫描包的方式进行处理的，你会发现我们的servlet，filter根本没有任何的编码。

在这里我们将使用另外一种方式进行处理：使用代码注册Servlet：

编写类：com.kfit.base.servlet.DruidConfiguration ：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
package com.kfit.base.servlet;
  
import org.springframework.boot.context.embedded.FilterRegistrationBean;
import org.springframework.boot.context.embedded.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
  
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;
  
/**
 * druid 配置.
 *
 * 这样的方式不需要添加注解：@ServletComponentScan
 * @author Administrator
 *
 */
@Configuration
public class DruidConfiguration 
    
    /**
     * 注册一个StatViewServlet
     * @return
     */
    @Bean
    public ServletRegistrationBean DruidStatViewServle2()
       //org.springframework.boot.context.embedded.ServletRegistrationBean提供类的进行注册.
       ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(newStatViewServlet(),"/druid2/*");
       
       //添加初始化参数：initParams
       
       //白名单：
       servletRegistrationBean.addInitParameter("allow","127.0.0.1");
       //IP黑名单 (存在共同时，deny优先于allow) : 如果满足deny的话提示:Sorry, you are not permitted to view this page.
       servletRegistrationBean.addInitParameter("deny","192.168.1.73");
       //登录查看信息的账号密码.
       servletRegistrationBean.addInitParameter("loginUsername","admin2");
       servletRegistrationBean.addInitParameter("loginPassword","123456");
       //是否能够重置数据.
       servletRegistrationBean.addInitParameter("resetEnable","false");
       return servletRegistrationBean;
    
    
    /**
     * 注册一个：filterRegistrationBean
     * @return
     */
    @Bean
    public FilterRegistrationBean druidStatFilter2()
       
       FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(newWebStatFilter());
       
       //添加过滤规则.
       filterRegistrationBean.addUrlPatterns("/*");
       
       //添加不需要忽略的格式信息.
   filterRegistrationBean.addInitParameter("exclusions","*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid2/*");
       return filterRegistrationBean;
    
    

启动应用就可以访问：http://127.0.0.1:8080/druid2/index.html输入账号和密码：admin2/123456 就可以访问了。

以上是关于SpringBoot:spring boot使用Druid和监控配置的主要内容，如果未能解决你的问题，请参考以下文章

我使用 Springboot。 spring-boot-starter-data-jpa 依赖于 log4j。它脆弱吗？

springboot：Spring boot中Redis的使用

Spring Boot 入门

markdown Spring Boot #SpringBoot #Spring #Java

Spring Boot 初识

springboot：Spring boot中mongodb的使用