Skip to main content
 首页 » 编程设计

Spring 条件Bean配置实现

2022年07月19日132jirigala

Spring 条件Bean配置实现

本文介绍Spring 4引入的一个新特性,条件实例化Bean。我们首先了解下Spring4之前的实现方式,接着学习Spring4 提供的Condition接口和 @Conditional注解。

1. 概述

有时需要根据环境创建依赖注入bean,环境可能是正在运行的操作系统、或应用服务器等。Bean配置也可能依赖具体哪个Java版本,环境变量的属性值,或你的应用正运行的阶段,如开发、测试、生产阶段等。诸如此类情况,我们需要根据条件实例化bean。

2. Spring 3 实现

2.1. Spring Expression Language (SpEL)实现

Spring3 提供了Spring Expression Language (SpEL),利用SpEl可以实现根据条件装载Bean。下面通过示例进行说明:

public class MyDao { 
  @Value("#{systemProperties['os.arch'].equals('x86') ? winDataSource : unixDataSource}") 
  private DataSource datasource; 
  ... 
} 

这里在@Value注解中通过SpEl表达式进行条件加载。

2.2. Profile实现

Spring 3.1 提供了基于Profile的bean配置/创建。即能够使用配置类基于一定命名环境创建bean。

为了演示该特性,假设我们应用根据不同环境需要不同的bean配置,如邮件服务Bean依赖不同的操作系统,示例代码如下:

@Configuration 
public class MyConfiguration { 
  
  @Bean 
  public EmailService emailerService(){ 
    if (System.getProperty("os.name").contains("Windows")){ 
      return new WindowsEmailService(); 
    } 
    return new LinuxEmailService(); 
  } 
} 

@Bean注解的方法动态返回正确的邮件服务bean。

从Spring 3.1开始,这种硬编码方法的另一种替代方法(如果需要支持其他操作系统会发生什么?)是使用Profile实现。通过@Profile定义一组bean。我们例子需要两个profile,分别对应Windows和Linux。

@Configuration 
@Profile("Linux") 
public class LinuxConfiguration { 
  
  @Bean 
  public EmailService emailerService() { 
    return new LinuxEmailService(); 
  } 
} 
@Profile("Windows")  
public class WindowsConfiguration { 
  
  @Bean 
  public EmailService emailerService() { 
    return new WindowsEmailService(); 
  } 
} 

profile准备就绪后,可以通过setActiveProfiles()选择合适的bean:

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); 
context.getEnvironment().setActiveProfiles("Linux"); 
context.scan("com.intertech"); 
context.refresh(); 

3. Spring 4 实现方式

Spring 4 增加了新的 @Conditional 注解可以实现类似条件配置,但不在需要profile。还是用上面的示例进行说明。需要两个类分别实现Condition接口,并实现matches()方法,在方法类检查条件返回boolean值表明是否条件符合。

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"); 
  } 
} 

ConditionContext参数给matches方法提供了访问环境、容器、类加载器等能力,可以利用这些决定返回是否符合条件。AnnotatedTypeMetadata参数给matches提供访问增加条件注解的方法。

条件设置好了,现在定义配置类,给创建bean的方法增加条件注解@Conditional,并指定对于的条件类。

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都命名为“emailerService”,但只有其中一个被容器调用基于条件创建bean。

该示例仅使用创建bean的条件。实际上这些条件可以作为可重用的机制,用于对各种bean进行条件设置。

4. 总结

本文带你了解Spring不同版本实现条件化实现Bean机制。条件Bean是Spring Boot简化配置的底层实现机制,希望本文能够加深你对Spring的理解和青睐。


本文参考链接:https://blog.csdn.net/neweastsun/article/details/105129840