Spring注解导入：@Import使用及原理详解

最新推荐文章于 2024-09-30 06:44:32 发布

竹林幽深

最新推荐文章于 2024-09-30 06:44:32 发布

阅读量395

点赞数

文章标签： spring java 后端

原文链接：https://mp.weixin.qq.com/s/CJMhCsgUlw5svwxOn6mUeg

版权

原创 Shepherd Shepherd进阶笔记 2023-03-30 09:01 发表于浙江

收录于合集#Spring10个

清明雨上,许嵩 - 自定义

1.概述

@Import 是 Spring 基于 Java 注解配置的主要组成部分，@Import 注解提供了类似 @Bean 注解的功能，向Spring容器中注入bean，也对应实现了与Spring XML中的元素相同的功能，注解定义如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {

 /**
  * {@link Configuration @Configuration}, {@link ImportSelector},
  * {@link ImportBeanDefinitionRegistrar}, or regular component classes to import.
  */
 Class<?>[] value();

}

从定义上来看，@Import注解非常简单，只有一个属性value()，类型为类对象数组，如value={A.class, B.class}，这样就可以把类A和B交给Spring容器管理。但是这个类对象需要细分为三种对象，也对应着@Import的三种用法如下：

普通类
实现了ImportSelector接口的类（这是重点~Spring Boot的自动配置原理就用到这种方式）
实现了ImportBeanDefinitionRegistrar接口的类

项目推荐：基于SpringBoot2.x、SpringCloud和SpringCloudAlibaba企业级系统架构底层框架封装，解决业务开发时常见的非功能性需求，防止重复造轮子，方便业务快速开发和企业技术栈框架统一管理。引入组件化的思想实现高内聚低耦合并且高度可配置化，做到可插拔。严格控制包依赖和统一版本管理，做到最少化依赖。注重代码规范和注释，非常适合个人学习和企业使用

Github地址：https://github.com/plasticene/plasticene-boot-starter-parent

Gitee地址：https://gitee.com/plasticene3/plasticene-boot-starter-parent

下面我们就针对@Import的三种不同用法一一举例阐述说明。

2.@Import的三种用法

2.1 注入普通类

这种方式很简单，直接上代码，首先先随便定义一个普通类：这里我定义了一个Student类

@Data
public class Student {
    private Long id;
    private String name;
    private Integer age;
}

接下来就是声明一个配置类，然后使用@Import导入注入即可：

@Configuration
@Import({Student.class})
public class MyConfig {

    @Bean
    public Person person01() {
        Person person = Person.builder().id(1l).name("shepherd").age(25).build();
        return person;
    }


    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MyConfig.class);
        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        // 遍历Spring容器中的beanName
        for (String beanDefinitionName : beanDefinitionNames) {
            System.out.println(beanDefinitionName);
        }
    }

}

这里我用@Bean注入了一个bean，想证实一下@Import实现的功能与其类似，执行上面的main()结果如下：

org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
myConfig
com.shepherd.common.config.Student
person01

可以看到，这里默认注入了一些Spring内部bean和我们在MyConfig中注入的bean，@Import({Student.class})把Student类注入到了Spring容器中，beanName默认为全限定类名com.shepherd.common.config.Student，而@Bean注入的默认为方法名，这也是两者的区别。

2.2 实现了ImportSelector接口的类

这一方式比较重要，也可以说是@Import最常用的方式，Spring Boot的自动装配原理就用到了这种方式，所以得认真学习一下。

我们先来看看ImportSelector这个接口的定义：

public interface ImportSelector {

 /**
  * Select and return the names of which class(es) should be imported based on
  * the {@link AnnotationMetadata} of the importing @{@link Configuration} class.
  * @return the class names, or an empty array if none
  */
 String[] selectImports(AnnotationMetadata importingClassMetadata);

 /**
  * Return a predicate for excluding classes from the import candidates, to be
  * transitively applied to all classes found through this selector's imports.
  * <p>If this predicate returns {@code true} for a given fully-qualified
  * class name, said class will not be considered as an imported configuration
  * class, bypassing class file loading as well as metadata introspection.
  * @return the filter predicate for fully-qualified candidate class names
  * of transitively imported configuration classes, or {@code null} if none
  * @since 5.2.4
  */
 @Nullable
 default Predicate<String> getExclusionFilter() {
  return null;
 }

}

selectImports( )返回一个包含了类全限定名的数组，这些类会注入到Spring容器当中。注意如果为null，要返回空数组，不然后续处理会报错空指针
getExclusionFilter()该方法制定了一个对类全限定名的排除规则来过滤一些候选的导入类，默认不排除过滤。该接口可以不实现

接下来我们编写一个类来实现ImportSelector接口

public class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.shepherd.common.config.Student",
        "com.shepherd.common.config.Person"};
    }
}

最后在配置类中使用@Import导入：

@Configuration
@Import({MyImportSelector.class})
public class MyConfig {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MyConfig.class);
        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        // 遍历Spring容器中的beanName
        for (String beanDefinitionName : beanDefinitionNames) {
            System.out.println(beanDefinitionName);
        }
    }
}

执行结果如下：

org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
myConfig
com.shepherd.common.config.Student
com.shepherd.common.config.Person

可以看出，Spring没有把MyImportSelector当初一个普通类进行处理，而是根据selectImports( )返回的全限定类名数组批量注入到Spring容器中。当然你也可以实现重写getExclusionFilter()方法排除某些类，比如你不想注入Person类，你就可以通过这种方式操作一下即可，这里就不再展示代码案例，可以自行尝试。

2.3 实现了ImportBeanDefinitionRegistrar接口的类

这种方式通过描述就可以知道是通过实现ImportBeanDefinitionRegistrar将要注入的类添加到BeanDefinition注册中心，这样Spring 后续会根据bean定义信息将类注入到容器中。

老规矩，我们先看看ImportBeanDefinitionRegistrar的定义：

public interface ImportBeanDefinitionRegistrar {

 default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry, BeanNameGenerator importBeanNameGenerator) {
    
  registerBeanDefinitions(importingClassMetadata, registry);
 }

 
 default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
 }

}

可以看到一共有两个同名重载方法，都是用于将类的BeanDefinition注入。

唯一的区别就是，2个参数的方法，只能手动的输入beanName，而3个参数的方法，可以利用BeanNameGenerator根据beanDefinition自动生成beanName

自定义一个类实现ImportBeanDefinitionRegistrar:

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {


    //使用 BeanNameGenerator自动生成beanName
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry, BeanNameGenerator importBeanNameGenerator) {
        BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(Person.class);
        AbstractBeanDefinition beanDefinition = beanDefinitionBuilder.getBeanDefinition();
        String beanName = importBeanNameGenerator.generateBeanName(beanDefinition, registry);
        registry.registerBeanDefinition(beanName, beanDefinition);
    }

    // 手动指定beanName
//    @Override
//    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
//        BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(Student.class);
//        AbstractBeanDefinition beanDefinition = beanDefinitionBuilder.getBeanDefinition();
//        registry.registerBeanDefinition("student001", beanDefinition);
//    }

}

注意，这里只能注入一个bean，所以只能实现一个方法进行注入，如果两个都是实现，前面的一个方法生效。

将上面2.2小节的配置类变成@Import({MyImportBeanDefinitionRegistrar.class})即可，执行结果和上面一样的，这里不再展示了。

3.@Import的实现原理

探究@Import注解实现源码之前，不得不引出Spring中一个非常重要的类：ConfigurationClassPostProcessor，从名字可以看出它是一个BeanFactoryPostProcessor，主要用于处理一些配置信息和注解扫描。之前我们就在总结的 @Configuration 和 @Component区别于实现原理文章中讲述过该类的核心所在，感兴趣的可根据该文章链接跳转自行查看，不出意外地，@Import注解的扫描、解析也在其中，其流程图如下所示：

ConfigurationClassPostProcessor既然是一个后置处理器，我们就直接从其后置处理方法入手即可，经过debug调试发现ConfigurationClassPostProcessor的postProcessBeanDefinitionRegistry()是完成对@Component，@ComponentScan，@Bean，@Configuration，@Import等等注解的处理的入口方法

@Override
 public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
  int registryId = System.identityHashCode(registry);
  if (this.registriesPostProcessed.contains(registryId)) {
   throw new IllegalStateException(
     "postProcessBeanDefinitionRegistry already called on this post-processor against " + registry);
  }
  if (this.factoriesPostProcessed.contains(registryId)) {
   throw new IllegalStateException(
     "postProcessBeanFactory already called on this post-processor against " + registry);
  }
  this.registriesPostProcessed.add(registryId);

    // 处理配置类
  processConfigBeanDefinitions(registry);
 }

processConfigBeanDefinitions()处理配置类的核心逻辑：该方法比较长，碍于篇幅，我提取出有关@Import解析的核心代码，其余代码用......替代。

 public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
  List<BeanDefinitionHolder> configCandidates = new ArrayList<>();
  String[] candidateNames = registry.getBeanDefinitionNames();
    // 将配置类加入到configCandidates集合当中
  for (String beanName : candidateNames) {
   BeanDefinition beanDef = registry.getBeanDefinition(beanName);
   if (beanDef.getAttribute(ConfigurationClassUtils.CONFIGURATION_CLASS_ATTRIBUTE) != null) {
    if (logger.isDebugEnabled()) {
     logger.debug("Bean definition has already been processed as a configuration class: " + beanDef);
    }
   }
   else if (ConfigurationClassUtils.checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) {
    configCandidates.add(new BeanDefinitionHolder(beanDef, beanName));
   }
  }

    // 配置类集合为空，直接返回，不需要做下面的解析
  // Return immediately if no @Configuration classes were found
  if (configCandidates.isEmpty()) {
   return;
  }

  ......
  
  // 解析配置类，以do...while()循环方式遍历解析所有配置类的@Component，@ComponentScan，@Bean，@Configuration，@Import
  // Parse each @Configuration class
  ConfigurationClassParser parser = new ConfigurationClassParser(
    this.metadataReaderFactory, this.problemReporter, this.environment,
    this.resourceLoader, this.componentScanBeanNameGenerator, registry);

  Set<BeanDefinitionHolder> candidates = new LinkedHashSet<>(configCandidates);
  Set<ConfigurationClass> alreadyParsed = new HashSet<>(configCandidates.size());
  do {
    // 解析注解入口
   parser.parse(candidates);
   parser.validate();
   
   ......
      // 执行完配置类的解析之后，根据解析得到的configClasses转换为beanDefinition放入到Sping容器当中  
      // Read the model and create bean definitions based on its content
   if (this.reader == null) {
    this.reader = new ConfigurationClassBeanDefinitionReader(
      registry, this.sourceExtractor, this.resourceLoader, this.environment,
      this.importBeanNameGenerator, parser.getImportRegistry());
   }
   this.reader.loadBeanDefinitions(configClasses);
      
      ......

  }
  while (!candidates.isEmpty());
  
  ......
  
 }

接下来的疏通一下解析配置类的流程如下所示：

ConfigurationClassParser -> parse() -> processConfigurationClass() -> doProcessConfigurationClass()

上面的方法我为了方便方便省略掉了方法参数，自己调试时候如果找不到方法，可以直接搜索方法名查找调用流程。当我们看到以都do开头的方法就看到希望了，因为熟悉Spring框架源码的人都知道在Spring底层代码中，以do开头方法一般就是核心逻辑代码实现所在。

doProcessConfigurationClass()源码如下：

 protected final SourceClass doProcessConfigurationClass(
   ConfigurationClass configClass, SourceClass sourceClass, Predicate<String> filter)
   throws IOException {

  if (configClass.getMetadata().isAnnotated(Component.class.getName())) {
   // Recursively process any member (nested) classes first
   processMemberClasses(configClass, sourceClass, filter);
  }

  // Process any @PropertySource annotations
  for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable(
    sourceClass.getMetadata(), PropertySources.class,
    org.springframework.context.annotation.PropertySource.class)) {
   if (this.environment instanceof ConfigurableEnvironment) {
    processPropertySource(propertySource);
   }
   else {
    logger.info("Ignoring @PropertySource annotation on [" + sourceClass.getMetadata().getClassName() +
      "]. Reason: Environment must implement ConfigurableEnvironment");
   }
  }

  // Process any @ComponentScan annotations
  Set<AnnotationAttributes> componentScans = AnnotationConfigUtils.attributesForRepeatable(
    sourceClass.getMetadata(), ComponentScans.class, ComponentScan.class);
  if (!componentScans.isEmpty() &&
    !this.conditionEvaluator.shouldSkip(sourceClass.getMetadata(), ConfigurationPhase.REGISTER_BEAN)) {
   for (AnnotationAttributes componentScan : componentScans) {
    // The config class is annotated with @ComponentScan -> perform the scan immediately
    Set<BeanDefinitionHolder> scannedBeanDefinitions =
      this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());
    // Check the set of scanned definitions for any further config classes and parse recursively if needed
    for (BeanDefinitionHolder holder : scannedBeanDefinitions) {
     BeanDefinition bdCand = holder.getBeanDefinition().getOriginatingBeanDefinition();
     if (bdCand == null) {
      bdCand = holder.getBeanDefinition();
     }
     if (ConfigurationClassUtils.checkConfigurationClassCandidate(bdCand, this.metadataReaderFactory)) {
      parse(bdCand.getBeanClassName(), holder.getBeanName());
     }
    }
   }
  }

  // Process any @Import annotations
    // 处理注解@import的入口方法
  processImports(configClass, sourceClass, getImports(sourceClass), filter, true);

  // Process any @ImportResource annotations
  AnnotationAttributes importResource =
    AnnotationConfigUtils.attributesFor(sourceClass.getMetadata(), ImportResource.class);
  if (importResource != null) {
   String[] resources = importResource.getStringArray("locations");
   Class<? extends BeanDefinitionReader> readerClass = importResource.getClass("reader");
   for (String resource : resources) {
    String resolvedResource = this.environment.resolveRequiredPlaceholders(resource);
    configClass.addImportedResource(resolvedResource, readerClass);
   }
  }

  // Process individual @Bean methods
  Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass);
  for (MethodMetadata methodMetadata : beanMethods) {
   configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass));
  }

  // Process default methods on interfaces
  processInterfaces(configClass, sourceClass);

  // Process superclass, if any
  if (sourceClass.getMetadata().hasSuperClass()) {
   String superclass = sourceClass.getMetadata().getSuperClassName();
   if (superclass != null && !superclass.startsWith("java") &&
     !this.knownSuperclasses.containsKey(superclass)) {
    this.knownSuperclasses.put(superclass, configClass);
    // Superclass found, return its annotation metadata and recurse
    return sourceClass.getSuperClass();
   }
  }

  // No superclass -> processing is complete
  return null;
 }

上面包含对众多注解的处理，这里不一一讲述，后续我们讲到相应注解再解析相应代码片段，今天我直奔主题进入其中的解析@Import的方法processImports()

private void processImports(ConfigurationClass configClass, SourceClass currentSourceClass,
   Collection<SourceClass> importCandidates, Predicate<String> exclusionFilter,
   boolean checkForCircularImports) {
  if (importCandidates.isEmpty()) {//准备注入的候选类集合为空 直接返回
   return;
  }

  if (checkForCircularImports && isChainedImportOnStack(configClass)) {//循环注入的检查
   this.problemReporter.error(new CircularImportProblem(configClass, this.importStack));
  }
  else {
   this.importStack.push(configClass);
   try {
    for (SourceClass candidate : importCandidates) {//遍历注入的候选集合
     /**
      * 如果是实现了ImportSelector接口的类
      */
     if (candidate.isAssignable(ImportSelector.class)) {
      // Candidate class is an ImportSelector -> delegate to it to determine imports
      Class<?> candidateClass = candidate.loadClass();
      ImportSelector selector = ParserStrategyUtils.instantiateClass(candidateClass, ImportSelector.class,
        this.environment, this.resourceLoader, this.registry);
      Predicate<String> selectorFilter = selector.getExclusionFilter();
      if (selectorFilter != null) {
       exclusionFilter = exclusionFilter.or(selectorFilter);//过滤注入的类
      }
      if (selector instanceof DeferredImportSelector) { 延迟注入
       this.deferredImportSelectorHandler.handle(configClass, (DeferredImportSelector) selector);
      }
      else {//调用selector当中的selectImports方法，得到要注入的类的全限定名
       String[] importClassNames = selector.selectImports(currentSourceClass.getMetadata());
              // 获得元类信息
       Collection<SourceClass> importSourceClasses = asSourceClasses(importClassNames, exclusionFilter);
              // 递归的处理注入的类
       processImports(configClass, currentSourceClass, importSourceClasses, exclusionFilter, false);
      }
     }
     /**
      * 如果是ImportBeanDefinitionRegistrar 则configClass.addImportBeanDefinitionRegistrar 提前放到一个map当中
      */
     else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {
      // Candidate class is an ImportBeanDefinitionRegistrar ->
      // delegate to it to register additional bean definitions
      Class<?> candidateClass = candidate.loadClass();
      ImportBeanDefinitionRegistrar registrar =
        ParserStrategyUtils.instantiateClass(candidateClass, ImportBeanDefinitionRegistrar.class,
          this.environment, this.resourceLoader, this.registry);//实例化
      configClass.addImportBeanDefinitionRegistrar(registrar, currentSourceClass.getMetadata());//放到一个map中
     }
     /**
      * 如果是普通类
      */
     else {
      // Candidate class not an ImportSelector or ImportBeanDefinitionRegistrar ->
      // process it as an @Configuration class
      this.importStack.registerImport(
        currentSourceClass.getMetadata(), candidate.getMetadata().getClassName());
      processConfigurationClass(candidate.asConfigClass(configClass), exclusionFilter);
     }
    }
   }
   catch (BeanDefinitionStoreException ex) {
    throw ex;
   }
   catch (Throwable ex) {
    throw new BeanDefinitionStoreException(
      "Failed to process import candidates for configuration class [" +
      configClass.getMetadata().getClassName() + "]", ex);
   }
   finally {
    this.importStack.pop();
   }
  }
 }

该方法的核心逻辑：先进行注入集合的判空和循环依赖的检查，最后再进行遍历注入的候选集合，三种类型的类执行不同的逻辑：

实现了ImportSelector接口的类，调用getExclusionFilter()方法，如果不为空，那么就进行过滤，过滤后调用selectImports()方法，得到要注入的类的全限定名。根据类全限定名，得到类元信息。然后递归的调用processImports()方法
实现了ImportBeanDefinitionRegistrar接口的类，会实例化这个类，放入集合importBeanDefinitionRegistrars当中。
普通类型的类（上面两个都不满足），那么就把它当作是配置类来处理，调用processConfigurationClass()方法，最终会放入到configurationClasses这个集合当中。

经过一系列的递归调用，实现了ImportBeanDefinitionRegistrar接口的类，会放入到importBeanDefinitionRegistrars集合当中，其余的类都放入到configurationClasses集合当中。之后就会回到processConfigBeanDefinitions方法，也就是执行完了ConfigurationClassParser的parse()方法。此时会执行loadBeanDefinitions将configurationClasses集合当中类加载的Spring容器当中，并且从 importBeanDefinitionRegistrars 缓存当中拿到所有的ImportBeanDefinitionRegistrar并执行registerBeanDefinitions方法。

4.总结

根据上述分析，@Import注解还是依靠ConfigurationClassPostProcessor核心后置处理器实现的，所以这里想再次强调一下该类的重要性，要重点关注啦。基于以上全部就是我们对@Import注解的使用和原理分析啦，请笑纳~~~春天(Spring)来了，接下来我将开启对Spring、Spring Boot、Spring Cloud系列的专栏知识点总结，如果你对什么知识点比较迷惑或者感兴趣，可以在评论区留言，后续给你安排、安排、安排