springBoot注解@Conditional

官方文檔定義：“Indicates that a component is only eligible for registration when all specified conditions match”，意思是只有滿足一些列條件之后創建一個bean。

@Conditional定義

@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.TYPE, ElementType.METHOD)  
public @interface Conditional{  
lass <!--?extends Condition-->[] value();  
} 

@Conditional注解主要用在以下位置：

• 類級別可以放在注標識有@Component（包含@Configuration）的類上
• 作為一個meta-annotation,組成自定義注解
• 方法級別可以放在標識由@Bean的方法上

如果一個@Configuration的類標記了@Conditional，所有標識了@Bean的方法和@Import注解導入的相關類將遵從這些條件。

 

condition接口定義如下：

public interface Condition{  
/** Determine if the condition matches. 
* @param context the condition context 
* @param metadata meta-data of the {@link AnnotationMetadata class} or 
* {@link Method method} being checked. 
* @return {@code true} if the condition matches and the component can be registered 
* or {@code false} to veto registration. 
*/  
boolean matches(ConditionContext context, AnnotatedTypeMedata metadata);  
}

下面看一個例子：

import org.springframework.context.annotation.Condition;  
import org.springframework.context.annotation.ConditionContext;  
import org.springframework.core.type.AnnotatedTypeMetadata;  
   
public class LinuxCondition implements Condition{  
   
  @Override  
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {  
    return context.getEnvironment().getProperty("os.name").contains("Linux");  }  
} 

import org.springframework.context.annotation.Condition;   
import org.springframework.context.annotation.ConditionContext;   
import org.springframework.core.type.AnnotatedTypeMetadata;   
   
public class WindowsCondition implements Condition{  
   
  @Override   
  public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {  
    return context.getEnvironment().getProperty("os.name").contains("Windows");  
  }  
}  

我們有兩個類LinuxCondition 和WindowsCondition 。兩個類都實現了Condtin接口，重載的方法返回一個基於操作系統類型的布爾值。

下面我們定義兩個bean，一個符合條件另外一個不符合條件：

import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Conditional;  
import org.springframework.context.annotation.Configuration;  
   
@Configuration  
public class MyConfiguration {  
   
  @Bean(name="emailerService")  
  @Conditional(WindowsCondition.class)  
  public EmailService windowsEmailerService(){  
      return new WindowsEmailService();  
  }  
   
  @Bean(name="emailerService")  
  @Conditional(LinuxCondition.class)  
  public EmailService linuxEmailerService(){  
    return new LinuxEmailService();  
  }  
}  

當符合某一個條件的時候，這里的@Bean才會被初始化。