【SpringBoot】自动配置&&自动加载controller的原理

最新推荐文章于 2024-03-22 14:55:54 发布

aristo_boyunv

最新推荐文章于 2024-03-22 14:55:54 发布

阅读量1k

点赞数 1

文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/weixin_43475992/article/details/132109806

版权

SpringBoot自动配置&&自动加载controller的原理.md

好久没有更新自己的博客了,自己最近的正好有点空闲的时间进行,自己在写着写着,突然想起来,

为什么我们点击application就能自动加载@Controller呢?(好家伙,我顿时鱼鳃,哈哈)

1.首先我们来到启动现场===>启动类

@SpringBootApplication
public class TestApplication extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(ActAfterApplication.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(ActAfterApplication.class, args);
    }
}

我们会看到在TestApplication启动类上会有一个注解:@SpringBootApplication

这个注解,就是我们今天的文章的核心,核心**,核心**!!!=====>你可能会说,我问怎么加载@Controllerd的,你给我看这些干啥子?别急啊!_{大白(●—●),我们向下看}

2.`@SpringBootApplication`剖析

首先我们看点击这个注解进去的当中的三个关键注解

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan ====> 这个注解就是我们为什么Spring会加载@Controller组件关键所在

@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 {

3.`@SpringBootConfiguration`:

这个注解作用标明此类为配置类,点进去发现就是@Configuration,在加载时加载到Spring IOC中

你就把他想成是一个让他拥有配置的角色的作用就行啦===> 给他套个龙袍,当太子

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration    //就是这个注解最关键=====================================
public @interface SpringBootConfiguration {

}

4.`@EnableAutoConfiguration`

**作用:**这个注解可以说是Springboot的灵魂,自动配置,也就是将我们配置文件配置的配置类都加载进来,

它会扫描jar包下面的META-INF/spring.factories文件,将所有符合条件的自动配置类加载到IOC容器中====>是自动配置的核心

为什么?我们点进源码去看看呗,如下的源码,我们会看其中有两个核心的注解 (就是自动配置的关键,这两个注解说明,可以不看,忽略直接看下一个核心注解)

1.@AutoConfigurationPackage

2.@Import(AutoConfigurationImportSelector.class)

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

4.1 `@AutoConfigurationPackage`

点击源码,我们会看到其中的一个: @Import(AutoConfigurationPackages.Registrar.class)

**作用:**借助@Import注解导入符合自动配置类的集合,目的为了加载到IOC容器中

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {

AutoConfigurationPackages.Registrar.class的源码,这个可以直接忽略,感兴趣的可以看看

	static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {

		@Override
		public void registerBeanDefinitions(AnnotationMetadata metadata,
				BeanDefinitionRegistry registry) {
			register(registry, new PackageImport(metadata).getPackageName());  //获取包名
		}

		@Override
		public Set<Object> determineImports(AnnotationMetadata metadata) {
			return Collections.singleton(new PackageImport(metadata));
		}

	}

4.2`@Import(AutoConfigurationImportSelector.class)`

这个类就更重要了,问什么这样说?让我们结合下面的源码一起解读(为了阅读的便利性,只保留所需源码的核心块)

根据引入的AutoConfigurationImportSelector中的selectImports方法,
读取所有依赖的jar包下面也就是META-INF/spring.factories 下面的文件(怎么借加载此目录下面的呢?===>请看getCandidateConfigurations讲解)
并且根据加载的条件加载项目所需要的类

通过这三个步骤,也就完成SpringBoot的自动加载 ===> 从而@AutoConfigurationPackage执行结束

public class AutoConfigurationImportSelector
		implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware,
		BeanFactoryAware, EnvironmentAware, Ordered {

	@Override
	public String[] selectImports(AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return NO_IMPORTS;
		}
		AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
				.loadMetadata(this.beanClassLoader);
		AnnotationAttributes attributes = getAttributes(annotationMetadata);
		List<String> configurations = getCandidateConfigurations(annotationMetadata,attributes);
		configurations = removeDuplicates(configurations);
		Set<String> exclusions = getExclusions(annotationMetadata, attributes);
		checkExcludedClasses(configurations, exclusions);
		configurations.removeAll(exclusions);
		configurations = filter(configurations, autoConfigurationMetadata);
		fireAutoConfigurationImportEvents(configurations, exclusions);
		return StringUtils.toStringArray(configurations);
	}

getCandidateConfigurations:

为了便于确认,我将AutoConfigurationImportSelector类下面此方法单独拎出来

z这个方法会读取所有的’META-INF/spring.factories’的依赖jar包,

获取spring.factories全名称,====.>其实下面的注解也写了 >点击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;
	}

5.`@ComponentScan`

前面的两个注解说完了,我们终于来到此注解,也是解开我心里疑惑的注解了

就特么我解释吗?===> 就是将我们注册@Controller,@Service,等注解自动扫描加到IOC容器中

@ComponentScan(excludeFilters = {
		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })