Springboot框架中的注解-@Import注解的使用以及意义

比眉伴天荒 2022-12-03 05:22 546阅读 0赞

## 1.简介 ##

在平时看源码或者很多配置类上面都会出现@Import注解,功能就是和Spring XML 里面 的 一样. @Import注解是用来导入配置类或者一些需要前置加载的类.

## 2.源码解析 ##

2.1 导入配置的三种类型  
@Import支持 三种方式  
1.带有@Configuration的配置类(4.2 版本之前只可以导入配置类，4.2版本之后 也可以导入 普通类)  
2.ImportSelector 的实现  
3.ImportBeanDefinitionRegistrar 的实现

2.2 源码解释

/**
     * Indicates one or more {@link Configuration @Configuration} classes to import.
     *
     *功能类似XML 里面的 <import/> ,可以导入 @Configuration配置类，ImportSelector、
     * ImportBeanDefinitionRegistrar 的实现,4.2 版本之后可以导入普通类(类似AnnotationConfigApplicationContext#register
     * )
     * <p>Provides functionality equivalent to the {@code <import/>} element in Spring XML.
     * Allows for importing {@code @Configuration} classes, {@link ImportSelector} and
     * {@link ImportBeanDefinitionRegistrar} implementations, as well as regular component
     * classes (as of 4.2; analogous to {@link AnnotationConfigApplicationContext#register}).
     *
     * 可以在类级别声明或作为元注释声明
     * <p>May be declared at the class level or as a meta-annotation.
     * 如需要引入XML或其他类型的文件，使用@ImportResource注解
     * <p>If XML or other non-{@code @Configuration} bean definition resources need to be
     * imported, use the {@link ImportResource @ImportResource} annotation instead.
     */
     @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Import {
        
    
    	/**
    	 * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
    	 * or regular component classes to import.
    	 */
    	Class<?>[] value();
    
    }

3、测试例子  
3.1 导入普通类  
新建一个TestA

public class TestA {
        
    
        public void fun(String str) {
        
            System.out.println(str);
        }
    
        public void printName() {
        
            System.out.println("类名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
        }
    }

新建一个ImportConfig,在类上面加上@Configuration，加上@Configuration是为了能让Spring 扫描到这个类，并且直接通过@Import引入TestA类

@Import({
        TestA.class})
    @Configuration
    public class ImportConfig {
        
    }

3.测试结果  
TestA 是一个普通的类，现在可以被@Autowired注释然后调用，就直接说明已经被Spring 注入并管理了，普通的类都是需要先实例化

@RunWith(SpringJUnit4ClassRunner.class)
    @SpringBootTest(classes = ApplicationMain.class)
    public class ImportAnnotionTest {
        
    
        @Autowired
        TestA testA;
    
        @Test
        public void TestA() {
        
            testA.printName();
        }
    }

打印：  
类名 ：com.test.importdemo.TestA  
1  
3.2 导入带有@Configuration的配置类  
新建TestB

@Configuration
    public class TestB {
        
        public void fun(String str) {
        
            System.out.println(str);
        }
    
        public void printName() {
        
            System.out.println("类名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
        }
    }

在ImportConfig.class里面直接引入TestB

@Import({
        TestA.class,TestB.class})
    @Configuration
    public class ImportConfig {
        
    }

3.测试结果  
TestB.class 的类上面已经有了@Configuration注解,本身就会配spring扫到并实例，@import引入带有@Configuration的配置文件，是需要先实例这个配置文件再进行相关操作

@Autowired
        TestB testB;
        @Test
        public void TestB(){
        
            testB.printName();
        }

> 打印： ImportAnnotionTest in 8.149 seconds (JVM running for 10.104) 类名  
> ：com.test.importdemo.TestB 2019-01-31 14:12:05.737 INFO 23760 — \[  
> Thread-2\]

3.3 通过ImportSelector 方式导入的类  
新建TestC.class

public class TestC {
        
        public void fun(String str) {
        
            System.out.println(str);
        }
    
        public void printName() {
        
            System.out.println("类名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
        }
    }

2.新建SelfImportSelector.class 实现ImportSelector 接口,注入TestC.class

//TODO ImportSelector 相关解释
    
    public class SelfImportSelector implements ImportSelector {
        
        @Override
        public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        
            return new String[]{
        "com.test.importdemo.TestC"};
        }
    }

3.ImportConfig上面引入SelfImportSelector.class

@Import({
        TestA.class,TestB.class,SelfImportSelector.class})
    @Configuration
    public class ImportConfig {
        
    }

4.测试结果

@Autowired  
TestC testC;

@Test  
public void TestC() \{  
testC.printName();  
\}

> 打印： ImportAnnotionTest in 7.23 seconds (JVM running for 9.065) 类名  
> ：com.test.importdemo.TestC 2020-09-01 22:23:15.330 INFO 1196 — \[

3.4 通过 ImportBeanDefinitionRegistrar 方式导入的类  
1.新建TestD.class

public class TestD {
        
        public void fun(String str) {
        
            System.out.println(str);
        }
    
        public void printName() {
        
            System.out.println("类名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
        }
    }

2.新建SelfImportBeanDefinitionRegistrar.class,实现接口ImportBeanDefinitionRegistrar,注入TestD.class

public class SelfImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
        
        @Override
        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        
            RootBeanDefinition root = new RootBeanDefinition(TestD.class);
            registry.registerBeanDefinition("testD", root);
        }
    }

3.ImportConfig类上加上导入SelfImportBeanDefinitionRegistrar.class

@Import({
        TestA.class,TestB.class,SelfImportSelector.class,
            SelfImportBeanDefinitionRegistrar.class})
    @Configuration
    public class ImportConfig {
        
    }

4.测试结果

@Autowired  
TestD testD;

@Test  
public void TestD() \{  
testD.printName();  
\}

> 打印： ImportAnnotionTest in 7.817 seconds (JVM running for 9.874) 类名  
> ：com.test.importdemo.TestD 2020-09-01 22:30:05.781 INFO 23476 — \[

**通过以上几种方法都是能成功注入Spring Ioc 容器中进行管理。**

![在这里插入图片描述][2020090122131873.gif_pic_center]

[2020090122131873.gif_pic_center]: /images/20221123/f209a174825d4420bde5949b07cfa379.png