【手撕 Spring】条件化的 bean

心已赠人 2024-05-04 08:02 76阅读 0赞

![在这里插入图片描述][255df648eac543ec9802764546c92b1a.png]

> ?**博主介绍**： 博主从事应用安全和大数据领域，有8年研发经验，5年面试官经验，Java技术专家，WEB架构师，阿里云专家博主，华为云云享专家，51CTO 专家博主

⛪️ 个人社区：[个人社区][Link 1]  
? 个人主页：[个人主页][Link 2]  
? 专栏地址： ✅ [带你手撕 Spring][Spring]  
?八股文专题：[剑指大厂，手撕 Java 八股文][Java]

#### 文章目录 ####

*   *   *  一、什么是条件化的 bean
         *  二、为什么要条件化的 bean
         *  三、在Condition中检查是否存在某个属性
         *  四、ProfileCondition检查某个bean profile是否可用

#### 一、什么是条件化的 bean ####

Spring条件化的bean是根据不同的条件在应用程序中选择性地创建和配置的bean。条件化的bean可以根据环境变量、系统属性、配置文件中的属性或其他条件进行配置。通过使用Spring的条件化注解和配置，可以根据不同的条件选择性地创建和配置bean，以满足特定的需求。条件化的bean可以在不同的环境中使用不同的配置，从而实现灵活的应用程序配置。

#### 二、为什么要条件化的 bean ####

条件化的bean可以根据特定的条件选择性地创建和配置，这样可以使应用程序更加灵活和可配置。以下是一些使用条件化的bean的原因：

1.  环**境适应性**：不同的环境可能需要不同的配置。通过条件化的bean，可以根据当前的环境条件选择性地创建和配置bean，以适应不同的环境需求。
2.  **动态配置**：条件化的bean可以根据配置文件中的属性或其他条件进行配置。这样，可以在应用程序运行时动态地改变bean的行为和配置，而无需重新编译和部署应用程序。
3.  **模块化开发**：条件化的bean可以根据不同的模块或组件进行配置。这样，可以将应用程序拆分为多个模块，每个模块可以根据自己的需求选择性地创建和配置自己的bean，从而实现更好的模块化开发和维护。
4.  **测试和调试**：条件化的bean可以根据测试环境或调试模式进行配置。这样，在测试和调试阶段可以选择性地创建和配置特定的bean，以方便测试和调试过程。  
    总之，条件化的bean可以使应用程序更加灵活、可配置和易于维护，同时提供了更好的环境适应性和模块化开发的支持。

假设你希望一个或多个bean只有在应用的类路径下包含特定的库时才创建。或者我们希望某个bean只有当另外某个特定的bean也声明了之后才会创建。我们还可能要求只有某个特定的环境变量设置之后，才会创建某个bean。

在Spring 4之前，很难实现这种级别的条件化配置，但是Spring 4引入了一个新的@Conditional注解，它可以用到带有@Bean注解的方法上。如果给定的条件计算结果为true，就会创建这个bean，否则的话，这个bean会被忽略。

@Bean
    @Conditional(MagicExistsCondition.class)
    public MagicBean magicBean() {
        
        return new MagicBean();
    }

可以看到，@Conditional中给定了一个Class，它指明了条件——在本例中，也就是MagicExistsCondition。@Conditional将会  
通过Condition接口进行条件对比：

public interface Condition {
        
        boolean matches(ConditionContext ctxt, AnnotatedTypeMetadata metadata);
    }

设置给@Conditional的类可以是任意实现了Condition接口的类型。可以看出来，这个接口实现起来很简单直接，只需提供matches()方法的实现即可。如果matches()方法返回true，那么就会创建带有@Conditional注解的bean。如果matches()方法返回false，将不会创建这些bean。

#### 三、在Condition中检查是否存在某个属性 ####

public class MagicExistsCondition implements Condition {
        
        public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        
            Environment env = context.getEnvironment();
            return env.containsProperty("magic");
        }
    }

在上面的程序清单中，matches()方法很简单但功能强大。它通过给定的ConditionContext对象进而得到Environment对象，并使用这个对象检查环境中是否存在名为magic的环境属性。在本例中，属性的值是什么无所谓，只要属性存在即可满足要求。如果满足这个条件的话，matches()方法就会返回true。所带来的结果就是条件能够得到满足，所有@Conditional注解上引用MagicExistsCondition的bean都会被创建。

话说回来，如果这个属性不存在的话，就无法满足条件，matches()方法会返回false，这些bean都不会被创建。

MagicExistsCondition中只是使用了ConditionContext得到的Environment，但Condition实现的考量因素可能会比这更多。matches()方法会得到ConditionContext和AnnotatedTypeMetadata对象用来做出决策。

ConditionContext是一个接口，大致如下所示：

public interface ConditionContext {
        
        BeanDefinitionRegistry getRegistry();
        ConfigurableListableBeanFactory getBeanFactory();
        Environment getEnvironment();
        ResourceLoader getResourceLoader();
        ClassLoader getClassLoader();
    }

通过ConditionContext，我们可以做到如下几点：

*  借助getRegistry() 返回的BeanDefinitionRegistry检查bean定义;
 *  借助getBeanFactory() 返回的ConfiqurablelistableBeanFactory检查bean是否存在，甚至探查bean的属性
 *  借助getEnvironment () 返回的Environment检查环境变量是否存在以及它的值是什么;
 *  读取并探查qetResourceLoader () 返回的ResourceLoader所加载的资源;。
 *  借助getclassLoader () 返回的classLoader加载并检查类是否存在。

AnnotatedTypeMetadata则能够让我们检查带有@Bean注解的方法上还有什么其他的注解。像ConditionContext一样，AnnotatedTypeMetadata也是一个接口。它如下所示：

public interface AnnotatedTypeMetadata {
        
        boolean isAnnotated(String annotationType);
        Map<String, Object> getAnnotationAttributes(String annotationType);
        Map<String, Object> getAnnotationAttributes(String annotationType, boolean classValuesAsString);
        MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationType);
        MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationType, boolean classValuesAsString);
    }

借助isAnnotated()方法，我们能够判断带有@Bean注解的方法是不是还有其他特定的注解。借助其他的那些方法，我们能够检查@Bean注解的方法上其他注解的属性。

非常有意思的是，从Spring 4开始，@Profile注解进行了重构，使其基于@Conditional和Condition实现。作为如何使用@Conditional和Condition的例子，我们来看一下在Spring 4中，@Profile是如何实现的。

@Profile注解如下所示：

@Retention(RetentionPolicy.RUNTIME)
    @Target({
        ElementType.TYPE, ElementType.METHOD})
    @Documented
    @Conditional(ProfileCondition.class)
    public @interface Profile {
        
        String value();
    }

@Profile本身也使用了@Conditional注解，并且引用ProfileCondition作为Condition实现。如下所示，ProfileCondition实现了Condition接口，并且在做出决策的过程中，考虑到了ConditionContext和AnnotatedTypeMetadata中的多个因素。

#### 四、ProfileCondition检查某个bean profile是否可用 ####

class ProfileCondition implements Condition {
        
        public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        
            if (context.getEnvironment() != null) {
        
                MultiValueMap<String, Object> attrs = metadata.getAllAnnotationAttributes(Profile.class.getName());
                if (attrs != null) {
        
                    for (Object value : attrs.get("value")) {
        
                        if (context.getEnvironment().acceptsProfiles((String[]) value)) {
        
                            return true;
                        }
                    }
                }
            }
            return false;
        }
    }

我们可以看到，ProfileCondition通过AnnotatedTypeMetadata得到了用于@Profile注解的所有属性。借助该信息，它会明确地检查value属性，该属性包含了bean的profile名称。然后，它根据通过ConditionContext得到的Environment来检查（借助acceptsProfiles()方法）该profile是否处于激活状态。

>  精彩专栏推荐订阅：在下方专栏??

>  ✅ [2023年华为OD机试真题（A卷&B卷）+ 面试指导 ][2023_OD_A_B_ _]  
>  ✅ [ 精选100套 Java 项目案例 ][_100_ Java _]  
>  ✅ [面试需要避开的坑（活动）][Link 3]  
>  ✅ [你找不到的核心代码][Link 4]  
>  ✅ [带你手撕 Spring][Spring]

> ?? 本文由激流原创，原创不易，希望大家关注、点赞、收藏，给博主一点鼓励，感谢！！！

![在这里插入图片描述][7b7478e55aa24a948b358051ef941b6a.webp_pic_center]

[255df648eac543ec9802764546c92b1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/04/93a204af35ae4958af0ca3b47599f302.png
[Link 1]: https://bbs.csdn.net/forums/45c04d3f41cc4dadaf312be1d1379b45?category=10003
[Link 2]: https://jiliu.blog.csdn.net/
[Spring]: https://blog.csdn.net/qq_37967783/category_12391987.html
[Java]: https://blog.csdn.net/qq_37967783/article/details/130940512
[2023_OD_A_B_ _]: https://blog.csdn.net/qq_37967783/category_12389634.html
[_100_ Java _]: https://blog.csdn.net/qq_37967783/category_12388267.html
[Link 3]: https://blog.csdn.net/qq_37967783/category_12380337.html
[Link 4]: https://blog.csdn.net/qq_37967783/category_12391346.html
[7b7478e55aa24a948b358051ef941b6a.webp_pic_center]: https://img-blog.csdnimg.cn/7b7478e55aa24a948b358051ef941b6a.webp#pic_center