SpringBoot自动装配的时候为什么没有走selectImports方法?

Posted 2022-02-08 波波烤鸭

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot自动装配的时候为什么没有走selectImports方法?相关的知识，希望对你有一定的参考价值。

SpringBoot自动装配的时候为什么没有走selectImports方法?

本文首先需要大家对SpringBoot的自动装配比较清楚，如果不清楚的可以移步我之前介绍的自动装配的相关视频和文章。

一、疑惑点

我们之前在分析SpringBoot自动装配源码的时候讲过在 @EnableAutoConfiguration注解上通过 @Import注解导入了一个 ImportSelector接口的实现类 AutoConfigurationImportSelector。按照之前对 @Import 注解的理解，应该会执行重写的 selectImports 方法，但调试的时候，执行的流程好像和我们期待的不一样哦，没有走 selectImports方法。

通过Debug模式，端点定位我们能够发现进入到了getAutoConfigurationEntry方法中。

但是没有进入selectImports方法。

这是什么原因呢？他不是实现了ImportSelector接口吗？怎么和我们之前理解的不一样呢？这就需要我们再来细说下@Import注解了。

二、@Import

我们前面介绍过@Import注解可以根据添加的不同类型做出不同的操作

导入类型	注入方式
实现了ImportSelector接口	不注入该类型的对象，调用selectImports方法，将返回的数据注入到容器中
实现了ImportBeanDefinitionRegistrar接口	不注入该类型的对象，调用registerBeanDefinitions方法，通过注册器注入
普通类型	直接注入该类型的对象

而在自动装配中导入的AutoConfigurationImportSelector这个类型有点特殊。具体看下类图结构

那这个DeferredImportSelector这个接口的作用是什么呢？字面含义是延迟导入的意思。具体怎么实现的后面再说，我们先来说下他的作用。

三、DeferredImportSelector接口

DeferredImportSelector接口本身也有ImportSelector接口的功能，如果我们仅仅是实现了DeferredImportSelector接口，重写了selectImports方法，那么selectImports方法还是会被执行的，来看代码。

public class MyDeferredImportSelector implements DeferredImportSelector 

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) 
        System.out.println("selectImports方法执行了---->");
        return new String[0];

对应的配置启动类

@Configuration
@Import(MyDeferredImportSelector.class)
public class JavaConfig 

    public static void main(String[] args) 
        ApplicationContext ac = new AnnotationConfigApplicationContext(JavaConfig.class);

启动效果：

但是如果我们重写了DeferredImportSelector中的Group接口，并重写了getImportGroup，那么容器在启动的时候就不会执行selectImports方法了，而是执行getImportGroup方法。进而执行Group中重写的方法。

public class MyDeferredImportSelector implements DeferredImportSelector 

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) 
        System.out.println("selectImports方法执行了---->");
        return new String[0];
    

    @Override
    public Class<? extends Group> getImportGroup() 
        System.out.println("getImportGroup");
        return MyDeferredImportSelectorGroup.class;
    

    public static class MyDeferredImportSelectorGroup implements Group
        private final List<Entry> imports = new ArrayList<>();
        @Override
        public void process(AnnotationMetadata metadata, DeferredImportSelector selector) 
            System.out.println("MyDeferredImportSelectorGroup.Group");
        

        @Override
        public Iterable<Entry> selectImports() 
            System.out.println("Group中的：selectImports方法");
            return imports;

执行效果：

通过上面的效果解释了为什么在SpringBoot自动装配的时候没有走selectImports方法。那么DeferredImportSelector接口的作用是什么呢？为什么要这么设计呢？我们接下来继续分析

四、DeferredImportSelector的作用

通过前面的类图结构我们知道DeferredImportSelector是ImportSelector接口的一个扩展。

ImportSelector实例的selectImports方法的执行时机，是在@Configguration注解中的其他逻辑被处理之前，所谓的其他逻辑，包括对@ImportResource、@Bean这些注解的处理（注意，这里只是对@Bean修饰的方法的处理，并不是立即调用@Bean修饰的方法，这个区别很重要！)

DeferredImportSelector实例的selectImports方法的执行时机，是在@Configguration注解中的其他逻辑被处理完毕之后，所谓的其他逻辑，包括对@ImportResource、@Bean这些注解的处理.

上面的结论我们可以直接在源码中看到对应的答案。首先定位到ConfigurationClassParser中的parse方法。