DruidDataSource配置属性列表

前言

DruidDataSource配置兼容DBCP，但个别配置的语意有所区别。 以下配置说明基于druid 1.2.22 整理，请升级至1.2.22或更高版本，并参考以下属性进行相关配置

配置项说明

配置项名称	缺省值	说明	java set方法定义
connectProperties	{}	map方式放入自定义的key和value，在Filter等地方可以获取该信息进行相应逻辑控制	public void com.alibaba.druid.pool.DruidDataSource.setConnectProperties(java.util.Properties)
connectionProperties	null	字符串方式放入自定义的key和value，键值对用分号隔开，比如“a=b;c=d”，传入空白字符串表示清空属性，实际拆分字符串后赋值给connectProperties，在Filter等地方可以获取该信息进行相应逻辑控制	public void com.alibaba.druid.pool.DruidAbstractDataSource.setConnectionProperties(java.lang.String)
connectTimeout	0	新增的控制创建连接时的socket连接最大等待超时，单位是毫秒，默认0表示永远等待，工作原理是在创建连接时将该值设置到对应数据库驱动的属性信息中由其JDBC驱动进行控制	public void com.alibaba.druid.pool.DruidAbstractDataSource.setConnectTimeout(int)
connectionInitSqls	[]	数组方式定义物理连接初始化的时候执行的1到多条sql语句，比如连接MySQL数据库使用低版本驱动的情况下，想使用utf8mb4,则可以配置sql为： set NAMES 'utf8mb4'	public void com.alibaba.druid.pool.DruidAbstractDataSource.setConnectionInitSqls(java.util.Collection)
createScheduler	null	可以使用定时线程池方式异步创建连接，比起默认的单线程创建连接方式，经实际验证这种更可靠	public void com.alibaba.druid.pool.DruidAbstractDataSource.setCreateScheduler(java.util.concurrent.ScheduledExecutorService)
dbType	null	对于不是Druid自动适配支持的db类型，可以强制指定db类型，字符串值来自com.alibaba.druid.DbType的枚举名	public void com.alibaba.druid.pool.DruidAbstractDataSource.setDbType(java.lang.String)
destroyScheduler	null	可以使用定时线程池方式异步创建连接，比起默认的单线程创建连接方式，经实际验证这种更可靠	public void com.alibaba.druid.pool.DruidAbstractDataSource.setDestroyScheduler(java.util.concurrent.ScheduledExecutorService)
driverClassName	根据url自动识别	这一项可配可不配，如果不配置druid会根据url自动识别dbType，然后选择相应的driverClassName	com.alibaba.druid.pool.DruidAbstractDataSource.setDriverClassName(String)
exceptionSorter	null	当数据库抛出一些不可恢复的异常时，抛弃连接	public void com.alibaba.druid.pool.DruidAbstractDataSource.setExceptionSorter(com.alibaba.druid.pool.ExceptionSorter)
failFast	false	null	public void com.alibaba.druid.pool.DruidAbstractDataSource.setFailFast(boolean)
filters		属性类型是逗号隔开的字符串，通过别名的方式配置扩展插件，插件别名列表请参考druid jar包中的 /META-INF/druid-filter.properties,常用的插件有： 监控统计用的filter:stat 日志用的filter:log4j 防御sql注入的filter:wall 防御sql注入的filter:wall	com.alibaba.druid.pool.DruidAbstractDataSource.setFilters(String)
initialSize	0	初始化数据源时建立物理连接的个数。初始化发生在显示调用init方法，或者第一次getConnection时	public void com.alibaba.druid.pool.DruidAbstractDataSource.setInitialSize(int)
keepAlive	false	连接池中的minIdle数量以内的连接，空闲时间超过minEvictableIdleTimeMillis，则会执行keepAlive操作。实际项目中建议配置成true	public void com.alibaba.druid.pool.DruidDataSource.setKeepAlive(boolean)
keepAliveBetweenTimeMillis	120000	null	public void com.alibaba.druid.pool.DruidAbstractDataSource.setKeepAliveBetweenTimeMillis(long)
logAbandoned	false	在开启removeAbandoned为true的情况，可以开启该设置，druid在销毁未及时关闭的连接时，则会输出日志信息，便于定位连接泄露问题	public void com.alibaba.druid.pool.DruidAbstractDataSource.setLogAbandoned(boolean)
loginTimeout		单位是秒，底层调用DriverManager全局静态方法	java.sql.DriverManager.setLoginTimeout(int)
maxActive	8	连接池最大活跃连接数量，当连接数量达到该值时，再获取新连接时，将处于等待状态，直到有连接被释放，才能借用成功	public void com.alibaba.druid.pool.DruidDataSource.setMaxActive(int)
maxEvictableIdleTimeMillis	25200000	null	public void com.alibaba.druid.pool.DruidAbstractDataSource.setMaxEvictableIdleTimeMillis(long)
maxIdle	8	已经彻底废弃，配置了也没效果，以maxActive为准	public void com.alibaba.druid.pool.DruidAbstractDataSource.setMaxIdle(int)
maxOpenPreparedStatements	10	null	public void com.alibaba.druid.pool.DruidAbstractDataSource.setMaxOpenPreparedStatements(int)
maxPoolPreparedStatementPerConnectionSize	10	要启用PSCache，必须配置大于0，当大于0时，poolPreparedStatements自动触发修改为true。在Druid中，不会存在Oracle下PSCache占用内存过多的问题，可以把这个数值配置大一些，比如说100	public void com.alibaba.druid.pool.DruidAbstractDataSource.setMaxPoolPreparedStatementPerConnectionSize(int)
maxWait	-1	获取连接时最大等待时间，单位毫秒。配置了maxWait之后，缺省启用公平锁，并发效率会有所下降，如果需要可以通过配置useUnfairLock属性为true使用非公平锁。	public void com.alibaba.druid.pool.DruidAbstractDataSource.setMaxWait(long)
minEvictableIdleTimeMillis	1800000	连接保持空闲而不被驱逐的最小时间	public void com.alibaba.druid.pool.DruidAbstractDataSource.setMinEvictableIdleTimeMillis(long)
minIdle	0	连接池最小空闲数量	public void com.alibaba.druid.pool.DruidAbstractDataSource.setMinIdle(int)
name	DataSource-****	配置这个属性的意义在于，如果存在多个数据源，监控的时候可以通过名字来区分开来。如果没有配置，将会生成一个名字，格式是："DataSource-" + System.identityHashCode(this). 另外配置此属性至少在1.0.5版本中是不起作用的，强行设置name会出错。详情-点此处。	public void com.alibaba.druid.pool.DruidAbstractDataSource.setName(java.lang.String)
numTestsPerEvictionRun	3	不再使用，已经彻底废弃，一个DruidDataSource只支持一个EvictionRun	public void com.alibaba.druid.pool.DruidAbstractDataSource.setNumTestsPerEvictionRun(int)
password	null	连接数据库的密码。如果你不希望密码直接写在配置文件中，可以使用passwordCallback进行配置，或者使用ConfigFilter。详细看这里	public void com.alibaba.druid.pool.DruidAbstractDataSource.setPassword(java.lang.String)
passwordCallback	null	可以自定义实现定制的PasswordCallback，然后实现定制的密码解密效果	public void com.alibaba.druid.pool.DruidAbstractDataSource.setPasswordCallback(javax.security.auth.callback.PasswordCallback)
phyTimeoutMillis	-1	强制回收物理连接的最大超时时长，大于0的情况下才生效，当物理创建之后存活的时长超过该值时，该连接会强制销毁，便于重新创建新连接，建议可以配置成7小时的毫秒值，比如25200000，这样可以规避MySQL的8小时连接断开问题	public void com.alibaba.druid.pool.DruidAbstractDataSource.setPhyTimeoutMillis(long)
poolPreparedStatements	false	是否缓存preparedStatement，也就是PSCache。PSCache对支持游标的数据库性能提升巨大，比如说oracle。在mysql下建议关闭。	public void com.alibaba.druid.pool.DruidDataSource.setPoolPreparedStatements(boolean)
proxyFilters		类型是List<com.alibaba.druid.filter.Filter>，如果同时配置了filters和proxyFilters，是组合关系，并非替换关系	com.alibaba.druid.pool.DruidAbstractDataSource.setProxyFilters(List)
queryTimeout	0	控制查询结果的最大超时，单位是秒，大于0才生效，最终底层调用是java.sql.Statement.setQueryTimeout(int)	public void com.alibaba.druid.pool.DruidAbstractDataSource.setQueryTimeout(int)
removeAbandoned	false	是否回收泄露的连接,默认不开启，建议只在测试环境设置未开启，利用测试环境发现业务代码中未正常关闭连接的情况	public void com.alibaba.druid.pool.DruidAbstractDataSource.setRemoveAbandoned(boolean)
removeAbandonedTimeoutMillis	300000	开启回收泄露连接的最大超时，默认300秒表示连接被借出超过5分钟后，且removeAbandoned开启的情况下，强制关闭该泄露连接	public void com.alibaba.druid.pool.DruidAbstractDataSource.setRemoveAbandonedTimeoutMillis(long)
socketTimeout	0	新增的控制创建连接时的socket最大读超时，单位是毫秒，默认0表示永远等待，配置成10000则表示db操作如果在10秒内未返回应答，将抛出异常，工作原理是在创建连接时将该值设置到对应数据库驱动的属性信息中由其JDBC驱动进行控制	public void com.alibaba.druid.pool.DruidAbstractDataSource.setSocketTimeout(int)
testOnBorrow	false	申请连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能，其实一般情况下都可以开启，只有性能要求极其高且连接使用很频繁的情况下才有必要禁用。	public void com.alibaba.druid.pool.DruidAbstractDataSource.setTestOnBorrow(boolean)
testOnReturn	false	归还连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能，这个一般不需要开启。	public void com.alibaba.druid.pool.DruidAbstractDataSource.setTestOnReturn(boolean)
testWhileIdle	true	建议配置为true，不影响性能，并且保证安全性。申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。	public void com.alibaba.druid.pool.DruidAbstractDataSource.setTestWhileIdle(boolean)
timeBetweenEvictionRunsMillis	60000	有两个含义： 1) Destroy线程会检测连接的间隔时间，如果连接空闲时间大于等于minEvictableIdleTimeMillis则关闭物理连接。 2) testWhileIdle的判断依据，详细看testWhileIdle属性的说明	public void com.alibaba.druid.pool.DruidAbstractDataSource.setTimeBetweenEvictionRunsMillis(long)
transactionQueryTimeout	0	控制查询结果的最大超时，单位是秒，大于0才生效，最终是在开启事务的情况下底层调用java.sql.Statement.setQueryTimeout(int)	public void com.alibaba.druid.pool.DruidAbstractDataSource.setTransactionQueryTimeout(int)
url		连接数据库的url，不同数据库不一样。例如： mysql : jdbc:mysql://10.20.153.104:3306/druid2 oracle : jdbc:oracle:thin:@10.20.149.85:1521:ocnauto	com.alibaba.druid.pool.DruidAbstractDataSource.setUrl(String)
username	null	连接数据库的用户名	public void com.alibaba.druid.pool.DruidAbstractDataSource.setUsername(java.lang.String)
validationQuery	null	用来检测连接是否有效的sql，要求是一个查询语句，常用select 'x'。如果validationQuery为null，testOnBorrow、testOnReturn、testWhileIdle都不会起作用。	public void com.alibaba.druid.pool.DruidAbstractDataSource.setValidationQuery(java.lang.String)
validationQueryTimeout	-1	单位：秒，检测连接是否有效的超时时间，大于0才生效。底层调用jdbc Statement对象的void setQueryTimeout(int seconds)方法	public void com.alibaba.druid.pool.DruidAbstractDataSource.setValidationQueryTimeout(int)

实际配置示例

以下配置来自某实际运行多年的项目，仅作适当信息屏蔽处理。 spring bean声明：

 <bean id="Druid-CP-Create" class="java.util.concurrent.ScheduledThreadPoolExecutor">
    <constructor-arg value="3" index="0" />
  </bean>
  <bean id="Druid-CP-Destroy" class="java.util.concurrent.ScheduledThreadPoolExecutor">
    <constructor-arg value="3" index="0" />
  </bean>
  <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
    <!-- 基本属性 url、user、password -->
    <property name="url" value="${jdbc.url}" />
    <property name="username" value="${jdbc.username}" />
    <!-- <property name="password" value="xxxxx" /> -->
    <property name="passwordCallback" ref="xxxxxxPasswordCallback" />
    <!-- 配置初始化大小、最小、最大 -->
    <property name="initialSize" value="${jdbc.initialSize}" />
    <property name="minIdle" value="${jdbc.minIdle}" />
    <property name="maxActive" value="${jdbc.maxActive}" />
    <!-- 配置获取连接等待超时的时间 -->
    <property name="maxWait" value="${jdbc.maxWait}" />
    <property name="createScheduler" ref="Druid-CP-Create" />
    <property name="destroyScheduler" ref="Druid-CP-Destroy" />
    <!-- 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 -->
    <property name="timeBetweenEvictionRunsMillis" value="${jdbc.timeBetweenEvictionRunsMillis}" />
    <!-- 配置一个连接在池中最小生存的时间，单位是毫秒 -->
    <property name="minEvictableIdleTimeMillis" value="${jdbc.minEvictableIdleTimeMillis}" />
    <!-- 空闲连接保活 -->
    <property name="keepAlive" value="true" />
    <!-- 检测语句强制用执行SQL（规避网关的假连接，参考启动属性：-Ddruid.mysql.usePingMethod=false） -->
    <property name="validationQuery" value="SELECT 1" />
    <property name="testWhileIdle" value="true" />
    <property name="testOnBorrow" value="true" />
    <property name="testOnReturn" value="false" />
    <!-- 打开PSCache，并且指定每个连接上PSCache的大小 -->
    <property name="poolPreparedStatements" value="false" />
    <!-- 使用MySQL 低版本驱动时指定连接使用utf8mb4,以便于支持4字节的emoji字符和GB18030-2022规范所要求的生僻字  -->
      <property name="connectionInitSqls">
          <list>
              <value>set NAMES 'utf8mb4'</value>
          </list>
      </property>
    <property name="connectProperties">
      <props>
      <prop key="MySQLIndexMergeOff">true</prop>
      </props>
    </property>
    <!-- 配置监控统计拦截的filters -->
    <property name="filters" value="stat,slf4j" />
    <!-- 配置监控统计filters -->
    <property name="proxyFilters">
      <list>
        <ref bean="stat-filter" />
      </list>
    </property>
  </bean>
  <bean id="xxxxxxPasswordCallback" class="cn.xxxx.druid.DruidPasswordCallback">
    <property name="password">
      <bean factory-bean="password" factory-method="toCharArray" />
    </property>
    <property name="sysPublicKeyFilePath" value="classpath:sys_pub.pem" />
    <property name="appPrivateKeyFilePath" value="classpath:sys_priv.pem" />
  </bean>
<!--加密后的密码密文内容 -->
  <bean id="password" class="java.lang.String">
    <constructor-arg index="0" value="${jdbc.password}" />
  </bean>
<!-- 自定义扩展增强的 stat filter-->
  <bean id="stat-filter" class="cn.xxxx.druid.DruidStatFilter">
    <!-- SQL 慢查询的时长 -->
    <property name="slowSqlMillis" value="200" />
    <property name="logSlowSql" value="true" />
    <property name="mergeSql" value="true" />
    <property name="maxSampleCountPerMergeSql" value="10" />
    <property name="maxUpdateCountNeedWarning" value="1000" />
    <property name="maxQueryFetchCountNeedWarning" value="1000" />
    <property name="maxQueryPacketSizeNeedWarning" value="512000" />
    <property name="slowTransactionnMillis" value="500" />
  </bean>

相应application.properties配置示例：

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://192.168.1.1:3306/test?characterEncoding=UTF-8&autoReconnect=true&allowMultiQueries=true&serverTimezone=GMT%2B8
jdbc.username=root
jdbc.password=123456
jdbc.initialSize=1
jdbc.minIdle=1
jdbc.maxActive=100
jdbc.maxWait=10000
jdbc.timeBetweenEvictionRunsMillis=60000
jdbc.minEvictableIdleTimeMillis=300000