spring @Import注解的作用和几种使用方式

本文深入探讨Spring框架中@Import注解的使用方式及作用,解析其支持的三种类型:带@Congfiguration注解的类、ImportSelector接口实现与ImportBeanDefinitionRegistrar接口实现,通过具体案例如@EnableSwagger2、@EnableAutoConfiguration和@EnableApolloConfig,阐述它们如何在Spring Boot应用中导入配置。


最近在看springboot启动流程的时候,发现很多@EnableXX类型的注解,里面都有@Import注解;这里先简单总结下,import注解,其实就是导入配置类用的。

总结

value支持的三种类型:

1.带有@Congfiguration注解的类(spring4.2版本开始支持普通类);

比如EnableSwagger2的开启注解:

@Retention(value = java.lang.annotation.RetentionPolicy.RUNTIME)
@Target(value = { java.lang.annotation.ElementType.TYPE })
@Documented
@Import({Swagger2DocumentationConfiguration.class})//看这里
public @interface EnableSwagger2 {
}

然后打开Swagger2DocumentationConfiguration这个类:

@Configuration
@Import({ SpringfoxWebMvcConfiguration.class, SwaggerCommonConfiguration.class })
@ComponentScan(basePackages = {
    "springfox.documentation.swagger2.readers.parameter",
    "springfox.documentation.swagger2.web",
    "springfox.documentation.swagger2.mappers"
})
public class Swagger2DocumentationConfiguration {

就是带有@Configuration注解的类。

2.ImportSelector接口的实现;

比如springboot的@EnableAutoConfiguration注解:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)//看这里
public @interface EnableAutoConfiguration {

然后打开AutoConfigurationImportSelector这个类:

public class AutoConfigurationImportSelector
		implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware,
		BeanFactoryAware, EnvironmentAware, Ordered {

就是实现了DeferredImportSelector这个接口,然后DeferredImportSelector继承了ImportSelector接口。

public interface DeferredImportSelector extends ImportSelector {

3.ImportBeanDefinitionRegistrar接口的实现;

比如携程Apollo的@EnableApolloConfig注解:

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Import({ApolloConfigRegistrar.class})//看这里
public @interface EnableApolloConfig {
    String[] value() default {"application"};

然后打开ApolloConfigRegistrar这个类:

public class ApolloConfigRegistrar implements ImportBeanDefinitionRegistrar {
    public ApolloConfigRegistrar() {

就是实现了ImportBeanDefinitionRegistrar。

至于@import的详细介绍,
见一篇写的非常好的帖子:https://blog.youkuaiyun.com/mamamalululu00000000/article/details/86711079

### 回答1: @Import注解Spring框架的一种注解,可以用来快速导入多个组件,包括类、包或者配置类。 使用@Import注解可以在一个配置类中快速导入其他组件,而不必通过@Bean或@ComponentScan注解来导入。这样可以方便地将功能模块化,并且使用起来也更加方便。 使用方法如下: 1. 在配置类上使用@Import注解,并指定要导入的组件的类型数组。 例如: ``` @Import({MyConfiguration.class, MyBean.class}) public class AppConfig { // ... } ``` 2. 也可以使用ImportSelector接口ImportBeanDefinitionRegistrar接口来动态选择注册组件。 例如: ``` @Import(MyImportSelector.class) public class AppConfig { // ... } public class MyImportSelector implements ImportSelector { @Override public String[] selectImports(AnnotationMetadata importingClassMetadata) { // 在这里可以动态的返回需要导入的组件 return new String[] {MyBean.class.getName()}; } } ``` 使用@Import注解导入组件的好处是可以方便地将组件模块化,可以将一个功能模块分成若干个配置类,然后使用@Import注解导入。这样可以让代码更加清晰,更加方便维护。 ### 回答2: @Import注解Spring框架中的一种注解,在使用注解时,可以将其他配置类或者Bean定义类导入到当前配置类中。通过@Import注解,可以在一个配置类中同时引入多个不同的配置类或者Bean定义类,实现了配置的模块化复用。 @Import注解可以实现多种功能,具体包括以下几点: 1. 导入配置类:通过@Import注解可以将其他的配置类导入到当前的配置类中,这样可以将多个配置类组合在一起,实现配置的分离复用,提高代码的可维护性可读性。 2. 导入Bean定义类:除了配置类之外,@Import注解也可以将其他的Bean定义类引入到当前配置类中,这样可以将多个不同的Bean定义类组合在一起,实现Bean的组装扩展。 3. 导入自动配置类:Spring Boot框架中的自动配置就是通过@Import注解来实现的,通过将相应的自动配置类导入到配置类中,可以实现对应功能的自动配置初始化,减少了开发人员的工作量。 4. 导入条件配置:通过@Import注解可以根据不同的条件来选择性地导入不同的配置类或者Bean定义类,根据具体的条件来进行动态的选择配置,实现更加灵活可配置化的开发。 总结来说,@Import注解Spring框架中起到了组合扩展配置的作用,可以将多个配置类或者Bean定义类导入到当前配置类中,实现了配置的模块化复用,同时也提供了条件导入的功能,使得配置的选择更加灵活可配置化。 ### 回答3: @Import注解Spring框架中的一个注解作用是用于导入其他的配置类或者Bean。通过@Import注解,我们可以将其他的配置类或者Bean引入到当前的配置类中,从而实现配置类之间的解耦。 @Import注解可以用于导入其他的@Configuration配置类,这样可以方便地将多个配置类合并到一个总的配置类中。通过@Import注解,我们可以将不同的配置类按照逻辑进行划分,分别编写配置类,然后使用@Import注解将它们引入到一个总的配置类中。这样做的好处是,能够更好地组织管理配置类,提高代码的可读性可维护性。 除了导入其他的配置类,@Import注解还可以用于导入其他的普通的Bean。这对于一些无法通过@Configuration注解进行配置的Bean来说非常有用。通过@Import注解,我们可以将这些Bean引入到当前的配置类中,然后使用@Autowired注解进行注入。 总之,@Import注解作用是使得配置类之间可以进行解耦,并且可以方便地引入其他的配置类或者Bean。它在Spring框架中的应用非常广泛,能够有效地提高代码的可读性、可维护性复用性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值