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();
    }
}


相关文章
|
22天前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
36 4
|
22天前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
65 2
|
22天前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
40 2
|
25天前
|
消息中间件 Java 数据库
解密Spring Boot:深入理解条件装配与条件注解
Spring Boot中的条件装配与条件注解提供了强大的工具,使得应用程序可以根据不同的条件动态装配Bean,从而实现灵活的配置和管理。通过合理使用这些条件注解,开发者可以根据实际需求动态调整应用的行为,提升代码的可维护性和可扩展性。希望本文能够帮助你深入理解Spring Boot中的条件装配与条件注解,在实际开发中更好地应用这些功能。
31 2
|
25天前
|
JSON Java 数据格式
springboot常用注解
@RestController :修饰类,该控制器会返回Json数据 @RequestMapping(“/path”) :修饰类,该控制器的请求路径 @Autowired : 修饰属性,按照类型进行依赖注入 @PathVariable : 修饰参数,将路径值映射到参数上 @ResponseBody :修饰方法,该方法会返回Json数据 @RequestBody(需要使用Post提交方式) :修饰参数,将Json数据封装到对应参数中 @Controller@Service@Compont: 将类注册到ioc容器
|
26天前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
38 2
|
22天前
|
前端开发 Java 开发者
Spring MVC中的控制器:@Controller注解全解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序控制层的核心。它不仅简化了控制器的定义,还提供了灵活的请求映射和处理机制。本文将深入探讨`@Controller`注解的用法、特点以及在实际开发中的应用。
55 0
|
2月前
|
人工智能 自然语言处理 前端开发
SpringBoot + 通义千问 + 自定义React组件:支持EventStream数据解析的技术实践
【10月更文挑战第7天】在现代Web开发中,集成多种技术栈以实现复杂的功能需求已成为常态。本文将详细介绍如何使用SpringBoot作为后端框架,结合阿里巴巴的通义千问(一个强大的自然语言处理服务),并通过自定义React组件来支持服务器发送事件(SSE, Server-Sent Events)的EventStream数据解析。这一组合不仅能够实现高效的实时通信,还能利用AI技术提升用户体验。
223 2
|
3天前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
41 14
|
26天前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
42 1
SpringBoot入门(7)- 配置热部署devtools工具
下一篇
DataWorks