Spring @Import注解的使用

 更新时间:2021年05月14日 11:52:53   作者:口袋里的猫  
@Import注解算是SpringBoot自动配置原理中一个很重要的注解,本文介绍了该注解的源码分析及使用方法,感兴趣的朋友可以了解下

认识@Import注解

先看一下源码

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

	/**
	 * {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
	 * or regular component classes to import.
	 */
	Class<?>[] value();

}

@Import表示要导入的一个或多个@Configuration类

看注释value通常是一个普通的组件,Configuration,ImportSelector,ImportBeanDefinitionRegistrar。

搭建项目结构用于测试

  • 先创建一个maven工程
  • 加入依赖
<dependencies>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.18</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>4.3.24.RELEASE</version>
    </dependency>
</dependencies>

编写测试代码
Tom.java

@Data
public class Tom {
    private String color;
    private Integer age;
}

AppConfig.java

@Configuration
public class AppConfig {
}

App.java

public class App {
    public static void main(String[] args) {
        // 创建容器
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        // 获取bean
        Tom tom = context.getBean(Tom.class);
        System.out.println(tom);
    }
}

@Import用法

第一种普通组件
@Import({ 要导入的容器中的组件 } )

CustomConfiguration.java

@Configuration
public class CustomConfiguration {
    @Bean
    public Tom tom() {
        Tom tom = new Tom();
        tom.setAge(11);
        tom.setColor("红色");
        return tom;
    }
}

将AppConfig.java加上@Import({ CustomConfiguration.class })

@Import({ CustomConfiguration.class })
@Configuration
public class AppConfig {
}

这个时候运行App已经可以获取到Tom

第二种ImportSelector
CustomSelector.java

public class CustomSelector implements ImportSelector {

    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[] { "com.moli.pojo.Tom" };
    }
}

将AppConfig.java加上@Import({ CustomRegistrar.class })

@Import({ CustomRegistrar.class })
@Configuration
public class AppConfig {
}

这个时候运行App已经可以获取到Tom

第三种ImportBeanDefinitionRegistrar
CustomRegistrar.java

public class CustomRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(Tom.class);
        builder.setScope(BeanDefinition.SCOPE_SINGLETON);
        builder.addPropertyValue("color", "灰色");
        builder.addPropertyValue("age", "12");
        registry.registerBeanDefinition("tom", builder.getBeanDefinition());
    }
}

将AppConfig.java加上@Import({ CustomSelector.class })

@Import({ CustomSelector.class })
@Configuration
public class AppConfig {
}

这个时候运行App已经可以获取到Tom

最佳搭档 - @Import通用形式

在开源软件中大部分@Import中是伴随着一个@EnableXXX使用的

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({ CustomRegistrar.class })
public @interface EnableTom {
}

将AppConfig.java加上@EnableTom

@EnableTom
@Configuration
public class AppConfig {
}

这样看起来,是不是有那味了。

其实SpringBoot的自动配置就是@Import的一个应用

@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    ...
}

总结

直白一点使用@Import注解可以快速把实例加入Spring的IOC容器中

其实这三种用法也算是一种用法,就是导入一个类到容器,容器根据类的注解类型等信息对不同类进行不同处理;

方法一:导入一个Configuration组件,组件创建了一个Tom类的Bean;

方法二:CustomSelector返回的类的全限定类名,实际上要导入到容器中的组件全类名;

方法三:ImportBeanDefinitionRegistrar类似于第二种ImportSelector用法,只不过这种用法能自定义化注册,往容器内注入一个BeanDefinition,然后BeanDeiniton在容器内转为一个实例bean;

以上就是Spring @Import注解的使用的详细内容,更多关于Spring @Import注解的资料请关注脚本之家其它相关文章!

相关文章

  • spring中JdbcTemplate操作oracle的存储过程实例代码

    spring中JdbcTemplate操作oracle的存储过程实例代码

    JdbcTemplate是Spring对JDBC的封装,目的是使JDBC更加易于使用,JdbcTemplate是Spring的一部分,下面这篇文章主要给大家介绍了关于spring中JdbcTemplate操作oracle的存储过程的相关资料,需要的朋友可以参考下
    2023-04-04
  • 18个Java8日期处理的实践(太有用了)

    18个Java8日期处理的实践(太有用了)

    这篇文章主要介绍了18个Java8日期处理的实践(太有用了),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01
  • JavaGUI菜单栏与文本和密码及文本域组件使用详解

    JavaGUI菜单栏与文本和密码及文本域组件使用详解

    这篇文章主要介绍了JavaGUI菜单栏与文本和密码及文本域组件使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2023-03-03
  • 学习Java之如何正确地向上转型与向下转型

    学习Java之如何正确地向上转型与向下转型

    面向对象的第三个特征是多态,实现多态有三个必要条件:继承、方法重写和向上转型,在学习多态之前,我们还要先学习Java的类型转换,本篇文章就来带大家认识什么是类型转换,看看类型转换都有哪几种情况,以及如何避免类型转换时出现异常
    2023-05-05
  • Java8对List排序的方法大全

    Java8对List排序的方法大全

    这篇文章主要给大家介绍了关于Java8对List排序的方法大全,其实Java针对数组和List的排序都有实现,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-07-07
  • java获取用户输入的字符串方法

    java获取用户输入的字符串方法

    今天小编就为大家分享一篇java获取用户输入的字符串方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • String转BigDecimal,BigDecimal常用操作,以及避免踩坑记录

    String转BigDecimal,BigDecimal常用操作,以及避免踩坑记录

    这篇文章主要介绍了String转BigDecimal,BigDecimal常用操作,以及避免踩坑记录,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • 详解Java编程JDialog窗体的用法及实例

    详解Java编程JDialog窗体的用法及实例

    这篇文章主要介绍了Java编程中JDialog窗体的用法及实例,描述了其特征,具有一定参考价值,需要的朋友可以了解下。
    2017-09-09
  • libsvm支持向量机回归示例

    libsvm支持向量机回归示例

    这篇文章主要介绍了libsvm支持向量机回归示例,需要的朋友可以参考下
    2014-05-05
  • Java package编译乱码问题解决

    Java package编译乱码问题解决

    这篇文章主要介绍了Java package编译乱码问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-05-05

最新评论