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