クラス ScheduledExecutorFactoryBean
- 実装されたすべてのインターフェース:
SerializableSE
、ThreadFactorySE
、EventListenerSE
、Aware
、BeanNameAware
、DisposableBean
、FactoryBean<ScheduledExecutorServiceSE>
、InitializingBean
、ApplicationContextAware
、ApplicationListener<ContextClosedEvent>
、Lifecycle
、Phased
、SmartLifecycle
ScheduledExecutorService
SE(デフォルト: ScheduledThreadPoolExecutor
SE)をセットアップし、Bean 参照用に公開する FactoryBean
。ScheduledExecutorTasks
の登録を許可し、初期化時に ScheduledExecutorService
SE を自動的に開始し、コンテキストの破棄時にキャンセルします。起動時にタスクの静的登録のみが必要なシナリオでは、アプリケーションコードで ScheduledExecutorService
SE インスタンス自体にアクセスする必要はまったくありません。ScheduledExecutorFactoryBean
は、ライフサイクル統合に使用されています。
別の方法として、コンストラクターインジェクションを使用して ScheduledThreadPoolExecutor
SE インスタンスを直接セットアップするか、Executors
SE クラスを指すファクトリメソッド定義を使用することができます。 これは特に、構成クラスの一般的な @Bean
メソッドに強くお勧めします。この FactoryBean
バリアントでは、ScheduledExecutorService
の代わりに FactoryBean
型を強制的に返すことになります。
ScheduledExecutorService
SE は、実行ごとに新しいジョブをインスタンス化する Quartz とは対照的に、繰り返し実行間で共有される Runnable
SE インスタンスを使用することに注意してください。
警告 : ネイティブ ScheduledExecutorService
SE を介して送信された Runnables
SE は、例外をスローすると、実行スケジュールから削除されます。このような例外の後も実行を継続する場合は、この FactoryBean の "continueScheduledExecutionAfterException"
プロパティを "true" に切り替えます。
フィールドサマリー
クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたフィールド
DEFAULT_PHASE, logger
インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
OBJECT_TYPE_ATTRIBUTE
コンストラクターのサマリー
方法の概要
修飾子と型メソッド説明protected ScheduledExecutorServiceSE
createExecutor
(int poolSize, ThreadFactorySE threadFactory, RejectedExecutionHandlerSE rejectedExecutionHandler) 新しいScheduledExecutorService
SE インスタンスを作成します。このファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。ClassSE<? extends ScheduledExecutorServiceSE>
この FactoryBean が作成するオブジェクトの型、または事前に不明な場合はnull
を返します。protected RunnableSE
特定のタスクをスケジュールする実際の Runnable を決定します。protected ExecutorServiceSE
initializeExecutor
(ThreadFactorySE threadFactory, RejectedExecutionHandlerSE rejectedExecutionHandler) ターゲットExecutorService
SE インスタンスを作成します。boolean
このファクトリによって管理されるオブジェクトはシングルトンですか? つまり、FactoryBean.getObject()
は常に同じオブジェクト(キャッシュ可能な参照)を返しますか?protected void
registerTasks
(ScheduledExecutorTask[] tasks, ScheduledExecutorServiceSE executor) 指定されたScheduledExecutorTasks
を指定されたScheduledExecutorService
SE に登録します。void
setContinueScheduledExecutionAfterException
(boolean continueScheduledExecutionAfterException) 例外をスローした後、スケジュールされたタスクの実行を継続するかどうかを指定します。void
setExposeUnconfigurableExecutor
(boolean exposeUnconfigurableExecutor) この FactoryBean が、作成されたエグゼキューターの構成不可能なデコレーターを公開するかどうかを指定します。void
setPoolSize
(int poolSize) ScheduledExecutorService のプールサイズを設定します。void
setRemoveOnCancelPolicy
(boolean removeOnCancelPolicy) ScheduledThreadPoolExecutor
SE でキャンセル時に削除モードを設定します。void
setScheduledExecutorTasks
(ScheduledExecutorTask... scheduledExecutorTasks) ScheduledExecutorTask オブジェクトのリストを、この FactoryBean が作成する ScheduledExecutorService に登録します。クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたメソッド
afterExecute, afterPropertiesSet, beforeExecute, cancelRemainingTask, destroy, getPhase, initialize, initiateEarlyShutdown, initiateShutdown, isRunning, onApplicationEvent, setAcceptTasksAfterContextClose, setApplicationContext, setAwaitTerminationMillis, setAwaitTerminationSeconds, setBeanName, setPhase, setRejectedExecutionHandler, setThreadFactory, setThreadNamePrefix, setVirtualThreads, setWaitForTasksToCompleteOnShutdown, shutdown, start, stop, stop
クラス org.springframework.scheduling.concurrent.CustomizableThreadFactory から継承されたメソッド
newThread
クラス org.springframework.util.CustomizableThreadCreator から継承されたメソッド
createThread, getDefaultThreadNamePrefix, getThreadGroup, getThreadNamePrefix, getThreadPriority, isDaemon, nextThreadName, setDaemon, setThreadGroup, setThreadGroupName, setThreadPriority
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.context.ApplicationListener から継承されたメソッド
supportsAsyncExecution
インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド
isAutoStartup
コンストラクターの詳細
ScheduledExecutorFactoryBean
public ScheduledExecutorFactoryBean()
メソッドの詳細
setPoolSize
public void setPoolSize(int poolSize) ScheduledExecutorService のプールサイズを設定します。デフォルトは 1 です。setScheduledExecutorTasks
ScheduledExecutorTask オブジェクトのリストを、この FactoryBean が作成する ScheduledExecutorService に登録します。各 ScheduledExecutorTask の設定に応じて、ScheduledExecutorService のスケジュール方法の 1 つを介して登録されます。- 関連事項:
ScheduledExecutorService.schedule(java.lang.Runnable, long, java.util.concurrent.TimeUnit)
SEScheduledExecutorService.scheduleWithFixedDelay(java.lang.Runnable, long, long, java.util.concurrent.TimeUnit)
SEScheduledExecutorService.scheduleAtFixedRate(java.lang.Runnable, long, long, java.util.concurrent.TimeUnit)
SE
setRemoveOnCancelPolicy
public void setRemoveOnCancelPolicy(boolean removeOnCancelPolicy) ScheduledThreadPoolExecutor
SE でキャンセル時に削除モードを設定します。デフォルトは
false
です。true
に設定されている場合、ターゲットエグゼキューターはキャンセル時に削除モードに切り替えられます(可能な場合は、ソフトフォールバックが使用されます)。setContinueScheduledExecutionAfterException
public void setContinueScheduledExecutionAfterException(boolean continueScheduledExecutionAfterException) 例外をスローした後、スケジュールされたタスクの実行を継続するかどうかを指定します。デフォルトは "false" で、
ScheduledExecutorService
SE のネイティブの動作に一致します。各タスクの例外のない実行のためにこのフラグを "true" に切り替え、正常に実行された場合のようにスケジュールされた実行を継続します。setExposeUnconfigurableExecutor
public void setExposeUnconfigurableExecutor(boolean exposeUnconfigurableExecutor) この FactoryBean が、作成されたエグゼキューターの構成不可能なデコレーターを公開するかどうかを指定します。デフォルトは "false" で、生のエグゼキューターを Bean 参照として公開します。このフラグを "true" に切り替えて、クライアントがエグゼキューターの構成を変更できないようにします。
initializeExecutor
protected ExecutorServiceSE initializeExecutor(ThreadFactorySE threadFactory, RejectedExecutionHandlerSE rejectedExecutionHandler) クラスからコピーされた説明:ExecutorConfigurationSupport
ターゲットExecutorService
SE インスタンスを作成します。afterPropertiesSet
によって呼び出されます。- 次で指定:
- クラス
ExecutorConfigurationSupport
のinitializeExecutor
- パラメーター:
threadFactory
- 使用する ThreadFactoryrejectedExecutionHandler
- 使用する RejectedExecutionHandler- 戻り値:
- 新しい ExecutorService インスタンス
- 関連事項:
createExecutor
protected ScheduledExecutorServiceSE createExecutor(int poolSize, ThreadFactorySE threadFactory, RejectedExecutionHandlerSE rejectedExecutionHandler) 新しいScheduledExecutorService
SE インスタンスを作成します。デフォルト実装は
ScheduledThreadPoolExecutor
SE を作成します。サブクラスでオーバーライドして、カスタムScheduledExecutorService
SE インスタンスを提供できます。- パラメーター:
poolSize
- 指定されたプールサイズthreadFactory
- 使用する ThreadFactoryrejectedExecutionHandler
- 使用する RejectedExecutionHandler- 戻り値:
- 新しい ScheduledExecutorService インスタンス
- 関連事項:
registerTasks
指定されたScheduledExecutorTasks
を指定されたScheduledExecutorService
SE に登録します。- パラメーター:
tasks
- 指定された ScheduledExecutorTasks (空になることはありません)executor
- タスクを登録する ScheduledExecutorService
getRunnableToSchedule
特定のタスクをスケジュールする実際の Runnable を決定します。例外をキャッチしてログに記録する
DelegatingErrorHandlingRunnable
でタスクの Runnable をラップします。必要に応じて、"continueScheduledExecutionAfterException"
フラグに従って例外を抑制します。- パラメーター:
task
- スケジュールする ScheduledExecutorTask- 戻り値:
- スケジュールする実際の Runnable (デコレータかもしれません)
getObject
インターフェースからコピーされた説明:FactoryBean
このファクトリによって管理されるオブジェクトのインスタンス(おそらく共有または独立)を返します。BeanFactory
と同様に、これにより、シングルトンとプロトタイプの両方の設計パターンをサポートできます。この FactoryBean が呼び出し時にまだ完全に初期化されていない場合(たとえば、循環参照に関係しているため)、対応する
FactoryBeanNotInitializedException
をスローします。FactoryBeans は
null
オブジェクトを返すことができます。Bean ファクトリはこれを通常の値と見なし、この場合はFactoryBeanNotInitializedException
をスローしません。ただし、FactoryBean 実装では、必要に応じてFactoryBeanNotInitializedException
自体をスローすることが推奨されます。- 次で指定:
- インターフェース
FactoryBean<ScheduledExecutorServiceSE>
のgetObject
- 戻り値:
- Bean のインスタンス (
null
にすることができます) - 関連事項:
getObjectType
インターフェースからコピーされた説明:FactoryBean
この FactoryBean が作成するオブジェクトの型、または事前に不明な場合はnull
を返します。これにより、たとえばオートワイヤーなどで、オブジェクトをインスタンス化せずに特定の型の Bean を確認できます。
シングルトンオブジェクトを作成する実装の場合、このメソッドはシングルトンの作成を可能な限り回避し、事前に型を推定する必要があります。プロトタイプの場合は、ここで意味のある型を返すことも推奨されます。
このメソッドは、この FactoryBean が完全に初期化される前に呼び出すことができます。初期化中に作成された状態に依存しないでください。もちろん、利用可能な場合はそのような状態を引き続き使用できます。
注意 : オートワイヤーは、ここで
null
を返す FactoryBeans を単に無視します。FactoryBean の現在の状態を使用して、このメソッドを適切に実装することを強くお勧めします。- 次で指定:
- インターフェース
FactoryBean<ScheduledExecutorServiceSE>
のgetObjectType
- 戻り値:
- この FactoryBean が作成するオブジェクトの型、または呼び出し時に不明な場合は
null
- 関連事項:
isSingleton
public boolean isSingleton()インターフェースからコピーされた説明:FactoryBean
このファクトリによって管理されるオブジェクトはシングルトンですか? つまり、FactoryBean.getObject()
は常に同じオブジェクト(キャッシュ可能な参照)を返しますか?注意 : FactoryBean がシングルトンオブジェクトを保持していることを示している場合、
getObject()
から返されたオブジェクトは、所有する BeanFactory によってキャッシュされる可能性があります。FactoryBean が常に同じ参照を公開しない限り、true
を返さないでください。FactoryBean 自体のシングルトンステータスは、通常、所有する BeanFactory によって提供されます。通常、そこではシングルトンとして定義する必要があります。
注意 :
false
を返すこのメソッドは、返されるオブジェクトが独立したインスタンスであることを必ずしも示しません。拡張SmartFactoryBean
インターフェースの実装は、SmartFactoryBean.isPrototype()
メソッドを通じて独立したインスタンスを明示的に示す場合があります。この拡張インターフェースを実装しないプレーンなFactoryBean
実装は、isSingleton()
実装がfalse
を返す場合、常に独立したインスタンスを返すと単純に想定されます。FactoryBean
は通常シングルトンインスタンスを管理するため、デフォルトの実装ではtrue
が返されます。- 次で指定:
- インターフェース
FactoryBean<ScheduledExecutorServiceSE>
のisSingleton
- 戻り値:
- 公開されたオブジェクトがシングルトンかどうか
- 関連事項: