关于@Import注解的几个问题

本文来说下关于@Import注解的几个问题

---

概述

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

---

导入配置的三种类型

@Import支持 三种方式

1. 带有@Configuration的配置类(4.2 版本之前只可以导入配置类，4.2版本之后 也可以导入 普通类)
2. ImportSelector 的实现
3. ImportBeanDefinitionRegistrar 的实现

这些用法或许只有一个目的，就是导入Bean。那为什么要这么麻烦，手动导入Bean呢，@ComponentScan不是可以自动扫描包注册Bean嘛？

其实这里的原因有两点：

• @ComponentScan一般只会扫到自己项目中的Bean，第三方jar包中的@Bean扫不到。
• @Import注解可以结合@Conditional注解使用，即条件导入，@Conditional在spring源码中也是大量用到，这个我后面会专题介绍。

---

源码解释

源码解释

/**
 * 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();

}

---

测试例子

导入普通类

新建一个TestA

package cn.wideth.test;

public class TestA {

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

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

package cn.wideth.test;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

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

}

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

package cn.wideth.test;

import cn.wideth.PdaAndIpadApplication;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = PdaAndIpadApplication.class)
public class ImportAnnotationTest {

    @Autowired
    private TestA testA;

    @Test
    public void TestA() {
        testA.printName();
    }
}

测试结果

---

导入带有@Configuration的配置类

新建TestB

package cn.wideth.test;

import org.springframework.context.annotation.Configuration;

@Configuration
public class TestB {

    public void printName() {

        System.out.println("类名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
    }
}

在ImportConfig.class里面直接引入TestB

package cn.wideth.test;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

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

}

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

package cn.wideth.test;

import cn.wideth.PdaAndIpadApplication;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = PdaAndIpadApplication.class)
public class ImportAnnotationTest {

    @Autowired
    private TestB testb;

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

程序结果

---

通过ImportSelector 方式导入的类

新建TestC.class

package cn.wideth.test;

public class TestC {

    public void printName() {

        System.out.println("类名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
    }
}

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

package cn.wideth.test;

import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;

public class SelfImportSelector implements ImportSelector {

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"cn.wideth.test.TestC"};
    }
}

ImportConfig上面引入SelfImportSelector.class

package cn.wideth.test;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

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

}

测试程序

package cn.wideth.test;

import cn.wideth.PdaAndIpadApplication;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = PdaAndIpadApplication.class)
public class ImportAnnotationTest {

    @Autowired
    private TestC testc;

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

测试结果

---

通过 ImportBeanDefinitionRegistrar 方式导入的类

新建TestD.class

package cn.wideth.test;

public class TestD {

    public void printName() {

        System.out.println("类名 ：" + Thread.currentThread().getStackTrace()[1].getClassName());
    }
}

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

package cn.wideth.test;

import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

public class SelfImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {

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

ImportConfig类上加上导入SelfImportBeanDefinitionRegistrar.class

package cn.wideth.test;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

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

}

测试程序

package cn.wideth.test;

import cn.wideth.PdaAndIpadApplication;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = PdaAndIpadApplication.class)
public class ImportAnnotationTest {

    @Autowired
    private TestD testd;

    @Test
    public void testd() {
        testd.printName();
    }
}

测试结果

---

本文小结

本文详细介绍了@Import注解相关的知识与内容。