Spring注解@Import使用

简介: Spring注解@Import使用

一、认识@Import注解


@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {
    Class<?>[] value();
}


@Import注解的用法


导入一个或多个Bean

导入@Configuration类

导入ImportSelector的实现类

导入ImportBeanDefinitionRegistrar的实现类

我们在springboot中可以看到大量的@Import在自动配置类中出现,对于我们实际业务开发中是很少使用到的,那么它究竟为什么出现以及目的是什么呢?


@Import可以用来辅助导入bean,此时有个问题既然有了@Component以及@ComponentScan()为什么还需要它呢?


一般@ComponentScan()只能扫描你当前项目下标注@Controller的实体类以及其他配置类,若是有第三方导入进来或者不在自动扫描包下的实体类就无法被扫描,那么也就不会被Spring容器接管。此时就可以通过@Import注解来进行引入了!!!



二、实操


前置准备


引入依赖:


<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.3.7</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.3.6</version>
    </dependency>
</dependencies>



实现



上面一中介绍到@Import可以配合四种方式来进行导入对应的class,来让spring容器生成实体类并进行管理,这里的话在pojo中创建四个实体类如TestBean1、xxx…、TestBean4,其他三个类是用来进行配合@Import来进行导入的


四个实体类:


public class TestBean1 {
    @Override
    public String toString() {
        return super.toString()+"--我是TestBean1";
    }
}
public class TestBean2 {
    @Override
    public String toString() {
        return super.toString()+"--我是TestBean2";
    }
}
public class TestBean3 {
    @Override
    public String toString() {
        return super.toString()+"--我是TestBean3";
    }
}
public class TestBean4 {
    @Override
    public String toString() {
        return super.toString()+"--我是TestBean4";
    }
}



四种需要配合@Import导入的实体类


//方式一:直接传入class
//方式二:@Configuration+@Bean
@Configuration
public class ImportBeanByConfig {
    @Bean
    public TestBean2 testBean2(){
        return new TestBean2();
    }
}
//方式三:实现ImportBeanDefinitionRegistrar重写方法来进行手动注册
public class ImportBeanByImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(TestBean4.class);
        registry.registerBeanDefinition("TestBean4", rootBeanDefinition);
    }
}
//方式四:实现ImportSelector重写方法将多个class以数组形式返回
public class ImportBeanByImportSelector implements ImportSelector {
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        return new String[]{"pojo.TestBean3"};
    }
}




Spring配置类:借助该类进行打开自动扫描包


@Configuration
@ComponentScan("scan")  //自动扫描改包下
public class SpringConfig {
}


自动扫描包下的两个类:


ImportTest.java:用来导入那些不是自动包下的类
@Import({
        TestBean1.class,   //方式一:直接引入class类
        ImportBeanByConfig.class,  //方式二:将@Configuration+@Bean的类交由Spring容器管理
        ImportBeanByImportSelector.class,  //方式三:对于实现ImportSelector接口并重写selectImports方法返回的class交由Spring管理
        ImportBeanByImportBeanDefinitionRegistrar.class  //方式四:实现ImportBeanDefinitionRegistrar并重写方法,方法中进行注册
})
@Configuration
public class ImportTest {
}


CommonController.java:用于检测@Import导入的class被容器接管并实例化


@Component
public class CommonController {
    @Autowired(required = false)
    private TestBean1 testBean1;
    @Autowired(required = false)
    private TestBean2 testBean2;
    @Autowired(required = false)
    private TestBean3 testBean3;
    @Autowired(required = false)
    private TestBean4 testBean4;
    public void printImportBeanInfo(){
        System.out.println(testBean1);
        System.out.println(testBean2);
        System.out.println(testBean3);
        System.out.println(testBean4);
    }
}



最终的测试类:用于检验效果


public class Test {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        CommonController controller = (CommonController) context.getBean("commonController");
        System.out.println(controller);
        controller.printImportBeanInfo();
    }
}


相关文章
|
15天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
3天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
17 4
SpringBoot必须掌握的常用注解!
|
5天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
29 2
|
5天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
23 1
|
20天前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
24天前
|
XML Java 数据库
Spring boot的最全注解
Spring boot的最全注解
|
12天前
|
存储 Java 数据管理
强大!用 @Audited 注解增强 Spring Boot 应用,打造健壮的数据审计功能
本文深入介绍了如何在Spring Boot应用中使用`@Audited`注解和`spring-data-envers`实现数据审计功能,涵盖从添加依赖、配置实体类到查询审计数据的具体步骤,助力开发人员构建更加透明、合规的应用系统。
|
2月前
|
SQL 监控 druid
springboot-druid数据源的配置方式及配置后台监控-自定义和导入stater(推荐-简单方便使用)两种方式配置druid数据源
这篇文章介绍了如何在Spring Boot项目中配置和监控Druid数据源,包括自定义配置和使用Spring Boot Starter两种方法。
|
25天前
|
人工智能 自然语言处理 前端开发
SpringBoot + 通义千问 + 自定义React组件:支持EventStream数据解析的技术实践
【10月更文挑战第7天】在现代Web开发中,集成多种技术栈以实现复杂的功能需求已成为常态。本文将详细介绍如何使用SpringBoot作为后端框架,结合阿里巴巴的通义千问(一个强大的自然语言处理服务),并通过自定义React组件来支持服务器发送事件(SSE, Server-Sent Events)的EventStream数据解析。这一组合不仅能够实现高效的实时通信,还能利用AI技术提升用户体验。
125 2
|
3月前
|
缓存 Java Maven
Java本地高性能缓存实践问题之SpringBoot中引入Caffeine作为缓存库的问题如何解决
Java本地高性能缓存实践问题之SpringBoot中引入Caffeine作为缓存库的问题如何解决