脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → @Import注解四种使用方式

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注解四种使用方式内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Java中Collections.emptyList()的注意事项

    Java中Collections.emptyList()的注意事项

    这篇文章主要给大家介绍了关于Java中Collections.emptyList()的注意事项，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • springboot统一接口返回数据的实现

    springboot统一接口返回数据的实现

    这篇文章主要介绍了springboot统一接口返回数据的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • Java文件处理之使用XWPFDocument导出Word文档

    Java文件处理之使用XWPFDocument导出Word文档

    最近因项目开发的需要,整理了一份用JAVA导出WORD文档,下面这篇文章主要给大家介绍了关于Java文件处理之使用XWPFDocument导出Word文档的相关资料,需要的朋友可以参考下
    2023-12-12
  • Spring Boot常见外部配置文件方式详析

    Spring Boot常见外部配置文件方式详析

    这篇文章主要给大家介绍了关于Spring Boot常见外部配置文件方式的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者使用Spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
    2020-07-07
  • 教你构建第一个Java Applet程序

    教你构建第一个Java Applet程序

    本文的主要目的是创建一个简单的Java applet,需要的朋友可以参考下
    2014-10-10
  • java集合类HashMap源码解析

    java集合类HashMap源码解析

    这篇文章主要介绍了Java集合之HashMap用法,结合实例形式分析了java map集合中HashMap定义、遍历等相关操作技巧,需要的朋友可以参考下
    2021-06-06
  • Java设计模式之命令模式CommandPattern详解

    Java设计模式之命令模式CommandPattern详解

    这篇文章主要介绍了Java设计模式之命令模式CommandPattern详解,命令模式是把一个请求封装为一个对象,从而使你可用不同的请求对客户进行参数化；对请求排队或记录请求日志,以及支持可撤销的操作,需要的朋友可以参考下
    2023-10-10
  • Java 使用 Graphql 搭建查询服务详解

    Java 使用 Graphql 搭建查询服务详解

    这篇文章主要介绍了Java 使用 Graphql 搭建查询服务详解的相关资料,需要的朋友可以参考下
    2016-12-12
  • mybatis selectKey赋值未生效的原因分析

    mybatis selectKey赋值未生效的原因分析

    这篇文章主要介绍了mybatis selectKey赋值未生效的原因分析，selectKey 会将 SELECT LAST_INSERT_ID()的结果放入到传入的实体类的主键里面，文中通过代码示例给大家讲解非常详细,需要的朋友可以参考下
    2024-02-02
  • Java使用WatchService监控文件内容变化的示例

    Java使用WatchService监控文件内容变化的示例

    本篇文章主要介绍了Java使用WatchService监控文件变化的示例，非常具有实用价值，需要的朋友可以参考下
    2017-10-10

最新评论