SpringBoot 自动装配原理源码分析

SpringBoot 自动装配原理源码分析

---

自动装配原理

1.实现原理和机制

自动装配实际上就是把第三方组件的Bean装载到IOC容器里，不需要开发人员再去写Bean相关的一个配置

1.1@SpringBootApplication

在SpringBoot应用里，只需要在启动类上加上**@SpringBootApplication注解，就可以去实现自动装配。 @SpringBootApplication注解是一个复合注解包含三个重要的注解，@SpringBootConfiguration,@EnableAutoConfiguration，@ComponentScan真正去实现自动装配的注解是@EnableAutoConfiguration**注解。

1.2@SpringBootConfiguration

@SpringBootConfiguration就是@Configuration注解的别名，用于指定一个类是配置类，因此使用了@SpringBootApplication注解后，启动类中也可加入@Bean。

1.3@ComponentScan

扫描被@Component (@Service,@Controller)注解的 bean，注解默认会扫描启动类所在的包下所有的类 ，可以自定义不扫描某些 bean。

1.4@EnableAutoConfiguration

@EnableAutoConfiguration是自动配置的核心，它引导自动配置机制。

通过 @Import 引入 AutoConfigurationImportSelector

AutoConfigurationImportSelector的作用是根据项目的依赖和配置情况，动态地选择并加载适合的自动配置类。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage//作用：将main包下的所有组件注册到容器中
@Import(AutoConfigurationImportSelector.class)//加载自动装配类 xxxAutoconfiguration
public @interface EnableAutoConfiguration {
	String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
    Class<?>[] exclude() default {};
    String[] excludeName() default {};
}

AutoConfigurationImportSelector:加载自动装配类

AutoConfigurationImportSelector的继承关系如下

---

著作权归JavaGuide(javaguide.cn)所有 基于MIT协议 原文链接：https://javaguide.cn/system-design/framework/spring/spring-boot-auto-assembly-principles.html

AutoConfigurationImportSelector 类实现了 ImportSelector接口，也就实现了这个接口中的 selectImports方法，该方法主要用于获取所有符合条件的类的全限定类名，这些类需要被加载到 IoC 容器中。

ImportSelector 接口用于实现动态地选择需要被导入到容器中的配置类的逻辑。

public interface ImportSelector {
    /**
     * @param importingClassMetadata 用于描述使用了 @Import 注解的配置类的注解元数据。
     * @return 数组中的每个元素都是一个全限定类名，表示需要被导入到容器中的配置类。
     */ 
    String[] selectImports(AnnotationMetadata var1);
    /**
     * 提供一个可选的排除过滤器，决定哪些配置类应该被排除在外。
     * 默认返回 null，表示没有排除过滤器。
     */
    @Nullable
    default Predicate<String> getExclusionFilter() {
        return null; // 默认没有排除过滤器
    }
}

1. 利用getAutoConfigurationEntry(annotationMetadata),给容器中批量导入一些组件
2. 调用List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取到所有需要导入到容器中的配置类
3. 利用工厂加载 Map<String, List> loadSpringFactories(@Nullable ClassLoader classLoader)；得到所有的组件
4. 从META-INF/spring.factories位置来加载一个文件。默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件**,

按照条件装配（@Conditional)最终会按需配置

@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
    // 检查自动配置是否启用
    if (!isEnabled(annotationMetadata)) {
        // 如果自动配置没有启用，返回一个表示不导入任何配置类的常量
        return NO_IMPORTS;
    }
    // 获取与注解元数据相关的自动配置条目（包含要导入的配置类）
    AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
    // 将自动配置条目中的配置类名转换为字符串数组并返回
    return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}

/**
 * 获取自动配置入口信息，包括需要加载的自动配置类和需要排除的配置类。
 * 
 * @param annotationMetadata 配置类的注解元数据
 * @return 应该导入的自动配置项
 */
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    // 检查自动配置是否启用
    if (!isEnabled(annotationMetadata)) {
        // 如果自动配置没有启用，返回一个空的自动配置条目
        return EMPTY_ENTRY;
    }
    // 获取注解的属性（例如，@EnableAutoConfiguration 注解的属性）
    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 = getConfigurationClassFilter().filter(configurations);
    // 触发自动配置导入事件
    fireAutoConfigurationImportEvents(configurations, exclusions);
    // 返回一个包含配置类和排除类的自动配置条目
    return new AutoConfigurationEntry(configurations, exclusions);
}

通过Debug演示自动装配过程

获取需要自动装配的所有配置类，读取META-INF/spring.factories

文件的配置内容都被我们读取到了.XXXAutoConfiguration的作用就是按需加载组件。

不光是这个依赖下的META-INF/spring.factories被读取到，所有 Spring Boot Starter 下的META-INF/spring.factories都会被读取到。

可是spring.factories中这么多配置，每次启动都要全部加载么？

很显然这是不现实的,debug继续我们可以发现，configurations 的值变小了。

原因就在于经历了一次筛选,只有@ConditionalOnXXX 中的所有条件都满足，该类才会生效。

1.5自动装配条件

SpringBoot在进行自动装配的时候,并不是将所有的全部加载,而是由选择的,通过@Conditon

注解系列来控制.常见条件包括:

• @ConditionalOnClass:如果类路径中包含某个特定类，则激活该 Bean。
• @ConditionalOnProperty:根据配置文件中的某个属性值来控制是否激活该 Bean。
• @ConditionalOnMissingBean:只有在 Spring 容器中没有某个类型的 Bean 时才激活该 Bean。
• @ConditionalOnBean:只有当 Spring 容器中存在特定类型的 Bean 时，才会装配目标 Bean。
• @ConditionalOnWebApplication:当前应用是否是web应用，如果是，当前配置类生效

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

@Configuration //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@EnableConfigurationProperties(HttpEncodingProperties.class) //启动指定类的ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把HttpEncodingProperties加入到ioc容器中
@ConditionalOnWebApplication //Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效； 判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing =true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled；如果不存在，判断也是成立的//即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
public class HttpEncodingAutoConfiguration {
      //他已经和SpringBoot的配置文件映射了
      private final HttpEncodingProperties properties;
      //只有一个有参构造器的情况下，参数的值就会从容器中拿
      public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
         this.properties = properties;
      }
 @Bean //给容器中添加一个组件，这个组件的某些值需要从properties中获取
@ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件？
public CharacterEncodingFilter characterEncodingFilter() {
       CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
       filter.setEncoding(this.properties.getCharset().name());
       filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST)); 
       filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
       return filter;
}

精髓：

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

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

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

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

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

作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置里面的所有内容才生效；

@Conditional扩展注解	作用（判断是否满足当前指定条件）
@ConditionalOnJava	系统的java版本是否符合要求
@ConditionalOnBean	容器中存在指定Bean；
@ConditionalOnMissingBean	容器中不存在指定Bean；
@ConditionalOnExpression	满足SpEL表达式指定
@ConditionalOnClass	系统中有指定的类
@ConditionalOnMissingClass	系统中没有指定的类
@ConditionalOnSingleCandidate	容器中只有一个指定的Bean，或者这个Bean是首选Bean
@ConditionalOnProperty	系统中指定的属性是否有指定的值
@ConditionalOnResource	类路径下是否存在指定资源文件
@ConditionalOnWebApplication	当前是web环境
@ConditionalOnNotWebApplication	当前不是web环境
@ConditionalOnJndi	JNDI存在指定项

自动配置类必须在一定的条件下才能生效；

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

我们可以通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置
不是web环境 |
| @ConditionalOnJndi | JNDI存在指定项 |

自动配置类必须在一定的条件下才能生效；

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

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