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

相关文章
|
1月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
52 0
|
2天前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
110 73
|
2天前
|
存储 Java Spring
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration,关于Bean对象的五个常用注解
|
2天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
29天前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
42 4
|
1月前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
68 4
SpringBoot必须掌握的常用注解!
|
29天前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
110 2
|
29天前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
50 2
|
1月前
|
消息中间件 Java 数据库
解密Spring Boot:深入理解条件装配与条件注解
Spring Boot中的条件装配与条件注解提供了强大的工具,使得应用程序可以根据不同的条件动态装配Bean,从而实现灵活的配置和管理。通过合理使用这些条件注解,开发者可以根据实际需求动态调整应用的行为,提升代码的可维护性和可扩展性。希望本文能够帮助你深入理解Spring Boot中的条件装配与条件注解,在实际开发中更好地应用这些功能。
38 2
|
1月前
|
JSON Java 数据格式
springboot常用注解
@RestController :修饰类,该控制器会返回Json数据 @RequestMapping(“/path”) :修饰类,该控制器的请求路径 @Autowired : 修饰属性,按照类型进行依赖注入 @PathVariable : 修饰参数,将路径值映射到参数上 @ResponseBody :修饰方法,该方法会返回Json数据 @RequestBody(需要使用Post提交方式) :修饰参数,将Json数据封装到对应参数中 @Controller@Service@Compont: 将类注册到ioc容器