这类注解都不知道还好意思说会Spring Boot ？

前言

不知道大家在使用Spring Boot开发的日常中有没有用过@Conditionalxxx注解，比如@ConditionalOnMissingBean。相信看过Spring Boot源码的朋友一定不陌生。

@Conditionalxxx这类注解表示某种判断条件成立时才会执行相关操作。掌握该类注解，有助于日常开发，框架的搭建。

今天这篇文章就从前世今生介绍一下该类注解。

由于时间关系，没有写的很详细，有一部分省略掉了，需要完整版的朋友可以点一点下方链接免费领取

链接：1103806531暗号：优快云

@Conditional

@Conditional注解是从Spring4.0才有的，可以用在任何类型或者方法上面，通过@Conditional注解可以配置一些条件判断，当所有条件都满足的时候，被@Conditional标注的目标才会被Spring容器处理。

@Conditional的使用很广，比如控制某个Bean是否需要注册，在Spring Boot中的变形很多，比如@ConditionalOnMissingBean、@ConditionalOnBean等等，如下：

该注解的源码其实很简单，只有一个属性value，表示判断的条件（一个或者多个），是org.springframework.context.annotation.Condition类型，源码如下：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {

    /**
     * All {@link Condition} classes that must {@linkplain Condition#matches match}
     * in order for the component to be registered.
     */
    Class<? extends Condition>[] value();
}

@Conditional注解实现的原理很简单，就是通过org.springframework.context.annotation.Condition这个接口判断是否应该执行操作。

Condition接口

@Conditional注解判断条件与否取决于value属性指定的Condition实现，其中有一个matches()方法，返回true表示条件成立，反之不成立，接口如下：

@FunctionalInterface
public interface Condition {
    boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

matches中的两个参数如下：

context：条件上下文，ConditionContext接口类型的，可以用来获取容器中上下文信息。
metadata：用来获取被@Conditional标注的对象上的所有注解信息

ConditionContext接口

这个接口很重要，能够从中获取Spring上下文的很多信息，比如ConfigurableListableBeanFactory，源码如下：

public interface ConditionContext {

    /**
     * 返回bean定义注册器，可以通过注册器获取bean定义的各种配置信息
     */
    BeanDefinitionRegistry getRegistry();

    /**
     * 返回ConfigurableListableBeanFactory类型的bean工厂，相当于一个ioc容器对象
     */
    @Nullable
    ConfigurableListableBeanFactory getBeanFactory();

    /**
     * 返回当前spring容器的环境配置信息对象
     */
    Environment getEnvironment();

    /**
     * 返回资源加载器
     */
    ResourceLoader getResourceLoader();

    /**
     * 返回类加载器
     */
    @Nullable
    ClassLoader getClassLoader();
}

Spring Boot中常用的一些注解

Spring Boot中大量使用了这些注解，常见的注解如下：

1. @ConditionalOnBean：当容器中有指定Bean的条件下进行实例化。
2. @ConditionalOnMissingBean：当容器里没有指定Bean的条件下进行实例化。
3. @ConditionalOnClass：当classpath类路径下有指定类的条件下进行实例化。
4. @ConditionalOnMissingClass：当类路径下没有指定类的条件下进行实例化。
5. @ConditionalOnWebApplication：当项目是一个Web项目时进行实例化。
6. @ConditionalOnNotWebApplication：当项目不是一个Web项目时进行实例化。
7. @ConditionalOnProperty：当指定的属性有指定的值时进行实例化。
8. @ConditionalOnExpression：基于SpEL表达式的条件判断。
9. @ConditionalOnJava：当JVM版本为指定的版本范围时触发实例化。
10. @ConditionalOnResource：当类路径下有指定的资源时触发实例化。
11. @ConditionalOnJndi：在JNDI存在的条件下触发实例化。
12. @ConditionalOnSingleCandidate：当指定的Bean在容器中只有一个，或者有多个但是指定了首选的Bean时触发实例化。

比如在WEB模块的自动配置类WebMvcAutoConfiguration下有这样一段代码：

    @Bean
        @ConditionalOnMissingBean
        public InternalResourceViewResolver defaultViewResolver() {
            InternalResourceViewResolver resolver = new InternalResourceViewResolver();
            resolver.setPrefix(this.mvcProperties.getView().getPrefix());
            resolver.setSuffix(this.mvcProperties.getView().getSuffix());
            return resolver;
        }

常见的@Bean和@ConditionalOnMissingBean注解结合使用，意思是当容器中没有InternalResourceViewResolver这种类型的Bean才会注入。这样写有什么好处呢？好处很明显，可以让开发者自定义需要的视图解析器，如果没有自定义，则使用默认的，这就是Spring Boot为自定义配置提供的便利。

我这边也整理了一份 架构师全套视频教程和关于java的系统化资料，包括java核心知识点、面试专题和20年最新的互联网真题、电子书等都有。有需要的朋友可以点一点下方链接免费领取！

链接：1103806531暗号：优快云