SpringBoot--自动装配原理详解及应用之Conditional注解

SpringBoot作为当今开发的主流框架，作为一名java开发是不可能的不了解的，这个东西是典型的用起来很简单，但是了解到原理之后就会不自觉地感叹，真TMNB！

本文主要讲解其自动装配的原理，以及我们日常中怎么去用到这块的内容。

一、Conditional注解

首先我们先建立一个Student对象，里面没有任何属性

public class Student {
}

然后我们建立一个命题：

如果项目中导入了fastjson，则会将Student放入IOC当中，如果没有，则不加载。

@SpringBootApplication
public class SpringbootConditionApplication {public static void main(String[] args) {SpringApplication.run(SpringbootConditionApplication.class, args);}}

如上图所示，这是springboot的启动类（引导类），在这里我们先简单讲一下SpringApplication的run方法

可以看到run方法是有返回值的，对象为ConfigurableApplicationContext，是一个配置上下文对象，spring中的IOC就是一个上下文对象，于是我们可以看到通过这个上下文对象可以获得我们的环境以及IOC当中的Bean。

于是我们可以将代码这样写

@SpringBootApplication
public class SpringbootConditionApplication {public static void main(String[] args) {ConfigurableApplicationContext context = SpringApplication.run(SpringbootConditionApplication.class, args);// 获取名为student的beanObject student = context.getBean("student");System.out.println(student);}}

这时候，我们再编写一个StudentConfig的类对student进行配置，如下

@Configuration
public class StudentConfig {@Beanpublic Student student(){return new Student();}
}

这时候我们启动项目，可以看到项目直接启动成功

但这并没有满足我们的要求，就是在项目中有导入了fastjson才会将student加载的要求，这时候就要用到Condition注解。Conditional作用就是当你注册bean时，可以对这个bean添加一定的自定义条件，当满足这个条件时，注册这个bean，否则不注册

我们来看下Conditional的代码

这个注解里只定义了一个Class类型的数组，这没什么，重点在于泛型要求为Condition

然后我们看下Condition的这个接口

这个接口只定义了一个方法名为matches，返回值为一个boolean，这个时候我们不难猜出，当Conditional注解中的值为true则会执行标注的方法，这里我们再写一个类实现Condition接口，可以看到默认的返回值是为 false，然后我们再对它稍加改造

public class ClassOnCondition implements Condition {@Overridepublic boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {// 定义一个布尔值boolean flag;try {// 通过反射找到fastjson的类Class<?> aClass = Class.forName("com.alibaba.fastjson.JSON");// 找到了则返回trueflag = true;} catch (ClassNotFoundException e) {// 找不到则返回falseflag = false;}return flag; }
}

最后别忘了在StudentConfig中指定我们刚刚编写的类

@Configuration
public class StudentConfig {@Bean@Conditional(ClassOnCondition.class)public Student student(){return new Student();}
}

然后我们把项目中的依赖注释掉

启动项目，果不其然报错了，显示找不到student这个bean

这个时候肯定有机智的小朋友可能会提问了，这个路径写死了不就很耦合吗，这不搞个动态加载？

那这里呢，我们就可以定义一个注解，叫ConditionalOnClass，其中定义一个数组，因为设置的条件可以有多个

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ClassOnCondition.class)
public @interface ConditionalOnClass {String[] value();
}

这个时候，我们来把StudentConfig中的注解改成我们自定义的，并传入值

@Configuration
public class StudentConfig {@Bean
//    @Conditional(ClassOnCondition.class)@ConditionalOnClass("com.alibaba.fastjson.JSON")public Student student(){return new Student();}
}

最后呢，我们在把之前定义的ClassOnCondition进行修改，不过在修改之前，稍微讲一下这两个入参：

ConditionContext：这个对象是个上下文对象，可以用它获取环境，ioc以及类加载器

AnnotatedtypeMetadata：注解元对象，可以获得注解中传入的值

我们将代码修改成下图所示

public class ClassOnCondition implements Condition {@Overridepublic boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {// 定义一个布尔值boolean flag;try {// 通过注解名获取其中的值Map<String, Object> map = metadata.getAnnotationAttributes(ConditionalOnClass.class.getName());// 获取value的值String[] classNames = (String[]) map.get("value");for (String className : classNames) {Class<?> aClass = Class.forName(className);}flag = true;} catch (ClassNotFoundException e) {// 找不到则返回falseflag = false;}return flag;}
}

取消掉fastjson的依赖果然还是报错了

加入之后又成功获取了

二、springboot中对Conditional注解的运用

那面试的时候，面试官可能就会问spring中是怎么做到限制的

这个时候

本文实例的springboot版本为2.6.1，我们可以找到这个工程，spring-boot-autoconfigure

找到这个工程的condition文件夹，可以看到其中有很多的相关的注解，

就比如：ConditionOnProperty:当配置文件中有相对应的键值对，则会执行相应方法

那这些都是springboot给我们定义好了的，我们可以直接使用，效果和我们刚刚自定义的是一样

然后我们以kafka作为例子举例，看看springboot是如何做的

找到这个类，我们来看其中的代码

当图中1的含义为项目中没有KafkaTemplate的字节码文件，则下面的2都不会执行

当1满足时，我们看2（含义为当IOC容器中没有KafkaTemplate时，则会执行标注的方法）

这就是SpringBoot当中对Conditional注解的用法，下一张我们会讲解如何切换springboot中的Enable注解。