From 965dd33ec80f33b1084b7cd7739798cd1e8c5c4a Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Mon, 22 Feb 2016 10:32:37 -0800 Subject: [PATCH] Introduce @SpringBootConfiguration annotation Add a new @SpringBootConfiguration annotation that can be used to indicate the primary application configuration. The new annotation is primarily indented to allow test automatically code to find the main configuration class. See gh-5295 --- .../autoconfigure/SpringBootApplication.java | 5 +- .../boot/SpringBootConfiguration.java | 46 +++++++++++++++++++ 2 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 spring-boot/src/main/java/org/springframework/boot/SpringBootConfiguration.java diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java index d2f6d7a1edc..9f6a2cd0b32 100644 --- a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java +++ b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/SpringBootApplication.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2015 the original author or authors. + * 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. @@ -23,6 +23,7 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +import org.springframework.boot.SpringBootConfiguration; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; @@ -43,7 +44,7 @@ import org.springframework.core.annotation.AliasFor; @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited -@Configuration +@SpringBootConfiguration @EnableAutoConfiguration @ComponentScan public @interface SpringBootApplication { diff --git a/spring-boot/src/main/java/org/springframework/boot/SpringBootConfiguration.java b/spring-boot/src/main/java/org/springframework/boot/SpringBootConfiguration.java new file mode 100644 index 00000000000..b8282bed960 --- /dev/null +++ b/spring-boot/src/main/java/org/springframework/boot/SpringBootConfiguration.java @@ -0,0 +1,46 @@ +/* + * 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; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +import org.springframework.context.annotation.Configuration; + +/** + * Indicates that a class provides Spring Boot application + * {@link Configuration @Configuration}. Can be used as an alternative to the Spring's + * standard {@code @Configuration} annotation so that configuration can be found + * automatically (for example in tests). + *

+ * Application should only ever include one + * {@code @SpringApplicationConfiguration} and most idiomatic Spring Boot applications + * will inherit it from {@code @SpringBootApplication}. + * + * @author Phillip Webb + * @since 1.4.0 + */ +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@Documented +@Configuration +public @interface SpringBootConfiguration { + +}