您的位置: 首页  >  文章  >  Spring Boot下Druid连接池的使用配置分析

Spring Boot下Druid连接池的使用配置分析

分类: 文章 • 2024-03-30 21:45:21
引言： 在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和C3P0。Druid提供了一个高效、功能强大、可扩展性好的数据库连接池。
  •   数据库密码加密。直接把数据库密码写在配置文件中，这是不好的行为，容易导致安全问题。DruidDruiver和DruidDataSource都支持PasswordCallback。  
  •  SQL执行日志，Druid提供了不同的LogFilter，能够支持Common-Logging、Log4j和JdkLog，你可以按需要选择相应的LogFilter，监控你应用的数据库访问情况。 
  •   扩展JDBC，如果你要对JDBC层有编程的需求，可以通过Druid提供的Filter-Chain机制，很方便编写JDBC层的扩展插件。 

     项目地址： https://github.com/alibaba/druid

3.   Spring Boot与Druid的集成

       MySQL Driver驱动包：

[html] view plain copy
  1. <dependency>  
  2.             <groupId>mysql</groupId>  
  3.             <artifactId>mysql-connector-java</artifactId>  
  4.             <scope>runtime</scope>  
  5.         </dependency>  
    Spring Boot的JPA依赖包：
[html] view plain copy
  1. <dependency>  
  2.             <groupId>org.springframework.boot</groupId>  
  3.             <artifactId>spring-boot-starter-data-jpa</artifactId>  
  4.         </dependency>  
   阿里系的Druid依赖包：
[html] view plain copy
  1. <dependency>  
  2.             <groupId>com.alibaba</groupId>  
  3.             <artifactId>druid</artifactId>  
  4.             <version>1.0.25</version>  
  5.         </dependency>  
    Spring Boot中的application.properties配置信息：

[html] view plain copy
  1. # 驱动配置信息  
  2. spring.datasource.type=com.alibaba.druid.pool.DruidDataSource  
  3. spring.datasource.url = jdbc:mysql://127.0.0.1:3306/mealsystem?useUnicode=true&characterEncoding=utf-8  
  4. spring.datasource.username = root  
  5. spring.datasource.password = 123456  
  6. spring.datasource.driverClassName = com.mysql.jdbc.Driver  
  7.    
  8. #连接池的配置信息  
  9. spring.datasource.initialSize=5  
  10. spring.datasource.minIdle=5  
  11. spring.datasource.maxActive=20  
  12. spring.datasource.maxWait=60000  
  13. spring.datasource.timeBetweenEvictionRunsMillis=60000  
  14. spring.datasource.minEvictableIdleTimeMillis=300000  
  15. spring.datasource.validationQuery=SELECT 1 FROM DUAL  
  16. spring.datasource.testWhileIdle=true  
  17. spring.datasource.testOnBorrow=false  
  18. spring.datasource.testOnReturn=false  
  19. spring.datasource.poolPreparedStatements=true  
  20. spring.datasource.maxPoolPreparedStatementPerConnectionSize=20  
  21. spring.datasource.filters=stat,wall,log4j  
  22. 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中的直接支持，故需要进行配置信息的定制：

[html] view plain copy
  1. @Configuration  
  2. public class DruidDBConfig {  
  3.     private Logger logger = LoggerFactory.getLogger(DruidDBConfig.class);  
  4.       
  5.     @Value("${spring.datasource.url}")  
  6.     private String dbUrl;  
  7.       
  8.     @Value("${spring.datasource.username}")  
  9.     private String username;  
  10.       
  11.     @Value("${spring.datasource.password}")  
  12.     private String password;  
  13.       
  14.     @Value("${spring.datasource.driverClassName}")  
  15.     private String driverClassName;  
  16.       
  17.     @Value("${spring.datasource.initialSize}")  
  18.     private int initialSize;  
  19.       
  20.     @Value("${spring.datasource.minIdle}")  
  21.     private int minIdle;  
  22.       
  23.     @Value("${spring.datasource.maxActive}")  
  24.     private int maxActive;  
  25.       
  26.     @Value("${spring.datasource.maxWait}")  
  27.     private int maxWait;  
  28.       
  29.     @Value("${spring.datasource.timeBetweenEvictionRunsMillis}")  
  30.     private int timeBetweenEvictionRunsMillis;  
  31.       
  32.     @Value("${spring.datasource.minEvictableIdleTimeMillis}")  
  33.     private int minEvictableIdleTimeMillis;  
  34.       
  35.     @Value("${spring.datasource.validationQuery}")  
  36.     private String validationQuery;  
  37.       
  38.     @Value("${spring.datasource.testWhileIdle}")  
  39.     private boolean testWhileIdle;  
  40.       
  41.     @Value("${spring.datasource.testOnBorrow}")  
  42.     private boolean testOnBorrow;  
  43.       
  44.     @Value("${spring.datasource.testOnReturn}")  
  45.     private boolean testOnReturn;  
  46.       
  47.     @Value("${spring.datasource.poolPreparedStatements}")  
  48.     private boolean poolPreparedStatements;  
  49.       
  50.     @Value("${spring.datasource.maxPoolPreparedStatementPerConnectionSize}")  
  51.     private int maxPoolPreparedStatementPerConnectionSize;  
  52.       
  53.     @Value("${spring.datasource.filters}")  
  54.     private String filters;  
  55.       
  56.     @Value("{spring.datasource.connectionProperties}")  
  57.     private String connectionProperties;  
  58.       
  59.     @Bean     //声明其为Bean实例  
  60.     @Primary  //在同样的DataSource中，首先使用被标注的DataSource  
  61.     public DataSource dataSource(){  
  62.         DruidDataSource datasource = new DruidDataSource();  
  63.           
  64.         datasource.setUrl(this.dbUrl);  
  65.         datasource.setUsername(username);  
  66.         datasource.setPassword(password);  
  67.         datasource.setDriverClassName(driverClassName);  
  68.           
  69.         //configuration  
  70.         datasource.setInitialSize(initialSize);  
  71.         datasource.setMinIdle(minIdle);  
  72.         datasource.setMaxActive(maxActive);  
  73.         datasource.setMaxWait(maxWait);  
  74.         datasource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);  
  75.         datasource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);  
  76.         datasource.setValidationQuery(validationQuery);  
  77.         datasource.setTestWhileIdle(testWhileIdle);  
  78.         datasource.setTestOnBorrow(testOnBorrow);  
  79.         datasource.setTestOnReturn(testOnReturn);  
  80.         datasource.setPoolPreparedStatements(poolPreparedStatements);  
  81.         datasource.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);  
  82.         try {  
  83.             datasource.setFilters(filters);  
  84.         } catch (SQLException e) {  
  85.             logger.error("druid configuration initialization filter", e);  
  86.         }  
  87.         datasource.setConnectionProperties(connectionProperties);  
  88.           
  89.         return datasource;  
  90.     }  
  91. }  
    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的实现类：

[html] view plain copy
  1. import javax.servlet.annotation.WebFilter;  
  2. import javax.servlet.annotation.WebInitParam;  
  3.   
  4. import com.alibaba.druid.support.http.WebStatFilter;  
  5.   
  6. @WebFilter(filterName="druidWebStatFilter",urlPatterns="/*",  
  7.     initParams={  
  8.         @WebInitParam(name="exclusions",value="*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*")//忽略资源  
  9.    }  
  10. )  
  11. public class DruidStatFilter extends WebStatFilter {  
  12.   
  13. }  
  StatViewServlet:
[html] view plain copy
  1. import javax.servlet.annotation.WebInitParam;  
  2. import javax.servlet.annotation.WebServlet;  
  3.   
  4. import com.alibaba.druid.support.http.StatViewServlet;  
  5.   
  6. @WebServlet(urlPatterns="/druid/*",  
  7.     initParams={  
  8.          @WebInitParam(name="allow",value="127.0.0.1,192.168.163.1"),// IP白名单(没有配置或者为空，则允许所有访问)  
  9.          @WebInitParam(name="deny",value="192.168.1.73"),// IP黑名单 (存在共同时，deny优先于allow)  
  10.          @WebInitParam(name="loginUsername",value="admin"),// 用户名  
  11.          @WebInitParam(name="loginPassword",value="123456"),// 密码  
  12.          @WebInitParam(name="resetEnable",value="false")// 禁用HTML页面上的“Reset All”功能  
  13. })  
  14. public class DruidStatViewServlet extends StatViewServlet {  
  15.     private static final long serialVersionUID = -2688872071445249539L;  
  16.   
  17. }  
这两个类相当于在web.xml中声明了一个servlet， 等价于如下的配置信息（web.xml):

[html] view plain copy
  1. <servlet>    
  2.         <servlet-name>DruidStatView</servlet-name>    
  3.         <servlet-class>com.alibaba.druid.support.http.StatViewServlet</servlet-class>    
  4.     </servlet>    
  5.     <servlet-mapping>    
  6.         <servlet-name>DruidStatView</servlet-name>    
  7.         <url-pattern>/druid/*</url-pattern>    
  8.     </servlet-mapping>    
 filter的配置信息：

[html] view plain copy
  1. <filter>    
  2.         <filter-name>DruidWebStatFilter</filter-name>    
  3.         <filter-class>com.alibaba.druid.support.http.WebStatFilter</filter-class>    
  4.         <init-param>    
  5.             <param-name>exclusions</param-name>    
  6.             <param-value>*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*</param-value>    
  7.         </init-param>    
  8.       </filter>    
  9.       <filter-mapping>    
  10.         <filter-name>DruidWebStatFilter</filter-name>    
  11.         <url-pattern>/*</url-pattern>    
  12.       </filter-mapping>    
   然后相应的配置工作就完成了，直接启动即可看到相应的应用了。

4.    运行界面以及介绍

    访问地址： http://192.168.163.1:8080/druid/index.html

     Spring Boot下Druid连接池的使用配置分析

   

    Spring Boot下Druid连接池的使用配置分析

5.   参考资料

  • http://blog.****.net/xiaoyu411502/article/details/51392237
  •  http://stackoverflow.com/questions/32833641/not-able-to-set-spring-datasource-type

相关推荐