Druid的使用详解

一、关于Druid

Druid是一个JDBC组件，它包括三部分： 

• DruidDriver 代理Driver，能够提供基于Filter－Chain模式的插件体系。 

• DruidDataSource 高效可管理的数据库连接池。 

• SQLParser 

Druid可以做什么？ 

1) 可以监控数据库访问性能，Druid内置提供了一个功能强大的StatFilter插件，能够详细统计SQL的执行性能，这对于线上分析数据库访问性能有帮助。 

2) 替换DBCP和C3P0。Druid提供了一个高效、功能强大、可扩展性好的数据库连接池。 

3) 数据库密码加密。直接把数据库密码写在配置文件中，这是不好的行为，容易导致安全问题。DruidDruiver和DruidDataSource都支持PasswordCallback。 

4) SQL执行日志，Druid提供了不同的LogFilter，能够支持Common-Logging、Log4j和JdkLog，你可以按需要选择相应的LogFilter，监控你应用的数据库访问情况。 

扩展JDBC，如果你要对JDBC层有编程的需求，可以通过Druid提供的Filter-Chain机制，很方便编写JDBC层的扩展插件。

Druid开源中国社区地址：http://www.oschina.net/p/druid

 

二、工程配置

1、工程引入druid-1.0.15.jar

2、数据源配置

<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" destroy-method="close" lazy-init="false">
<property name="driverClassName" value="#{db.driver}" />
<property name="url" value="#{db.url}" />
<property name="username" value="#{db.user}" />
<property name="password" value="#{db.password}" />
<property name="initialSize" value="1" />
<property name="maxActive" value="50" />
<property name="maxIdle" value="0" />
<property name="maxWait" value="30000" />

<property name="filters" value="stat,wall" />
<property name="timeBetweenEvictionRunsMillis" value="3000" />  
<property name="minEvictableIdleTimeMillis" value="300000" />  
<property name="validationQuery" value="SELECT 'x'" />  
<property name="testWhileIdle" value="true" />  
<property name="testOnBorrow" value="false" />  
<property name="testOnReturn" value="false" />  
<property name="poolPreparedStatements" value="true" />  
<property name="maxPoolPreparedStatementPerConnectionSize" value="20" />
</bean>

详细参数说明

 

配置	缺省值	说明
name		配置这个属性的意义在于，如果存在多个数据源，监控的时候 可以通过名字来区分开来。如果没有配置，将会生成一个名字， 格式是：”DataSource-” + System.identityHashCode(this)
jdbcUrl		连接数据库的url，不同数据库不一样。例如： mysql : jdbc:mysql://10.20.153.104:3306/druid2  oracle : jdbc:oracle:thin:@10.20.149.85:1521:ocnauto
username		连接数据库的用户名
password		连接数据库的密码。如果你不希望密码直接写在配置文件中， 可以使用ConfigFilter。详细看这里： https://github.com/alibaba/druid/wiki/%E4%BD%BF%E7%94%A8ConfigFilter
driverClassName	根据url自动识别	这一项可配可不配，如果不配置druid会根据url自动识别dbType， 然后选择相应的driverClassName
initialSize	0	初始化时建立物理连接的个数。初始化发生在显示调用init方法， 或者第一次getConnection时
maxActive	8	最大连接池数量
maxIdle	8	已经不再使用，配置了也没效果
minIdle		最小连接池数量
maxWait		获取连接时最大等待时间，单位毫秒。配置了maxWait之后， 缺省启用公平锁，并发效率会有所下降， 如果需要可以通过配置useUnfairLock属性为true使用非公平锁。
poolPreparedStatements	false	是否缓存preparedStatement，也就是PSCache。 PSCache对支持游标的数据库性能提升巨大，比如说oracle。 在mysql5.5以下的版本中没有PSCache功能，建议关闭掉。 5.5及以上版本有PSCache，建议开启。
maxOpenPreparedStatements	-1	要启用PSCache，必须配置大于0，当大于0时， poolPreparedStatements自动触发修改为true。 在Druid中，不会存在Oracle下PSCache占用内存过多的问题， 可以把这个数值配置大一些，比如说100
validationQuery		用来检测连接是否有效的sql，要求是一个查询语句。 如果validationQuery为null，testOnBorrow、testOnReturn、 testWhileIdle都不会其作用。
testOnBorrow	true	申请连接时执行validationQuery检测连接是否有效， 做了这个配置会降低性能。
testOnReturn	false	归还连接时执行validationQuery检测连接是否有效， 做了这个配置会降低性能
testWhileIdle	false	建议配置为true，不影响性能，并且保证安全性。 申请连接的时候检测，如果空闲时间大于 timeBetweenEvictionRunsMillis， 执行validationQuery检测连接是否有效。
timeBetweenEvictionRunsMillis		有两个含义： 1) Destroy线程会检测连接的间隔时间  2) testWhileIdle的判断依据，详细看testWhileIdle属性的说明
numTestsPerEvictionRun		不再使用，一个DruidDataSource只支持一个EvictionRun
minEvictableIdleTimeMillis
connectionInitSqls		物理连接初始化的时候执行的sql
exceptionSorter	根据dbType自动识别	当数据库抛出一些不可恢复的异常时，抛弃连接
filters		属性类型是字符串，通过别名的方式配置扩展插件， 常用的插件有： 监控统计用的filter:stat  日志用的filter:log4j  防御sql注入的filter:wall
proxyFilters		类型是List<com.alibaba.druid.filter.Filter>， 如果同时配置了filters和proxyFilters， 是组合关系，并非替换关系

3、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>

至此基本配置完成，可以查看内置监控页面了，路径是/druid/index.html，

完整路径是http://127.0.0.1:8080/druid/index.html

如果还需要使用Web应用、URI监控、Session监控、Spring监控等则还需要继续增加配置。

4、Wen应用配置

WebStatFilter用于采集web-jdbc关联监控的数据

在Web.xml中增加配置，就可以使用Web应用、URI监控、Session监控等功能

 

<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>
    <init-param>
    	<param-name>profileEnable</param-name>
    	<param-value>true</param-value>
	</init-param>
	<init-param>
        <param-name>principalCookieName</param-name>
        <param-value>USER_COOKIE</param-value>
    </init-param>
    <init-param>
        <param-name>principalSessionName</param-name>
        <param-value>USER_SESSION</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>DruidWebStatFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

5、Spring监控配置

在Spring配置文件中增加

<bean id="druid-stat-interceptor" class="com.alibaba.druid.support.spring.stat.DruidStatInterceptor">
    </bean>
<bean id="druid-stat-pointcut" class="org.springframework.aop.support.JdkRegexpMethodPointcut" scope="prototype">
   <property name="patterns">
       <list>
           <value>com.company.bussines.service.*</value>
           <value>com.company.bussines.dao.*</value>
       </list>
   </property>
</bean>

<aop:config proxy-target-class="true">
   <aop:advisor advice-ref="druid-stat-interceptor" pointcut-ref="druid-stat-pointcut" />
</aop:config>

所有配置完成。

Wallfilter配置

配置WallFilter，可以起到拦截作用，从而形成SQL的白名单和黑名单。

缺省情况下，配置装载的目录如下：

数据库类型	目录
mysql	META-INF/druid/wall/mysql
oracle	META-INF/druid/wall/oracle
sqlserver	META-INF/druid/wall/sqlserver
postgres	META-INF/druid/wall/postgres

从配置目录中以下文件中读取配置：

1. deny-variant.txt

2. deny-schema.txt

3. deny-function.txt

4. permit-variant.txt

5. permit-variant.txt

指定配置装载的目录是可以指定，例如：

1. <bean id="wall-filter-config" class="com.alibaba.druid.wall.WallConfig" init-method="init">

2. <!-- 指定配置装载的目录 -->

3. <property name="dir" value="META-INF/druid/wall/mysql" />

4. </bean>

5.  

6. <bean id="wall-filter" class="com.alibaba.druid.wall.WallFilter">

7. <property name="dbType" value="mysql" />

8. <property name="config" ref="wall-filter-config" />

9. </bean>

10.  

11. <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">

12. ...

13. <property name="proxyFilters">

14. <list>

15. <ref bean="wall-filter"/>

16. </list>

17. </property>

18. </bean>

本文实例中，采用如下的配置：

1.  

2. <bean id="wall-filter-config" class="com.alibaba.druid.wall.WallConfig"

3. init-method="init">

4. <!-- 指定配置装载的目录 -->

5. <property name="dir" value="META-INF/druid/wall/mysql" />

6. </bean>

7.  

8. <bean id="wall-filter" class="com.alibaba.druid.wall.WallFilter">

9. <property name="dbType" value="mysql" />

10. <property name="config" ref="wall-filter-config" />

11. </bean>

12.  

13. <!-- 配置数据源-druid -->

14. <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"

15. destroy-method="close">

16. <property name="url" value="${jdbc.url}" />

17. <property name="username" value="${jdbc.username}" />

18. <property name="password" value="${jdbc.password}" />

19. <property name="filters" value="stat" />

20. <property name="maxActive" value="20" />

21. <property name="initialSize" value="1" />

22. <property name="maxWait" value="60000" />

23. <property name="minIdle" value="1" />

24. <property name="timeBetweenEvictionRunsMillis" value="60000" />

25. <property name="minEvictableIdleTimeMillis" value="300000" />

26. <property name="testWhileIdle" value="true" />

27. <property name="testOnBorrow" value="false" />

28. <property name="testOnReturn" value="false" />

29. <property name="poolPreparedStatements" value="true" />

30. <property name="maxOpenPreparedStatements" value="20" />

31. <property name="proxyFilters">

32. <list>

33. <ref bean="wall-filter" />

34. </list>

35. </property>

36. </bean>

配置好Wallfilter, 我们就可以看到SQL防火墙 TAB下的内容了。

因为是默认状态，没有配置任何拦截的属性信息，所以，SQL的执行都在白名单中展示出来了。

配置Spring和jdbc的关联

最后，还有一个Tab的内容没有展示，那就是Spring监控。

Druid提供了Spring和Jdbc的关联监控。

本文在Spring的applicationContext.xml配置文件中配置如下信息，支持方法名的拦截。

1. <bean id="druid-stat-interceptor"

2. class="com.alibaba.druid.support.spring.stat.DruidStatInterceptor">

3. </bean>

4.  

5. <bean id="druid-stat-pointcut" class="org.springframework.aop.support.JdkRegexpMethodPointcut"

6. scope="prototype">

7. <property name="patterns">

8. <list>

9. <value>com.demo.mybatis.auto.*</value>

10. <value>com.demo.mybatis.manual.*</value>

11. </list>

12. </property>

13. </bean>

14. <aop:config>

15. <aop:advisor advice-ref="druid-stat-interceptor"

16. pointcut-ref="druid-stat-pointcut" />

17. </aop:config>

 

完工后，我们再去看一下，Spring监控的TAB内容，就可以看到相关的MyBatis Mapper执行信息。

在Spring监控页，可以显示相关DAO执行的方法，方法执行的次数、执行的时间等信息。