В этой главе мы раскроем для вас механизм работы Spring Boot Auto Configuration (Автоконфигурация).Когда дело доходит до автоконфигурации, аннотация @EnableAutoConfiguration определенно неотделима.
package org.springframework.boot.autoconfigure;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
Class<?>[] exclude() default {};
String[] excludeName() default {};
}
Здесь задействованы две метааннотации:@AutoConfigurationPackage, @Import(EnableAutoConfigurationImportSelector.class), где @AutoConfigurationPackageОпределяется следующим образом:
package org.springframework.boot.autoconfigure;
import ....
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
}
@AutoConfigurationPackageМета-аннотация @Import используется в определении аннотации, а значение атрибута аннотации равноAutoConfigurationPackages.Registrar.class, AutoConfigurationPackages.Registrarкласс реализует интерфейсImportBeanDefinitionRegistrar
Аннотация @Import может принимать следующие классы Java определенных типов.
- Классы, аннотированные с помощью @Configuration
- Класс реализации ImportSelector: код для обработки аннотированных классов @Configuration
- Класс реализации DeferredImportSelector: аналогичен ImportSelector, разница в том, что операция обработки откладывается до тех пор, пока не будут обработаны все остальные элементы конфигурации, прежде чем продолжить.
- Класс реализации ImportBeanDefinitionRegistrar
AutoConfigurationPackages.RegistrarБин будет зарегистрирован в контейнере Spring, а сам Бин будет хранить список определяемых пользователем пакетов конфигурации. Сама Spring Boot использует этот список. Например: для класса конфигурации доступа к данным spring-boot-autoconfigure вы можете получить этот список конфигурации с помощью статического метода: **AutoConfigurationPackages.get(BeanFactory)**, ниже приведен пример кода.
package com.logicbig.example;
import ...
@EnableAutoConfiguration
public class AutoConfigurationPackagesTest {
public static void main (String[] args) {
SpringApplication app =
new SpringApplication(AutoConfigurationPackagesTest.class);
app.setBannerMode(Banner.Mode.OFF);
app.setLogStartupInfo(false);
ConfigurableApplicationContext c = app.run(args);
List<String> packages = AutoConfigurationPackages.get(c);
System.out.println("packages: "+packages);
}
}
Вывод кода выглядит следующим образом:
2017-01-03 10:17:37.372 INFO 10752 --- [ main] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@67b467e9: startup date [Tue Jan 03 10:17:37 CST 2017]; root of context hierarchy
2017-01-03 10:17:38.155 INFO 10752 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup
packages: [com.logicbig.example]
2017-01-03 10:17:38.170 INFO 10752 --- [ Thread-1] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@67b467e9: startup date [Tue Jan 03 10:17:37 CST 2017]; root of context hierarchy
2017-01-03 10:17:38.171 INFO 10752 --- [ Thread-1] o.s.j.e.a.AnnotationMBeanExporter : Unregistering JMX-exposed beans on shutdown
**@Import(EnableAutoConfigurationImportSelector.class)Аннотации — это точки входа для механизма автоматической настройки.EnableAutoConfigurationImportSelectorРеализует интерфейс DeferredImportSelector, который внутренне вызываетМетод SpringFactoriesLoader.loadFactoryNames()**, который будет загружать классы конфигурации из META-INF/spring.factories.
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
AnnotationAttributes attributes) {
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
Assert.notEmpty(configurations,
"No auto configuration classes found in META-INF/spring.factories. If you "
+ "are using a custom packaging, make sure that file is correct.");
return configurations;
}
Найдите значение ключа org.springframework.boot.autoconfigure.EnableAutoConfiguration из spring.factories:
spring-boot-autoconfigureНеявно включается по умолчанию во все программы запуска
Один из следующих фрагментов кода для класса конфигурации JmxAutoConfiguration
package org.springframework.boot.autoconfigure.jmx;
.......
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.condition.SearchStrategy;
.....
@Configuration
@ConditionalOnClass({ MBeanExporter.class })
@ConditionalOnProperty(prefix = "spring.jmx", name = "enabled", havingValue = "true", matchIfMissing = true)
public class JmxAutoConfiguration implements
EnvironmentAware, BeanFactoryAware {
.....
}
@ConditionalOnClass
@ConditionalOnClassЭто аннотация, определяемая мета-аннотацией **@Conditional(OnClassCondition.class**. Мы знаем, что @Conditional является условной аннотацией. Только когда условие истинно, класс и метод, аннотированные @Conditional, будут загружены в контейнер компонента Spring. Для приведенного выше примера фрагмента кода, только когда MBeanExporter.class был включен в путь к классам (конкретная проверка аналогична логике загрузки Class.forName, когда целевой класс включен в путь к классам, метод возвращает true, иначе возвращается false), OnClassCondition#matches() вернет true.
@ConditionalOnProperty
с **@ConditionalOnClassпохожий,@ConditionalOnPropertyэто еще одна переменная типа @Conditional, которая аннотируется метаАннотация, определенная @Conditional(OnPropertyCondition.class)**. **OnPropertyCondition#matches()** вернет значение true, только если целевое свойство содержит указанное значение или приведенный выше фрагмент кода:
@ConditionalOnProperty(prefix = "spring.jmx", name = "enabled",
havingValue = "true", matchIfMissing = true)
Если наше приложение настроено с помощью spring.jmx.enabled=true, то контейнер Spring автоматически зарегистрирует JmxAutoConfiguration,matchIfMissing=trueУказывает true по умолчанию (свойство конфигурации не задано).
Некоторые другие условные аннотации
пакет 'org.springframework.boot.autoconfigure.condition,Все условные аннотации следуютСоглашение об именах ConditionalOnXyz. Если вы хотите разработать собственный начальный пакет, вам необходимо понимать эти API, а другим разработчикам лучше всего понимать базовый механизм работы.
Используйте параметр --debug
@EnableAutoConfiguration
public class DebugModeExample {
public static void main (String[] args) {
//just doing this programmatically for demo
String[] appArgs = {"--debug"};
SpringApplication app = new SpringApplication(DebugModeExample.class);
app.setBannerMode(Banner.Mode.OFF);
app.setLogStartupInfo(false);
app.run(appArgs);
}
}
вывод
2017-01-02 21:15:17.322 DEBUG 5704 --- [ main] o.s.boot.SpringApplication : Loading source class com.logicbig.example.DebugModeExample
2017-01-02 21:15:17.379 DEBUG 5704 --- [ main] o.s.b.c.c.ConfigFileApplicationListener : Skipped (empty) config file 'file:/D:/LogicBig/example-projects/spring-boot/boot-customizing-autoconfig/target/classes/application.properties' (classpath:/application.properties)
2017-01-02 21:15:17.379 DEBUG 5704 --- [ main] o.s.b.c.c.ConfigFileApplicationListener : Skipped (empty) config file 'file:/D:/LogicBig/example-projects/spring-boot/boot-customizing-autoconfig/target/classes/application.properties' (classpath:/application.properties) for profile default
2017-01-02 21:15:17.384 INFO 5704 --- [ main] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@2f0a87b3: startup date [Mon Jan 02 21:15:17 CST 2017]; root of context hierarchy
2017-01-02 21:15:18.032 INFO 5704 --- [ main] o.s.j.e.a.AnnotationMBeanExporter : Registering beans for JMX exposure on startup
2017-01-02 21:15:18.047 DEBUG 5704 --- [ main] utoConfigurationReportLoggingInitializer :
=========================
AUTO-CONFIGURATION REPORT
=========================
Positive matches:
-----------------
GenericCacheConfiguration matched:
- Cache org.springframework.boot.autoconfigure.cache.GenericCacheConfiguration automatic cache type (CacheCondition)
JmxAutoConfiguration matched:
- @ConditionalOnClass found required class 'org.springframework.jmx.export.MBeanExporter' (OnClassCondition)
- @ConditionalOnProperty (spring.jmx.enabled=true) matched (OnPropertyCondition)
JmxAutoConfiguration#mbeanExporter matched:
- @ConditionalOnMissingBean (types: org.springframework.jmx.export.MBeanExporter; SearchStrategy: current) did not find any beans (OnBeanCondition)
JmxAutoConfiguration#mbeanServer matched:
- @ConditionalOnMissingBean (types: javax.management.MBeanServer; SearchStrategy: all) did not find any beans (OnBeanCondition)
JmxAutoConfiguration#objectNamingStrategy matched:
- @ConditionalOnMissingBean (types: org.springframework.jmx.export.naming.ObjectNamingStrategy; SearchStrategy: current) did not find any beans (OnBeanCondition)
NoOpCacheConfiguration matched:
- Cache org.springframework.boot.autoconfigure.cache.NoOpCacheConfiguration automatic cache type (CacheCondition)
PropertyPlaceholderAutoConfiguration#propertySourcesPlaceholderConfigurer matched:
- @ConditionalOnMissingBean (types: org.springframework.context.support.PropertySourcesPlaceholderConfigurer; SearchStrategy: current) did not find any beans (OnBeanCondition)
RedisCacheConfiguration matched:
- Cache org.springframework.boot.autoconfigure.cache.RedisCacheConfiguration automatic cache type (CacheCondition)
SimpleCacheConfiguration matched:
- Cache org.springframework.boot.autoconfigure.cache.SimpleCacheConfiguration automatic cache type (CacheCondition)
Negative matches:
-----------------
ActiveMQAutoConfiguration:
Did not match:
- @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
AopAutoConfiguration:
Did not match:
- @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)
ArtemisAutoConfiguration:
Did not match:
- @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.artemis.jms.client
...............................
....................
Exclusions:
-----------
None
Unconditional classes:
----------------------
org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration
org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration
org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration
2017-01-02 21:15:18.058 INFO 5704 --- [ Thread-1] s.c.a.AnnotationConfigApplicationContext : Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@2f0a87b3: startup date [Mon Jan 02 21:15:17 CST 2017]; root of context hierarchy
2017-01-02 21:15:18.059 INFO 5704 --- [ Thread-1] o.s.j.e.a.AnnotationMBeanExporter : Unregistering JMX-exposed beans on shutdown
в приведенном выше выводе
- Положительные совпадения: условие @Conditional истинно, и класс конфигурации загружается контейнером Spring.
- Отрицательные совпадения: условие @Conditional ложно, класс конфигурации не загружается контейнером Spring.
- Исключения: Сторона приложения явно исключает загрузку конфигурации.
- Безусловные классы: автоматически настроенные классы не содержат никаких условий на уровне класса, то есть классы всегда загружаются автоматически.
Отключить автоматическую настройку для определенных классов
@EnableAutoConfiguration(exclude = {JmxAutoConfiguration.class})
public class ExcludeConfigExample {
public static void main (String[] args) {
//just doing this programmatically for demo
String[] appArgs = {"--debug"};
SpringApplication app = new SpringApplication(ExcludeConfigExample.class);
app.setBannerMode(Banner.Mode.OFF);
app.setLogStartupInfo(false);
app.run(appArgs);
}
}
вывод
.............
=========================
AUTO-CONFIGURATION REPORT
=========================
Positive matches:
-----------------
GenericCacheConfiguration matched:
- Cache org.springframework.boot.autoconfigure.cache.GenericCacheConfiguration automatic cache type (CacheCondition)
NoOpCacheConfiguration matched:
- Cache org.springframework.boot.autoconfigure.cache.NoOpCacheConfiguration automatic cache type (CacheCondition)
PropertyPlaceholderAutoConfiguration#propertySourcesPlaceholderConfigurer matched:
- @ConditionalOnMissingBean (types: org.springframework.context.support.PropertySourcesPlaceholderConfigurer; SearchStrategy: current) did not find any beans (OnBeanCondition)
RedisCacheConfiguration matched:
- Cache org.springframework.boot.autoconfigure.cache.RedisCacheConfiguration automatic cache type (CacheCondition)
SimpleCacheConfiguration matched:
- Cache org.springframework.boot.autoconfigure.cache.SimpleCacheConfiguration automatic cache type (CacheCondition)
Negative matches:
-----------------
ActiveMQAutoConfiguration:
Did not match:
- @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
AopAutoConfiguration:
Did not match:
- @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)
.................................
Exclusions:
-----------
org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration
Unconditional classes:
----------------------
org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration
org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration
org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration