org.springframework.boot.autoconfigure

Annotation Type EnableAutoConfiguration

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
 @AutoConfigurationPackage
 @Import(value=AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration

Enable auto-configuration of the Spring Application Context, attempting to guess and configure beans that you are likely to need. Auto-configuration classes are usually applied based on your classpath and what beans you have defined. For example, if you have tomcat-embedded.jar on your classpath you are likely to want a TomcatServletWebServerFactory (unless you have defined your own ServletWebServerFactory bean).

When using @SpringBootApplication, the auto-configuration of the context is automatically enabled and adding this annotation has therefore no additional effect.

Auto-configuration tries to be as intelligent as possible and will back-away as you define more of your own configuration. You can always manually exclude() any configuration that you never want to apply (use excludeName() if you don't have access to them). You can also exclude them through the spring.autoconfigure.exclude property. Auto-configuration is always applied after user-defined beans have been registered.

The package of the class that is annotated with @EnableAutoConfiguration, usually through @SpringBootApplication, has specific significance and is often used as a 'default'. For example, it will be used when scanning for @Entity classes. It is generally recommended that you place @EnableAutoConfiguration (if you're not using @SpringBootApplication) in a root package so that all sub-packages and classes can be searched.

Auto-configuration classes are regular Spring @Configuration beans. They are located using ImportCandidates and the SpringFactoriesLoader mechanism (keyed against this class). Generally auto-configuration beans are @Conditional beans (most often using @ConditionalOnClass and @ConditionalOnMissingBean annotations).

Since:

1.0.0

Author:

Phillip Webb, Stephane Nicoll

See Also:

ConditionalOnBean, ConditionalOnMissingBean, ConditionalOnClass, AutoConfigureAfter, SpringBootApplication

Field Summary

Fields

Modifier and Type	Fields and Description
static String	ENABLED_OVERRIDE_PROPERTY Environment property that can be used to override when auto-configuration is enabled.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	exclude Exclude specific auto-configuration classes such that they will never be applied.
String[]	excludeName Exclude specific auto-configuration class names such that they will never be applied.

Field Detail

ENABLED_OVERRIDE_PROPERTY

public static final String ENABLED_OVERRIDE_PROPERTY

Environment property that can be used to override when auto-configuration is enabled.

Element Detail

exclude

public abstract Class<?>[] exclude

Exclude specific auto-configuration classes such that they will never be applied.

Returns:

the classes to exclude

Default:

{}

excludeName

public abstract String[] excludeName

Exclude specific auto-configuration class names such that they will never be applied.

Returns:

the class names to exclude

Since:

1.3.0

Default:

{}