1前言
在hello world中已经启动了一个最精简的springboot 应用.从我们编写的代码来看,它与非spring boot应用区别有两个地方:
(1)在QuickStartApplication
类上添加了注解@SpringBootApplication
;
(2)是main方法调用SpringApplication.run(QuickStartApplication.class,args)
这篇博客主要分享第一点,注解@SpringBootApplication
.分享的时候,我也是按照自己阅读源码的方式(每个人都有自己方法,方式.不喜勿噴).
2进入主题
我用IDEA进行开发,所以使用快捷键也是IDEA的.下面就是demo里代码
@SpringBootApplication
public class QuickStartApplication {
public static void main(String[]args){
SpringApplication.run(QuickStartApplication.class,args);
}
}
进入到@SpringBootApplication
的源码,可以看到里面组合了三个我们感兴趣的注解:@ComponentScan
,@EnableAutoConfiguration
,@SpringBootConfiguration
.我们一一分析这三个注解.
2.1@ComponentScan
使用过spring框架的小伙伴都知道,spring里有四大注解:@Service
,@Repository
,@Component
,@Controller
用来定义一个bean.@ComponentScan
注解就是用来自动扫描被这些注解标识的类,最终生成ioc容器里的bean.可以通过设置@ComponentScan
basePackages,includeFilters,excludeFilters属性来动态确定自动扫描范围,类型已经不扫描的类型.默认情况下:它扫描所有类型,并且扫描范围是@ComponentScan
注解所在配置类包及子包的类,在hello word 工程里,添加了一个componentscan 分支,说明这个情况.QuickStartApplication
,CurrentPackageController
类的package是com.simos.componentscan
.SubPackageController
的package 是com.simos.componentscan.controller
.而OutPackageController
的package是com.simos.controller
.启动后只有:SubPackageController
,CurrentPackageController
被扫描生成bean,而OutPackageController
却没有被扫描到.下面三个截图说明了这一点:
总结一下,使用
@SpringBootApplication
注解,就说明你使用了@ComponentScan
的默认配置,这就建议你把使用@SpringBootApplication
注解的类放置在root package(官方表述)下,其他类都置在root package的子包里面,这样bean就不会被漏扫描.
2.2@SpringBootConfiguration
这个注解的作用与@Configuration
作用相同,都是用来声明当前类是一个配置类.可以通过@Bean
注解生成IOC容器管理的bean.在QuickStartApplication
中定义bean,并在@HelloController
中注入使用
@SpringBootApplication
public class QuickStartApplication {
public static void main(String[]args){
SpringApplication.run(QuickStartApplication.class,args);
}
@Bean
public BeanTest beanTest(){
return new BeanTest();
}
}
下面是@HelloController
@RestController
public class HelloController {
@Autowired
BeanTest beanTest;
@RequestMapping(value = "/hello",method = RequestMethod.GET)
public String hello(){
return "hello world!";
}
@RequestMapping(value = "/beantest",method = RequestMethod.GET)
public String beanTest(){
return "beanTest!";
}
}
2.3@EnableAutoConfiguration
@EnableAutoConfiguration
是springboot实现自动化配置的核心注解,通过这个注解把spring应用所需的bean注入容器中.@EnableAutoConfiguration
源码通过@Import
注入了一个ImportSelector
的实现类
AutoConfigurationImportSelector
,这个ImportSelector
最终实现根据我们的配置,动态加载所需的bean.
'AutoConfigurationImportSelector'的完成动态加载实现方法源码如下:
@Override
//annotationMetadata 是@import所用在的注解.这里指定是@EnableAutoConfiguration
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
//加载XXConfiguration的元数据信息(包含了某些类被生成bean条件),继续跟进这个方法调用,就会发现加载的是:spring-boot-autoconfigure jar包里面META-INF的spring-autoconfigure-metadata.properties
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
.loadMetadata(this.beanClassLoader);
//获取注解里设置的属性,在@SpringBootApplication设置的exclude,excludeName属性值,其实就是设置@EnableAutoConfiguration的这两个属性值
AnnotationAttributes attributes = getAttributes(annotationMetadata);
//从spring-boot-autoconfigure jar包里面META-INF/spring.factories加载配置类的名称,打开这个文件发现里面包含了springboot框架提供的所有配置类
List<String> configurations = getCandidateConfigurations(annotationMetadata,
attributes);
//去掉重复项
configurations = removeDuplicates(configurations);
//获取自己配置不需要生成bean的class
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
//校验被exclude的类是否都是springboot自动化配置里的类,如果存在抛出异常
checkExcludedClasses(configurations, exclusions);
//删除被exclude掉的类
configurations.removeAll(exclusions);
//过滤刷选,满足OnClassCondition的类
configurations = filter(configurations, autoConfigurationMetadata);
fireAutoConfigurationImportEvents(configurations, exclusions);
//返回需要注入的bean的类路径
return StringUtils.toStringArray(configurations);
}
3小结
通过第二节我们可以看到,springboot是通过注解@EnableAutoConfiguration
的方式,去查找,过滤,加载所需的configuration
,@ComponentScan
扫描我们自定义的bean,@SpringBootConfiguration
使得被@SpringBootApplication
注解的类声明为注解类.因此@SpringBootApplication
的作用等价于同时组合使用@EnableAutoConfiguration
,@ComponentScan
,@SpringBootConfiguration
.