SpringBoot中的@Import注解四種使用方式詳解

更新時間：2023年12月29日 11:03:26 作者：my_sky_

這篇文章主要介紹了SpringBoot中的@Import注解四種使用方式詳解,@Import注解只可以標注在類上,可以結合 @Configuration注解、ImportSelector、ImportBeanDefinitionRegistrar一起使用,也可以導入普通的類,需要的朋友可以參考下

@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 的實現(xiàn)類，導入 ImportBeanDefinitionRegister 的實現(xiàn)類。

需要注意的是：ImportSelector、ImportBeanDefinitionRegistrar 這兩個接口都必須依賴于 @Import 一起使用，而 @Import 可以單獨使用。

我們熟悉的 @EnableAsync 、@EnableCaching、@EnableScheduling 等都是借助 @Import 注解來實現(xiàn)的。

需要導入的類

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 實現(xiàn)類

ImportSelector是一個接口，實現(xiàn)這個接口需要重寫selectImports方法。selectImports方法會返回一個String數(shù)組，它包含的元素是需要被導入到容器中的類的全限定名。

下面我們實現(xiàn) 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 還可以實現(xiàn)根據(jù)條件導入某個類，例如 @EnableAsync 可以根據(jù)屬性mode來選擇實現(xiàn)代理的方式。

@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 {
	...
}

像這種還不能決定注入哪個類，就可以實現(xiàn)此接口，根據(jù)條件或配置來注入合適的處理類。

4、導入 ImportBeanDefinitionRegistrar 實現(xiàn)類

當類實現(xiàn)了 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();
    }
}

到此這篇關于SpringBoot中的@Import注解四種使用方式詳解的文章就介紹到這了,更多相關@Import注解四種使用方式內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: