Polish @IntegrationComponentScan auto-configuration

See gh-2037
See gh-7718
This commit is contained in:
Phillip Webb 2016-12-21 20:06:36 -08:00
parent a79f71cbe8
commit 982f41b70c
6 changed files with 191 additions and 65 deletions

View File

@ -16,15 +16,11 @@
package org.springframework.boot.autoconfigure.integration;
import java.util.Map;
import javax.management.MBeanServer;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@ -37,12 +33,8 @@ import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.StandardAnnotationMetadata;
import org.springframework.integration.annotation.IntegrationComponentScan;
import org.springframework.integration.config.EnableIntegration;
import org.springframework.integration.config.EnableIntegrationManagement;
import org.springframework.integration.config.IntegrationComponentScanRegistrar;
import org.springframework.integration.gateway.GatewayProxyFactoryBean;
import org.springframework.integration.jmx.config.EnableIntegrationMBeanExport;
import org.springframework.integration.monitor.IntegrationMBeanExporter;
@ -63,12 +55,18 @@ import org.springframework.util.StringUtils;
@AutoConfigureAfter(JmxAutoConfiguration.class)
public class IntegrationAutoConfiguration {
/**
* Basic Spring Integration configuration.
*/
@Configuration
@EnableIntegration
protected static class IntegrationConfiguration {
}
/**
* Spring Integration JMX configuration.
*/
@Configuration
@ConditionalOnClass(EnableIntegrationMBeanExport.class)
@ConditionalOnMissingBean(value = IntegrationMBeanExporter.class, search = SearchStrategy.CURRENT)
@ -107,6 +105,9 @@ public class IntegrationAutoConfiguration {
}
/**
* Integration management configuration.
*/
@Configuration
@ConditionalOnClass({ EnableIntegrationManagement.class,
EnableIntegrationMBeanExport.class })
@ -121,45 +122,13 @@ public class IntegrationAutoConfiguration {
}
/**
* Integration component scan configuration.
*/
@ConditionalOnMissingBean(GatewayProxyFactoryBean.class)
@Import(AutoIntegrationComponentScanRegistrar.class)
@Import(IntegrationAutoConfigurationScanRegistrar.class)
protected static class IntegrationComponentScanAutoConfiguration {
}
private static class AutoIntegrationComponentScanRegistrar
extends IntegrationComponentScanRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
final BeanDefinitionRegistry registry) {
StandardAnnotationMetadata metadata = new StandardAnnotationMetadata(
IntegrationComponentScanConfiguration.class, true) {
@Override
public Map<String, Object> getAnnotationAttributes(
String annotationName) {
Map<String, Object> annotationAttributes = super.getAnnotationAttributes(
annotationName);
if (IntegrationComponentScan.class.getName().equals(annotationName)) {
BeanFactory beanFactory = (BeanFactory) registry;
if (AutoConfigurationPackages.has(beanFactory)) {
annotationAttributes.put("value",
AutoConfigurationPackages.get(beanFactory));
}
}
return annotationAttributes;
}
};
super.registerBeanDefinitions(metadata, registry);
}
@IntegrationComponentScan
private class IntegrationComponentScanConfiguration {
}
}
}

View File

@ -0,0 +1,87 @@
/*
* Copyright 2012-2016 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.integration;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.StandardAnnotationMetadata;
import org.springframework.integration.annotation.IntegrationComponentScan;
import org.springframework.integration.config.IntegrationComponentScanRegistrar;
/**
* Variation of {@link IntegrationComponentScanRegistrar} the links
* {@link AutoConfigurationPackages}.
*
* @author Artem Bilan
* @author Phillip Webb
*/
class IntegrationAutoConfigurationScanRegistrar extends IntegrationComponentScanRegistrar
implements BeanFactoryAware {
private BeanFactory beanFactory;
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
this.beanFactory = beanFactory;
}
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
final BeanDefinitionRegistry registry) {
super.registerBeanDefinitions(
new IntegrationComponentScanConfigurationMetaData(this.beanFactory),
registry);
}
private static class IntegrationComponentScanConfigurationMetaData
extends StandardAnnotationMetadata {
private final BeanFactory beanFactory;
IntegrationComponentScanConfigurationMetaData(BeanFactory beanFactory) {
super(IntegrationComponentScanConfiguration.class, true);
this.beanFactory = beanFactory;
}
@Override
public Map<String, Object> getAnnotationAttributes(String annotationName) {
Map<String, Object> attributes = super.getAnnotationAttributes(
annotationName);
if (IntegrationComponentScan.class.getName().equals(annotationName)
&& AutoConfigurationPackages.has(this.beanFactory)) {
List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
attributes = new LinkedHashMap<String, Object>(attributes);
attributes.put("value", packages.toArray(new String[packages.size()]));
}
return attributes;
}
}
@IntegrationComponentScan
private static class IntegrationComponentScanConfiguration {
}
}

View File

@ -24,6 +24,7 @@ import javax.management.MBeanServer;
import org.junit.After;
import org.junit.Test;
import org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration.IntegrationComponentScanAutoConfiguration;
import org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
@ -65,7 +66,7 @@ public class IntegrationAutoConfigurationTests {
public void integrationIsAvailable() {
load();
assertThat(this.context.getBean(TestGateway.class)).isNotNull();
assertThat(this.context.getBean(IntegrationAutoConfiguration.IntegrationComponentScanAutoConfiguration.class))
assertThat(this.context.getBean(IntegrationComponentScanAutoConfiguration.class))
.isNotNull();
}
@ -73,12 +74,12 @@ public class IntegrationAutoConfigurationTests {
public void explicitIntegrationComponentScan() {
this.context = new AnnotationConfigApplicationContext();
this.context.register(IntegrationComponentScanConfiguration.class,
JmxAutoConfiguration.class,
IntegrationAutoConfiguration.class);
JmxAutoConfiguration.class, IntegrationAutoConfiguration.class);
this.context.refresh();
assertThat(this.context.getBean(TestGateway.class)).isNotNull();
assertThat(this.context.getBeansOfType(IntegrationAutoConfiguration.IntegrationComponentScanAutoConfiguration.class))
.isEmpty();
assertThat(this.context
.getBeansOfType(IntegrationComponentScanAutoConfiguration.class))
.isEmpty();
}
@Test
@ -89,7 +90,8 @@ public class IntegrationAutoConfigurationTests {
this.context.setParent(parent);
this.context.register(JmxAutoConfiguration.class,
IntegrationAutoConfiguration.class);
TestPropertySourceUtils.addInlinedPropertiesToEnvironment(this.context, "SPRING_JMX_DEFAULT_DOMAIN=org.foo");
TestPropertySourceUtils.addInlinedPropertiesToEnvironment(this.context,
"SPRING_JMX_DEFAULT_DOMAIN=org.foo");
this.context.refresh();
assertThat(this.context.getBean(HeaderChannelRegistry.class)).isNotNull();
}

View File

@ -0,0 +1,38 @@
/*
* Copyright 2012-2016 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 sample.integration;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class SampleCommandLineRunner implements CommandLineRunner {
private final SampleMessageGateway gateway;
public SampleCommandLineRunner(SampleMessageGateway gateway) {
this.gateway = gateway;
}
@Override
public void run(String... args) throws Exception {
for (String arg : args) {
this.gateway.echo(arg);
}
}
}

View File

@ -0,0 +1,26 @@
/*
* Copyright 2012-2016 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 sample.integration;
import org.springframework.integration.annotation.MessagingGateway;
@MessagingGateway(defaultRequestChannel = "outputChannel")
public interface SampleMessageGateway {
void echo(String message);
}

View File

@ -23,9 +23,8 @@ import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import org.junit.AfterClass;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import sample.integration.SampleIntegrationApplication;
import sample.integration.producer.ProducerApplication;
@ -48,32 +47,37 @@ import static org.assertj.core.api.Assertions.assertThat;
*/
public class SampleIntegrationApplicationTests {
private static ConfigurableApplicationContext context;
@BeforeClass
public static void start() throws Exception {
context = SpringApplication.run(SampleIntegrationApplication.class);
}
@AfterClass
public static void stop() {
if (context != null) {
context.close();
}
}
private ConfigurableApplicationContext context;
@Before
public void deleteOutput() {
FileSystemUtils.deleteRecursively(new File("target/input"));
FileSystemUtils.deleteRecursively(new File("target/output"));
}
@After
public void stop() {
if (this.context != null) {
this.context.close();
}
}
@Test
public void testVanillaExchange() throws Exception {
this.context = SpringApplication.run(SampleIntegrationApplication.class);
SpringApplication.run(ProducerApplication.class, "World");
String output = getOutput();
assertThat(output).contains("Hello World");
}
@Test
public void testMessageGateway() throws Exception {
this.context = SpringApplication.run(SampleIntegrationApplication.class,
"testviamg");
String output = getOutput();
assertThat(output).contains("testviamg");
}
private String getOutput() throws Exception {
Future<String> future = Executors.newSingleThreadExecutor()
.submit(new Callable<String>() {