SpringBoot深入探究@Conditional條件裝配的使用

更新時(shí)間：2022年06月27日 11:05:37 作者：鳴鼓ming

這篇文章主要為大家介紹了SpringBoot底層注解@Conditional的使用分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

1.相關(guān)介紹

@Conditional注解可以用在任何類型或者方法上面，通過@Conditional注解可以配置一些條件判斷，當(dāng)所有條件都滿足的時(shí)候，被@Conditional標(biāo)注的目標(biāo)才會(huì)被spring容器處理。

比如可以通過@Conditional來控制bean是否需要注冊(cè)，控制被@Configuration標(biāo)注的配置類是需要需要被解析等。

Conditional相關(guān)的其它注解：

注解	描述
@ConditionalOnBean	在某個(gè) bean 存在的時(shí)候
@ConditionalOnMissingBean	在某個(gè) bean 不存在的時(shí)候
@ConditionalOnClass	當(dāng)前 classPath 下可以找到某個(gè) class 的時(shí)候
@ConditionalOnMissingClass	當(dāng)前 classPath 下無法找到某個(gè) class 的時(shí)候
@ConditionalOnResource	當(dāng)前 classPath 下否存在某個(gè)資源文件的時(shí)候
@ConditionalOnProperty	當(dāng)前 JVM 包含某個(gè)屬性值的時(shí)候
@ConditionalOnWebApplication	當(dāng)前 Spring context 是 web 應(yīng)用程序的時(shí)候
@ConditionalOnJava	在指定JDK版本的時(shí)候
@ConditionalOnExpression	符合表達(dá)式的時(shí)候
@ConditionalOnJndi	JNDI存在該項(xiàng)的時(shí)候

2.舉例測(cè)試

@ConditionalOnBean, 在某個(gè) bean 存在的時(shí)候被標(biāo)注的組件才被注冊(cè)到IOC容器中

下面是其詳細(xì)代碼

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional({OnBeanCondition.class})
public @interface ConditionalOnBean {
    Class<?>[] value() default {};
    String[] type() default {};
    Class<? extends Annotation>[] annotation() default {};
    String[] name() default {};
    SearchStrategy search() default SearchStrategy.ALL;
    Class<?>[] parameterizedContainer() default {};
}

我們就拿它來測(cè)試一下

1.指定組件不存在時(shí)

MyConfig

package com.limi.config;
import com.limi.entity.User;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.*;
@Configuration
public class MyConfig {
//    @Bean
//    public User user01(){
//        return new User(1, "andy", "123456");
//    }
    @Bean
    @ConditionalOnBean(name = "user01") //當(dāng)user01存在時(shí)才注冊(cè)u(píng)ser02
    public User user02(){
        return new User(2, "bob", "666666");
    }
}

MainApplication

package com.limi;
import com.limi.entity.User;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        //1、返回我們IOC容器
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        if(run.containsBean("user01"))
            System.out.println((User)run.getBean("user01"));
            System.out.println("user01 不存在!\n");
        if(run.containsBean("user02"))
            System.out.println((User)run.getBean("user02"));
        else
            System.out.println("user02 不存在!\n");
    }
}

運(yùn)行結(jié)果

2.指定組件存在時(shí)

MyConfig

package com.limi.config;
import com.limi.entity.User;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.*;
@Configuration
public class MyConfig {
    @Bean
    public User user01(){
        return new User(1, "andy", "123456");
    @Bean
    @ConditionalOnBean(name = "user01") //當(dāng)user01存在時(shí)才注冊(cè)u(píng)ser02
    public User user02(){
        return new User(2, "bob", "666666");
    }
}

MainApplication

package com.limi;
import com.limi.entity.User;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        //1、返回我們IOC容器
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        if(run.containsBean("user01"))
            System.out.println((User)run.getBean("user01"));
        else
            System.out.println("user01 不存在!\n");
        if(run.containsBean("user02"))
            System.out.println((User)run.getBean("user02"));
        else
            System.out.println("user02 不存在!\n");
    }
}

運(yùn)行結(jié)果

3.完整代碼

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.limi</groupId>
    <artifactId>springboot-test1</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.4.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
    <!--打包插件, 使用它可以把項(xiàng)目打包為jar包-->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

User

package com.limi.entity;
public class User {
    private Integer id;
    private String userName;
    private String passWord;
    public User(){}
    public User(Integer id, String userName, String passWord) {
        this.id = id;
        this.userName = userName;
        this.passWord = passWord;
    }
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                '}';
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getUserName() {
        return userName;
    }
    public void setUserName(String userName) {
        this.userName = userName;
    }
    public String getPassWord() {
        return passWord;
    }
    public void setPassWord(String passWord) {
        this.passWord = passWord;
    }
}

MyConfig

package com.limi.config;
import com.limi.entity.User;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.*;
@Configuration
public class MyConfig {
    @Bean
    public User user01(){
        return new User(1, "andy", "123456");
    }
    @Bean
    @ConditionalOnBean(name = "user01") //當(dāng)user01存在時(shí)才注冊(cè)u(píng)ser02
    public User user02(){
        return new User(2, "bob", "666666");
    }
}

MainApplication

package com.limi;
import com.limi.entity.User;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        //1、返回我們IOC容器
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        if(run.containsBean("user01"))
            System.out.println((User)run.getBean("user01"));
        else
            System.out.println("user01 不存在!\n");
        if(run.containsBean("user02"))
            System.out.println((User)run.getBean("user02"));
        else
            System.out.println("user02 不存在!\n");
    }
}

到此這篇關(guān)于SpringBoot深入探究@Conditional條件裝配的使用的文章就介紹到這了,更多相關(guān)SpringBoot @Conditional內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: