当前位置:首页 > 公众号精选 > 架构师社区
[导读]作者:vivo 互联网服务器团队-Pengpeng一、前言大部分的配置都可以用Java类注解来代替,而在SpringBoot项目中见的最多的莫过于@SpringBootApplication注解了,它在每个SpringBoot的启动类上都有标注。这个注解对SpringBoot的启...

作者:vivo 互联网服务器团队-Peng peng

一、前言



大部分的配置都可以用Java类 注解来代替,而在SpringBoot项目中见的最多的莫过于@SpringBootApplication注解了,它在每个SpringBoot的启动类上都有标注。
这个注解对SpringBoot的启动和自动配置到底有什么样的影响呢?本文将为各位大佬解析它的源码,揭开@SpringBootApplication注解神秘的面纱。

二、正文


对SpringBoot工程的自动配置很感兴趣,于是学习其源码并整理了其中一些内容,如果有错误请大家指正~话不多说,直接上源码;
@SpringBootApplication注解的源码如下:
@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 {...}
可以看到这是一个复合注解,一共包括7个不同的注解,下面对这7个不同的注解进行分析。
2.1 注解 
2.1.1 注解1@Target({ElementType.TYPE})
用来表示注解作用范围,TYPE表示作用范围为类或接口。
2.1.2 注解2:@Retention(RetentionPolicy.RUNTIME)

2.1.3 注解3:@Documented表明这个注释是由 javadoc记录的。
2.1.4 注解4:@Inherited放在注解上,当父类加了@SpringBootApplication注解时,子类也会继承这个注解(对接口的实现类无效)。
2.1.5 注解5:@SpringBootConfiguration底层仍是@Configuration注解, 源码如下:
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Configurationpublic @interface SpringBootConfiguration {}
2.1.6 注解6:@ComponetScan
@ComponentScan这个注解在Spring中很重要,它对应XML配置中的元素@ComponentScan的功能其实就是自动扫描并加载符合条件的组件(比如@Component和@Repository等)或者bean定义,最终将这些bean定义加载到IoC容器中。
可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围,如果不指定,则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。所以SpringBoot的启动类最好是放在root package下,因为默认不指定basePackages。
2.2 注解:@EnableAutoConfiguration
个人感觉@EnableAutoConfiguration这个Annotation最为重要它的作用可以概括为:借助@Import的帮助,将所有符合自动配置条件的bean定义加载到IoC容器
其源码如下:
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import(AutoConfigurationImportSelector.class)public @interface EnableAutoConfiguration { String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; Class[] exclude() default {}; String[] excludeName() default {};}这里需要关注@AutoConfigurationPackage@Import(AutoConfigurationImportSelector.class)两个注解。
2.2.1 注释:@AutoConfigurationPackage
源码如下:
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import(AutoConfigurationImportSelector.class)public @interface EnableAutoConfiguration { String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; Class[] exclude() default {}; String[] excludeName() default {};}
可以发现这个注解的核心其实也是Import注解,表示对于标注该注解的类的包,应当使用AutoConfigurationPackages注册。
接着看Registrar这个类:
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
@Override //metadata是我们注解所在的元信息 public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { //将我们注解所在包下所有的组件进行注册 register(registry, new PackageImport(metadata).getPackageName()); }
@Override public Set determineImports(AnnotationMetadata metadata) { return Collections.singleton(new PackageImport(metadata)); }}
这个类中的核心方法是register方法:
private static final String BEAN = AutoConfigurationPackages.class.getName(); public static void register(BeanDefinitionRegistry registry, String... packageNames) { if (registry.containsBeanDefinition(BEAN)) { BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN); ConstructorArgumentValues constructorArguments = beanDefinition.getConstructorArgumentValues(); constructorArguments.addIndexedArgumentValue(0, addBasePackages(constructorArguments, packageNames)); } else { GenericBeanDefinition beanDefinition = new GenericBeanDefinition(); beanDefinition.setBeanClass(BasePackages.class); beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, packageNames); beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE); registry.registerBeanDefinition(BEAN, beanDefinition); }}
register方法的逻辑非常清晰:如果这个bean已经被注册,就获取它的构造函数参数值,并将包名添加进去;否则就创建一个新的bean定义并进行注册。通过@AutoConfigurationPackage这个注解,可以将注解所在包下所有的组件进行注册。
2.2.2 注解:@Import(AutoConfigurationImportSelector.class)
这个注解导入了AutoConfigurationImportSelector这个类这个类的核心方法是selectImports方法,实现自ImportSelector接口。方法基于我们在pom.xml文件中配置的jar包和组件进行导入。所以方法返回的是一个Class全路径的String数组,返回的Class会被Spring容器管理。
方法源码如下:
@Overridepublic String[] selectImports(AnnotationMetadata annotationMetadata) { if (!isEnabled(annotationMetadata)) { return NO_IMPORTS; } AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader .loadMetadata(this.beanClassLoader); AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata); return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());}
这个方法的结构也很清晰,首先通过isEnabled方法判断是否需要进行导入,如果需要导入的话,通过loadMetadata方法获取配置信息,并通过getAutoConfigurationEntry进行自动装配。
isEnabled方法源码如下:
protected boolean isEnabled(AnnotationMetadata metadata) { if (getClass() == AutoConfigurationImportSelector.class) { return getEnvironment().getProperty(EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY, Boolean.class, true); } return true;}
这个方法通过EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY这个配置项进行判断是否需要自动配置,默认为true。
loadMetadata方法源码如下:
protected static final String PATH = "META-INF/" "spring-autoconfigure-metadata.properties";
public static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader) { return loadMetadata(classLoader, PATH); }
static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader, String path) { try { Enumeration urls = (classLoader != null) ? classLoader.getResources(path) : ClassLoader.getSystemResources(path); Properties properties = new Properties(); while (urls.hasMoreElements()) { properties.putAll(PropertiesLoaderUtils.loadProperties(new UrlResource(urls.nextElement()))); } return loadMetadata(properties); } catch (IOException ex) { throw new IllegalArgumentException("Unable to load @ConditionalOnClass location [" path "]", ex); } } static AutoConfigurationMetadata loadMetadata(Properties properties) { return new PropertiesAutoConfigurationMetadata(properties); }
可以看到这个方法会加载META-INF/spring-autoconfigure-metadata.properties下的所有配置信息并包装成AutoConfigurationMetadata对象返回。
注:spring-autoconfigure-metadata.properties文件在spring-boot-autoconfigure-2.1.9.RELEASE.jar/META-INF下。
getAutoConfigurationEntry方法源码如下:
protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) { if (!isEnabled(annotationMetadata)) { return EMPTY_ENTRY; } AnnotationAttributes attributes = getAttributes(annotationMetadata); List configurations = getCandidateConfigurations(annotationMetadata, attributes); configurations = removeDuplicates(configurations); Set exclusions = getExclusions(annotationMetadata, attributes); checkExcludedClasses(configurations, exclusions); configurations.removeAll(exclusions); configurations = filter(configurations, autoConfigurationMetadata); fireAutoConfigurationImportEvents(configurations, exclusions); return new AutoConfigurationEntry(configurations, exclusions);}
这个方法是AutoConfiguration的主流程方法,可以将这个方法的每一行看做一个步骤,那么处理步骤如下:
1. 加载配置了@EnableAutoConfiguration注解的属性值getAttribute方法:
protected AnnotationAttributes getAttributes(AnnotationMetadata metadata) { String name = getAnnotationClass().getName(); AnnotationAttributes attributes = AnnotationAttributes.fromMap(metadata.getAnnotationAttributes(name, true)); Assert.notNull(attributes, () -> "No auto-configuration attributes found. Is " metadata.getClassName() " annotated with " ClassUtils.getShortName(name) "?"); return attributes;}
2.得到META-INF/spring.factories文件中以@EnableAutoConfiguration完全限定类名做key的value,getCandidateConfigurations方法:
protected List getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) { List 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;}
其中,SpringFactoriesLoader.loadFactoryNames()这个方法的作用是使用给定的类加载器从META-INF/spring.factories加载给定类型的工厂实现的完全限定类名;
3.去重;4.得到需要排除的类的类名,这些类可以在@EnableAutoConfiguration注解中配置;5.检查这两个集合;6.把需要排除的类移除;
7.根据OnBeanCondition、OnClassCondition等条件进行过滤(有兴趣可以深入了解);
8.广播事件,得到AutoConfigurationImportListener所有实现类,然后生成事件进行广播;
9.把需要装配和排除的类完全限定名封装成了AutoConfigurationEntry对象返回。

因此,@EnableAutoConfiguration可以简单总结为:从classpath中搜寻所有的META-INF/spring.factories配置文件,并将其中EnableAutoConfiguration对应的配置项通过反射实例化为的标注@Configuration的IoC容器配置类,并加载到IoC容器。

三、小结


通过以上分析可知@SpringBootApplication解的运作是通过@SpringApplicationConfiguration声明被标注类为配置类,从而被AnnotationConfigApplicationContext扫描并初始化Spring容器。
通过@EnableAutoConfiguration来扫描,过滤并加载所需要的组件;通过@ComponentScan扫描并注册所有标注了@Component及其子注解的类;这些注解的共同运作实现了springboot工程强大的自动配置能力。

本站声明: 本文章由作者或相关机构授权发布,目的在于传递更多信息,并不代表本站赞同其观点,本站亦不保证或承诺内容真实性等。需要转载请联系该专栏作者,如若文章内容侵犯您的权益,请及时联系本站删除。
换一批
延伸阅读

业内消息,昨天苹果公司(Apple)发布了搭载 M4 芯片的 iPad Pro、搭载 M2 芯片的 iPad Air、新的妙控键盘、Apple Pencil Pro 等一系列新品,并介绍了 Final Cut Pro 和...

关键字: 苹果 iPad

业内消息,TikTok 目前正就早前通过的禁令起诉美国政府。TikTok 昨天提交的法庭文件表示,早前拜登政府签署的法令以国家安全为由要求 TikTok 在 9 个月内与其母公司字节跳动进行剥离,否则将禁止在美国地区开展...

关键字: TikTok

近日工信部发布了2024年一季度电子信息制造业运行情况,海关统计我国电子信息制造业生产稳步增长,出口持续回升,效益继续改善,投资保持较高增速,地区间营收分化明显。

关键字: 集成电路

5月6日,新思科技宣布将把其软件完整性业务(SIG部门)出售给Clearlake Capital和Francisco Partners领导的私募股权财团,交易价值21亿美元,预计今年下半年完成。交易完成后,该业务将成为一...

关键字: 新思科技 SIG

业内消息,科技媒体 Android Headline 近日深挖数据库,发现魅族计划推出包括魅族 21 Note 在内 5 款手机,型号分别为 M411H、M411L、M412H、M421Q 和 M431Q,只是目前尚未确...

关键字: AI 魅族

业内消息,昨天问界(AITO)汽车发布题为《关于山西省侯平高速路段交通事故中问界新 M7 Plus 相关技术问题的说明》的长微博。博文表示 AITO 汽车自 4 月 26 日山西省侯平高速路段事故发生后一直配合交警部门开...

关键字: 问界 AITO 华为

近日,字节跳动发布《企业纪律与职业道德委员会通报(2024年2号)》,因涉嫌构成刑事犯罪、违反廉洁诚信制度、违反利益冲突制度、违反信息安全制度四项原因辞退员工61人。近年来,多家互联网公司密集进行内部反腐整顿,包括腾讯、...

关键字: 互联网 字节跳动 辞退 腾讯 百度

业内消息,4月28日特斯拉CEO马斯克闪电访华,次日马斯克在与宁德时代董事长曾毓群会面后已经离开北京。马斯克不到24小时的访问行程硕果累累,最重大的突破是特斯拉在智能驾驶合规性方面获得“放行”,成为首个通过国家相关标准的...

关键字: 特斯拉 自动驾驶 FSD

近日,华为内部发布了一则令人瞩目的人事调整文件,宣布华为终端BG(业务集团)CEO余承东将卸任,转而担任华为终端BG董事长一职。这一变动不仅引起了业界的广泛关注与讨论,也预示着华为在组织架构和战略方向上的一次重大调整。

关键字: 余承东 华为 终端BG CEO

业内重磅消息,近日4家日本电信行业领军企业(DOCOMO、NTT公司、NEC公司以及富士通)联手打造的全球首款高速6G无线设备正式亮相。该创新产品的问世是科技界的一项重大突破,标志着通信技术迈入了全新的时代。

关键字: 日本 6G 无线设备
关闭
关闭