springboot情操陶冶-@SpringBootApplication注解解析
承接前文springboot情操陶冶-@Configuration注解解析,本文将在前文的基础上对@SpringBootApplication注解作下简单的分析
@SpringBootApplication
该注解是springboot最集中的一个注解,也是应用最广泛的注解。官方也多用此注解以启动spring服务,我们看下其中的源码
@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 {
@AliasFor(annotation = EnableAutoConfiguration.class)
Class<?>[] exclude() default {};
@AliasFor(annotation = EnableAutoConfiguration.class)
String[] excludeName() default {};
@AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
String[] scanBasePackages() default {};
@AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses")
Class<?>[] scanBasePackageClasses() default {};
}
通过上述代码可知,其整合了@EnableAutoConfiguration
和@ComponentScan
两个主要的注解,并以此作了默认的指定。
属性exclude和excludeName,其默认为空,指定的话最终由EnableAutoConfiguration.class来完成解析
属性scanBasePackages和scanBasePackageClasses,其默认为空,指定的话最终由ComponentScan.class来完成解析
默认情况下,以
@SpringBootApplication
注解的所在类的包名作为beanDefinition扫描路径。
扫描过程中屏蔽META-INF\spring.factories文件中org.springframework.boot.autoconfigure.EnableAutoConfiguration
属性指定的class集合支持多个
@ComponentScan
注解同时与@SpringBootApplication
注解搭配使用
@ComponentScan注解在前文中已了解的差不多了,笔者此处就针对@EnableAutoConfiguration注解作下详细的分析
@EnableAutoConfiguration
单纯从英文单词上看是开启自动注入的意思,具体的话笔者还是根据源码来解读。首先看下注解的源码
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
/**
* Exclude specific auto-configuration classes such that they will never be applied.
* @return the classes to exclude
*/
Class<?>[] exclude() default {};
/**
* Exclude specific auto-configuration class names such that they will never be
* applied.
* @return the class names to exclude
* @since 1.3.0
*/
String[] excludeName() default {};
}
它用到了我们前文提及的@Import注解,所以我们关注所引入的AutoConfigurationImportSelector.class
AutoConfigurationImportSelector
其是DeferredImportSelector.class接口的实现类,此处我们直接查看复写的方法selectImports()
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
// spring.boot.enableautoconfiguration属性读取,默认为true
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
// read all META-INF\spring-autoconfigure-metadata.properties files
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
.loadMetadata(this.beanClassLoader);
// 获取相应类上@EnableAutoConfiguration对应的属性
AnnotationAttributes attributes = getAttributes(annotationMetadata);
// read all <org.springframework.boot.autoconfigure.EnableAutoConfiguration> properties from META-INF\spring.factories
List<String> configurations = getCandidateConfigurations(annotationMetadata,
attributes);
configurations = removeDuplicates(configurations);
// read exclude/excludeName property or spring.autoconfigure.exclude property
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
// make sure the assignable exclusions are present in classpath and in configurations collection, or will throw exception
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
// filter the present configurations
configurations = filter(configurations, autoConfigurationMetadata);
// fire the AutoConfigurationImportEvent by AutoConfigurationImportListener.class
fireAutoConfigurationImportEvents(configurations, exclusions);
return StringUtils.toStringArray(configurations);
}
对上述的步骤此处再作下总结
优先判断环境变量spring.boot.enableautoconfiguration,如果指定为false,则不引入任何类。默认为true
读取classpath环境下所有的META-INF\spring-autoconfigure-metadata.properties文件,加载其中的所有属性保存至autoConfigurationMetadata
获取相应类上@EnableAutoConfiguration对应的属性,其实也就是exclude属性和excludeName属性
读取classpath环境下所有的META-INF\spring.factories文件中的
org.springframework.boot.autoconfigure.EnableAutoConfiguration
属性,得到configurations集合根据第三步读取的配置以及
spring.autoconfigure.exclude
环境变量指定的配置,得到exclusions集合确保exclusions集合是configurations集合的子集,以及exclusions集合内的class均是存在于classpath环境的。否则异常会抛出
根据上述的exclusions集合筛选出未被过滤的configurations集合。
根据第7点筛选出来的configurations集合,再在autoConfigurationMetadata的基础上针对
ConditionalOnClass
属性筛选一轮
比如:org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration.ConditionalOnClass=org.springframework.cache.CacheManager
表示如果要应用CacheAutoConfiguration,则得保证org.springframework.cache.CacheManager类存在触发AutoConfigurationImportEvent事件
返回筛选过后的configurations集合
笔者此处罗列下spring-boot-autoconfigure-2.0.3.REALEASE包中的spring.factories
中的EnableAutoConfiguration默认属性,属性太多,节选如下
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
...
org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JndiConnectionFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration,\
...
org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration,\
...
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.reactive.WebSocketReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketServletAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration
当然用户也可以自定义去实现需要自动注入的配置类。
总结
@SpringBootApplication注解内含@EnableAutoConfiguration注解和@ComponentScan注解,所以这两个注解结合再搭配上@Configuration注解便可以实现springboot的相关功能了。
在这之中,@EnableAutoConfiguration注解最为重要,其扩展性很好,方便springboot无缝对接不同的插件(NoSql插件、Web插件、JMX协议插件等等),读者需要好好分析。
下节预告
通过查阅上述的多个自动注解,发现用到了@Conditional和AutoConfigureAfter注解,都属于条件判断,在深入理解springboot整合其他插件前,必须对此两个注解有深刻的理解。
springboot情操陶冶-@SpringBootApplication注解解析的更多相关文章
- springboot情操陶冶-@ConfigurationProperties注解解析
承接前文springboot情操陶冶-@Configuration注解解析,本文将在前文的基础上阐述@ConfigurationProperties注解的使用 @ConfigurationProper ...
- springboot情操陶冶-@Configuration注解解析
承接前文springboot情操陶冶-SpringApplication(二),本文将在前文的基础上分析下@Configuration注解是如何一步一步被解析的 @Configuration 如果要了 ...
- SpringMVC源码情操陶冶-AnnotationDrivenBeanDefinitionParser注解解析器
mvc:annotation-driven节点的解析器,是springmvc的核心解析器 官方注释 Open Declaration org.springframework.web.servlet.c ...
- springboot情操陶冶-web配置(一)
承接前文springboot情操陶冶-@SpringBootApplication注解解析,在前文讲解的基础上依次看下web方面的相关配置 环境包依赖 在pom.xml文件中引入web依赖,炒鸡简单, ...
- springboot情操陶冶-@Conditional和@AutoConfigureAfter注解解析
承接前文springboot情操陶冶-@Configuration注解解析,本文将在前文的基础上阐述@AutoConfigureAfter和@Conditional注解的作用与解析 1.@Condit ...
- springboot情操陶冶-jmx解析
承接前文springboot情操陶冶-@Configuration注解解析,近期笔者接触的项目中有使用到了jmx的协议框架,遂在前文的基础上讲解下springboot中是如何整合jmx的 知识储备 J ...
- springboot情操陶冶-SpringApplication(二)
承接前文springboot情操陶冶-SpringApplication(一),本文将对run()方法作下详细的解析 SpringApplication#run() main函数经常调用的run()方 ...
- springboot情操陶冶-web配置(七)
参数校验通常是OpenApi必做的操作,其会对不合法的输入做统一的校验以防止恶意的请求.本文则对参数校验这方面作下简单的分析 spring.factories 读者应该对此文件加以深刻的印象,很多sp ...
- springboot情操陶冶-web配置(四)
承接前文springboot情操陶冶-web配置(三),本文将在DispatcherServlet应用的基础上谈下websocket的使用 websocket websocket的简单了解可见维基百科 ...
随机推荐
- 查看进程被哪台电脑的哪个进程连接(netstat)
1.netstat -ano|findstr 进程号,找出连接该进程A所有的ip(可以看到该进程的端口号和连接进程的端口号): 2.到连接该进程的电脑上,打开cmd命令行,输入netstat -ano ...
- mixer中动态Alpha通道处理案例
本案例处理的是RGB+a,每个色彩的采样为10位位宽. 1.在Mixer IP中打开Alpha Blending Enable 和Alpha Input Stream Enable.这样在Blo ...
- Python开发——17.CSS
一.CSS 1.概述 CSS(Cascading Style Sheets),层叠样式表,用来控制网页数据的表现,使网页的表现与数据内容分离. 2.引入方式 (1)行内式 <body> & ...
- mac下crontab定时任务使用
这篇文章的作用 BREAK TIME 本地pc配置定时任务,开机后每隔一小时执行一次,open这个页面,休息半分钟 cron创建备忘 首先创建定时任务 crontab -e 0 */ * * * op ...
- Nginx访问控制模块
一.Nginx访问控制模块 Nginx默认安装的模块http_access_module,可以基于来源IP进行访问控制. 1.模块安装 nginx中内置ngx_http_access_module,除 ...
- RabbitMQ 分发到多Consumer(Publish/Subscribe)
上篇文章中,我们把每个Message都是deliver到某个Consumer.在这篇文章中,我们将会将同一个Message deliver到多个Consumer中.这个模式也被成为 "pub ...
- Must Know Tips/Tricks in Deep Neural Networks
Must Know Tips/Tricks in Deep Neural Networks (by Xiu-Shen Wei) Deep Neural Networks, especially C ...
- 【javascript】谈谈HTML5: Web-Worker、canvas、indexedDB、拖拽事件
前言:作为一名Web开发者,可能你并没有对这个“H5”这个字眼投入太多的关注,但实际上它早已不知不觉进入到你的开发中,并且总有一天会让你不得不正视它,了解它并运用它 打个比方:<海贼王> ...
- 【ZCTF】easy reverse 详解
0x01 前言 团队逆向牛的解题思路,分享出来~ 0x02 内容 0. 样本 bbcdd1f7-9983-4bf4-9fde-7f77a6b947b4.dll 1. 静态分析 使用IDAP ...
- DVWA 1.9 通关秘籍
DVWA 1.9 通关秘籍 本文来源:i春秋社区-分享你的技术,为安全加点温度 DVWA (Dam Vulnerable Web Application) DVWA是用PHP+Mysql编写 ...