在SpringBoot中可以通过@Configuration对某个类注解将该类申明为配置类,以此在代替先前spring版本中配置xml中的功能,并且增加了可读性与维护性。并且在注解类中的类方法中可以通过@Bean对该类方法返回的对象注入到Spring容器中,其方法名也是该对象在spring容器中的对象名。
//简单的配置类及对象注入到spring容器中。
@Configuration
public class DemoConfiguration {
@Bean()
public String demoObj(){
return "demoObj";
}
//底层采用DefaultParameterNameDiscoverer类,可获取到容器中bean-name为demoObj的对象
@Bean()
public String demoObj2(String demoObj){
return "demoObj2"
}
}
然而我们在自定义配置类往往需要有更大的灵活性,以适应不同场景下的不同装配规则,当然SpringBoot也有考虑到这一点,也为我们提供了一系列的关于Configuration的条件类注解,以助于我们更好的编写出灵活的装备类。比如我们可以根据在classpath中是否具有某个类而决定是否进行装配,又或者说可以根据容器中是否已经具有某个bean后而决定是否进行装配等。以下将列出在Configuration中经常伴随着使用的条件注解。
| 条件配置注解 |注解说明|
|:-|:-|
|@ConditionalOnBean|当Spring容器中具有某个Bean时才进行装配|
|@ConditionalOnClass|当classpath中存在某个对象时才进行装配|
|@ConditionalOnCloudPlatform|当处于SpringCloud环境时才进行装配|
|@ConditionalOnExpression|当SpEL表达式返回true时才进行装配|
|@ConditionalOnJava|当java版本为指定的版本时才进行装配|
|@ConditionalOnJndi|当有通过JNDI加载资源时才进行装配|
|@ConditionalOnMissingBean|当Spring容器中不具有某个Bean时才进行装配|
|@ConditionalOnMissingClass|当classpath中不存在某个对象时才进行装配|
|@ConditionalOnNotWebApplication|当不是处于WebApp环境时才进行装配|
|@ConditionalOnProperty|在Environment下具有某个配置信息时才进行装配|
|@ConditionalOnResource|当classpath下具有某个资源信息(全路径)时才进行装配|
|@ConditionalOnSingleCandidate|指定的class类在spring容器中只存在一个时才进行装配|
|@ConditionalOnWebApplication|当处于WebApp环境时才进行装配|
|@ConditionalOnRepositoryType|当特定类型的spring Data JPA启用的时候才进行装配|
以上注解信息分别在spring包spring-boot-autoconfigure-2.0.1.RELEASE.jar中的org.springframework.boot.autoconfigure.condition路径中。该注解即可以注释在类配置上,也可以注释在类方法上以便对整个装配范围的颗粒度做更好的选择
但是需要注意的是,JAVA在进行编译时会有编译期的检查,所以在使用了@ConditionalOnClass和@ConditionalOnMissingClass的时候编译时需要确保所指定的class在classpath中存在,否则会报编译期的异常。而在外部引用时不需要确保其class是否存在于classpath。因为jvm是按需读取class,当遇到遇到的class时才会调用classloader进行读取存入方法区中。而如果读取不到其会被@ConditionalOnClass与@ConditionalOnMissingClass对应的处理类感知到,并且使该注解下的配置类不进行具体的装配从而起到效果。
有时候单单只使用配置条件类注解仍然无法满足某些特定的需求,比如说需要按照某个加载顺序进行装配类加载,这时候就需要配置顺序类对配置类进行注解来达到这种效果。
| 顺序配置注解 |注解说明|
|:-|:-|
|@AutoConfigureAfter|在某个配置类装配后才进行装配|
|@AutoConfigureBefore|在某个配置类装配前先提前装配|
|@AutoConfigureOrder|定义装配顺序,其值越低配置优先级越高|
需要注意的是该注解类只能作用于配置类上以调整装配的执行顺序。