From 0b7eda89d47753c4152e54686e199090dc9fbc28 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Wed, 5 Feb 2014 20:21:46 -0800 Subject: [PATCH] Don't eagerly initialize FactoryBeans Fix `EmbeddedServletContainerAutoConfiguration` so that it does not accidentally eagerly initialize factory beans. Fixes gh-306 --- ...ddedServletContainerAutoConfiguration.java | 20 +++--- .../AutoConfigurationReproTests.java | 66 +++++++++++++++++++ .../autoconfigure/EarlyInitFactoryBean.java | 44 +++++++++++++ .../src/test/resources/early-init-test.xml | 11 ++++ 4 files changed, 132 insertions(+), 9 deletions(-) create mode 100644 spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/AutoConfigurationReproTests.java create mode 100644 spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/EarlyInitFactoryBean.java create mode 100644 spring-boot-autoconfigure/src/test/resources/early-init-test.xml diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/EmbeddedServletContainerAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/EmbeddedServletContainerAutoConfiguration.java index 7aef7b0e2f0..2b5f5f7ccef 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/EmbeddedServletContainerAutoConfiguration.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/EmbeddedServletContainerAutoConfiguration.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2013 the original author or authors. + * Copyright 2012-2014 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. @@ -24,7 +24,6 @@ import org.eclipse.jetty.util.Loader; import org.springframework.beans.BeansException; import org.springframework.beans.factory.BeanFactory; import org.springframework.beans.factory.BeanFactoryAware; -import org.springframework.beans.factory.config.BeanDefinition; import org.springframework.beans.factory.config.ConfigurableListableBeanFactory; import org.springframework.beans.factory.support.BeanDefinitionRegistry; import org.springframework.beans.factory.support.RootBeanDefinition; @@ -45,6 +44,7 @@ import org.springframework.context.annotation.ImportBeanDefinitionRegistrar; import org.springframework.core.Ordered; import org.springframework.core.annotation.Order; import org.springframework.core.type.AnnotationMetadata; +import org.springframework.util.ObjectUtils; /** * {@link EnableAutoConfiguration Auto-configuration} for an embedded servlet containers. @@ -107,15 +107,17 @@ public class EmbeddedServletContainerAutoConfiguration { @Override public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) { - if (this.beanFactory != null - && this.beanFactory.getBeansOfType( - EmbeddedServletContainerCustomizerBeanPostProcessor.class) - .size() == 0) { - BeanDefinition beanDefinition = new RootBeanDefinition( - EmbeddedServletContainerCustomizerBeanPostProcessor.class); + if (this.beanFactory == null) { + return; + } + if (ObjectUtils.isEmpty(this.beanFactory.getBeanNamesForType( + EmbeddedServletContainerCustomizerBeanPostProcessor.class, true, + false))) { registry.registerBeanDefinition( "embeddedServletContainerCustomizerBeanPostProcessor", - beanDefinition); + new RootBeanDefinition( + EmbeddedServletContainerCustomizerBeanPostProcessor.class)); + } } } diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/AutoConfigurationReproTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/AutoConfigurationReproTests.java new file mode 100644 index 00000000000..5ab538c78fb --- /dev/null +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/AutoConfigurationReproTests.java @@ -0,0 +1,66 @@ +/* + * Copyright 2012-2014 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.boot.autoconfigure; + +import org.junit.After; +import org.junit.Test; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.ImportResource; +import org.springframework.context.support.PropertySourcesPlaceholderConfigurer; + +import static org.hamcrest.Matchers.equalTo; +import static org.junit.Assert.assertThat; + +/** + * Tests to reproduce reported issues. + * + * @author Phillip Webb + */ +public class AutoConfigurationReproTests { + + private ConfigurableApplicationContext context; + + @After + public void cleanup() { + if (this.context != null) { + this.context.close(); + } + } + + @Test + public void doesNotEarlyInitializeFactoryBeans() throws Exception { + SpringApplication application = new SpringApplication(EarlyInitConfig.class, + PropertySourcesPlaceholderConfigurer.class, + EmbeddedServletContainerAutoConfiguration.class); + this.context = application.run(); + String bean = (String) this.context.getBean("earlyInit"); + assertThat(bean, equalTo("bucket")); + } + + @Configuration + public static class Config { + } + + @Configuration + @ImportResource("classpath:/early-init-test.xml") + public static class EarlyInitConfig { + + } +} diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/EarlyInitFactoryBean.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/EarlyInitFactoryBean.java new file mode 100644 index 00000000000..92166de9041 --- /dev/null +++ b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/EarlyInitFactoryBean.java @@ -0,0 +1,44 @@ +/* + * Copyright 2012-2014 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.boot.autoconfigure; + +import org.springframework.beans.factory.FactoryBean; + +public class EarlyInitFactoryBean implements FactoryBean { + + private String propertyFromConfig; + + public void setPropertyFromConfig(String propertyFromConfig) { + this.propertyFromConfig = propertyFromConfig; + } + + @Override + public boolean isSingleton() { + return true; + } + + @Override + public Class getObjectType() { + return null; + } + + @Override + public String getObject() throws Exception { + return this.propertyFromConfig; + } + +} diff --git a/spring-boot-autoconfigure/src/test/resources/early-init-test.xml b/spring-boot-autoconfigure/src/test/resources/early-init-test.xml new file mode 100644 index 00000000000..9c28c45026c --- /dev/null +++ b/spring-boot-autoconfigure/src/test/resources/early-init-test.xml @@ -0,0 +1,11 @@ + + + + + + + + +