脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot Condition

SpringBoot自动装配之Condition深入讲解

 更新时间：2023年01月16日 08:53:08   作者：不死鸟.亚历山大.狼崽子  
@Conditional表示仅当所有指定条件都匹配时，组件才有资格注册。该@Conditional注释可以在以下任一方式使用：作为任何@Bean方法的方法级注释、作为任何类的直接或间接注释的类型级别注释@Component，包括@Configuration类、作为元注释，目的是组成自定义构造型注释

Condition是在Spring 4.0 增加的条件判断功能，通过这个可以功能可以实现选择性的创建 Bean操作。

思考：

SpringBoot是如何知道要创建哪个Bean的？比如SpringBoot是如何知道要创建RedisTemplate的？

看一个例子：

当我们没导入redis-start时，会报错

引出问题

Exception in thread "main" org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'redisTemplate' available
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBeanDefinition(DefaultListableBeanFactory.java:874)
	at org.springframework.beans.factory.support.AbstractBeanFactory.getMergedLocalBeanDefinition(AbstractBeanFactory.java:1358)
	at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:309)
	at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:208)
	at org.springframework.context.support.AbstractApplicationContext.getBean(AbstractApplicationContext.java:1154)
	at com.example.condition.SpringbootDemo01Application.main(SpringbootDemo01Application.java:13)

当导入redis起步依赖后

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
org.springframework.data.redis.core.RedisTemplate@5a6d5a8f

问题：

SpringBoot是怎么知道我们导入redis坐标的呢？

案例一

需求：

在 Spring 的 IOC 容器中有一个 User 的 Bean，现要求：

通过condition设置加载或者不加载。

新建实体类：

package com.example.condition.entity;
public class User {
}

新建配置文件：

package com.example.condition.config;
import com.example.condition.condition.ClassCondition;
import com.example.condition.entity.User;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
@Configuration
public class UserConfig {
    @Bean
    @Conditional(ClassCondition.class)
    public User user(){
        return new User();
    }
}

新建condition:

如果为true则加载，如果为false则不加载

package com.example.condition.condition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
public class ClassCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return true;
    }
}

测试：

package com.example.condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class SpringbootDemo01Application {
    public static void main(String[] args) {
        //启动SpringBoot应用，返回Spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootDemo01Application.class, args);
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

案例二

需求：

在 Spring 的 IOC 容器中有一个 User 的 Bean，现要求：

导入Jedis坐标后，加载该Bean，没导入，则不加载。

新建User实体类：

package com.example.condition.entity;
public class User {
}

新建配置文件：

package com.example.condition.config;
import com.example.condition.condition.ClassCondition;
import com.example.condition.entity.User;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
@Configuration
public class UserConfig {
    @Bean
    @Conditional(ClassCondition.class)
    public User user(){
        return new User();
    }
}

condition通过反射判断jedis是否已经加载完毕

package com.example.condition.condition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
public class ClassCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        boolean flag =true;
        try {
            Class<?> cls = Class.forName("redis.clients.jedis.Jedis");
        }catch (ClassNotFoundException e){
            flag =false;
        }
        return flag;
    }
}

测试类：

package com.example.condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class SpringbootDemo01Application {
    public static void main(String[] args) {
        //启动SpringBoot应用，返回Spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootDemo01Application.class, args);
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

引入jedis进行测试判断：

        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
            <version>3.6.0</version>
        </dependency>

案例三

需求：

在 Spring 的 IOC 容器中有一个 User 的 Bean，现要求：

  • 导入Jedis坐标后，加载该Bean，没导入，则不加载。
  • 将类的判断定义为动态的。判断哪个字节码文件存在可以动态指定。

实体类：

package com.example.condition.entity;
public class User {
}

自定义注解：

package com.example.condition.condition;import org.springframework.context.annotation.Conditional;import java.lang.annotation.*;@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(ClassCondition.class)public @interface ConditionOnClass {    String[] value();}

Condition类：

package com.example.condition.condition;
import org.springframework.context.annotation.Conditional;
import java.lang.annotation.*;
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ClassCondition.class)
public @interface ConditionOnClass {
    String[] value();
}

配置类：

package com.example.condition.condition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;
import java.util.Map;
public class ClassCondition implements Condition {
    /**
     * @param context  上下文对象，用于获取环境，ClassLoader对象
     * @param metadata 注解的元对象，可以用于注解定义的属性值
     * @return
     */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Environment environment = context.getEnvironment();
        //1.需求：导入指定坐标后创建Bean
        //思路：判断指定坐标文件是否存在
        //获取注解属性值 value
        Map<String, Object> map = metadata.getAnnotationAttributes(ConditionOnClass.class.getName());
        String[] value = (String[]) map.get("value");
        boolean flag = true;
        try {
            for (String className : value) {
                Class<?> cls = Class.forName(className);
            }
        } catch (ClassNotFoundException e) {
            flag = false;
        }
        return flag;
    }
}

测试类：

package com.example.condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class SpringbootDemo01Application {
    public static void main(String[] args) {
        //启动SpringBoot应用，返回Spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootDemo01Application.class, args);
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

总结

自定义条件：

① 定义条件类：自定义类实现Condition接口，重写 matches 方法，在 matches 方法中进行逻辑判断，返回 boolean值 。 matches 方法两个参数：

  • context：上下文对象，可以获取属性值，获取类加载器，获取BeanFactory等。
  • metadata：元数据对象，用于获取注解属性。

② 判断条件：在初始化Bean时，使用 @Conditional(条件类.class)注解

SpringBoot 提供的常用条件注解：

  • ConditionalOnProperty：判断配置文件中是否有对应属性和值才初始化Bean
@Bean
@ConditionalOnProperty(name = "com",havingValue = "example")
public User user1(){
    return new User();
}

配置文件添加一下属性：

com = example

  • ConditionalOnClass：判断环境中是否有对应字节码文件才初始化Bean
  • ConditionalOnMissingBean：判断环境中没有对应Bean才初始化Bean

到此这篇关于SpringBoot自动装配之Condition深入讲解的文章就介绍到这了,更多相关SpringBoot Condition内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Java 获取本机的IP与MAC地址实现详解

    Java 获取本机的IP与MAC地址实现详解

    这篇文章主要介绍了Java 获取本机的IP与MAC地址实现详解的相关资料,需要的朋友可以参考下
    2016-09-09
  • 轻轻松松吃透Java并发fork/join框架

    轻轻松松吃透Java并发fork/join框架

    fork/join是一个工具框架 ,本文详细的介绍了fork/join框架的具体使用，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2021-07-07
  • java的Object里wait()实现原理讲解

    java的Object里wait()实现原理讲解

    这篇文章主要介绍了java的Object里wait()实现原理，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-09-09
  • 全面剖析java 数据类型与运算符

    全面剖析java 数据类型与运算符

    这篇文章主要介绍了Java基本数据类型和运算符,结合实例形式详细分析了java基本数据类型、数据类型转换、算术运算符、逻辑运算符等相关原理与操作技巧,需要的朋友可以参考下
    2021-09-09
  • SpringBoot之HttpWebServiceMessageSenderBuilder用法详解

    SpringBoot之HttpWebServiceMessageSenderBuilder用法详解

    这篇文章主要介绍了SpringBoot之HttpWebServiceMessageSenderBuilder用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-04-04
  • maven中自定义MavenArchetype的实现

    maven中自定义MavenArchetype的实现

    Maven自身提供了许多Archetype来方便用户创建Project,为了避免在创建project时重复的拷贝和修改,我们通过自定义Archetype来规范显得还蛮有必要,下面就来介绍一下,感兴趣的可以了解一下
    2025-01-01
  • MyEclipse2018中安装Mybatis generator插件的实现步骤

    MyEclipse2018中安装Mybatis generator插件的实现步骤

    这篇文章主要介绍了MyEclipse2018中安装Mybatis generator插件的实现步骤，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2019-02-02
  • java实现百度云文字识别接口代码

    java实现百度云文字识别接口代码

    这篇文章主要为大家详细介绍了java实现百度云文字识别的接口代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-11-11
  • Sentinel热点规则示例详解分析

    Sentinel热点规则示例详解分析

    这篇文章主要介绍了何为热点？热点即经常访问的数据。很多时候我们希望统计某个热点数据中访问频次最高的 Top K 数据，并对其访问进行限制
    2021-09-09
  • 使用SpringBoot进行身份验证和授权的示例详解

    使用SpringBoot进行身份验证和授权的示例详解

    在广阔的 Web 开发世界中,身份验证是每个数字领域的守护者,在本教程中,我们将了解如何以本机方式保护、验证和授权 Spring-Boot 应用程序的用户,并遵循框架的良好实践,希望对大家有所帮助
    2023-11-11

最新评论