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注解使用

到此这篇关于SpringBoot @Import与@Conditional注解使用详解的文章就介绍到这了,更多相关SpringBoot @Import与@Conditional内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Gateway网关自定义拦截器的不可重复读取数据问题

    Gateway网关自定义拦截器的不可重复读取数据问题

    这篇文章主要介绍了Gateway网关自定义拦截器的不可重复读取数据问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08
  • Spring中过滤器(Filter)和拦截器(Interceptor)的区别和联系解析

    Spring中过滤器(Filter)和拦截器(Interceptor)的区别和联系解析

    在我们日常的开发中,我们经常会用到Filter和Interceptor,这篇文章主要介绍了Spring中过滤器(Filter)和拦截器(Interceptor)的区别和联系 ,需要的朋友可以参考下
    2022-10-10
  • 图解Java排序算法之3种简单排序

    图解Java排序算法之3种简单排序

    这篇文章主要为大家详细介绍了Java排序算法之3种简单排序,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • Spring中@Configuration注解和@Component注解的区别详解

    Spring中@Configuration注解和@Component注解的区别详解

    这篇文章主要介绍了Spring中@Configuration注解和@Component注解的区别详解,@Configuration 和 @Component 到底有何区别呢?我先通过如下一个案例,在不分析源码的情况下,小伙伴们先来直观感受一下这两个之间的区别,需要的朋友可以参考下
    2023-09-09
  • Java多线程案例实战之定时器的实现

    Java多线程案例实战之定时器的实现

    在Java中可以使用多线程和定时器来实现定时任务,下面这篇文章主要给大家介绍了关于Java多线程案例之定时器实现的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-01-01
  • 浅谈一下Java中枚举的用法

    浅谈一下Java中枚举的用法

    这篇文章主要介绍了浅谈一下Java中枚举的用法,枚举是一个被命名的整型常数的集合,用于声明一组带标识符的常数,当一个变量有几种固定可能的取值时,就可以将它定义为枚举类型,需要的朋友可以参考下
    2023-04-04
  • 详解Java数字签名提供XML安全

    详解Java数字签名提供XML安全

    在本篇文章中我们给大家整理了关于Java数字签名提供XML安全的知识点内容,有需要的朋友们可以学习下。
    2018-08-08
  • java实现大文本文件拆分

    java实现大文本文件拆分

    这篇文章主要为大家详细介绍了java实现大文本文件拆分,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-05-05
  • Java实现布隆过滤器的示例详解

    Java实现布隆过滤器的示例详解

    布隆过滤器(Bloom Filter)是1970年由布隆提出来的,实际上是由一个很长的二进制数组+一系列hash算法映射函数,用于判断一个元素是否存在于集合中。本文主要介绍了Java实现布隆过滤器的示例代码,希望对大家有所帮助
    2023-03-03
  • SpringBoot使用JdbcTemplate访问操作数据库基本用法

    SpringBoot使用JdbcTemplate访问操作数据库基本用法

    这篇文章主要介绍了SpringBoot使用JdbcTemplate访问操作数据库基本用法,Spring对数据库的操作在jdbc上s面做了深层次的封装,使用spring的注入功能,可以把DataSource注册到JdbcTemplate之中。下文详细内容需要的小伙伴可以参考一下
    2022-02-02

最新评论