apache commons-pool的配置参数

apache commons-pool的配置参数

write by yinmingjun，引用请注明。

 

最近在研究jedis，jedis的对象池是借助于apache的commons-pool实现的，发现关于commons-pool的文档真的很少，也许是大家都觉得commons-pool足够简单吧，不需要一个文档来描述。

 

看 了一下commons-pool的代码，写的真的很好，在java社区总是有这么一些人，在做无私的奉献，很佩服。在空闲之余，写一下commons- pool的配置说明，帮助那些只是希望简单理解或使用commons-pool的同学，知道如何配置commons-pool。

 

本文基于apache commons-pool-1.5.5。

 

对pool的配置一般是通过org.apache.commons.pool.impl.GenericObjectPool.Config来完成，这是个简单的数值对象，每个成员都预设了默认值，这里我们详细的介绍一下里面的各个成员的含义。

 

maxActive

控制池中对象的最大数量。

默认值是8，如果是负值表示没限制。

 

maxIdle

控制池中空闲的对象的最大数量。

默认值是8，如果是负值表示没限制。

 

minIdle

控制池中空闲的对象的最小数量。

默认值是0。

 

whenExhaustedAction

指定池中对象被消耗完以后的行为，有下面这些选择：

• WHEN_EXHAUSTED_FAIL                  0

• WHEN_EXHAUSTED_GROW             2

• WHEN_EXHAUSTED_BLOCK             1

 

如果是WHEN_EXHAUSTED_FAIL，当池中对象达到上限以后，继续borrowObject会抛出NoSuchElementException异常。

如果是WHEN_EXHAUSTED_GROW，当池中对象达到上限以后，会创建一个新对象，并返回它。

如果是WHEN_EXHAUSTED_BLOCK，当池中对象达到上限以后，会一直等待，直到有一个对象可用。这个行为还与maxWait有关，如果maxWait是正数，那么会等待maxWait的毫秒的时间，超时会抛出NoSuchElementException异常；如果maxWait为负值，会永久等待。

 

whenExhaustedAction 的默认值是WHEN_EXHAUSTED_BLOCK，maxWait的默认值是-1。

 

maxWait

whenExhaustedAction 如果是WHEN_EXHAUSTED_BLOCK，指定等待的毫秒数。如果maxWait是正数，那么会等待maxWait的毫秒的时间，超时会抛出NoSuchElementException异常；如果maxWait为负值，会永久等待。

maxWait的默认值是-1。

 

testOnBorrow

如果testOnBorrow被设置，pool会在borrowObject返回对象之前使用PoolableObjectFactory的validateObject来验证这个对象是否有效，要是对象没通过验证，这个对象会被丢弃，然后重新选择一个新的对象。

 

testOnBorrow的默认值是false。

 

testOnReturn

如果testOnReturn被设置，pool会在returnObject的时候通过PoolableObjectFactory的validateObject方法验证对象，如果对象没通过验证，对象会被丢弃，不会被放到池中。

 

testOnReturn的默认值是false。

 

testWhileIdle

指定idle对象是否应该使用PoolableObjectFactory的validateObject校验，如果校验失败，这个对象会从对象池中被清除。

这个设置仅在timeBetweenEvictionRunsMillis被设置成正值（>0）的时候才会生效。

testWhileIdle的默认值是false。

 

timeBetweenEvictionRunsMillis

指定驱逐线程的休眠时间。如果这个值不是正数（>0），不会有驱逐线程运行。

timeBetweenEvictionRunsMillis的默认值是-1。

 

numTestsPerEvictionRun

设置驱逐线程每次检测对象的数量。

这个设置仅在timeBetweenEvictionRunsMillis被设置成正值（>0）的时候才会生效。

numTestsPerEvictionRun的默认值是3。

 

minEvictableIdleTimeMillis

指定最小的空闲驱逐的时间间隔（空闲超过指定的时间的对象，会被清除掉）。

这个设置仅在timeBetweenEvictionRunsMillis被设置成正值（>0）的时候才会生效。

minEvictableIdleTimeMillis默认值是30分钟。

 

softMinEvictableIdleTimeMillis

与minEvictableIdleTimeMillis类似，也是指定最小的空闲驱逐的时间间隔（空闲超过指定的时间的对象，会被清除掉），不过会参考minIdle的值，只有idle对象的数量超过minIdle的值，对象才会被清除。

这个设置仅在timeBetweenEvictionRunsMillis被设置成正值（>0）的时候才会生效，并且这个配置能被minEvictableIdleTimeMillis配置取代（minEvictableIdleTimeMillis配置项的优先级更高）。

softMinEvictableIdleTimeMillis的默认值是-1。

 

lifo

pool可以被配置成LIFO队列（last-in-first-out）或FIFO队列（first-in-first-out），来指定空闲对象被使用的次序。

lifo的默认值是true。