クラス ThreadPoolTaskExecutorBuilder
java.lang.ObjectSE
org.springframework.boot.task.ThreadPoolTaskExecutorBuilder
ThreadPoolTaskExecutor の構成と作成に使用できるビルダー。一般的な ThreadPoolTaskExecutor 設定を設定し、taskDecorator(TaskDecorator) を登録するための便利なメソッドを提供します。高度な設定については、ThreadPoolTaskExecutorCustomizer の使用を検討してください。 典型的な自動構成 Spring Boot アプリケーションでは、このビルダーは Bean として利用でき、ThreadPoolTaskExecutor が必要なときにいつでも注入できます。
- 導入:
- 3.2.0
- 作成者:
- Stephane Nicoll, Filip Hrisafov, Yanming Zhou
コンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明acceptTasksAfterContextClose(boolean acceptTasksAfterContextClose) アプリケーションコンテキストクローズフェーズが開始された後に、さらなるタスクを受け入れるかどうかを設定します。additionalCustomizers(IterableSE<? extends ThreadPoolTaskExecutorCustomizer> customizers) ThreadPoolTaskExecutorに適用する必要があるThreadPoolTaskExecutorCustomizersを追加します。additionalCustomizers(ThreadPoolTaskExecutorCustomizer... customizers) ThreadPoolTaskExecutorに適用する必要があるThreadPoolTaskExecutorCustomizersを追加します。allowCoreThreadTimeOut(boolean allowCoreThreadTimeOut) コアスレッドのタイムアウトを許可するかどうかを設定します。awaitTermination(boolean awaitTermination) executor が、実行中のタスクを中断したり、キュー内のすべてのタスクを実行したりせずに、シャットダウン時にスケジュールされたタスクが完了するのを待つかどうかを設定します。awaitTerminationPeriod(DurationSE awaitTerminationPeriod) シャットダウン時に executor がブロックする最大時間を設定します。build()新しいThreadPoolTaskExecutorインスタンスをビルドし、このビルダーを使用して構成します。<T extends ThreadPoolTaskExecutor>
T指定された型の新しいThreadPoolTaskExecutorインスタンスをビルドし、このビルダーを使用して構成します。<T extends ThreadPoolTaskExecutor>
Tconfigure(T taskExecutor) このビルダーを使用して、提供されたThreadPoolTaskExecutorインスタンスを構成します。corePoolSize(int corePoolSize) スレッドのコア数を設定します。customizers(IterableSE<? extends ThreadPoolTaskExecutorCustomizer> customizers) ThreadPoolTaskExecutorに適用するThreadPoolTaskExecutorCustomizersを設定します。customizers(ThreadPoolTaskExecutorCustomizer... customizers) ThreadPoolTaskExecutorに適用するThreadPoolTaskExecutorCustomizersを設定します。keepAlive(DurationSE keepAlive) スレッドが終了する前にアイドル状態を維持できる時間制限を設定します。maxPoolSize(int maxPoolSize) スレッドの最大許容数を設定します。queueCapacity(int queueCapacity) キューの容量を設定します。taskDecorator(TaskDecorator taskDecorator) TaskDecoratorを使用するように設定するか、nullを使用しないように設定します。threadNamePrefix(StringSE threadNamePrefix) 新しく作成されたスレッドの名前に使用する接頭辞を設定します。
コンストラクターの詳細
ThreadPoolTaskExecutorBuilder
public ThreadPoolTaskExecutorBuilder()
メソッドの詳細
queueCapacity
キューの容量を設定します。無制限の容量はプールを増加させないため、maxPoolSizeを無視します。- パラメーター:
queueCapacity- 設定するキュー容量- 戻り値:
- 新しいビルダーインスタンス
corePoolSize
スレッドのコア数を設定します。キューがいっぱいでない限り、事実上その最大スレッド数。allowCoreThreadTimeOut(boolean)が有効になっている場合、コアスレッドは拡大および縮小できます。- パラメーター:
corePoolSize- 設定するコアプールサイズ- 戻り値:
- 新しいビルダーインスタンス
maxPoolSize
スレッドの最大許容数を設定します。queueがいっぱいになると、プールはそのサイズまで拡張して、負荷に対応できます。queue capacityが無制限の場合、この設定は無視されます。- パラメーター:
maxPoolSize- 設定する最大プールサイズ- 戻り値:
- 新しいビルダーインスタンス
allowCoreThreadTimeOut
コアスレッドのタイムアウトを許可するかどうかを設定します。有効にすると、プールの動的な拡大と縮小が可能になります。- パラメーター:
allowCoreThreadTimeOut- コアスレッドのタイムアウトが許可されている場合- 戻り値:
- 新しいビルダーインスタンス
keepAlive
スレッドが終了する前にアイドル状態を維持できる時間制限を設定します。- パラメーター:
keepAlive- 設定するキープアライブ- 戻り値:
- 新しいビルダーインスタンス
acceptTasksAfterContextClose
public ThreadPoolTaskExecutorBuilder acceptTasksAfterContextClose(boolean acceptTasksAfterContextClose) アプリケーションコンテキストクローズフェーズが開始された後に、さらなるタスクを受け入れるかどうかを設定します。- パラメーター:
acceptTasksAfterContextClose- アプリケーションコンテキストのクローズフェーズが開始した後にさらにタスクを受け入れるかどうか- 戻り値:
- 新しいビルダーインスタンス
- 導入:
- 3.3.0
awaitTermination
executor が、実行中のタスクを中断したり、キュー内のすべてのタスクを実行したりせずに、シャットダウン時にスケジュールされたタスクが完了するのを待つかどうかを設定します。- パラメーター:
awaitTermination- executor がシャットダウン時にタスクが完了するのを待つ必要があるかどうか- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
awaitTerminationPeriod
シャットダウン時に executor がブロックする最大時間を設定します。設定すると、コンテナーの残りがシャットダウンを続ける前に、残りのタスクが実行を完了するのを待つために、executor はシャットダウン時にブロックします。これは、残りのタスクがコンテナーによって管理されている他のリソースへのアクセスを必要とする可能性がある場合に特に役立ちます。- パラメーター:
awaitTerminationPeriod- 設定する終了待ち期間- 戻り値:
- 新しいビルダーインスタンス
threadNamePrefix
新しく作成されたスレッドの名前に使用する接頭辞を設定します。- パラメーター:
threadNamePrefix- 設定するスレッド名の接頭辞- 戻り値:
- 新しいビルダーインスタンス
taskDecorator
TaskDecoratorを使用するように設定するか、nullを使用しないように設定します。- パラメーター:
taskDecorator- 使用するタスクデコレータ- 戻り値:
- 新しいビルダーインスタンス
customizers
ThreadPoolTaskExecutorに適用するThreadPoolTaskExecutorCustomizersを設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。- パラメーター:
customizers- 設定するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
customizers
public ThreadPoolTaskExecutorBuilder customizers(IterableSE<? extends ThreadPoolTaskExecutorCustomizer> customizers) ThreadPoolTaskExecutorに適用するThreadPoolTaskExecutorCustomizersを設定します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。この値を設定すると、以前に構成されたカスタマイザーが置き換えられます。- パラメーター:
customizers- 設定するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalCustomizers
public ThreadPoolTaskExecutorBuilder additionalCustomizers(ThreadPoolTaskExecutorCustomizer... customizers) ThreadPoolTaskExecutorに適用する必要があるThreadPoolTaskExecutorCustomizersを追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。- パラメーター:
customizers- 追加するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
additionalCustomizers
public ThreadPoolTaskExecutorBuilder additionalCustomizers(IterableSE<? extends ThreadPoolTaskExecutorCustomizer> customizers) ThreadPoolTaskExecutorに適用する必要があるThreadPoolTaskExecutorCustomizersを追加します。カスタマイザーは、ビルダー構成が適用された後に追加された順序で適用されます。- パラメーター:
customizers- 追加するカスタマイザー- 戻り値:
- 新しいビルダーインスタンス
- 関連事項:
build
新しいThreadPoolTaskExecutorインスタンスをビルドし、このビルダーを使用して構成します。- 戻り値:
- 構成済みの
ThreadPoolTaskExecutorインスタンス。 - 関連事項:
build
指定された型の新しいThreadPoolTaskExecutorインスタンスをビルドし、このビルダーを使用して構成します。- 型パラメーター:
T- タスク実行者の型- パラメーター:
taskExecutorClass- 作成するテンプレート型- 戻り値:
- 構成済みの
ThreadPoolTaskExecutorインスタンス。 - 関連事項:
configure
このビルダーを使用して、提供されたThreadPoolTaskExecutorインスタンスを構成します。- 型パラメーター:
T- タスク実行者の型- パラメーター:
taskExecutor- 構成するThreadPoolTaskExecutor- 戻り値:
- タスク実行者インスタンス
- 関連事項: