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 的实现类，导入 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();
}
}到此这篇关于SpringBoot中的@Import注解四种使用方式详解的文章就介绍到这了,更多相关@Import注解四种使用方式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了mybatis中的limit参数,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2023-11-11
intern() 方法返回字符串对象的规范化表示形式。它遵循以下规则：对于任意两个字符串 s 和 t，当且仅当 s.equals(t) 为 true 时，s.intern() == t.intern() 才为 true2021-10-10
本篇文章主要介绍了详解springmvc使用JSR-303进行数据校验，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。2017-02-02
Solr我还是个菜鸟，写这一些文章只是记录一下最近一段时间学习Solr的心得，望各位同仁不要见笑，还希望多多指点2012-11-11
今天小编就为大家分享一篇关于Java并发的CAS原理与ABA问题的讲解，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧2019-01-01
Android官方对协程的定义-协程是一种并发设计模式，您可以在Android平台上使用它来简化异步执行的代码。协程是在版本1.3中添加到Kotlin的，它基于来自其他语言的既定概念2022-11-11
这篇文章主要介绍了Java中的ConcurrentHashMap集合源码解析,ConcurrentHashMap底层容器和HashMap相同,同样是Node数组+链表+红黑树,不同的是在原来的基础之上使用了Synchronized+CAS来保证线程安全,下面我们来进行源码分析,需要的朋友可以参考下2023-11-11
这篇文章主要介绍了Java实现Excel导入导出数据库的方法,结合实例形式分析了java针对Excel的读写及数据库操作相关实现技巧,需要的朋友可以参考下2017-08-08
这篇文章主要为大家介绍了Spring的DI依赖注入，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助2022-01-01
这篇文章主要为大家详细介绍了Java单机版的书店管理系统设计模块和思想第三章，感兴趣的小伙伴们可以参考一下2016-08-08
最新评论