Exclude beans with scheduled methods from global lazy init

This commit updates TaskSchedulingAutoConfiguration to contribute a
LazyInitializationExcludeFilter that processes beans that have
@Scheduled methods. This lets them be contributed to the context so
that scheduled methods are invoked as expected.

Closes gh-25315
This commit is contained in:
Stephane Nicoll
2021-04-19 14:03:31 +02:00
parent aa9d0bc421
commit 54613c77d4
4 changed files with 191 additions and 0 deletions

View File

@@ -0,0 +1,71 @@
/*
* Copyright 2012-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.boot.autoconfigure.task;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.annotation.Schedules;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link ScheduledBeanLazyInitializationExcludeFilter}.
*
* @author Stephane Nicoll
*/
class ScheduledBeanLazyInitializationExcludeFilterTests {
private final ScheduledBeanLazyInitializationExcludeFilter filter = new ScheduledBeanLazyInitializationExcludeFilter();
@Test
void beanWithScheduledMethodIsDetected() {
assertThat(isExcluded(TestBean.class)).isTrue();
}
@Test
void beanWithSchedulesMethodIsDetected() {
assertThat(isExcluded(AnotherTestBean.class)).isTrue();
}
@Test
void beanWithoutScheduledMethodIsDetected() {
assertThat(isExcluded(ScheduledBeanLazyInitializationExcludeFilterTests.class)).isFalse();
}
private boolean isExcluded(Class<?> type) {
return this.filter.isExcluded("test", new RootBeanDefinition(type), type);
}
private static class TestBean {
@Scheduled
void doStuff() {
}
}
private static class AnotherTestBean {
@Schedules({ @Scheduled(fixedRate = 5000), @Scheduled(fixedRate = 2500) })
void doStuff() {
}
}
}

View File

@@ -16,6 +16,9 @@
package org.springframework.boot.autoconfigure.task;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CountDownLatch;
@@ -23,8 +26,10 @@ import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import org.awaitility.Awaitility;
import org.junit.jupiter.api.Test;
import org.springframework.boot.LazyInitializationBeanFactoryPostProcessor;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.task.TaskSchedulerCustomizer;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
@@ -121,6 +126,22 @@ class TaskSchedulingAutoConfigurationTests {
});
}
@Test
void enableSchedulingWithLazyInitializationInvokeScheduledMethods() {
List<String> threadNames = new ArrayList<>();
new ApplicationContextRunner()
.withInitializer((context) -> context
.addBeanFactoryPostProcessor(new LazyInitializationBeanFactoryPostProcessor()))
.withPropertyValues("spring.task.scheduling.thread-name-prefix=scheduling-test-")
.withBean(LazyTestBean.class, () -> new LazyTestBean(threadNames))
.withUserConfiguration(SchedulingConfiguration.class)
.withConfiguration(AutoConfigurations.of(TaskSchedulingAutoConfiguration.class)).run((context) -> {
// No lazy lookup.
Awaitility.waitAtMost(Duration.ofSeconds(3)).until(() -> !threadNames.isEmpty());
assertThat(threadNames).allMatch((name) -> name.contains("scheduling-test-"));
});
}
@Configuration(proxyBeanMethods = false)
@EnableScheduling
static class SchedulingConfiguration {
@@ -193,6 +214,21 @@ class TaskSchedulingAutoConfigurationTests {
}
static class LazyTestBean {
private final List<String> threadNames;
LazyTestBean(List<String> threadNames) {
this.threadNames = threadNames;
}
@Scheduled(fixedRate = 2000)
void accumulate() {
this.threadNames.add(Thread.currentThread().getName());
}
}
static class TestTaskScheduler extends ThreadPoolTaskScheduler {
TestTaskScheduler() {