SpringBoot自动配置原理

java小白冲刺者

已于 2023-06-20 16:23:39 修改

阅读量6.1k

点赞数 10

于 2022-05-22 00:49:08 首次发布

原文链接：https://www.kuangstudy.com/course?cid=1

版权

java 同时被 3 个专栏收录

46 篇文章 2 订阅

订阅专栏

后端

41 篇文章 5 订阅

订阅专栏

注解

3 篇文章 1 订阅

订阅专栏

根据狂神说总结
狂神说学习官网：https://www.kuangstudy.com/course?cid=1
分析完了 pom.xml 来看看这个启动类

默认的主启动类

//@SpringBootApplication 来标注一个主程序类
//说明这是一个Spring Boot应用
@SpringBootApplication
public class SpringbootApplication {

   public static void main(String[] args) {
     //以为是启动了一个方法，没想到启动了一个服务
      SpringApplication.run(SpringbootApplication.class, args);
   }

}

但是 一个简单的启动类并不简单！ 我们来分析一下这些注解都干了什么

@SpringBootApplication

作用：标注在某个类上，说明这个类是SpringBoot的主配置类，SpringBoot项目就应该运行这个类的main方法来启动SpringBoot应用。
进入这个注解：可以看到上面还有很多其他注解！

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
    // ......
}

@ComponentScan

这个注解在Spring中很重要，它对应XML配置中的元素。

作用：自动扫描包（扫描当前主启动类同级的包）并加载符合条件的组件或者bean，将这个bean定义加载到IOC容器中。

@SpringBootConfiguration

作用：SpringBoot的配置类，标注在某个类上，表示这是一个SpringBoot的配置类。

我们继续进去这个注解查看

@Configuration
public @interface SpringBootConfiguration {}

这里的@Configuration，说明这是一个配置类，配置类就是对应Spring的xml配置文件。

再往里看

@Component
public @interface Configuration {}

里面的@Component说明，启动类本身也是Spring中的一个组件而已，负责启动应用！

我们回到 SpringBootApplication 注解中继续看。

@EnableAutoConfiguration

@EnableAutoConfiguration ：开启自动配置功能
在这里插入图片描述
以前我们需要自己配置的东西，现在SpringBoot可以自动帮助我们配置；

@EnableAutoConfiguration告诉SpringBoot开启自动配置功能，这样自动配置才能生效；

点进注解接续查看：
在这里插入图片描述
@AutoConfigurationPackage ：自动配置包
再点进去查看：

@import ：（自动注册包和@ComponentScan自动扫描包，是联动的）Spring底层注解@import，给容器中导入一个组件。

Registrar.class 作用：将主启动类所在包及包下面所有子包里面的所有组件扫描到Spring容器；

这个分析完了，退到上一步，继续看。

@Import({AutoConfigurationImportSelector.class})

@Import({AutoConfigurationImportSelector.class}) ： 给容器导入组件；

AutoConfigurationImportSelector： 自动配置导入选择器，那么它会导入哪些组件的选择器呢？我们点击去看这个类的源码。

在这里插入图片描述
1、这个类中有一个这样的方法 getAutoConfigurationEntry（） 获取自动配置的实体，此方法中有一个 this.getCandidateConfigurations(annotationMetadata, attributes); 获得候选配置的方法；

List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);

点击getCandidateConfigurations();
();

// 获得候选的配置
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, 		AnnotationAttributes attributes) {
    //这里的getSpringFactoriesLoaderFactoryClass（）方法
    //返回的就是我们最开始看的启动自动导入配置文件的注解类；EnableAutoConfiguration
    List<String> configurations = 		SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.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;
}

点击getSpringFactoriesLoaderFactoryClass()方法；
在这里插入图片描述
进入getSpringFactoriesLoaderFactoryClass()方法；
这个方法，标注了EnableAutoConfiguration注解的类。

2、这个方法又调用SpringFactoriesLoader 类的静态方法！我们进入SpringFactoriesLoader类loadFactoryNames() 方法------->获取所有的加载配置。

public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
    String factoryClassName = factoryClass.getName();
    //这里它又调用了 loadSpringFactories 方法
    return (List)loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}

3、我们继续点击查看 loadSpringFactories 方法
在这里插入图片描述
loadSpringFactories 方法中的classLoader.getResources(“META-INF/spring.factories”) —》获取项目资源；

ClassLoader.getSystemResources(“META-INF/spring.factories”)—》获取系统资源。

项目资源和系统资源都是在"META-INF/spring.factories"文件中获取的。

private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
    //获得classLoader ， 我们返回可以看到这里得到的就是EnableAutoConfiguration标注的类本身
    MultiValueMap<String, String> result = (MultiValueMap)cache.get(classLoader);
    if (result != null) {
        return result;
    } else {
        try {
            //去获取一个资源 "META-INF/spring.factories"
            Enumeration<URL> urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");
            LinkedMultiValueMap result = new LinkedMultiValueMap();

            // 从这些资源中遍历了所有的nextElement（自动配置）
            //将读取到的资源遍历，封装成为一个Properties供我们使用
            while(urls.hasMoreElements()) {
                URL url = (URL)urls.nextElement();
                UrlResource resource = new UrlResource(url);
                Properties properties = PropertiesLoaderUtils.loadProperties(resource);
                Iterator var6 = properties.entrySet().iterator();

                while(var6.hasNext()) {
                    Entry<?, ?> entry = (Entry)var6.next();
                    String factoryClassName = ((String)entry.getKey()).trim();
                    String[] var9 = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
                    int var10 = var9.length;

                    for(int var11 = 0; var11 < var10; ++var11) {
                        String factoryName = var9[var11];
                        result.add(factoryClassName, factoryName.trim());
                    }
                }
            }

            cache.put(classLoader, result);
            return result;
        } catch (IOException var13) {
            throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var13);
        }
    }
}

4、发现一个多次出现的文件：spring.factories，全局搜索它

spring.factories

我们看上面的代码都是在"META-INF/spring.factories"文件中获取配置。它的位置在
在这里插入图片描述
我们根据源头打开spring.factories ，看到了很多自动配置文件；这就是自动配置根源所在！

思考：这么多自动配置为什么有的没有生效，需要导入对应的start才能有作用！

通过核心注解：@ConditionalOnxxx：如果这里边的条件都满足，才会生效。
在这里插入图片描述
我们在上面的自动配置类随便找一个打开看看，比如：WebMvcAutoConfiguration

WebMvcAutoConfiguration

在这里插入图片描述
可以看到这些一个个的都是JavaConfig配置类，而且都注入了一些Bean，可以找一些自己认识的类，看着熟悉一下！

所以自动配置真正的实现是从classpath中搜寻所有的META-INF/spring.factories配置文件，并将其中对应的 org.springframework.boot.autoconfigure. 包下的配置项。但是不一定生效，要判断条件是否成立，只要导入了对应的start，就有对应的启动器了，有了启动器，我们自动装配才会生效。

通过反射实例化为对应标注了 @Configuration的JavaConfig形式的IOC容器配置类，然后将这些都汇总成为一个实例并加载到IOC容器中。

结论：

1、SpringBoot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值。

2、将这些值作为自动配置类导入容器，自动配置类就会生效，帮助我们进行自动配置工作。

3、整个J2EE的整体解决方案和自动配置都在springboot-autoconfigure的jar包中；

4、它会给容器中导入非常多的自动配置类（xxxAutoConfiguration）,就是给容器中导入这个场景需要的所有组件，并配置好这些组件。

5、有了自动配置类，免去了我们手动编写配置注入功能组件等的工作。

分析META-INF/spring.factories中文件的自动配置原理

分析自动配置原理

我们以**HttpEncodingAutoConfiguration（Http编码自动配置）**为例解释自动配置原理；

// 表示这是一个配置类，和以前编写的配置文件一样，也可以给容器中添加组件；
@Configuration 

// 启动指定类的configurationProperties功能；
// 进入这个HttpProperties查看，将配置文件中对应的值和HttpProperties绑定起来；
// 并把HttpProperties加入IOC容器中
@EnableConfigurationProperties({HttpProperties.class}) 

// Spring底层@Conditional注解
// 根据不同的条件判断，如果满足指定的条件，整个配置类里面的配置就会生效；
// 这里的意思就是判断当前应用是否是web应用，如果是，当前配置类生效；
@ConditionalOnWebApplication(
    type = Type.SERVLET
)

//判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnClass({CharacterEncodingFilter.class})

//判断配置文件中是否存在某个配置：spring.http.encoding.enabled；
  //如果不存在，判断也是成立的
  //即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)

public class HttpEncodingAutoConfiguration {
    //他已经和SpringBoot的配置文件映射了
    private final Encoding properties;
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }
    
    //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @Bean
    @ConditionalOnMissingBean //判断容器没有这个组件？
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
        return filter;
    }
    //。。。。。。。
}

一句话总结：根据当前不同的条件判断，决定这个配置类是否生效！

一旦这个配置类生效；这个配置类就会给容器中添加各种组件；
这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；
所有在配置文件中能配置的属性都是在xxxxProperties类中封装着；
配置文件能配置什么就可以参照某个功能对应的这个属性类；

//从配置文件中获取指定的值和bean的属性进行绑定
@ConfigurationProperties(prefix = "spring.http") 
public class HttpProperties {
    // .....
}

我们去配置文件里面试试前缀，看提示！

在这里插入图片描述
这就是自动装配的原理！

精髓

1、SpringBoot启动会加载大量的自动配置类；

2、我们看我们需要的功能有没有在SpringBoot默认写好的自动配置类当中；

3、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件存在在其中，我们就不需要再手动配置了）

4、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们只需要在配置文件中指定这些属性的值即可；

**xxxxAutoConfigurartion：自动配置类；**给容器中添加组件

xxxxProperties:封装配置文件中相关属性；

了解：@Conditional

了解完自动装配的原理后，我们来关注一个细节问题，自动配置类必须在一定的条件下才能生效；

@Conditional派生注解（Spring注解版原生的@Conditional作用）

作用：必须是@Conditional指定的条件成立，才能给容器中添加组件，配置完里面的所有内容才生效；
在这里插入图片描述
那么多的自动配置类，必须在一定的条件下才能生效；也就是说，我们加载了这么多的配置类，但不是所有的都生效了。

我们怎么知道哪些自动配置类生效？

我们可以通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；

#开启springboot的调试类
debug=true

Positive matches:（自动配置类启用的：正匹配）
在这里插入图片描述
Negative matches:（没有启动，没有匹配成功的自动配置类：负匹配）

Unconditional classes: （没有条件的类）

【演示：查看输出的日志】

掌握吸收理解原理，即可以不变应万变！

java小白冲刺者

关注

10
点赞
踩
36

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录