Force lazy-init to false when parsing scheduled:task

A <scheduled:task> element declared within a
<beans default-lazy-init="true"> element represents a contradiction in
terms: such a task will never be executed.

For this reason, we now override any inherited lazy-init settings
when parsing <scheduled:task> elements, forcing lazy-init to false
for the underlying ScheduledTaskRegistrar bean.

Thanks to Mike Youngstrom for contributing an initial patch.

Issue: SPR-8498
This commit is contained in:
Chris Beams 2011-07-19 23:00:12 +00:00
parent 576b8fec31
commit 718f025d64
3 changed files with 70 additions and 0 deletions

View File

@ -50,6 +50,7 @@ public class ScheduledTasksBeanDefinitionParser extends AbstractSingleBeanDefini
@Override
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
builder.setLazyInit(false); // lazy scheduled tasks are a contradiction in terms -> force to false
ManagedMap<RuntimeBeanReference, String> cronTaskMap = new ManagedMap<RuntimeBeanReference, String>();
ManagedMap<RuntimeBeanReference, String> fixedDelayTaskMap = new ManagedMap<RuntimeBeanReference, String>();
ManagedMap<RuntimeBeanReference, String> fixedRateTaskMap = new ManagedMap<RuntimeBeanReference, String>();

View File

@ -0,0 +1,54 @@
/*
* Copyright 2002-2011 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
*
* http://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.scheduling.config;
import org.junit.Test;
import org.springframework.context.support.GenericXmlApplicationContext;
/**
* Tests ensuring that tasks scheduled using the <task:scheduled> element
* are never marked lazy, even if the enclosing <beans> element declares
* default-lazy-init="true". See SPR-8498
*
* @author Mike Youngstrom
* @author Chris Beams
*/
public class LazyScheduledTasksBeanDefinitionParserTests {
@Test(timeout = 5000)
public void checkTarget() {
Task task =
new GenericXmlApplicationContext(
LazyScheduledTasksBeanDefinitionParserTests.class,
"lazyScheduledTasksContext.xml")
.getBean(Task.class);
while (!task.executed) {
try {
Thread.sleep(10);
} catch (Exception e) { /* Do Nothing */ }
}
}
static class Task {
volatile boolean executed = false;
public void doWork() {
executed = true;
}
}
}

View File

@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:task="http://www.springframework.org/schema/task"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task.xsd"
default-lazy-init="true">
<task:scheduled-tasks>
<task:scheduled ref="myTask" method="doWork" fixed-rate="10"/>
</task:scheduled-tasks>
<bean id="myTask" class="org.springframework.scheduling.config.LazyScheduledTasksBeanDefinitionParserTests$Task"/>
</beans>