Add configuration key "spring.task.execution.shutdown.reject-tasks-when-limit-reached"

Close GH-45027

Signed-off-by: Yanming Zhou <[email protected]>

Author: quaff

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/task/TaskExecutionProperties.java

@@ -83,6 +83,11 @@ public static class Simple {
 		 */
 		private Integer concurrencyLimit;
 
+		/**
+		 * Specify whether to reject tasks when the concurrency limit has been reached.
+		 */
+		private boolean rejectTasksWhenLimitReached;
+
 		public Integer getConcurrencyLimit() {
 			return this.concurrencyLimit;
 		}
@@ -91,6 +96,14 @@ public void setConcurrencyLimit(Integer concurrencyLimit) {
 			this.concurrencyLimit = concurrencyLimit;
 		}
 
+		public boolean isRejectTasksWhenLimitReached() {
+			return this.rejectTasksWhenLimitReached;
+		}
+
+		public void setRejectTasksWhenLimitReached(boolean rejectTasksWhenLimitReached) {
+			this.rejectTasksWhenLimitReached = rejectTasksWhenLimitReached;
+		}
+
 	}
 
 	public static class Pool {

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/task/TaskExecutorConfigurations.java

@@ -135,6 +135,7 @@ private SimpleAsyncTaskExecutorBuilder builder() {
 			builder = builder.taskDecorator(this.taskDecorator.getIfUnique());
 			TaskExecutionProperties.Simple simple = this.properties.getSimple();
 			builder = builder.concurrencyLimit(simple.getConcurrencyLimit());
+			builder = builder.rejectTasksWhenLimitReached(simple.isRejectTasksWhenLimitReached());
 			TaskExecutionProperties.Shutdown shutdown = this.properties.getShutdown();
 			if (shutdown.isAwaitTermination()) {
 				builder = builder.taskTerminationTimeout(shutdown.getAwaitTerminationPeriod());

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/task/TaskExecutionAutoConfigurationTests.java

@@ -82,10 +82,12 @@ void simpleAsyncTaskExecutorBuilderShouldReadProperties() {
 		this.contextRunner
 			.withPropertyValues("spring.task.execution.thread-name-prefix=mytest-",
 					"spring.task.execution.simple.concurrency-limit=1",
+					"spring.task.execution.simple.reject-tasks-when-limit-reached=true",
 					"spring.task.execution.shutdown.await-termination=true",
 					"spring.task.execution.shutdown.await-termination-period=30s")
 			.run(assertSimpleAsyncTaskExecutor((taskExecutor) -> {
 				assertThat(taskExecutor.getConcurrencyLimit()).isEqualTo(1);
+				assertThat(taskExecutor).hasFieldOrPropertyWithValue("rejectTasksWhenLimitReached", true);
 				assertThat(taskExecutor.getThreadNamePrefix()).isEqualTo("mytest-");
 				assertThat(taskExecutor).hasFieldOrPropertyWithValue("taskTerminationTimeout", 30000L);
 			}));

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/task/SimpleAsyncTaskExecutorBuilder.java

@@ -41,6 +41,7 @@
  * @author Stephane Nicoll
  * @author Filip Hrisafov
  * @author Moritz Halbritter
+ * @author Yanming Zhou
  * @since 3.2.0
  */
 public class SimpleAsyncTaskExecutorBuilder {
@@ -57,19 +58,22 @@ public class SimpleAsyncTaskExecutorBuilder {
 
 	private final Duration taskTerminationTimeout;
 
+	private final boolean rejectTasksWhenLimitReached;
+
 	public SimpleAsyncTaskExecutorBuilder() {
-		this(null, null, null, null, null, null);
+		this(null, null, null, null, null, null, false);
 	}
 
 	private SimpleAsyncTaskExecutorBuilder(Boolean virtualThreads, String threadNamePrefix, Integer concurrencyLimit,
 			TaskDecorator taskDecorator, Set<SimpleAsyncTaskExecutorCustomizer> customizers,
-			Duration taskTerminationTimeout) {
+			Duration taskTerminationTimeout, boolean rejectTasksWhenLimitReached) {
 		this.virtualThreads = virtualThreads;
 		this.threadNamePrefix = threadNamePrefix;
 		this.concurrencyLimit = concurrencyLimit;
 		this.taskDecorator = taskDecorator;
 		this.customizers = customizers;
 		this.taskTerminationTimeout = taskTerminationTimeout;
+		this.rejectTasksWhenLimitReached = rejectTasksWhenLimitReached;
 	}
 
 	/**
@@ -79,7 +83,7 @@ private SimpleAsyncTaskExecutorBuilder(Boolean virtualThreads, String threadName
 	 */
 	public SimpleAsyncTaskExecutorBuilder threadNamePrefix(String threadNamePrefix) {
 		return new SimpleAsyncTaskExecutorBuilder(this.virtualThreads, threadNamePrefix, this.concurrencyLimit,
-				this.taskDecorator, this.customizers, this.taskTerminationTimeout);
+				this.taskDecorator, this.customizers, this.taskTerminationTimeout, this.rejectTasksWhenLimitReached);
 	}
 
 	/**
@@ -89,7 +93,7 @@ public SimpleAsyncTaskExecutorBuilder threadNamePrefix(String threadNamePrefix)
 	 */
 	public SimpleAsyncTaskExecutorBuilder virtualThreads(Boolean virtualThreads) {
 		return new SimpleAsyncTaskExecutorBuilder(virtualThreads, this.threadNamePrefix, this.concurrencyLimit,
-				this.taskDecorator, this.customizers, this.taskTerminationTimeout);
+				this.taskDecorator, this.customizers, this.taskTerminationTimeout, this.rejectTasksWhenLimitReached);
 	}
 
 	/**
@@ -99,7 +103,7 @@ public SimpleAsyncTaskExecutorBuilder virtualThreads(Boolean virtualThreads) {
 	 */
 	public SimpleAsyncTaskExecutorBuilder concurrencyLimit(Integer concurrencyLimit) {
 		return new SimpleAsyncTaskExecutorBuilder(this.virtualThreads, this.threadNamePrefix, concurrencyLimit,
-				this.taskDecorator, this.customizers, this.taskTerminationTimeout);
+				this.taskDecorator, this.customizers, this.taskTerminationTimeout, this.rejectTasksWhenLimitReached);
 	}
 
 	/**
@@ -109,7 +113,7 @@ public SimpleAsyncTaskExecutorBuilder concurrencyLimit(Integer concurrencyLimit)
 	 */
 	public SimpleAsyncTaskExecutorBuilder taskDecorator(TaskDecorator taskDecorator) {
 		return new SimpleAsyncTaskExecutorBuilder(this.virtualThreads, this.threadNamePrefix, this.concurrencyLimit,
-				taskDecorator, this.customizers, this.taskTerminationTimeout);
+				taskDecorator, this.customizers, this.taskTerminationTimeout, this.rejectTasksWhenLimitReached);
 	}
 
 	/**
@@ -120,7 +124,19 @@ public SimpleAsyncTaskExecutorBuilder taskDecorator(TaskDecorator taskDecorator)
 	 */
 	public SimpleAsyncTaskExecutorBuilder taskTerminationTimeout(Duration taskTerminationTimeout) {
 		return new SimpleAsyncTaskExecutorBuilder(this.virtualThreads, this.threadNamePrefix, this.concurrencyLimit,
-				this.taskDecorator, this.customizers, taskTerminationTimeout);
+				this.taskDecorator, this.customizers, taskTerminationTimeout, this.rejectTasksWhenLimitReached);
+	}
+
+	/**
+	 * Specify whether to reject tasks when the concurrency limit has been reached.
+	 * @param rejectTasksWhenLimitReached whether to reject tasks when the concurrency
+	 * limit has been reached
+	 * @return a new builder instance
+	 * @since 3.5.0
+	 */
+	public SimpleAsyncTaskExecutorBuilder rejectTasksWhenLimitReached(boolean rejectTasksWhenLimitReached) {
+		return new SimpleAsyncTaskExecutorBuilder(this.virtualThreads, this.threadNamePrefix, this.concurrencyLimit,
+				this.taskDecorator, this.customizers, this.taskTerminationTimeout, rejectTasksWhenLimitReached);
 	}
 
 	/**
@@ -150,7 +166,8 @@ public SimpleAsyncTaskExecutorBuilder customizers(
 			Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers) {
 		Assert.notNull(customizers, "'customizers' must not be null");
 		return new SimpleAsyncTaskExecutorBuilder(this.virtualThreads, this.threadNamePrefix, this.concurrencyLimit,
-				this.taskDecorator, append(null, customizers), this.taskTerminationTimeout);
+				this.taskDecorator, append(null, customizers), this.taskTerminationTimeout,
+				this.rejectTasksWhenLimitReached);
 	}
 
 	/**
@@ -178,7 +195,8 @@ public SimpleAsyncTaskExecutorBuilder additionalCustomizers(
 			Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers) {
 		Assert.notNull(customizers, "'customizers' must not be null");
 		return new SimpleAsyncTaskExecutorBuilder(this.virtualThreads, this.threadNamePrefix, this.concurrencyLimit,
-				this.taskDecorator, append(this.customizers, customizers), this.taskTerminationTimeout);
+				this.taskDecorator, append(this.customizers, customizers), this.taskTerminationTimeout,
+				this.rejectTasksWhenLimitReached);
 	}
 
 	/**
@@ -220,6 +238,7 @@ public <T extends SimpleAsyncTaskExecutor> T configure(T taskExecutor) {
 		map.from(this.concurrencyLimit).to(taskExecutor::setConcurrencyLimit);
 		map.from(this.taskDecorator).to(taskExecutor::setTaskDecorator);
 		map.from(this.taskTerminationTimeout).as(Duration::toMillis).to(taskExecutor::setTaskTerminationTimeout);
+		map.from(this.rejectTasksWhenLimitReached).to(taskExecutor::setRejectTasksWhenLimitReached);
 		if (!CollectionUtils.isEmpty(this.customizers)) {
 			this.customizers.forEach((customizer) -> customizer.customize(taskExecutor));
 		}

spring-boot-project/spring-boot/src/test/java/org/springframework/boot/task/SimpleAsyncTaskExecutorBuilderTests.java

@@ -40,6 +40,7 @@
  * @author Stephane Nicoll
  * @author Filip Hrisafov
  * @author Moritz Halbritter
+ * @author Yanming Zhou
  */
 class SimpleAsyncTaskExecutorBuilderTests {
 
@@ -151,4 +152,10 @@ void taskTerminationTimeoutShouldApply() {
 		assertThat(executor).extracting("taskTerminationTimeout").isEqualTo(1000L);
 	}
 
+	@Test
+	void rejectTasksWhenLimitReachedShouldApply() {
+		SimpleAsyncTaskExecutor executor = this.builder.rejectTasksWhenLimitReached(true).build();
+		assertThat(executor).extracting("rejectTasksWhenLimitReached").isEqualTo(true);
+	}
+
 }