类 ThreadPoolExecutorFactoryBean
- java.lang.Object
- org.springframework.util.CustomizableThreadCreator
- org.springframework.scheduling.concurrent.CustomizableThreadFactory
- org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
- org.springframework.scheduling.concurrent.ThreadPoolExecutorFactoryBean
- 所有已实现的接口:
Serializable
,ThreadFactory
,Aware
,BeanNameAware
,DisposableBean
,FactoryBean<ExecutorService>
,InitializingBean
public class ThreadPoolExecutorFactoryBean extends ExecutorConfigurationSupport implements FactoryBean<ExecutorService>, InitializingBean, DisposableBean
JavaBean that allows for configuring aThreadPoolExecutor
in bean style (through its "corePoolSize", "maxPoolSize", "keepAliveSeconds", "queueCapacity" properties) and exposing it as a bean reference of its nativeExecutorService
type.The default configuration is a core pool size of 1, with unlimited max pool size and unlimited queue capacity. This is roughly equivalent to
Executors.newSingleThreadExecutor()
, sharing a single thread for all tasks. Setting"queueCapacity"
to 0 mimicsExecutors.newCachedThreadPool()
, with immediate scaling of threads in the pool to a potentially very high number. Consider also setting a"maxPoolSize"
at that point, as well as possibly a higher"corePoolSize"
(see also the"allowCoreThreadTimeOut"
mode of scaling).For an alternative, you may set up a
ThreadPoolExecutor
instance directly using constructor injection, or use a factory method definition that points to theExecutors
class. This is strongly recommended in particular for common@Bean
methods in configuration classes, where thisFactoryBean
variant would force you to return theFactoryBean
type instead of the actualExecutor
type.If you need a timing-based
ScheduledExecutorService
instead, considerScheduledExecutorFactoryBean
.- 从以下版本开始:
- 3.0
- 作者:
- Juergen Hoeller
- 另请参阅:
ExecutorService
,Executors
,ThreadPoolExecutor
, 序列化表格
字段概要
从类继承的字段 org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
logger
构造器概要
构造器 构造器 说明 ThreadPoolExecutorFactoryBean()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 protected ThreadPoolExecutor
createExecutor(int corePoolSize, int maxPoolSize, int keepAliveSeconds, BlockingQueue<Runnable> queue, ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)
Create a new instance ofThreadPoolExecutor
or a subclass thereof.protected BlockingQueue<Runnable>
createQueue(int queueCapacity)
Create the BlockingQueue to use for the ThreadPoolExecutor.ExecutorService
getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<? extends ExecutorService>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.protected ExecutorService
initializeExecutor(ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)
Create the targetExecutorService
instance.boolean
isSingleton()
Is the object managed by this factory a singleton?void
setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)
Specify whether to allow core threads to time out.void
setCorePoolSize(int corePoolSize)
Set the ThreadPoolExecutor's core pool size.void
setExposeUnconfigurableExecutor(boolean exposeUnconfigurableExecutor)
Specify whether this FactoryBean should expose an unconfigurable decorator for the created executor.void
setKeepAliveSeconds(int keepAliveSeconds)
Set the ThreadPoolExecutor's keep-alive seconds.void
setMaxPoolSize(int maxPoolSize)
Set the ThreadPoolExecutor's maximum pool size.void
setQueueCapacity(int queueCapacity)
Set the capacity for the ThreadPoolExecutor's BlockingQueue.从类继承的方法 org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
afterPropertiesSet, destroy, initialize, setAwaitTerminationSeconds, setBeanName, setRejectedExecutionHandler, setThreadFactory, setThreadNamePrefix, setWaitForTasksToCompleteOnShutdown, shutdown
从类继承的方法 org.springframework.scheduling.concurrent.CustomizableThreadFactory
newThread
从类继承的方法 org.springframework.util.CustomizableThreadCreator
createThread, getDefaultThreadNamePrefix, getThreadGroup, getThreadNamePrefix, getThreadPriority, isDaemon, nextThreadName, setDaemon, setThreadGroup, setThreadGroupName, setThreadPriority
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.beans.factory.DisposableBean
destroy
从接口继承的方法 org.springframework.beans.factory.InitializingBean
afterPropertiesSet
构造器详细资料
ThreadPoolExecutorFactoryBean
public ThreadPoolExecutorFactoryBean()
方法详细资料
setCorePoolSize
public void setCorePoolSize(int corePoolSize)
Set the ThreadPoolExecutor's core pool size. Default is 1.
setMaxPoolSize
public void setMaxPoolSize(int maxPoolSize)
Set the ThreadPoolExecutor's maximum pool size. Default isInteger.MAX_VALUE
.
setKeepAliveSeconds
public void setKeepAliveSeconds(int keepAliveSeconds)
Set the ThreadPoolExecutor's keep-alive seconds. Default is 60.
setAllowCoreThreadTimeOut
public void setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)
Specify whether to allow core threads to time out. This enables dynamic growing and shrinking even in combination with a non-zero queue (since the max pool size will only grow once the queue is full).Default is "false".
setQueueCapacity
public void setQueueCapacity(int queueCapacity)
Set the capacity for the ThreadPoolExecutor's BlockingQueue. Default isInteger.MAX_VALUE
.Any positive value will lead to a LinkedBlockingQueue instance; any other value will lead to a SynchronousQueue instance.
setExposeUnconfigurableExecutor
public void setExposeUnconfigurableExecutor(boolean exposeUnconfigurableExecutor)
Specify whether this FactoryBean should expose an unconfigurable decorator for the created executor.Default is "false", exposing the raw executor as bean reference. Switch this flag to "true" to strictly prevent clients from modifying the executor's configuration.
initializeExecutor
protected ExecutorService initializeExecutor(ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)
从类复制的说明:ExecutorConfigurationSupport
Create the targetExecutorService
instance. Called byafterPropertiesSet
.- 指定者:
initializeExecutor
在类中ExecutorConfigurationSupport
- 参数:
threadFactory
- the ThreadFactory to userejectedExecutionHandler
- the RejectedExecutionHandler to use- 返回:
- a new ExecutorService instance
- 另请参阅:
ExecutorConfigurationSupport.afterPropertiesSet()
createExecutor
protected ThreadPoolExecutor createExecutor(int corePoolSize, int maxPoolSize, int keepAliveSeconds, BlockingQueue<Runnable> queue, ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)
Create a new instance ofThreadPoolExecutor
or a subclass thereof.The default implementation creates a standard
ThreadPoolExecutor
. Can be overridden to provide customThreadPoolExecutor
subclasses.- 参数:
corePoolSize
- the specified core pool sizemaxPoolSize
- the specified maximum pool sizekeepAliveSeconds
- the specified keep-alive time in secondsqueue
- the BlockingQueue to usethreadFactory
- the ThreadFactory to userejectedExecutionHandler
- the RejectedExecutionHandler to use- 返回:
- a new ThreadPoolExecutor instance
- 另请参阅:
ExecutorConfigurationSupport.afterPropertiesSet()
createQueue
protected BlockingQueue<Runnable> createQueue(int queueCapacity)
Create the BlockingQueue to use for the ThreadPoolExecutor.A LinkedBlockingQueue instance will be created for a positive capacity value; a SynchronousQueue else.
- 参数:
queueCapacity
- the specified queue capacity- 返回:
- the BlockingQueue instance
- 另请参阅:
LinkedBlockingQueue
,SynchronousQueue
getObject
public ExecutorService getObject()
从接口复制的说明:FactoryBean
Return an instance (possibly shared or independent) of the object managed by this factory.As with a
BeanFactory
, this allows support for both the Singleton and Prototype design pattern.If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding
FactoryBeanNotInitializedException
.As of Spring 2.0, FactoryBeans are allowed to return
null
objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.- 指定者:
getObject
在接口中FactoryBean<ExecutorService>
- 返回:
- an instance of the bean (can be
null
) - 另请参阅:
FactoryBeanNotInitializedException
getObjectType
public Class<? extends ExecutorService> getObjectType()
从接口复制的说明:FactoryBean
Return the type of object that this FactoryBean creates, ornull
if not known in advance.This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null
here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.- 指定者:
getObjectType
在接口中FactoryBean<ExecutorService>
- 返回:
- the type of object that this FactoryBean creates, or
null
if not known at the time of the call - 另请参阅:
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
isSingleton
public boolean isSingleton()
从接口复制的说明:FactoryBean
Is the object managed by this factory a singleton? That is, willFactoryBean.getObject()
always return the same object (a reference that can be cached)?NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from
getObject()
might get cached by the owning BeanFactory. Hence, do not returntrue
unless the FactoryBean always exposes the same reference.The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning
false
does not necessarily indicate that returned objects are independent instances. An implementation of the extendedSmartFactoryBean
interface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()
method. PlainFactoryBean
implementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()
implementation returnsfalse
.- 指定者:
isSingleton
在接口中FactoryBean<ExecutorService>
- 返回:
- whether the exposed object is a singleton
- 另请参阅:
FactoryBean.getObject()
,SmartFactoryBean.isPrototype()