类 ForkJoinPoolFactoryBean
- java.lang.Object
- org.springframework.scheduling.concurrent.ForkJoinPoolFactoryBean
- 所有已实现的接口:
DisposableBean
,FactoryBean<ForkJoinPool>
,InitializingBean
public class ForkJoinPoolFactoryBean extends Object implements FactoryBean<ForkJoinPool>, InitializingBean, DisposableBean
A SpringFactoryBean
that builds and exposes a preconfiguredForkJoinPool
.- 从以下版本开始:
- 3.1
- 作者:
- Juergen Hoeller
字段概要
从接口继承的字段 org.springframework.beans.factory.FactoryBean
OBJECT_TYPE_ATTRIBUTE
构造器概要
构造器 构造器 说明 ForkJoinPoolFactoryBean()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
afterPropertiesSet()
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.void
destroy()
Invoked by the containingBeanFactory
on destruction of a bean.ForkJoinPool
getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.Class<?>
getObjectType()
Return the type of object that this FactoryBean creates, ornull
if not known in advance.boolean
isSingleton()
Is the object managed by this factory a singleton?void
setAsyncMode(boolean asyncMode)
Specify whether to establish a local first-in-first-out scheduling mode for forked tasks that are never joined.void
setAwaitTerminationSeconds(int awaitTerminationSeconds)
Set the maximum number of seconds that this ForkJoinPool is supposed to block on shutdown in order to wait for remaining tasks to complete their execution before the rest of the container continues to shut down.void
setCommonPool(boolean commonPool)
Set whether to expose JDK 8's 'common'ForkJoinPool
.void
setParallelism(int parallelism)
Specify the parallelism level.void
setThreadFactory(ForkJoinPool.ForkJoinWorkerThreadFactory threadFactory)
Set the factory for creating new ForkJoinWorkerThreads.void
setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)
Set the handler for internal worker threads that terminate due to unrecoverable errors encountered while executing tasks.
构造器详细资料
ForkJoinPoolFactoryBean
public ForkJoinPoolFactoryBean()
方法详细资料
setCommonPool
public void setCommonPool(boolean commonPool)
Set whether to expose JDK 8's 'common'ForkJoinPool
.Default is "false", creating a local
ForkJoinPool
instance based on the"parallelism"
,"threadFactory"
,"uncaughtExceptionHandler"
and"asyncMode"
properties on this FactoryBean.NOTE: Setting this flag to "true" effectively ignores all other properties on this FactoryBean, reusing the shared common JDK
ForkJoinPool
instead. This is a fine choice on JDK 8 but does remove the application's ability to customize ForkJoinPool behavior, in particular the use of custom threads.- 从以下版本开始:
- 3.2
- 另请参阅:
ForkJoinPool.commonPool()
setParallelism
public void setParallelism(int parallelism)
Specify the parallelism level. Default isRuntime.availableProcessors()
.
setThreadFactory
public void setThreadFactory(ForkJoinPool.ForkJoinWorkerThreadFactory threadFactory)
Set the factory for creating new ForkJoinWorkerThreads. Default isForkJoinPool.defaultForkJoinWorkerThreadFactory
.
setUncaughtExceptionHandler
public void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)
Set the handler for internal worker threads that terminate due to unrecoverable errors encountered while executing tasks. Default is none.
setAsyncMode
public void setAsyncMode(boolean asyncMode)
Specify whether to establish a local first-in-first-out scheduling mode for forked tasks that are never joined. This mode (asyncMode =true
) may be more appropriate than the default locally stack-based mode in applications in which worker threads only process event-style asynchronous tasks. Default isfalse
.
setAwaitTerminationSeconds
public void setAwaitTerminationSeconds(int awaitTerminationSeconds)
Set the maximum number of seconds that this ForkJoinPool is supposed to block on shutdown in order to wait for remaining tasks to complete their execution before the rest of the container continues to shut down. This is particularly useful if your remaining tasks are likely to need access to other resources that are also managed by the container.By default, this ForkJoinPool won't wait for the termination of tasks at all. It will continue to fully execute all ongoing tasks as well as all remaining tasks in the queue, in parallel to the rest of the container shutting down. In contrast, if you specify an await-termination period using this property, this executor will wait for the given time (max) for the termination of tasks.
Note that this feature works for the
"commonPool"
mode as well. The underlying ForkJoinPool won't actually terminate in that case but will wait for all tasks to terminate.
afterPropertiesSet
public void afterPropertiesSet()
从接口复制的说明:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- 指定者:
afterPropertiesSet
在接口中InitializingBean
getObject
@Nullable public ForkJoinPool 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<ForkJoinPool>
- 返回:
- an instance of the bean (can be
null
) - 另请参阅:
FactoryBeanNotInitializedException
getObjectType
public Class<?> 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<ForkJoinPool>
- 返回:
- 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
.The default implementation returns
true
, since aFactoryBean
typically manages a singleton instance.- 指定者:
isSingleton
在接口中FactoryBean<ForkJoinPool>
- 返回:
- whether the exposed object is a singleton
- 另请参阅:
FactoryBean.getObject()
,SmartFactoryBean.isPrototype()
destroy
public void destroy()
从接口复制的说明:DisposableBean
Invoked by the containingBeanFactory
on destruction of a bean.- 指定者:
destroy
在接口中DisposableBean