org.springframework.scheduling.concurrent

## 类 ThreadPoolExecutorFactoryBean

- java.lang.Object
- - org.springframework.util.CustomizableThreadCreator
  - - org.springframework.scheduling.concurrent.CustomizableThreadFactory
    - - org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
      - - org.springframework.scheduling.concurrent.ThreadPoolExecutorFactoryBean

- 所有已实现的接口:
    Serializable, ThreadFactory, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<ExecutorService>, org.springframework.beans.factory.InitializingBean

      public class ThreadPoolExecutorFactoryBean
      extends ExecutorConfigurationSupport
      implements org.springframework.beans.factory.FactoryBean<ExecutorService>, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

  JavaBean that allows for configuring a `ThreadPoolExecutor` in bean style (through its "corePoolSize", "maxPoolSize", "keepAliveSeconds", "queueCapacity" properties) and exposing it as a bean reference of its native `ExecutorService` type.

  The default configuration is a core pool size of 1, with unlimited max pool size and unlimited queue capacity. This is roughly equivalent to `Executors.newSingleThreadExecutor()`, sharing a single thread for all tasks. Setting `"queueCapacity"` to 0 mimics `Executors.newCachedThreadPool()`, with immediate scaling of threads in the pool to a potentially very high number. Consider also setting a `"maxPoolSize"` at that point, as well as possibly a higher `"corePoolSize"` (see also the `"allowCoreThreadTimeOut"` mode of scaling).

  For an alternative, you may set up a `ThreadPoolExecutor` 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 `@Bean` methods in configuration classes, where this `FactoryBean` variant would force you to return the `FactoryBean` type instead of the actual `Executor` type.

  If you need a timing-based `ScheduledExecutorService` instead, consider `ScheduledExecutorFactoryBean`.

  从以下版本开始:
    3.0
  作者:
    Juergen Hoeller
  另请参阅:
    `ExecutorService`, `Executors`, `ThreadPoolExecutor`, 序列化表格

- - ### 字段概要

    - ### 从类继承的字段 org.springframework.scheduling.concurrent.ExecutorConfigurationSupport

      `logger`

  - ### 构造器概要

    构造器
    构造器和说明
    `ThreadPoolExecutorFactoryBean()`

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `protected ThreadPoolExecutor` | `createExecutor(int corePoolSize, int maxPoolSize, int keepAliveSeconds, BlockingQueue<Runnable> queue, ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)` Create a new instance of `ThreadPoolExecutor` or a subclass thereof.
    `protected BlockingQueue<Runnable>` | `createQueue(int queueCapacity)` Create the BlockingQueue to use for the ThreadPoolExecutor.
    `ExecutorService` | `getObject()`
    `Class<? extends ExecutorService>` | `getObjectType()`
    `protected ExecutorService` | `initializeExecutor(ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)` Create the target `ExecutorService` instance.
    `boolean` | `isSingleton()`
    `void` | `setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)` Specify whether to allow core threads to time out.
    `void` | `setCorePoolSize(int corePoolSize)` Set the ThreadPoolExecutor's core pool size.
    `void` | `setExposeUnconfigurableExecutor(boolean exposeUnconfigurableExecutor)` Specify whether this FactoryBean should expose an unconfigurable decorator for the created executor.
    `void` | `setKeepAliveSeconds(int keepAliveSeconds)` Set the ThreadPoolExecutor's keep-alive seconds.
    `void` | `setMaxPoolSize(int maxPoolSize)` Set the ThreadPoolExecutor's maximum pool size.
    `void` | `setQueueCapacity(int queueCapacity)` Set the capacity for the ThreadPoolExecutor's BlockingQueue.

    - ### 从类继承的方法 org.springframework.scheduling.concurrent.ExecutorConfigurationSupport

      `afterPropertiesSet, cancelRemainingTask, destroy, initialize, 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.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### 从接口继承的方法 org.springframework.beans.factory.InitializingBean

      `afterPropertiesSet`

    - ### 从接口继承的方法 org.springframework.beans.factory.DisposableBean

      `destroy`

- - ### 构造器详细资料

    - #### ThreadPoolExecutorFactoryBean

          public ThreadPoolExecutorFactoryBean()

  - ### 方法详细资料

    - #### setCorePoolSize

          public void setCorePoolSize(int corePoolSize)

      Set the ThreadPoolExecutor's core pool size. Default is 1.

    - #### setMaxPoolSize

          public void setMaxPoolSize(int maxPoolSize)

      Set the ThreadPoolExecutor's maximum pool size. Default is `Integer.MAX_VALUE`.

    - #### setKeepAliveSeconds

          public void setKeepAliveSeconds(int keepAliveSeconds)

      Set the ThreadPoolExecutor's keep-alive seconds. Default is 60.

    - #### setAllowCoreThreadTimeOut

          public void setAllowCoreThreadTimeOut(boolean allowCoreThreadTimeOut)

      Specify whether to allow core threads to time out. This enables dynamic growing and shrinking even in combination with a non-zero queue (since the max pool size will only grow once the queue is full).

      Default is "false".

      另请参阅:
        `ThreadPoolExecutor.allowCoreThreadTimeOut(boolean)`

    - #### setQueueCapacity

          public void setQueueCapacity(int queueCapacity)

      Set the capacity for the ThreadPoolExecutor's BlockingQueue. Default is `Integer.MAX_VALUE`.

      Any positive value will lead to a LinkedBlockingQueue instance; any other value will lead to a SynchronousQueue instance.

      另请参阅:
        `LinkedBlockingQueue`, `SynchronousQueue`

    - #### 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.unconfigurableExecutorService(java.util.concurrent.ExecutorService)`

    - #### 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 ThreadPoolExecutor createExecutor(int corePoolSize,
                                                      int maxPoolSize,
                                                      int keepAliveSeconds,
                                                      BlockingQueue<Runnable> queue,
                                                      ThreadFactory threadFactory,
                                                      RejectedExecutionHandler rejectedExecutionHandler)

      Create a new instance of `ThreadPoolExecutor` or a subclass thereof.

      The default implementation creates a standard `ThreadPoolExecutor`. Can be overridden to provide custom `ThreadPoolExecutor` subclasses.

      参数:
        `corePoolSize` - the specified core pool size
        `maxPoolSize` - the specified maximum pool size
        `keepAliveSeconds` - the specified keep-alive time in seconds
        `queue` - the BlockingQueue to use
        `threadFactory` - the ThreadFactory to use
        `rejectedExecutionHandler` - the RejectedExecutionHandler to use
      返回:
        a new ThreadPoolExecutor instance
      另请参阅:
        `ExecutorConfigurationSupport.afterPropertiesSet()`

    - #### createQueue

          protected BlockingQueue<Runnable> createQueue(int queueCapacity)

      Create the BlockingQueue to use for the ThreadPoolExecutor.

      A LinkedBlockingQueue instance will be created for a positive capacity value; a SynchronousQueue else.

      参数:
        `queueCapacity` - the specified queue capacity
      返回:
        the BlockingQueue instance
      另请参阅:
        `LinkedBlockingQueue`, `SynchronousQueue`

    - #### getObject

          @Nullable
          public ExecutorService getObject()

      指定者:
        `getObject` 在接口中 `org.springframework.beans.factory.FactoryBean<ExecutorService>`

    - #### getObjectType

          public Class<? extends ExecutorService> getObjectType()

      指定者:
        `getObjectType` 在接口中 `org.springframework.beans.factory.FactoryBean<ExecutorService>`

    - #### isSingleton

          public boolean isSingleton()

      指定者:
        `isSingleton` 在接口中 `org.springframework.beans.factory.FactoryBean<ExecutorService>`