程序包 cn.taketoday.scheduling.concurrent

类 ScheduledExecutorFactoryBean

java.lang.Object

cn.taketoday.util.CustomizableThreadCreator

cn.taketoday.scheduling.concurrent.CustomizableThreadFactory

cn.taketoday.scheduling.concurrent.ExecutorConfigurationSupport

cn.taketoday.scheduling.concurrent.ScheduledExecutorFactoryBean

所有已实现的接口:

Aware, BeanNameAware, DisposableBean, FactoryBean<ScheduledExecutorService>, InitializingBean, Serializable, ThreadFactory

public class ScheduledExecutorFactoryBean
extends ExecutorConfigurationSupport
implements FactoryBean<ScheduledExecutorService>

FactoryBean that sets up a ScheduledExecutorService (by default: a ScheduledThreadPoolExecutor) and exposes it for bean references.

Allows for registration of ScheduledExecutorTasks, automatically starting the ScheduledExecutorService on initialization and cancelling it on destruction of the context. In scenarios that only require static registration of tasks at startup, there is no need to access the ScheduledExecutorService instance itself in application code at all; ScheduledExecutorFactoryBean is then just being used for lifecycle integration.

For an alternative, you may set up a ScheduledThreadPoolExecutor instance directly using constructor injection, or use a factory method definition that points to the Executors class. This is strongly recommended in particular for common @Component methods in configuration classes, where this FactoryBean variant would force you to return the FactoryBean type instead of ScheduledExecutorService.

Note that ScheduledExecutorService uses a Runnable instance that is shared between repeated executions, in contrast to Quartz which instantiates a new Job for each execution.

WARNING: Runnables submitted via a native ScheduledExecutorService are removed from the execution schedule once they throw an exception. If you would prefer to continue execution after such an exception, switch this FactoryBean's "continueScheduledExecutionAfterException" property to "true".

从以下版本开始:

4.0

作者:

Juergen Hoeller

另请参阅:

• setPoolSize(int)
• setRemoveOnCancelPolicy(boolean)
• ExecutorConfigurationSupport.setThreadFactory(java.util.concurrent.ThreadFactory)
• ScheduledExecutorTask
• ScheduledExecutorService
• ScheduledThreadPoolExecutor
• 序列化表格

字段概要

从类继承的字段 cn.taketoday.scheduling.concurrent.ExecutorConfigurationSupport

logger

从接口继承的字段 cn.taketoday.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

构造器概要

构造器

构造器	说明
ScheduledExecutorFactoryBean()

方法概要

修饰符和类型	方法	说明
protected ScheduledExecutorService	createExecutor(int poolSize, ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)	Create a new ScheduledExecutorService instance.
ScheduledExecutorService	getObject()
Class<? extends ScheduledExecutorService>	getObjectType()
protected Runnable	getRunnableToSchedule(ScheduledExecutorTask task)	Determine the actual Runnable to schedule for the given task.
protected ExecutorService	initializeExecutor(ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)	Create the target ExecutorService instance.
boolean	isSingleton()
protected void	registerTasks(ScheduledExecutorTask[] tasks, ScheduledExecutorService executor)	Register the specified ScheduledExecutorTasks on the given ScheduledExecutorService.
void	setContinueScheduledExecutionAfterException(boolean continueScheduledExecutionAfterException)	Specify whether to continue the execution of a scheduled task after it threw an exception.
void	setExposeUnconfigurableExecutor(boolean exposeUnconfigurableExecutor)	Specify whether this FactoryBean should expose an unconfigurable decorator for the created executor.
void	setPoolSize(int poolSize)	Set the ScheduledExecutorService's pool size.
void	setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)	Set the remove-on-cancel mode on ScheduledThreadPoolExecutor.
void	setScheduledExecutorTasks(ScheduledExecutorTask... scheduledExecutorTasks)	Register a list of ScheduledExecutorTask objects with the ScheduledExecutorService that this FactoryBean creates.

从类继承的方法 cn.taketoday.scheduling.concurrent.ExecutorConfigurationSupport

afterPropertiesSet, cancelRemainingTask, destroy, initialize, setAwaitTerminationMillis, setAwaitTerminationSeconds, setBeanName, setRejectedExecutionHandler, setThreadFactory, setThreadNamePrefix, setWaitForTasksToCompleteOnShutdown, shutdown

从类继承的方法 cn.taketoday.scheduling.concurrent.CustomizableThreadFactory

newThread

从类继承的方法 cn.taketoday.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

构造器详细资料

ScheduledExecutorFactoryBean

public ScheduledExecutorFactoryBean()

方法详细资料

setPoolSize

public void setPoolSize(int poolSize)

Set the ScheduledExecutorService's pool size. Default is 1.

setScheduledExecutorTasks

public void setScheduledExecutorTasks(ScheduledExecutorTask... scheduledExecutorTasks)

Register a list of ScheduledExecutorTask objects with the ScheduledExecutorService that this FactoryBean creates. Depending on each ScheduledExecutorTask's settings, it will be registered via one of ScheduledExecutorService's schedule methods.

另请参阅:

• ScheduledExecutorService.schedule(Runnable, long, java.util.concurrent.TimeUnit)
• ScheduledExecutorService.scheduleWithFixedDelay(Runnable, long, long, java.util.concurrent.TimeUnit)
• ScheduledExecutorService.scheduleAtFixedRate(Runnable, long, long, java.util.concurrent.TimeUnit)

setRemoveOnCancelPolicy

public void setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)

Set the remove-on-cancel mode on ScheduledThreadPoolExecutor.

Default is false. If set to true, the target executor will be switched into remove-on-cancel mode (if possible, with a soft fallback otherwise).

setContinueScheduledExecutionAfterException

public void setContinueScheduledExecutionAfterException(boolean continueScheduledExecutionAfterException)

Specify whether to continue the execution of a scheduled task after it threw an exception.

Default is "false", matching the native behavior of a ScheduledExecutorService. Switch this flag to "true" for exception-proof execution of each task, continuing scheduled execution as in the case of successful execution.

另请参阅:

• ScheduledExecutorService.scheduleAtFixedRate(java.lang.Runnable, long, long, java.util.concurrent.TimeUnit)

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.

另请参阅:

• Executors.unconfigurableScheduledExecutorService(java.util.concurrent.ScheduledExecutorService)

initializeExecutor

protected ExecutorService initializeExecutor(ThreadFactory threadFactory,
 RejectedExecutionHandler rejectedExecutionHandler)

从类复制的说明: ExecutorConfigurationSupport

Create the target ExecutorService instance. Called by afterPropertiesSet.

指定者:

initializeExecutor 在类中 ExecutorConfigurationSupport

参数:

threadFactory - the ThreadFactory to use

rejectedExecutionHandler - the RejectedExecutionHandler to use

返回:

a new ExecutorService instance

另请参阅:

• ExecutorConfigurationSupport.afterPropertiesSet()

createExecutor

protected ScheduledExecutorService createExecutor(int poolSize,
 ThreadFactory threadFactory,
 RejectedExecutionHandler rejectedExecutionHandler)

Create a new ScheduledExecutorService instance.

The default implementation creates a ScheduledThreadPoolExecutor. Can be overridden in subclasses to provide custom ScheduledExecutorService instances.

参数:

poolSize - the specified pool size

threadFactory - the ThreadFactory to use

rejectedExecutionHandler - the RejectedExecutionHandler to use

返回:

a new ScheduledExecutorService instance

另请参阅:

• ExecutorConfigurationSupport.afterPropertiesSet()
• ScheduledThreadPoolExecutor

registerTasks

protected void registerTasks(ScheduledExecutorTask[] tasks,
 ScheduledExecutorService executor)

Register the specified ScheduledExecutorTasks on the given ScheduledExecutorService.

参数:

tasks - the specified ScheduledExecutorTasks (never empty)

executor - the ScheduledExecutorService to register the tasks on.

getRunnableToSchedule

protected Runnable getRunnableToSchedule(ScheduledExecutorTask task)

Determine the actual Runnable to schedule for the given task.

Wraps the task's Runnable in a DelegatingErrorHandlingRunnable that will catch and log the Exception. If necessary, it will suppress the Exception according to the "continueScheduledExecutionAfterException" flag.

参数:

task - the ScheduledExecutorTask to schedule

返回:

the actual Runnable to schedule (may be a decorator)

getObject

@Nullable
public ScheduledExecutorService getObject()

指定者:

getObject 在接口中 FactoryBean<ScheduledExecutorService>

getObjectType

public Class<? extends ScheduledExecutorService> getObjectType()

指定者:

getObjectType 在接口中 FactoryBean<ScheduledExecutorService>

isSingleton

public boolean isSingleton()

指定者:

isSingleton 在接口中 FactoryBean<ScheduledExecutorService>