SpringBoot @Import与@Conditional注解使用详解
更新时间：2022年10月13日 16:21:47 作者：一根头发学一年
在了解spring boot自动配置原理前，再来了解下两个注解@Import注解和@Conditional注解，@Conditional是Spring4新提供的注解，它的作用是按照一定的条件进行判断，满足条件给容器注册bean
说明：基于atguigu学习笔记。
在了解spring boot自动配置原理前，再来了解下两个注解@Import注解和@Conditional注解。
@Import
@Import注解主要用于导入某些特殊的Bean，这些特殊的Bean和Bean Definitaion 有关。
主要用于导入@Configuration 类，ImportSelector和ImportBeanDefinitionRegistrar接口的实现类。
@Import可以添加在@SpringBootApplication(启动类)、@Configuration(配置类)、@Component(组件类)对应的类上。
一般在Spring boot 中配置都一般都是自动导入的，所以我们不需要使用@Import，但是如果你你想导入的配置类不在自动扫包路径，那么该配置类就需要使用@Import导入，尤其是第三方jar包的配置类都需要借助@Import来导入。
这里我们首先熟悉基本语法，具体的用法后面再学。
示例：
还使用上一章里项目示例：@Configuration注解和@Bean注解
使用 @Import导入我们需要的类，这里导入我们自己创建的类和第三方logback jar包里的类，如下：
config类：
package com.example.ethan.config;
import ch.qos.logback.core.db.DBHelper;
import com.example.ethan.bean.Dept;
import com.example.ethan.bean.User;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods=true)
public class ConfigDemo {
@Bean
public User user01(){
User zhangsan = new User("zhangsan", 18);
//user组件依赖了Dept组件
zhangsan.setDept(rd());
return zhangsan;
}
@Bean("my rd")
public Dept rd(){
return new Dept("研发部");
}
}主程序
package com.example.ethan;
import ch.qos.logback.core.db.DBHelper;
import com.example.ethan.bean.Dept;
import com.example.ethan.bean.User;
import com.example.ethan.config.ConfigDemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class EthanApplication {
public static void main(String[] args) {
// 返回ioc容器
ConfigurableApplicationContext run = SpringApplication.run(EthanApplication.class, args);
// 只查看User类型的Bean
String[] beanDefinitionNames = run.getBeanNamesForType(User.class);
System.out.println("========================");
for (String name : beanDefinitionNames) {
System.out.println(name);
}
DBHelper bean = run.getBean(DBHelper.class);
System.out.println(bean);
// com.example.ethan.bean.User
//user01
//ch.qos.logback.core.db.DBHelper@67207d8a
}
}可以看到，使用 @Import注解，会给容器中自动创建出这两个类型的Bean，且Bean的名字是全类名。
@Conditional
满足Conditional指定的条件，则进行注入指定Bean。
@Conditional是一个根注解，下面还派生了许多其他注解
@Conditional注解可以加在方法上也可以加在类上。当加在类上，当条件不成立，类中所有代码都不执行，如果加在方法上，则只这个方法不执行。
下面以@ConditionalOnBean（条件是判断是否含有某个Bean）为例，演示代码如下：
首先放在方法上：
package com.example.ethan.config;
import com.example.ethan.bean.Dept;
import com.example.ethan.bean.User;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods=true)
public class ConfigDemo {
@Bean("my rd")
public Dept rd(){
return new Dept("研发部");
}
@Bean
@ConditionalOnBean(name = "my rd")
public User user01(){
User zhangsan = new User("zhangsan", 18);
//user组件依赖了Dept组件
zhangsan.setDept(rd());
return zhangsan;
}
}主程序：
package com.example.ethan;
import ch.qos.logback.core.db.DBHelper;
import com.example.ethan.bean.Dept;
import com.example.ethan.bean.User;
import com.example.ethan.config.ConfigDemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class EthanApplication {
public static void main(String[] args) {
// 返回ioc容器
ConfigurableApplicationContext run = SpringApplication.run(EthanApplication.class, args);
boolean my_rd = run.containsBean("my rd");
System.out.println("容器中含有my rd这个Bean：" + my_rd);
boolean user01 = run.containsBean("user01");
System.out.println("容器中含有user01这个Bean：" + user01);
}
}这时候两个好结果都是true，因为按照顺序注入Bean时，先注入了"my rd"这个Bean到容器，然后在注入user01时，检查容器中含有my rd"这个Bean，就把user01也注入了。
如果把条件里name改为不存在的如"my rd02"，那么入user01就不会注入容器。
下面把注解放到类上：
package com.example.ethan.config;
import com.example.ethan.bean.Dept;
import com.example.ethan.bean.User;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration(proxyBeanMethods=true)
@ConditionalOnBean(name = "my rd")
public class ConfigDemo {
@Bean("my rd")
public Dept rd(){
return new Dept("研发部");
}
@Bean
public User user01(){
User zhangsan = new User("zhangsan", 18);
//user组件依赖了Dept组件
zhangsan.setDept(rd());
return zhangsan;
}
}这时候两个Bean都不会注入容器，因为在执行这个类时检查条件不成立。
这里对@ConditionalOnBean有个初步了解，具体何种用法类似，可举一反三。
参考：
到此这篇关于SpringBoot @Import与@Conditional注解使用详解的文章就介绍到这了,更多相关SpringBoot @Import与@Conditional内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要为大家介绍了springboot 如何更新json串里面的内容,文中有详细的解决方案供大家参考,对大家的学习或工作有一定的帮助,需要的朋友可以参考下2023-10-10
在非Spring Boot项目中运行Nacos示例,需要手动配置Tomcat容器,本文介绍了如何在IDEA中配置Tomcat,并详细解决了配置过程中可能遇到的异常情况,步骤包括修改IDEA项目结构、添加Web模块、配置Artifacts和Tomcat Server2024-10-10
MyBatisPlus是一个强大的数据库操作框架,其代码生成器可以快速生成实体类、映射文件等,本文介绍了如何导入MyBatisPlus相关依赖,创建代码生成器,并配置数据库信息以逆向生成代码,感兴趣的朋友跟随小编一起看看吧2024-09-09
这篇文章主要为大家介绍了SpringCloud声明式Feign客户端调用工具使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪2023-08-08
MapStruct是一个强大的Java映射框架,它能够在编译时生成映射代码,,本文主要介绍了Java中MapStruct映射处理器报错的问题解决,具有一定的参考价值,感兴趣的可以了解一下2024-03-03
Cookie和Session都是为了保持用户的访问状态，一方面为了方便业务实现，另一方面为了简化服务端的程序设计。这篇文章主要介绍了java中cookie和session的知识,需要的朋友可以参考下2016-09-09
这篇文章主要介绍了用Java进行zip文件压缩与解压缩的方法，帮助大家更好的理解和使用Java，感兴趣的朋友可以了解下2020-12-12
controller函数中参数列表使用多个@RequestBody问题
这篇文章主要介绍了controller函数中参数列表使用多个@RequestBody问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2023-04-04
这篇文章主要介绍了springboot单元测试两种方法实例详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-12-12
这篇文章主要介绍了Java多线程之等待队列DelayQueue详解, DelayQueue被称作"等待队列"或"JDK延迟队列",存放着实现了Delayed接口的对象,对象需要设置到期时间,当且仅当对象到期,才能够从队列中被取走(并非一定被取走),需要的朋友可以参考下2023-12-12
最新评论