ThreadPoolTaskExecutor (Spring Framework API)

java.lang.ObjectSE
- org.springframework.util.CustomizableThreadCreator
- - org.springframework.scheduling.concurrent.CustomizableThreadFactory
  - - org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
    - - org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor

実装されているすべてのインターフェース:
SerializableSE, ExecutorSE, ThreadFactorySE, Aware, BeanNameAware, DisposableBean, InitializingBean, AsyncListenableTaskExecutor, AsyncTaskExecutor, TaskExecutor, SchedulingTaskExecutor
```
public class ThreadPoolTaskExecutor
extends ExecutorConfigurationSupport
implements AsyncListenableTaskExecutor, SchedulingTaskExecutor
```
JavaBean は、ThreadPoolExecutorSE を Bean スタイルで (その "corePoolSize"、"maxPoolSize"、"keepAliveSeconds"、"queueCapacity" プロパティを介して) 構成し、それを Spring TaskExecutor として公開することを可能にします。このクラスは、管理と監視 (JMX 経由など) にも適しており、いくつかの便利な属性を提供します: "corePoolSize"、"maxPoolSize"、"keepAliveSeconds" (すべて実行時の更新をサポート)、"poolSize"、"activeCount" (イントロスペクションのみ)。
デフォルトの構成はコアプールサイズ 1 で、最大プールサイズとキュー容量は無制限です。これは、すべてのタスクで単一のスレッドを共有する Executors.newSingleThreadExecutor()SE とほぼ同等です。"queueCapacity" を 0 に設定すると、Executors.newCachedThreadPool()SE を模倣し、プール内のスレッドを潜在的に非常に高い数に即座にスケーリングします。また、その時点で "maxPoolSize" を設定し、場合によってはより高い "corePoolSize" を設定することも検討してください（スケーリングの "allowCoreThreadTimeOut" モードも参照してください）。
注意 : このクラスは、Spring の TaskExecutor インターフェースと ExecutorSE インターフェースを実装します。前者はプライマリインターフェースであり、もう一方は単に二次的な利便性として機能します。このため、例外処理は、特に TaskRejectedException に関して、Executor 契約ではなく TaskExecutor 契約に従います。
別の方法として、コンストラクターインジェクションを使用して ThreadPoolExecutor インスタンスを直接セットアップするか、ExecutorsSE クラスを指すファクトリメソッド定義を使用することができます。このような生のエグゼキュータを Spring TaskExecutor として公開するには、単に ConcurrentTaskExecutor アダプターでラップします。
導入:
2.0
作成者:
Juergen Hoeller
関連事項:
TaskExecutor, ThreadPoolExecutorSE, ThreadPoolExecutorFactoryBean, ConcurrentTaskExecutor, 連載形式

フィールドのサマリー
- クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたフィールド
  logger
- インターフェース org.springframework.core.task.AsyncTaskExecutor から継承されたフィールド
  TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE

コンストラクターの概要
コンストラクター
コンストラクターと説明
ThreadPoolTaskExecutor()

コンストラクター
コンストラクターと説明
`ThreadPoolTaskExecutor()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`cancelRemainingTask(RunnableSE task)` `ExecutorService.shutdownNow()`SE から返された、実行を決して推奨しない残りのタスクをキャンセルします。
`protected BlockingQueueSE<RunnableSE>`	`createQueue(int queueCapacity)` BlockingQueue を作成して、ThreadPoolExecutor に使用します。
`void`	`execute(RunnableSE task)` 指定された `task` を実行します。
`void`	`execute(RunnableSE task, long startTimeout)` 指定された `task` を実行します。
`int`	`getActiveCount()` 現在アクティブなスレッドの数を返します。
`int`	`getCorePoolSize()` ThreadPoolExecutor のコアプールサイズを返します。
`int`	`getKeepAliveSeconds()` ThreadPoolExecutor のキープアライブ秒数を返します。
`int`	`getMaxPoolSize()` ThreadPoolExecutor の最大プールサイズを返します。
`int`	`getPoolSize()` 現在のプールサイズを返します。
`ThreadPoolExecutorSE`	`getThreadPoolExecutor()` ネイティブアクセスの基になる ThreadPoolExecutor を返します。
`protected ExecutorServiceSE`	`initializeExecutor(ThreadFactorySE threadFactory, RejectedExecutionHandlerSE rejectedExecutionHandler)` メモ: このメソッドは、`ExecutorService`SE をその基本クラスに公開しますが、実際の `ThreadPoolExecutor`SE ハンドルを内部に保存します。
`void`	`setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)` コアスレッドのタイムアウトを許可するかどうかを指定します。
`void`	`setCorePoolSize(int corePoolSize)` ThreadPoolExecutor のコアプールサイズを設定します。
`void`	`setKeepAliveSeconds(int keepAliveSeconds)` ThreadPoolExecutor のキープアライブ秒数を設定します。
`void`	`setMaxPoolSize(int maxPoolSize)` ThreadPoolExecutor の最大プールサイズを設定します。
`void`	`setQueueCapacity(int queueCapacity)` ThreadPoolExecutor の BlockingQueue の容量を設定します。
`void`	`setTaskDecorator(TaskDecorator taskDecorator)` 実行しようとしている `Runnable`SE に適用するカスタム `TaskDecorator` を指定します。
`<T> FutureSE<T>`	`submit(CallableSE<T> task)` Callable タスクを送信して実行し、そのタスクを表す Future を受け取ります。
`FutureSE<?>`	`submit(RunnableSE task)` 実行可能な Runnable タスクを送信し、そのタスクを表す Future を受け取ります。
`<T> ListenableFuture<T>`	`submitListenable(CallableSE<T> task)` `Callable` タスクを実行のために送信し、そのタスクを表す `ListenableFuture` を受け取ります。
`ListenableFuture<?>`	`submitListenable(RunnableSE task)` `Runnable` タスクを実行のために送信し、そのタスクを表す `ListenableFuture` を受け取ります。

クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたメソッド
afterPropertiesSet, destroy, initialize, setAwaitTerminationMillis, setAwaitTerminationSeconds, setBeanName, setRejectedExecutionHandler, setThreadFactory, setThreadNamePrefix, setWaitForTasksToCompleteOnShutdown, shutdown

クラス org.springframework.scheduling.concurrent.CustomizableThreadFactory から継承されたメソッド
newThread

クラス org.springframework.util.CustomizableThreadCreator から継承されたメソッド
createThread, getDefaultThreadNamePrefix, getThreadGroup, getThreadNamePrefix, getThreadPriority, isDaemon, nextThreadName, setDaemon, setThreadGroup, setThreadGroupName, setThreadPriority

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.scheduling.SchedulingTaskExecutor から継承されたメソッド
prefersShortLivedTasks

- コンストラクターの詳細
  - ThreadPoolTaskExecutor
```
public ThreadPoolTaskExecutor()
```
- メソッドの詳細
  - setCorePoolSize
```
public void setCorePoolSize(int corePoolSize)
```
    ThreadPoolExecutor のコアプールサイズを設定します。デフォルトは 1 です。
    この設定は、JMX などを介して実行時に変更できます。
  - getCorePoolSize
```
public int getCorePoolSize()
```
    ThreadPoolExecutor のコアプールサイズを返します。
  - setMaxPoolSize
```
public void setMaxPoolSize(int maxPoolSize)
```
    ThreadPoolExecutor の最大プールサイズを設定します。デフォルトは Integer.MAX_VALUE です。
    この設定は、JMX などを介して実行時に変更できます。
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
    ThreadPoolExecutor の最大プールサイズを返します。
  - setKeepAliveSeconds
```
public void setKeepAliveSeconds(int keepAliveSeconds)
```
    ThreadPoolExecutor のキープアライブ秒数を設定します。デフォルトは 60 です。
    この設定は、JMX などを介して実行時に変更できます。
  - getKeepAliveSeconds
```
public int getKeepAliveSeconds()
```
    ThreadPoolExecutor のキープアライブ秒数を返します。
  - setQueueCapacity
```
public void setQueueCapacity(int queueCapacity)
```
    ThreadPoolExecutor の BlockingQueue の容量を設定します。デフォルトは Integer.MAX_VALUE です。
    正の値は、LinkedBlockingQueue インスタンスにつながります。その他の値は、SynchronousQueue インスタンスにつながります。
    関連事項:
    LinkedBlockingQueueSE, SynchronousQueueSE
  - setAllowCoreThreadTimeOut
```
public void setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)
```
    コアスレッドのタイムアウトを許可するかどうかを指定します。これにより、ゼロ以外のキューと組み合わせても動的な拡大と縮小が可能になります（最大プールサイズはキューがいっぱいになると拡大するため）。
    デフォルトは「false」。
    関連事項:
    ThreadPoolExecutor.allowCoreThreadTimeOut(boolean)SE
  - setTaskDecorator
```
public void setTaskDecorator(TaskDecorator taskDecorator)
```
    実行しようとしている RunnableSE に適用するカスタム TaskDecorator を指定します。
    このようなデコレータは、必ずしもユーザー提供の Runnable/Callable に適用されるのではなく、実際の実行コールバック（ユーザー提供のタスクのラッパーである可能性があります）に適用されることに注意してください。
    主な使用例は、タスクの呼び出しの周囲に実行コンテキストを設定するか、タスク実行の監視 / 統計を提供することです。
    注意 : TaskDecorator 実装での例外処理は、execute 呼び出しによる単純な Runnable 実行に制限されています。#submit 呼び出しの場合、公開された Runnable は、例外を伝搬しない FutureTask になります。例外を評価するには、キャストして Future#get を呼び出す必要がある場合があります。このような Future ケースで例外にアクセスする方法の例については、ThreadPoolExecutor#afterExecute javadoc を参照してください。
    導入:
    4.3
  - initializeExecutor
```
protected ExecutorServiceSE initializeExecutor(ThreadFactorySE threadFactory,
                                             RejectedExecutionHandlerSE rejectedExecutionHandler)
```
    メモ: このメソッドは、ExecutorServiceSE をその基本クラスに公開しますが、実際の ThreadPoolExecutorSE ハンドルを内部に保存します。このメソッドをオーバーライドして、executor を置き換えるのではなく、単に ExecutorService ハンドルを装飾したり、カスタム状態を保管したりしてください。
    次で指定:
    クラス ExecutorConfigurationSupport の initializeExecutor
    パラメーター:
    threadFactory - 使用する ThreadFactory
    rejectedExecutionHandler - 使用する RejectedExecutionHandler
    戻り値:
    新しい ExecutorService インスタンス
    関連事項:
    ExecutorConfigurationSupport.afterPropertiesSet()
  - createQueue
```
protected BlockingQueueSE<RunnableSE> createQueue(int queueCapacity)
```
    BlockingQueue を作成して、ThreadPoolExecutor に使用します。
    正の容量値に対して LinkedBlockingQueue インスタンスが作成されます。SynchronousQueue その他。
    パラメーター:
    queueCapacity - 指定されたキュー容量
    戻り値:
    BlockingQueue インスタンス
    関連事項:
    LinkedBlockingQueueSE, SynchronousQueueSE
  - getThreadPoolExecutor
```
public ThreadPoolExecutorSE getThreadPoolExecutor()
                                         throws IllegalStateExceptionSE
```
    ネイティブアクセスの基になる ThreadPoolExecutor を返します。
    戻り値:
    基になる ThreadPoolExecutor (非 null)
    例外:
    IllegalStateExceptionSE - ThreadPoolTaskExecutor がまだ初期化されていない場合
  - getPoolSize
```
public int getPoolSize()
```
    現在のプールサイズを返します。
    関連事項:
    ThreadPoolExecutor.getPoolSize()SE
  - getActiveCount
```
public int getActiveCount()
```
    現在アクティブなスレッドの数を返します。
    関連事項:
    ThreadPoolExecutor.getActiveCount()SE
  - execute
```
public void execute(RunnableSE task)
```
    インターフェースからコピーされた説明: TaskExecutor
    指定された task を実行します。
    実装が非同期実行戦略を使用している場合、呼び出しはすぐに戻るか、同期実行の場合はブロックする可能性があります。
    次で指定:
    インターフェース ExecutorSE の executeSE
    次で指定:
    インターフェース TaskExecutor の execute
    パラメーター:
    task - 実行する Runnable (非 null)
  - execute
```
public void execute(RunnableSE task,
                    long startTimeout)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    指定された task を実行します。
    次で指定:
    インターフェース AsyncTaskExecutor の execute
    パラメーター:
    task - 実行する Runnable (非 null)
    startTimeout - タスクが開始される予定の期間（ミリ秒）。これはエグゼキューターへのヒントとして意図されており、即時タスクの優先処理を可能にします。一般的な値は AsyncTaskExecutor.TIMEOUT_IMMEDIATE または AsyncTaskExecutor.TIMEOUT_INDEFINITE（TaskExecutor.execute(Runnable) で使用されるデフォルト）です。
  - submit
```
public FutureSE<?> submit(RunnableSE task)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    実行可能な Runnable タスクを送信し、そのタスクを表す Future を受け取ります。Future は完了時に null の結果を返します。
    次で指定:
    インターフェース AsyncTaskExecutor の submit
    パラメーター:
    task - 実行する Runnable (非 null)
    戻り値:
    タスクの保留中の完了を表す Future
  - submit
```
public <T> FutureSE<T> submit(CallableSE<T> task)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    Callable タスクを送信して実行し、そのタスクを表す Future を受け取ります。Future は、完了時に Callable の結果を返します。
    次で指定:
    インターフェース AsyncTaskExecutor の submit
    パラメーター:
    task - 実行する Callable (非 null)
    戻り値:
    タスクの保留中の完了を表す Future
  - submitListenable
```
public ListenableFuture<?> submitListenable(RunnableSE task)
```
    インターフェースからコピーされた説明: AsyncListenableTaskExecutor
    Runnable タスクを実行のために送信し、そのタスクを表す ListenableFuture を受け取ります。Future は完了時に null の結果を返します。
    次で指定:
    インターフェース AsyncListenableTaskExecutor の submitListenable
    パラメーター:
    task - 実行する Runnable (非 null)
    戻り値:
    保留中のタスクの完了を表す ListenableFuture
  - submitListenable
```
public <T> ListenableFuture<T> submitListenable(CallableSE<T> task)
```
    インターフェースからコピーされた説明: AsyncListenableTaskExecutor
    Callable タスクを実行のために送信し、そのタスクを表す ListenableFuture を受け取ります。Future は、完了時に Callable の結果を返します。
    次で指定:
    インターフェース AsyncListenableTaskExecutor の submitListenable
    パラメーター:
    task - 実行する Callable (非 null)
    戻り値:
    保留中のタスクの完了を表す ListenableFuture
  - cancelRemainingTask
```
protected void cancelRemainingTask(RunnableSE task)
```
    クラスからコピーされた説明: ExecutorConfigurationSupport
    ExecutorService.shutdownNow()SE から返された、実行を決して推奨しない残りのタスクをキャンセルします。
    オーバーライド:
    クラス ExecutorConfigurationSupport の cancelRemainingTask
    パラメーター:
    task - キャンセルするタスク (通常、RunnableFutureSE )
    関連事項:
    ExecutorConfigurationSupport.shutdown(), Future.cancel(boolean)SE

クラス ThreadPoolTaskExecutor

フィールドのサマリー

クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたフィールド

インターフェース org.springframework.core.task.AsyncTaskExecutor から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.scheduling.concurrent.ExecutorConfigurationSupport から継承されたメソッド

クラス org.springframework.scheduling.concurrent.CustomizableThreadFactory から継承されたメソッド

クラス org.springframework.util.CustomizableThreadCreator から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.scheduling.SchedulingTaskExecutor から継承されたメソッド

コンストラクターの詳細

ThreadPoolTaskExecutor

メソッドの詳細

setCorePoolSize

getCorePoolSize

setMaxPoolSize

getMaxPoolSize

setKeepAliveSeconds

getKeepAliveSeconds

setQueueCapacity

setAllowCoreThreadTimeOut

setTaskDecorator

initializeExecutor

createQueue

getThreadPoolExecutor

getPoolSize

getActiveCount

execute

execute

submit

submit

submitListenable

submitListenable

cancelRemainingTask