【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组件的时候,就会注册user1pet22


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


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


运行一下:


1268169-20210901215751299-1841800985.png


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


二、@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 配置文件里的组件被成功解析注册到了容器中。

相关文章
|
10天前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
28 0
|
28天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
17天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
41 4
SpringBoot必须掌握的常用注解!
|
1月前
|
XML Java 数据格式
Spring从入门到入土(bean的一些子标签及注解的使用)
本文详细介绍了Spring框架中Bean的创建和使用,包括使用XML配置文件中的标签和注解来创建和管理Bean,以及如何通过构造器、Setter方法和属性注入来配置Bean。
67 9
Spring从入门到入土(bean的一些子标签及注解的使用)
|
18天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
58 2
|
18天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
34 1
|
1月前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
13天前
|
存储 安全 Java
springboot当中ConfigurationProperties注解作用跟数据库存入有啥区别
`@ConfigurationProperties`注解和数据库存储配置信息各有优劣,适用于不同的应用场景。`@ConfigurationProperties`提供了类型安全和模块化的配置管理方式,适合静态和简单配置。而数据库存储配置信息提供了动态更新和集中管理的能力,适合需要频繁变化和集中管理的配置需求。在实际项目中,可以根据具体需求选择合适的配置管理方式,或者结合使用这两种方式,实现灵活高效的配置管理。
10 0
|
1月前
|
XML Java 数据库
Spring boot的最全注解
Spring boot的最全注解
|
1月前
|
JSON NoSQL Java
springBoot:jwt&redis&文件操作&常见请求错误代码&参数注解 (九)
该文档涵盖JWT(JSON Web Token)的组成、依赖、工具类创建及拦截器配置,并介绍了Redis的依赖配置与文件操作相关功能,包括文件上传、下载、删除及批量删除的方法。同时,文档还列举了常见的HTTP请求错误代码及其含义,并详细解释了@RequestParam与@PathVariable等参数注解的区别与用法。