Spring Boot 2系列(二十三):自动配置之@Conditional条件注解
要理解 Spring Boot 的自动配置,就必须先理解 Spring 的 @Conditional
注解,在自动配置类中常看到该注解的使用。
该注解指定了在什么条件下创建 Bean 进行配置。 Spring Boot包含多个 @Conditional
注释,可以在@Configuration
注解的类和@Bean
注解方法中使用。
@Conditional
类型的注解,可以注解在类上,可以注解在Bean
方法上,可以允许基于Spring Environment属性包含配置,可以仅允许在存在特定资源时包含配置。
也可自定义,通过实现Condition
接口,并重写其matches
方法来构造判断条件。
@Conditional
Class Conditions
@ConditionalOnClass
和@ConditionalOnMissingClass
两个在类上的注解:
判断指定的类是否存在来构建自动配置,也可使用name
属性名来指定类名。
Bean Conditions
@ConditionalOnBean
和@ConditionalOnMissingBean
两个在 Bean 方法上的注解:
判断指定的 Bean 是否存在来构建自动配置,可以使用value
属性来按类型或名称(id)指定 Bean, 可以使用search
属性指定 ApplicationContext 层次结构来搜索Bean
。
1 |
|
要添加注意添加 Bean 时的顺序,官方建议在自动配置类上仅使用 @ConditionalOnBean
和@ConditionalOnMissingBean
注释,因为可以保证这些注释在添加用户定义的Bean后执行。@ConditionalOnBean
和@ConditionalOnMissingBean
注解作用在@Configuration
注释的类上,等同于在作用在每个包含@Bean
的方法上。
Property Conditions
@ConditionalOnProperty
注解可以基于Spring Environment属性包含的配置进判断,再决定自动配置的执行,使用 prefix
和 name
属性指定应检查的属性。默认情况下,匹配存在且不等于false的任何属性。 您还可以使用havingValue
和matchIfMissing
属性创建更高级的检查。
Resource Conditions
@ConditionalOnResource
注释仅允许在存在特定资源时执行自动配置。 可以使用常用的 Spring 约定来指定资源,如以下示例所示:file:/home/user/test.dat。
Web Application Conditions
@ConditionalOnWebApplication
和@ConditionalOnNotWebApplication
注解用于判断应用程序是否为Web应用程序
,Web应用程序是使用Spring WebApplicationContext,定义会话范围或具有StandardServletEnvironment的任何应用程序。
SpEL Expression Conditions
@ConditionalOnExpression
注解允许根据SpEL表达式的结果来执行配置。
示例
条件:根据操作系统返回对应的内容。
定义判断条件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27//Windows系统的判断条件
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
public class WindowsCondition implements Condition {
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
return context.getEnvironment().getProperty("os.name").contains("Windows");
}
}
//Linux系统的判断条件
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
public class LinuxCondition implements Condition {
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
return context.getEnvironment().getProperty("os.name").contains("Linux");
}
}不同系统下的Bean类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23//接口
public interface ListService {
public String showListCmd();
}
//Windows下的实现类
public class WindowsListServiceImpl implements ListService {
public String showListCmd() {
return "dir";
}
}
//Linux下的实现类
public class LinuxListServiceImpl implements ListService {
public String showListCmd() {
return "ls";
}
}配置类
**@Conditional()**注解调用条件判断的类并根据返回的结果来创建Bean
。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
public class ConditionConfig {
public ListService windowsListService() {
return new WindowsListServiceImpl();
}
public ListService linuxListService() {
return new LinuxListServiceImpl();
}
}运行类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class ConditionMain {
public static void main(String[] args) {
AnnotationConfigApplicationContext context =
new AnnotationConfigApplicationContext(ConditionConfig.class);
ListService listService = context.getBean(ListService.class);
System.out.println(context.getEnvironment().getProperty("os.name")
+ "系统下的列表命令:"
+ listService.showListCmd());
//context.close();
}
}
Spring Boot 2系列(二十三):自动配置之@Conditional条件注解
http://blog.gxitsky.com/2018/07/10/SpringBoot-23-annotation-condition/