分析@SpringBootApplication注解做了哪些事锨亏。
總結(jié):@SpringBootApplication注解內(nèi)部有三個(gè)注解:
1、SpringBootConfiguration:springBootConfiguration注解上有configuration注解棵癣,所以作用和configuration注解類(lèi)似。
2夺衍、EnableAutoConfiguration:這個(gè)注解上有AutoConfigurationPackage注解和@Import(AutoConfigurationImportSelector.class)注解狈谊。
AutoConfigurationPackage注解:會(huì)將啟動(dòng)類(lèi)的包名下、以及子包下刷后,所有的類(lèi)的畴,注入到ioc容器。
@Import(AutoConfigurationImportSelector.class):會(huì)通過(guò)SpringFactoriesLoader.loadFactories方法獲取META-INF/spirng.factories下的EnableAutoConfiguration接口的所有組件實(shí)現(xiàn)類(lèi)尝胆,比如AopAutoConfiguration丧裁、RabbitAutoConfiguration,進(jìn)行各個(gè)組件的自動(dòng)化配置含衔。
3煎娇、ComponentScan:這個(gè)注解用于自定義spring boot掃描指定的包下的類(lèi)加入ioc容器,以及可以配置過(guò)濾規(guī)則贪染,過(guò)濾哪些不需要加入ioc容器缓呛。SpringBootApplication注解配置了一些自定義的過(guò)濾規(guī)則。
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication
springBootConfiguration注解上有configuration注解杭隙,所以作用類(lèi)似
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration
看這個(gè)類(lèi)前哟绊,先說(shuō)@import注解。
import注解有三種使用方式:
1痰憎、直接普通的類(lèi)的全類(lèi)名寫(xiě)上去票髓,會(huì)注入ioc容器。
@Import({com.test.A, com.test.B } )
public class C{
}
2铣耘、注入的類(lèi)洽沟,實(shí)現(xiàn)了ImportSelector接口,ImportSelector接口的抽象方法會(huì)返回需要注入的類(lèi)的名稱(chēng)數(shù)組蜗细。
3裆操、注入的類(lèi),實(shí)現(xiàn)了ImportBeanDefinitionRegistrar,ImportBeanDefinitionRegistrar接口的抽象方法踪区,會(huì)傳入?yún)?shù)BeanDefinitionRegistry 昆烁,用于手動(dòng)注入到ioc容器。
可以看到這個(gè)注解上有兩部分朽缴,AutoConfigurationPackage注解和import注解善玫。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration
AutoConfigurationPackages.Registrar實(shí)現(xiàn)了ImportBeanDefinitionRegistrar接口,用于手動(dòng)注入類(lèi)到ioc中密强,可以看到方法內(nèi)部傳參是啟動(dòng)類(lèi)的包名茅郎。把啟動(dòng)類(lèi)的包名下的所有類(lèi)都注入ioc。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
@Override
public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));
}
@Override
public Set<Object> determineImports(AnnotationMetadata metadata) {
return Collections.singleton(new PackageImports(metadata));
}
}
public static void register(BeanDefinitionRegistry registry, String... packageNames) {
if (registry.containsBeanDefinition(BEAN)) {
BasePackagesBeanDefinition beanDefinition = (BasePackagesBeanDefinition) registry.getBeanDefinition(BEAN);
beanDefinition.addBasePackages(packageNames);
}
else {
// 手動(dòng)注入到ioc或渤,傳參:?jiǎn)?dòng)類(lèi)的包名系冗。把啟動(dòng)類(lèi)的包名下的所有類(lèi)都注入ioc。
registry.registerBeanDefinition(BEAN, new BasePackagesBeanDefinition(packageNames));
}
}
回過(guò)頭來(lái)再看這個(gè)注解薪鹦,接著看@Import(AutoConfigurationImportSelector.class)
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
實(shí)現(xiàn)了ImportSelector接口掌敬,說(shuō)明selectImports方法返回的類(lèi)名數(shù)組會(huì)注入到ioc容器。
public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware,
ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered {
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
}
// 獲取注解屬性
AnnotationAttributes attributes = getAttributes(annotationMetadata);
// 核心池磁。獲取候選的configuration的全類(lèi)名數(shù)組奔害。
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
// 下面都是對(duì)候選的configuration進(jìn)行一些去重處理
configurations = removeDuplicates(configurations);
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = getConfigurationClassFilter().filter(configurations);
// 發(fā)布自動(dòng)配置導(dǎo)入事件
fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationEntry(configurations, exclusions);
}
SpringFactoriesLoader.loadFactories方法會(huì)獲取META-INF/spirng.factories下的指定類(lèi)的所有實(shí)現(xiàn)類(lèi)。
這里獲取配置的EnableAutoConfiguration的所有實(shí)現(xiàn)類(lèi)地熄。
spring boot自動(dòng)化配置各種組件的方式就是如此华临,spring-boot-autoconfiguration.jar包的spring.factories文件里定義好了各種組件的AutoConfiguration,包里也有各個(gè)AutoConfiguration類(lèi),比如AopAutoConfiguration端考、RabbitAutoConfiguration雅潭。組件又通過(guò)ConditionalOnClass達(dá)到自適應(yīng)加載。
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {
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;
}
protected Class<?> getSpringFactoriesLoaderFactoryClass() {
return EnableAutoConfiguration.class;
}
發(fā)布自動(dòng)配置導(dǎo)入事件:獲取META-INF/spirng.factories下配置的AutoConfigurationImportListener的所有實(shí)現(xiàn)類(lèi)却特,循環(huán)調(diào)用各個(gè)類(lèi)的監(jiān)聽(tīng)事件方法扶供。
private void fireAutoConfigurationImportEvents(List<String> configurations, Set<String> exclusions) {
// 獲取META-INF/spirng.factories下配置的AutoConfigurationImportListener的所有實(shí)現(xiàn)類(lèi)
List<AutoConfigurationImportListener> listeners = getAutoConfigurationImportListeners();
if (!listeners.isEmpty()) {
AutoConfigurationImportEvent event = new AutoConfigurationImportEvent(this, configurations, exclusions);
for (AutoConfigurationImportListener listener : listeners) {
// 如果監(jiān)聽(tīng)器實(shí)現(xiàn)了Aware接口,就填充Aware的所需的參數(shù)裂明。
invokeAwareMethods(listener);
// 調(diào)用事件監(jiān)聽(tīng)器的監(jiān)聽(tīng)事件
listener.onAutoConfigurationImportEvent(event);
}
}
}
protected List<AutoConfigurationImportListener> getAutoConfigurationImportListeners() {
// SpringFactoriesLoader.loadFactories方法會(huì)獲取META-INF/spirng.factories下的指定類(lèi)的所有實(shí)現(xiàn)類(lèi)椿浓。
// 這了獲取配置的AutoConfigurationImportListener的所有實(shí)現(xiàn)類(lèi)
return SpringFactoriesLoader.loadFactories(AutoConfigurationImportListener.class, this.beanClassLoader);
}
看一下SpringFactoriesLoader.loadFactoryNames方法。
1闽晦、存在一個(gè)緩存轰绵,也就是說(shuō)多次調(diào)用,不會(huì)重復(fù)解析加載
2尼荆、 獲取所有的META-INF/spring.factories路徑,包括各個(gè)jar包的唧垦。
3捅儒、循環(huán)解析,存到result這個(gè)map中,并返回這個(gè)map巧还。
public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
ClassLoader classLoaderToUse = classLoader;
if (classLoaderToUse == null) {
classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
}
String factoryTypeName = factoryType.getName();
return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
}
public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
// 存在一個(gè)緩存鞭莽,也就是說(shuō)多次調(diào)用,不會(huì)重復(fù)解析加載
Map<String, List<String>> result = cache.get(classLoader);
if (result != null) {
return result;
}
result = new HashMap<>();
try {
// 獲取所有的META-INF/spring.factories路徑麸祷,包括各個(gè)jar包的澎怒。
Enumeration<URL> urls = classLoader.getResources(FACTORIES_RESOURCE_LOCATION);
// 循環(huán)解析,存到result這個(gè)map中阶牍。
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
UrlResource resource = new UrlResource(url);
Properties properties = PropertiesLoaderUtils.loadProperties(resource);
for (Map.Entry<?, ?> entry : properties.entrySet()) {
String factoryTypeName = ((String) entry.getKey()).trim();
String[] factoryImplementationNames =
StringUtils.commaDelimitedListToStringArray((String) entry.getValue());
for (String factoryImplementationName : factoryImplementationNames) {
result.computeIfAbsent(factoryTypeName, key -> new ArrayList<>())
.add(factoryImplementationName.trim());
}
}
}
// Replace all lists with unmodifiable lists containing unique elements
result.replaceAll((factoryType, implementations) -> implementations.stream().distinct()
.collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList)));
cache.put(classLoader, result);
}
catch (IOException ex) {
throw new IllegalArgumentException("Unable to load factories from location [" +
FACTORIES_RESOURCE_LOCATION + "]", ex);
}
return result;
}
總結(jié):@SpringBootApplication注解內(nèi)部有三個(gè)注解:
1喷面、SpringBootConfiguration:springBootConfiguration注解上有configuration注解,所以作用和configuration注解類(lèi)似走孽。
2惧辈、EnableAutoConfiguration:這個(gè)注解上有AutoConfigurationPackage注解和@Import(AutoConfigurationImportSelector.class)注解。
AutoConfigurationPackage注解:會(huì)將啟動(dòng)類(lèi)的包名下磕瓷、以及子包下盒齿,所有的類(lèi),注入到ioc容器困食。
@Import(AutoConfigurationImportSelector.class):會(huì)通過(guò)SpringFactoriesLoader.loadFactories方法獲取META-INF/spirng.factories下的EnableAutoConfiguration接口的所有組件實(shí)現(xiàn)類(lèi)边翁,比如AopAutoConfiguration、RabbitAutoConfiguration硕盹,進(jìn)行各個(gè)組件的自動(dòng)化配置符匾。
3、ComponentScan:這個(gè)注解用于自定義spring boot掃描指定的包下的類(lèi)加入ioc容器莱睁,以及可以配置過(guò)濾規(guī)則待讳,過(guò)濾哪些不需要加入ioc容器。SpringBootApplication注解配置了一些自定義的過(guò)濾規(guī)則仰剿。