程序包 org.springframework.boot.task

类 SimpleAsyncTaskExecutorBuilder

java.lang.Object

org.springframework.boot.task.SimpleAsyncTaskExecutorBuilder

public class SimpleAsyncTaskExecutorBuilder
extends Object

Builder that can be used to configure and create a SimpleAsyncTaskExecutor. Provides convenience methods to set common SimpleAsyncTaskExecutor settings and register taskDecorator(TaskDecorator)). For advanced configuration, consider using SimpleAsyncTaskExecutorCustomizer.

In a typical auto-configured Spring Boot application this builder is available as a bean and can be injected whenever a SimpleAsyncTaskExecutor is needed.

从以下版本开始:

3.2.0

作者:

Stephane Nicoll, Filip Hrisafov, Moritz Halbritter, Yanming Zhou

构造器概要

构造器

构造器	说明
SimpleAsyncTaskExecutorBuilder()

方法概要

修饰符和类型	方法	说明
SimpleAsyncTaskExecutorBuilder	additionalCustomizers(Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers)	Add customizers that should be applied to the SimpleAsyncTaskExecutor.
SimpleAsyncTaskExecutorBuilder	additionalCustomizers(SimpleAsyncTaskExecutorCustomizer... customizers)	Add customizers that should be applied to the SimpleAsyncTaskExecutor.
SimpleAsyncTaskExecutor	build()	Build a new SimpleAsyncTaskExecutor instance and configure it using this builder.
<T extends SimpleAsyncTaskExecutor> T	build(Class<T> taskExecutorClass)	Build a new SimpleAsyncTaskExecutor instance of the specified type and configure it using this builder.
SimpleAsyncTaskExecutorBuilder	concurrencyLimit(Integer concurrencyLimit)	Set the concurrency limit.
<T extends SimpleAsyncTaskExecutor> T	configure(T taskExecutor)	Configure the provided SimpleAsyncTaskExecutor instance using this builder.
SimpleAsyncTaskExecutorBuilder	customizers(Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers)	Set the customizers that should be applied to the SimpleAsyncTaskExecutor.
SimpleAsyncTaskExecutorBuilder	customizers(SimpleAsyncTaskExecutorCustomizer... customizers)	Set the customizers that should be applied to the SimpleAsyncTaskExecutor.
SimpleAsyncTaskExecutorBuilder	rejectTasksWhenLimitReached(boolean rejectTasksWhenLimitReached)	Set whether to reject tasks when the concurrency limit has been reached.
SimpleAsyncTaskExecutorBuilder	taskDecorator(TaskDecorator taskDecorator)	Set the TaskDecorator to use or null to not use any.
SimpleAsyncTaskExecutorBuilder	taskTerminationTimeout(Duration taskTerminationTimeout)	Set the task termination timeout.
SimpleAsyncTaskExecutorBuilder	threadNamePrefix(String threadNamePrefix)	Set the prefix to use for the names of newly created threads.
SimpleAsyncTaskExecutorBuilder	virtualThreads(Boolean virtualThreads)	Set whether to use virtual threads.

从类继承的方法 java.lang.Object

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

构造器详细资料

SimpleAsyncTaskExecutorBuilder

public SimpleAsyncTaskExecutorBuilder()

方法详细资料

threadNamePrefix

public SimpleAsyncTaskExecutorBuilder threadNamePrefix(String threadNamePrefix)

Set the prefix to use for the names of newly created threads.

参数:

threadNamePrefix - the thread name prefix to set

返回:

a new builder instance

virtualThreads

public SimpleAsyncTaskExecutorBuilder virtualThreads(Boolean virtualThreads)

Set whether to use virtual threads.

参数:

virtualThreads - whether to use virtual threads

返回:

a new builder instance

rejectTasksWhenLimitReached

public SimpleAsyncTaskExecutorBuilder rejectTasksWhenLimitReached(boolean rejectTasksWhenLimitReached)

Set whether to reject tasks when the concurrency limit has been reached. By default false to block the caller until the submission can be accepted. Switch to true for immediate rejection instead.

参数:

rejectTasksWhenLimitReached - whether to reject tasks when the concurrency limit has been reached

返回:

a new builder instance

从以下版本开始:

3.5.0

concurrencyLimit

public SimpleAsyncTaskExecutorBuilder concurrencyLimit(Integer concurrencyLimit)

Set the concurrency limit.

参数:

concurrencyLimit - the concurrency limit

返回:

a new builder instance

taskDecorator

public SimpleAsyncTaskExecutorBuilder taskDecorator(TaskDecorator taskDecorator)

Set the TaskDecorator to use or null to not use any.

参数:

taskDecorator - the task decorator to use

返回:

a new builder instance

taskTerminationTimeout

public SimpleAsyncTaskExecutorBuilder taskTerminationTimeout(Duration taskTerminationTimeout)

Set the task termination timeout.

参数:

taskTerminationTimeout - the task termination timeout

返回:

a new builder instance

从以下版本开始:

3.2.1

customizers

public SimpleAsyncTaskExecutorBuilder customizers(SimpleAsyncTaskExecutorCustomizer... customizers)

Set the customizers that should be applied to the SimpleAsyncTaskExecutor. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

参数:

customizers - the customizers to set

返回:

a new builder instance

另请参阅:

• additionalCustomizers(SimpleAsyncTaskExecutorCustomizer...)

customizers

public SimpleAsyncTaskExecutorBuilder customizers(Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers)

Set the customizers that should be applied to the SimpleAsyncTaskExecutor. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

参数:

customizers - the customizers to set

返回:

a new builder instance

另请参阅:

• additionalCustomizers(Iterable)

additionalCustomizers

public SimpleAsyncTaskExecutorBuilder additionalCustomizers(SimpleAsyncTaskExecutorCustomizer... customizers)

Add customizers that should be applied to the SimpleAsyncTaskExecutor. Customizers are applied in the order that they were added after builder configuration has been applied.

参数:

customizers - the customizers to add

返回:

a new builder instance

另请参阅:

• customizers(SimpleAsyncTaskExecutorCustomizer...)

additionalCustomizers

public SimpleAsyncTaskExecutorBuilder additionalCustomizers(Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers)

Add customizers that should be applied to the SimpleAsyncTaskExecutor. Customizers are applied in the order that they were added after builder configuration has been applied.

参数:

customizers - the customizers to add

返回:

a new builder instance

另请参阅:

• customizers(Iterable)

build

public SimpleAsyncTaskExecutor build()

Build a new SimpleAsyncTaskExecutor instance and configure it using this builder.

返回:

a configured SimpleAsyncTaskExecutor instance.

另请参阅:

• build(Class)
• configure(SimpleAsyncTaskExecutor)

build

public <T extends SimpleAsyncTaskExecutor> T build(Class<T> taskExecutorClass)

Build a new SimpleAsyncTaskExecutor instance of the specified type and configure it using this builder.

类型参数:

T - the type of task executor

参数:

taskExecutorClass - the template type to create

返回:

a configured SimpleAsyncTaskExecutor instance.

另请参阅:

• build()
• configure(SimpleAsyncTaskExecutor)

configure

public <T extends SimpleAsyncTaskExecutor> T configure(T taskExecutor)

Configure the provided SimpleAsyncTaskExecutor instance using this builder.

类型参数:

T - the type of task executor

参数:

taskExecutor - the SimpleAsyncTaskExecutor to configure

返回:

the task executor instance

另请参阅:

• build()
• build(Class)