面试官：讲讲SpringBoot中的@Import注解！

Myth丶恋晨 2022-10-20 12:24 202阅读 0赞

## 你知道的越多，不知道的就越多，业余的像一棵小草！ ##

成功路上并不拥挤，因为坚持的人不多。

## 编辑：业余草 ##

cnblogs.com/pi-laoban/p/14766321.html

## 推荐：https://www.xttblog.com/?p=5184 ##

![3f3018d65c96580b771d28307eb2ce10.png][]

`@Import`注解算是SpringBoot自动配置原理中一个很重要的注解

## **认识@Import注解** ##

????先看一下源码

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Import {
    
     /**
      * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
      * or regular component classes to import.
      */
     Class<?>[] value();
    
    }

`@Import`表示要导入的一个或多个@Configuration类

看注释value通常是一个普通的组件，`Configuration`，`ImportSelector`，`ImportBeanDefinitionRegistrar`。

## **搭建项目结构用于测试** ##

1.  先创建一个maven工程
2.  加入依赖

<dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.18</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.3.24.RELEASE</version>
        </dependency>
    </dependencies>

1.  编写测试代码

**Tom.java**

@Data
    public class Tom {
        private String color;
        private Integer age;
    }

**AppConfig.java**

@Configuration
    public class AppConfig {
    }

**App.java**

public class App {
        public static void main(String[] args) {
            // 创建容器
            AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
            // 获取bean
            Tom tom = context.getBean(Tom.class);
            System.out.println(tom);
        }
    }

## **@Import用法** ##

### 第一种普通组件 ###

`@Import`（\{ 要导入的容器中的组件 \} ）

**CustomConfiguration.java**

@Configuration
    public class CustomConfiguration {
        @Bean
        public Tom tom() {
            Tom tom = new Tom();
            tom.setAge(11);
            tom.setColor("红色");
            return tom;
        }
    }

将**AppConfig.java**加上`@Import({ CustomConfiguration.class })`

@Import({ CustomConfiguration.class })
    @Configuration
    public class AppConfig {
    }

这个时候运行App已经可以获取到Tom

### 第二种`ImportSelector` ###

**CustomSelector.java**

public class CustomSelector implements ImportSelector {
    
        @Override
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
            return new String[] { "com.moli.pojo.Tom" };
        }
    }

将**AppConfig.java**加上`@Import({ CustomRegistrar.class })`

@Import({ CustomRegistrar.class })
    @Configuration
    public class AppConfig {
    }

这个时候运行App已经可以获取到Tom

### 第三种`ImportBeanDefinitionRegistrar` ###

**CustomRegistrar.java**

public class CustomRegistrar implements ImportBeanDefinitionRegistrar {
        @Override
        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
            BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(Tom.class);
            builder.setScope(BeanDefinition.SCOPE_SINGLETON);
            builder.addPropertyValue("color", "灰色");
            builder.addPropertyValue("age", "12");
            registry.registerBeanDefinition("tom", builder.getBeanDefinition());
        }
    }

将**AppConfig.java**加上`@Import({ CustomSelector.class })`

@Import({ CustomSelector.class })
    @Configuration
    public class AppConfig {
    }

这个时候运行App已经可以获取到Tom

## **最佳搭档 - @Import通用形式** ##

在开源软件中大部分`@Import`中是伴随着一个`@EnableXXX`使用的

@Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Import({ CustomRegistrar.class })
    public @interface EnableTom {
    }

将**AppConfig.java**加上`@EnableTom`

@EnableTom
    @Configuration
    public class AppConfig {
    }

这样看起来，是不是有那味了。

其实SpringBoot的自动配置就是@Import的一个应用

@SuppressWarnings("deprecation")
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @AutoConfigurationPackage
    @Import(EnableAutoConfigurationImportSelector.class)
    public @interface EnableAutoConfiguration {
        ...
    }

## **总结** ##

> 直白一点使用`@Import`注解可以快速把实例加入Spring的IOC容器中

其实这三种用法也算是一种用法，就是导入一个类到容器，容器根据类的注解类型等信息对不同类进行不同处理；

方法一：导入一个`Configuration`组件，组件创建了一个Tom类的Bean；

方法二：`CustomSelector`返回的类的全限定类名，实际上要导入到容器中的组件全类名；

方法三：`ImportBeanDefinitionRegistrar`类似于第二种`ImportSelector`用法，只不过这种用法能自定义化注册，往容器内注入一个`BeanDefinition`，然后`BeanDeiniton`在容器内转为一个实例bean；

![42a4911b9d2ba04e69984590a07573c1.png][]

[3f3018d65c96580b771d28307eb2ce10.png]: /images/20221020/e94594eb18024b3bad89b88751ab8e5f.png
[42a4911b9d2ba04e69984590a07573c1.png]: /images/20221020/0f602fb9e0ef414e8811ead68b5473b5.png