【SpringBoot2 从0开始】底层注解 - @Conditional、@ImportResource

简介: 【SpringBoot2 从0开始】底层注解 - @Conditional、@ImportResource

一、@ImportResource


@Conditional注解,是根据条件进行装配。满足了 Conditional 指定的条件,就进行组件的注入。


另外@Conditional是个根注解,在idea里使用 ctrl+H 可以打开它的结构。


1268169-20210901212038405-856571733.png


可以看到有许多的派生注解,每个注解都代表着一种功能。比如:


  • @ConditionalOnBean:当容器中存在指定的组件,才会做某些事情。
  • @ConditionalOnMissingBean:当容器中没有指定的组件,才会做某些事情。
  • @ConditionalOnClass:当容器中存在指定的类。
  • @ConditionalOnMissingClass:当容器中不存在指定的类。
  • @ConditionalOnResource:项目类路径里存在某个资源的时候。
  • @ConditionalOnJava:当是指定的 java 版本号。
  • @ConditionalOnWebApplication:当应用是一个 web 应用的时候。
  • @ConditionalOnNotWebApplication:当应用不是一个 web 应用的时候。
  • @ConditionalOnProperty:当配置文件里存在指定属性的时候。
  • ... ...


示例


以@ConditionalOnBean为例,演示一下用法。


还是看一下之前 MyConfig 类中的方法:


@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = true)
public class MyConfig {
    @Bean("user1")
    public User user01(){
        User pingguo = new User("pingguo",20);
        pingguo.setPet(tomcatPet());
        return pingguo;
    }
//    @Bean("pet1")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}


在这里,我把pet1这个组件给注释掉,现在tomcatPet()其实就是个普通的类方法。

先尝试在主运行类的 main 方法里获取一下 这 2 个 组件:


@SpringBootApplication(scanBasePackages = "com.pingguo")
public class MainApplication {
    public static void main(String[] args) {
        // 返回IOC容器
        final ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        boolean tomcatPet = run.containsBean("pet1");
        System.out.println("容器中存在 pet1 的组件:" + tomcatPet);
        boolean user1 = run.containsBean("user1");
        System.out.println("容器中存在 user1 的组件:" + user1);
    }
}


运行一下,查看结果:


1268169-20210901214402654-2133782758.png


果然,是不存在pet1组件的,因为@bean这个注解被我注释掉了。


OK,现在我有个需求,因为user1组件依赖pet1组件,如果没有pet1,我希望user1组件也直接别注册了。


这时候就可以使用@ConditionalOnBean注解来完成。


@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = true)
public class MyConfig {
    @ConditionalOnBean(name = "pet1")
    @Bean("user1")
    public User user01(){
        User pingguo = new User("pingguo",20);
        pingguo.setPet(tomcatPet());
        return pingguo;
    }
//    @Bean("pet1")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}


在 user1组件上加上@ConditionalOnBean(name = "pet1"),当没有pet1组件,就不注册user1组件。


现在再运行 main 方法测试一下,应该都是 false,2个组件都不存在。


1268169-20210901214921768-301805810.png


作用在类上


@ConditionalOnBean(name = "pet1")如果我放在类上:


@ConditionalOnBean(name = "pet1") // 放在类上
@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = true)
public class MyConfig {
    @Bean("user1")
    public User user01(){
        User pingguo = new User("pingguo",20);
        pingguo.setPet(tomcatPet());
        return pingguo;
    }
    @Bean("pet22")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}


现在就表示,当存在pet1组件的时候,这个类下面的所有才会生效。


这里我改了下面的组件注册变成pet22,也就是说当存在pet1组件的时候,就会注册user1和pet22。


在 main 方法里增加打印pet22,查看是否存在:


... ...
    boolean pet22 = run.containsBean("pet22");
    System.out.println("容器中存在 pet22 的组件:" + pet22);
... ...


运行一下:


1268169-20210901215751299-1841800985.png


因为不存在pet1这个组件,所有MyConfig类下面的2个组件user1和pet22的注册都不生效。


二、@ImportResource


@ImportResource注解是用来导入资源。


比如,之前我们可能会在 spring 配置文件中写非常多的组件导入:


... ...
    <bean id="haha" class="com.pingguo.boot.bean.User">
        <property name="name" value="pingguo"></property>
        <property name="age" value="20"></property>
    </bean>
    <bean id="hehe" class="com.pingguo.boot.bean.User">
        <property name="name" value="tomcat"></property>
    </bean>


这里只是demo,实际工程中可能会存在很多 bean,如果想要逐个迁移成注解的方式,会很麻烦。


但是现在容器里又是没有这些组件的,在 main 方法里输出测试一下:


boolean haha = run.containsBean("haha");
    System.out.println("容器中存在 haha 的组件:" + haha);
    boolean hehe = run.containsBean("hehe");
    System.out.println("容器中存在 hehe 的组件:" + hehe);


1268169-20210901220848476-1914936448.png


因为这些组件声明在 xml 里,springboot 也并不知道这些是干嘛的。


这时候就可以使用@ImportResource来导入这些组件:


//@ConditionalOnBean(name = "pet1")
@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = true)
@ImportResource("classpath:beans.xml")  //配置文件的类路径 
public class MyConfig {
    @Bean("user1")
    public User user01(){
        User pingguo = new User("pingguo",20);
        pingguo.setPet(tomcatPet());
        return pingguo;
    }
    @Bean("pet22")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}


这个时候再运行测试一下:


1268169-20210901221528196-845314929.png


xml 配置文件里的组件被成功解析注册到了容器中。

相关文章
|
XML 安全 Java
使用 Spring 的 @Aspect 和 @Pointcut 注解简化面向方面的编程 (AOP)
面向方面编程(AOP)通过分离横切关注点,如日志、安全和事务,提升代码模块化与可维护性。Spring 提供了对 AOP 的强大支持,核心注解 `@Aspect` 和 `@Pointcut` 使得定义切面与切入点变得简洁直观。`@Aspect` 标记切面类,集中处理通用逻辑;`@Pointcut` 则通过表达式定义通知的应用位置,提高代码可读性与复用性。二者结合,使开发者能清晰划分业务逻辑与辅助功能,简化维护并提升系统灵活性。Spring AOP 借助代理机制实现运行时织入,与 Spring 容器无缝集成,支持依赖注入与声明式配置,是构建清晰、高内聚应用的理想选择。
960 0
|
缓存 监控 Java
SpringBoot @Scheduled 注解详解
使用`@Scheduled`注解实现方法周期性执行,支持固定间隔、延迟或Cron表达式触发,基于Spring Task,适用于日志清理、数据同步等定时任务场景。需启用`@EnableScheduling`,注意线程阻塞与分布式重复问题,推荐结合`@Async`异步处理,提升任务调度效率。
1771 128
|
Java 测试技术 API
将 Spring 的 @Embedded 和 @Embeddable 注解与 JPA 结合使用的指南
Spring的@Embedded和@Embeddable注解简化了JPA中复杂对象的管理,允许将对象直接嵌入实体,减少冗余表与连接操作,提升数据库设计效率。本文详解其用法、优势及适用场景。
536 126
|
Java 测试技术 数据库
使用Spring的@Retryable注解进行自动重试
在现代软件开发中,容错性和弹性至关重要。Spring框架提供的`@Retryable`注解为处理瞬时故障提供了一种声明式、可配置的重试机制,使开发者能够以简洁的方式增强应用的自我恢复能力。本文深入解析了`@Retryable`的使用方法及其参数配置,并结合`@Recover`实现失败回退策略,帮助构建更健壮、可靠的应用程序。
1260 1
使用Spring的@Retryable注解进行自动重试
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
925 2
|
XML Java 数据格式
常用SpringBoot注解汇总与用法说明
这些注解的使用和组合是Spring Boot快速开发和微服务实现的基础,通过它们,可以有效地指导Spring容器进行类发现、自动装配、配置、代理和管理等核心功能。开发者应当根据项目实际需求,运用这些注解来优化代码结构和服务逻辑。
791 12
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
745 0
探索Spring Boot的@Conditional注解的上下文配置
|
智能设计 Java 测试技术
Spring中最大化@Lazy注解,实现资源高效利用
本文深入探讨了 Spring 框架中的 `@Lazy` 注解,介绍了其在资源管理和性能优化中的作用。通过延迟初始化 Bean,`@Lazy` 可显著提升应用启动速度,合理利用系统资源,并增强对 Bean 生命周期的控制。文章还分析了 `@Lazy` 的工作机制、使用场景、最佳实践以及常见陷阱与解决方案,帮助开发者更高效地构建可扩展、高性能的 Spring 应用程序。
492 0
Spring中最大化@Lazy注解,实现资源高效利用
|
安全 IDE Java
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码
本文介绍了如何在 Spring 应用程序中使用 Project Lombok 的 `@Data` 和 `@FieldDefaults` 注解来减少样板代码,提升代码可读性和可维护性,并探讨了其适用场景与限制。
407 0
Spring 的@FieldDefaults和@Data:Lombok 注解以实现更简洁的代码