Druid 简介
Druid 首先是一个数据库连接池,但它不仅仅是一个数据库连接池,还包含了一个 ProxyDriver,一系列内置的 JDBC 组件库(可以让程序员实现一些特殊的需求),一个 SQL Parser。在 Java 的世界中 Druid 是监控做的最好的数据库连接池,在功能、性能、扩展性方面,也有不错的表现
Druid 可以做什么?
- 数据库密码加密。直接把数据库密码写在配置文件中,这是不好的行为,容易导致安全问题,DruidDruiver 和 DruidDataSource 都支持 PasswordCallback。
- 替换其他 Java 连接池,Druid 提供了一个高效、功能强大、可扩展性好的数据库连接池。 可以监控数据库访问性能,Druid 内置提供了一个功能强大的 StatFilter 插件,能够详细统计 SQL 的执行性能,这对于线上分析数据库访问性能有很大帮助。
- SQL 执行日志,Druid 提供了不同的 LogFilter,能够支持 Common-Logging、Log4j 和 JdkLog,可以按需要选择相应的 LogFilter,监控应用的数据库访问情况。
- 扩展 JDBC,如果你要对 JDBC 层有编程的需求,可以通过 Druid 提供的 Filter 机制,很方便编写 JDBC 层的扩展插件。
SpringBoot整合Druid
阿里为 Druid 也提供了 Spring Boot Starter 的支持。官网这样解释:Druid Spring Boot Starter 用于帮助你在 Spring Boot 项目中轻松集成 Druid 数据库连接池和监控。
数据库密码加密
准备工作
- 配置 jdk 环境
- 准备 druid 的 jar 包
druid 的 jar 包在 maven 仓库即可寻得,如下
密码加密与配置的两种方式
快捷键 WIN + R
,输入 cmd
打开命令窗口
加密命令
java -cp 路径/druid-版本号.jar com.alibaba.druid.filter.config.ConfigTools 密码
|
加密信息输出到文本命令
java -cp 路径/druid-版本号.jar com.alibaba.druid.filter.config.ConfigTools 密码 >> xxx.txt
|
1.0.16版本之前
1.0.16版本之后
会分别生成加密的密码以及对应的公钥和私钥,公钥需在application.yml配置中使用
注:不设密文密码,而使用明文密码时,不需要配置connection-properties项
引入依赖包
<dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.1.23</version> </dependency>
|
application 配置
Druid Spring Boot Starter 配置属性的名称完全遵照 Druid,可以通过 Spring Boot 配置文件来配置Druid数据库连接池和监控,如果没有配置则使用默认值。
慢sql记录
开启Druid的慢SQL记录功能,如果遇到执行慢的SQL,便会输出到日志中
spring: druid: filter: stat: enabled: true db-type: mysql log-slow-sql: true slow-sql-millis: 2000
|
配置Druid数据源(连接池)
如同以前 c3p0、dbcp 数据源可以设置数据源连接初始化大小、最大连接数、等待时间、最小连接数等一样,Druid 数据源同理可以进行设置;
initial-size: 5 min-idle: 10 max-active: 20 max-wait: 60000 test-while-idle: true time-between-eviction-runs-millis: 2000 time-between-connect-error-millis: 60000 min-evictable-idle-time-millis: 600000 max-evictable-idle-time-millis: 900000 validation-query: select 1 test-on-borrow: false test-on-return: false pool-prepared-statements: true max-pool-prepared-statement-per-connection-size: 20 keepAlive: true
|
spring 监控
需要导入SprngBoot的AOP的Starter
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
|
aop-patterns: "cn.goitman.dao.*"
|
配置 Filter
通过 spring.datasource.druid.filters=stat,wall,log4j …的方式来启用相应的内置Filter。
如果默认配置不能满足需求,可以放弃这种方式,通过配置文件来配置Filter:
# 配置StatFilter spring.datasource.druid.filter.stat.enabled=true spring.datasource.druid.filter.stat.db-type=mysql spring.datasource.druid.filter.stat.log-slow-sql=true spring.datasource.druid.filter.stat.slow-sql-millis=2000
# 配置WallFilter spring.datasource.druid.filter.wall.enabled=true spring.datasource.druid.filter.wall.db-type=mysql spring.datasource.druid.filter.wall.config.delete-allow=false spring.datasource.druid.filter.wall.config.drop-table-allow=false
|
目前为以下 Filter 提供了配置支持,根据(spring.datasource.druid.filter.*)进行配置。
- StatFilter
- WallFilter
- ConfigFilter
- EncodingConvertFilter
- Slf4jLogFilter
- Log4jFilter
- Log4j2Filter
- CommonsLogFilter
不想使用内置的 Filters,要想使自定义 Filter 配置生效需要将对应 Filter 的 enabled 设置为 true ,Druid Spring Boot Starter 默认禁用 StatFilter
,可以将其 enabled 设置为 true 来启用它。
配置web监控 filter(WebStatFilter)
这个过滤器的作用就是统计 web 应用请求中所有的数据库信息,比如发出的 sql 语句,sql 执行的时间、请求次数、请求的 url 地址、以及seesion 监控、数据库表的访问次数
等等。
web-stat-filter: enabled: true url-pattern: '/*' exclusions: '*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*'
|
配置后台管理 Servlet(StatViewServlet)
Druid 数据源具有监控的功能,并提供了一个 web 界面方便用户查看,类似安装 路由器 时,人家也提供了一个默认的 web 页面;需要设置 Druid 的后台管理页面的属性,比如 登录账号、密码 等;
stat-view-servlet: enabled: true url-pattern: '/druid/*' allow: 127.0.0.1 deny: reset-enable: false login-username: admin login-password: admin
|
完整配置
spring: datasource: url: jdbc:mysql:///数据库名?useSSL=true&characterEncoding=utf8&serverTimezone=UTC driver-class-name: com.mysql.jdbc.Driver username: 帐号
password: gWI1WLwMJ4ch2MuqcL2Ua+TzFtTA9MTKRDGUgYAUk4Sb+gve/kVAV2YEmxcvCz5TGVa8k+7jg+POBGkeAzNWnw== type: com.alibaba.druid.pool.DruidDataSource druid: filter: stat: enabled: true db-type: mysql log-slow-sql: true slow-sql-millis: 2000 config: enabled: true
connection-properties: config.decrypt=true;config.decrypt.key=MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAIKdkhejQC9hvWWMcssB43bykaVM9tRBwoG3+ps5da5wcoqqvS92YfsB1+EBmZ/YNGw3DhTwhZ/QggJqyDzqhmcCAwEAAQ== initial-size: 5 min-idle: 10 max-active: 20 max-wait: 60000 test-while-idle: true time-between-eviction-runs-millis: 2000 time-between-connect-error-millis: 60000 min-evictable-idle-time-millis: 600000 max-evictable-idle-time-millis: 900000 validation-query: select 1 test-on-borrow: false test-on-return: false pool-prepared-statements: true max-pool-prepared-statement-per-connection-size: 20 keepAlive: true
aop-patterns: "cn.goitman.dao.*" use-global-data-source-stat: false filters: stat,wall,slf4j web-stat-filter: enabled: true url-pattern: '/*' exclusions: '*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*' stat-view-servlet: enabled: true url-pattern: '/druid/*' allow: 127.0.0.1 deny: reset-enable: false login-username: admin login-password: admin
|
监控页面
访问http://localhost:8080/druid/login.html
或 http://127.0.0.1:8080/druid/login.html
来到登录页面,输入用户名密码登录,进入首页
首页会展示项目使用的 JDK 版本、数据库驱动、JVM 相关统计信息。
当前DataSource配置的基本信息,上述配置的Filter可以在里面找到,如果没有配置Filter(一些信息会无法统计,例如“SQL监控”,会无法获取JDBC相关的SQL执行信息)
SQL 监控会将项目中具体执行的 SQL 打印出来,展示此 SQL 执行了多少次、每次返回多少数据、执行的时间分布是什么。这些功能非常的实用,方便我们在实际生产中查找出慢 SQL,最后对 SQL 进行调优。
统计了所有Controller接口的访问以及执行情况
利用aop 对指定接口的执行时间,jdbc数进行记录
druid提供了黑白名单的访问,可以清楚的看到sql防护情况。
可以看到当前的session状况,创建时间、最后活跃时间、请求次数、请求时间等详细参数。
通过api的形式访问Druid的监控接口,api接口返回Json形式数据。
去AD(广告)
访问监控页面的时候,你可能会在页面底部(footer)看到阿里巴巴的广告
原因:maven引入的druid的jar包中的common.js(里面有一段js代码是给页面的footer追加广告的)
<dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.1.23</version> </dependency>
|
# common.js的位置: com/alibaba/druid/1.1.23/druid-1.1.23.jar!/support/http/resources/js/common.js
|
如果想去掉,有两种方式:
手动注释代码(推荐
)
如果是使用Maven,直接到本地仓库中,查找这个jar包,要注释的代码:
先将jar
包改成后缀为rar
的压缩类型包,打开common.js
文件修改,修改完成后改回jar
后缀类型
完美解决
过滤器过滤
注册一个过滤器,过滤common.js的请求,使用正则表达式替换相关的广告内容
@Configuration @ConditionalOnWebApplication @AutoConfigureAfter(DruidDataSourceAutoConfigure.class) @ConditionalOnProperty(name = "spring.datasource.druid.stat-view-servlet.enabled", havingValue = "true", matchIfMissing = true) public class RemoveDruidAdConfig {
@Bean public FilterRegistrationBean removeDruidAdFilterRegistrationBean(DruidStatProperties properties) {
DruidStatProperties.StatViewServlet config = properties.getStatViewServlet(); String pattern = config.getUrlPattern() != null ? config.getUrlPattern() : "/druid/*"; String commonJsPattern = pattern.replaceAll("\\*", "js/common.js");
final String filePath = "support/http/resources/js/common.js";
Filter filter = new Filter() { @Override public void init(FilterConfig filterConfig) throws ServletException {}
@Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { chain.doFilter(request, response); response.resetBuffer(); String text = Utils.readFromResource(filePath); text = text.replaceAll("<a.*?banner\"></a><br/>", ""); text = text.replaceAll("powered.*?shrek.wang</a>", ""); response.getWriter().write(text); }
@Override public void destroy() {} };
FilterRegistrationBean registrationBean = new FilterRegistrationBean(); registrationBean.setFilter(filter); registrationBean.addUrlPatterns(commonJsPattern); return registrationBean; } }
|
常见问题:https://github.com/alibaba/druid/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98