本篇文章主要介绍了详解 Spring Boot 下 Druid 连接池的使用配置分析, 具有一定的参考价值, 感兴趣的小伙伴们可以参考一下
引言: 在 Spring Boot 下默认提供了若干种可用的连接池, Druid 来自于阿里系的一个开源连接池, 在连接池之外, 还提供了非常优秀的监控功能, 这里讲解如何与 Spring Boot 实现集成
1. 环境描述
spring Boot 1.4.0.RELEASE, JDK 1.8
2. Druid 介绍
Druid 是一个 JDBC 组件, 它包括三部分:
DruidDriver 代理 Driver, 能够提供基于 Filter-Chain 模式的插件体系
DruidDataSource 高效可管理的数据库连接池
SQLParser
Druid 可以做什么?
可以监控数据库访问性能, Druid 内置提供了一个功能强大的 StatFilter 插件, 能够详细统计 SQL 的执行性能, 这对于线上分析数据库访问性能有帮助
替换 DBCP 和 C3P0Druid 提供了一个高效功能强大可扩展性好的数据库连接池
数据库密码加密直接把数据库密码写在配置文件中, 这是不好的行为, 容易导致安全问题 DruidDruiver 和 DruidDataSource 都支持 PasswordCallback
SQL 执行日志, Druid 提供了不同的 LogFilter, 能够支持 Common-LoggingLog4j 和 JdkLog, 你可以按需要选择相应的 LogFilter, 监控你应用的数据库访问情况
扩展 JDBC, 如果你要对 JDBC 层有编程的需求, 可以通过 Druid 提供的 Filter-Chain 机制, 很方便编写 JDBC 层的扩展插件
项目地址: https://github.com/alibaba/druid
3. Spring Boot 与 Druid 的集成
MySQL Driver 驱动包:
- <dependency>
- <groupId>mysql</groupId>
- <artifactId>mysql-connector-java</artifactId>
- <scope>runtime</scope>
- </dependency>
Spring Boot 的 JPA 依赖包:
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-data-jpa</artifactId>
- </dependency>
阿里系的 Druid 依赖包:
- <dependency>
- <groupId>com.alibaba</groupId>
- <artifactId>druid</artifactId>
- <version>1.0.25</version>
- </dependency>
Spring Boot 中的 application.properties 配置信息:
- # 驱动配置信息
- spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
- spring.datasource.url = jdbc:mysql://127.0.0.1:3306/mealsystem?useUnicode=true&characterEncoding=utf-8
- spring.datasource.username = root
- spring.datasource.password = 123456
- spring.datasource.driverClassName = com.mysql.jdbc.Driver
- # 连接池的配置信息
- 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
- spring.datasource.poolPreparedStatements=true
- spring.datasource.maxPoolPreparedStatementPerConnectionSize=20
- spring.datasource.filters=stat,wall,log4j
- spring.datasource.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
在 Spring Boot1.4.0 中驱动配置信息没有问题, 但是连接池的配置信息不再支持这里的配置项, 即无法通过配置项直接支持相应的连接池; 这里列出的这些配置项可以通过定制化 DataSource 来实现
目前 Spring Boot 中默认支持的连接池有 dbcp,dbcp2, tomcat, hikari 三种连接池
由于 Druid 暂时不在 Spring Bootz 中的直接支持, 故需要进行配置信息的定制:
- @Configuration
- public class DruidDBConfig {
- private Logger logger = LoggerFactory.getLogger(DruidDBConfig.class);
- @Value("${spring.datasource.url}")
- private String dbUrl;
- @Value("${spring.datasource.username}")
- private String username;
- @Value("${spring.datasource.password}")
- private String password;
- @Value("${spring.datasource.driverClassName}")
- private String driverClassName;
- @Value("${spring.datasource.initialSize}")
- private int initialSize;
- @Value("${spring.datasource.minIdle}")
- private int minIdle;
- @Value("${spring.datasource.maxActive}")
- private int maxActive;
- @Value("${spring.datasource.maxWait}")
- private int maxWait;
- @Value("${spring.datasource.timeBetweenEvictionRunsMillis}")
- private int timeBetweenEvictionRunsMillis;
- @Value("${spring.datasource.minEvictableIdleTimeMillis}")
- private int minEvictableIdleTimeMillis;
- @Value("${spring.datasource.validationQuery}")
- private String validationQuery;
- @Value("${spring.datasource.testWhileIdle}")
- private boolean testWhileIdle;
- @Value("${spring.datasource.testOnBorrow}")
- private boolean testOnBorrow;
- @Value("${spring.datasource.testOnReturn}")
- private boolean testOnReturn;
- @Value("${spring.datasource.poolPreparedStatements}")
- private boolean poolPreparedStatements;
- @Value("${spring.datasource.maxPoolPreparedStatementPerConnectionSize}")
- private int maxPoolPreparedStatementPerConnectionSize;
- @Value("${spring.datasource.filters}")
- private String filters;
- @Value("{spring.datasource.connectionProperties}")
- private String connectionProperties;
- @Bean // 声明其为 Bean 实例
- @Primary // 在同样的 DataSource 中, 首先使用被标注的 DataSource
- public DataSource dataSource(){
- DruidDataSource datasource = new DruidDataSource();
- datasource.setUrl(this.dbUrl);
- datasource.setUsername(username);
- datasource.setPassword(password);
- datasource.setDriverClassName(driverClassName);
- //configuration
- datasource.setInitialSize(initialSize);
- datasource.setMinIdle(minIdle);
- datasource.setMaxActive(maxActive);
- datasource.setMaxWait(maxWait);
- datasource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
- datasource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
- datasource.setValidationQuery(validationQuery);
- datasource.setTestWhileIdle(testWhileIdle);
- datasource.setTestOnBorrow(testOnBorrow);
- datasource.setTestOnReturn(testOnReturn);
- datasource.setPoolPreparedStatements(poolPreparedStatements);
- datasource.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);
- try {
- datasource.setFilters(filters);
- } catch (SQLException e) {
- logger.error("druid configuration initialization filter", e);
- }
- datasource.setConnectionProperties(connectionProperties);
- return datasource;
- }
- }
DruidDBConfig 类被 @Configuration 标注, 用作配置信息; DataSource 对象被 @Bean 声明, 为 Spring 容器所管理, @Primary 表示这里定义的 DataSource 将覆盖其他来源的 DataSource
- # 下面为连接池的补充设置, 应用到上面所有数据源中
- # 初始化大小, 最小, 最大
- 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 版本是不能识别的
配置 StatView 的 Servlet:
Filter 的实现类:
- import javax.servlet.annotation.webFilter;
- import javax.servlet.annotation.WebInitParam;
- import com.alibaba.druid.support.http.WebStatFilter;
- @WebFilter(filterName="druidWebStatFilter",urlPatterns="/*",
- initParams={
- @WebInitParam(name="exclusions",value="*.js,*.gif,*.jpg,*.bmp,*.png,*.CSS,*.ico,/druid/*")// 忽略资源
- }
- )
- public class DruidStatFilter extends WebStatFilter {
- }
- StatViewServlet:
- import javax.servlet.annotation.WebInitParam;
- import javax.servlet.annotation.WebServlet;
- import com.alibaba.druid.support.http.StatViewServlet;
- @WebServlet(urlPatterns="/druid/*",
- initParams={
- @WebInitParam(name="allow",value="127.0.0.1,192.168.163.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 {
- private static final long serialVersionUID = -2688872071445249539L;
- }
这两个类相当于在 web.xml 中声明了一个 servlet, 等价于如下的配置信息 (web.xml):
- <servlet>
- <servlet-name>DruidStatView</servlet-name>
- <servlet-class>com.alibaba.druid.support.http.StatViewServlet</servlet-class>
- </servlet>
- <servlet-mapping>
- <servlet-name>DruidStatView</servlet-name>
- <url-pattern>/druid/*</url-pattern>
- </servlet-mapping>
filter 的配置信息:
- <filter>
- <filter-name>DruidWebStatFilter</filter-name>
- <filter-class>com.alibaba.druid.support.http.WebStatFilter</filter-class>
- <init-param>
- <param-name>exclusions</param-name>
- <param-value>*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*</param-value>
- </init-param>
- </filter>
- <filter-mapping>
- <filter-name>DruidWebStatFilter</filter-name>
- <url-pattern>/*</url-pattern>
- </filter-mapping>
然后相应的配置工作就完成了, 直接启动即可看到相应的应用了
4. 运行界面以及介绍
访问地址: http://192.168.163.1:8080/druid/index.html
5. 参考资料
- http://blog.csdn.net/xiaoyu411502/article/details/51392237
- http://stackoverflow.com/questions/32833641/not-able-to-set-spring-datasource-type
来源: http://www.phperz.com/article/18/0320/356676.html