@Import注解的四种使用方式

在介绍 @Import注解的使用之前，我们先看源码：

@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注解只可以标注在类上，可以结合 @Configuration注解、ImportSelector、ImportBeanDefinitionRegistrar一起使用，也可以导入普通的类。

因此，@Import的使用方式有4种：直接导入类，导入配置类来导入Bean，导入 ImportSelector 的实现类，导入 ImportBeanDefinitionRegister 的实现类。

需要注意的是：ImportSelector、ImportBeanDefinitionRegistrar 这两个接口都必须依赖于 @Import 一起使用，而 @Import 可以单独使用。

我们熟悉的 @EnableAsync 、@EnableCaching、@EnableScheduling 等都是借助 @Import 注解来实现的。

需要导入的类

public class Hello {
	private String msg;
	
    public void print() {
    	if (msg != null) {
    		System.out.println(msg);
    	} else {
    		System.out.println("hello word");
    	}
    }
}

1、直接导入类

@Import(Hello.class)
public class SpringTestApplication {

    public static void main(String[] args) {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(SpringTestApplication.class);
        Hello hello = applicationContext.getBean(Hello.class);
        hello.print();
    }
}

项目中常用的方式如下：

@Import(Hello.class)
@Configuration
public class Config { 
}

2、导入配置类来导入Bean

@Configuration
public class HelloConfiguration {

    @Bean
    public Hello createHello() {
        return new Hello();
    }
}

@Import(HelloConfiguration.class)
public class SpringTestApplication {

    public static void main(String[] args) {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(SpringTestApplication.class);
        Hello hello = applicationContext.getBean(Hello.class);
        hello.print();
    }
}

这种方式使用较少，只要把配置类放到能被扫描到的包下，就可以去掉 @Import 导入。这种方式的使用场景是配置类无法被扫描到。

3、导入 ImportSelector 实现类

ImportSelector是一个接口，实现这个接口需要重写selectImports方法。selectImports方法会返回一个String数组，它包含的元素是需要被导入到容器中的类的全限定名。

下面我们实现 ImportSelector 接口并重写 selectImports 方法，将Hello类的全限定名返回。

public class HelloImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        List list = new ArrayList<>();
        list.add("a.b.domain.Hello");
        return StringUtils.toStringArray(list);
    }
}

@Import(HelloImportSelector.class)
public class SpringTestApplication {

    public static void main(String[] args) {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(SpringTestApplication.class);
        Hello hello = applicationContext.getBean(Hello.class);
        hello.print();
    }
}

上面是导入指定的类，ImportSelector 还可以实现根据条件导入某个类，例如 @EnableAsync 可以根据属性mode来选择实现代理的方式。

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

	Class<? extends Annotation> annotation() default Annotation.class;

	boolean proxyTargetClass() default false;

	AdviceMode mode() default AdviceMode.PROXY;

	int order() default Ordered.LOWEST_PRECEDENCE;
}


public class AsyncConfigurationSelector extends AdviceModeImportSelector {
	private static final String ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME =
			"org.springframework.scheduling.aspectj.AspectJAsyncConfiguration";

	@Override
	@Nullable
	public String[] selectImports(AdviceMode adviceMode) {
		switch (adviceMode) {
			case PROXY:
				return new String[] {ProxyAsyncConfiguration.class.getName()};
			case ASPECTJ:
				return new String[] {ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME};
			default:
				return null;
		}
	}
}

public abstract class AdviceModeImportSelector implements ImportSelector {
	...
}

像这种还不能决定注入哪个类，就可以实现此接口，根据条件或配置来注入合适的处理类。

4、导入 ImportBeanDefinitionRegistrar 实现类

当类实现了 ImportBeanDefinitionRegistrar 接口，就可以拿到注册器，可以向容器中注册任何的Bean，并且可以对Bean添加属性。

public class HelloImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(Hello.class)
                .addPropertyValue("msg", "test")
                .getBeanDefinition();
        registry.registerBeanDefinition("hello", beanDefinition);
    }
}

@Import(HelloImportBeanDefinitionRegistrar.class)
public class SpringTestApplication {

    public static void main(String[] args) {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(SpringTestApplication.class);
        Hello hello = applicationContext.getBean(Hello.class);
        hello.print();
    }
}