目录
一、引言
- 之前学习和了解了Bean对象的注册。其中涉及注解有@Bean与@Import。
- Bean管理的第三个部分——>注册条件
二、案例引用(接着上篇博客)
- 接着上篇博客的学习,我想获取第三方jar包中实体类的对应的已经注入到Ioc容器的Bean对象的具体成员变量的值
- 这里用到注解@Value。把配置文件里面的信息读取程序里面使用。因为在程序中不能把信息写死了。而这个注解可以获取配置文件里的指定键对应的值。之前它用在成员变量上了,现在它也可以用在参数列表上。
@Value("${country.对应键名}")
- yml配置文件中的内容
- 如果我把配置文件里面的内容注释掉,再重新启动运行工程就会报错。因为前面用注解告诉springboot从配置文件里面读取(country.name与country.system),结果删除了就不能解析到它。
- 而我们正常的设置应该是这样:如果配置文件里面书写了对应的内容,就正常解析。如果没有写任何的东西,就不再注入country对象。如何做?这就要用到注册条件了。
三、注册条件
- SpringBoot提供了设置注册生效条件的注解@Conditional。我们可以借助于这个注解来设置Bean注册的条件,但是这个注解比较麻烦。所以要使用其更简单的衍生注解。
- 这类衍生的注解有很多,以下列出三个常用的注解以及说明
@Conditional的常用衍生注解 注解 说明 @ConditionalOnProperty 配置文件中存在对应的属性,才声明该bean @Conditional0nMissingBean 当不存在当前类型的bean时,才声明该bean @ConditionalOnclass 当前环境存在指定的这个类时,才声明该bean
- 回到IDEA继续尝试使用上述衍生注解
(1)@ConditionalOnProperty
(配置文件中存在对应的属性,才声明该bean)
- 首先使用注解@ConditionalOnProperty,这个注解有两个属性需要赋值。
- 添加这个注解后(如果没有前缀country,name属性是指定键名,也就是country下有name、system都配置好了才注入Country类的Bean对象,否则不注入)
- 此时再去启动类中获取并打印这个Bean对象就报错,因为前面注解判断条件生效,并没有注入进Ioc容器(测试成功)只要把配置文件的注释取消掉,再重新运行就可以了。
(2)Conditional0nMissingBean
(当不存在当前指定类型的Bean时,才声明和注入该Bean)
- 测试:如果Ioc容器中不存在已经注入好的Country,则注入Province,否则不注入。
- 首先前面yml配置文件注释去掉,然后Country已经注入到Ioc容器中
- 此时再把yml配置文件中的内容注释掉,这样就会因为注解@ConditionalOnProperty的注册条件生效,就不会注册Country的Bean对象。然后又因为注解@Conditional0nMissingBean的原因,判断条件生效,没有已经注入的Country就会注册Province的Bean对象,然后springboot的启动类就可以获取到Ioc容器里面的Province的Bean对象了。
(3)@ConditionalOnclass
(当前环境存在指定的这个类时,才声明该bean)
- 测试:如果当前环境中存在:"DispatcherServlet类",则注入Province,否则不注入。而这个类"DispatcherServlet"是当工程引入了web的起步依赖,则当前环境中会存在这个类,否则就没有。
- 首先我的pom文件里面并没有引入web的起步依赖。
- 然后我在使用这个注解@ConditionalOnclass的时候,要写指定类的全类名——>对应的一个属性值要声明"name"。这里采用双击shift,搜索全类名,像下面一样的操作步骤
- 如果没有web的起步依赖,就没有上面那个类DispatcherServlet
- 然后接下来用注解注册Bean的判断条件,如果环境中存在这个类,就注册Province的Bean对象。
- 显而易见会报错!!因为未引入web起步依赖,环境中不存在该类,它就获取不到Ioc容器中的Province的Bean对象
- 现在测试当pom文件中引入了web的起步依赖,记得刷新Maven。就成功了,不报错!
标签:Province,SpringBoot,配置文件,Conditional,Bean,注册,注解,注入 From: https://blog.csdn.net/m0_74363339/article/details/141958063四、总结
(1)学习的有关于Bean注册条件的相关注解,通常会在自定义starter、或者是学习springboot源码中看到。
(2)主要涉及到的相关注解:@Bean、自定义组合注解、@Conditional及其衍生注解:@ConditionalOnProperty、@Conditional0nMissingBean、@ConditionalOnclass。