Spring @Profile 注解介绍
在这之前先看一下@Conditional注解
以下是对官方描述的简单翻译
@Conditional这个注解表示'只有在所有指定条件匹配时, 组件才有资格进行注册。'
@Conditional可以通过以下任何方式使用：
1.在任何直接或间接使用@Component和@Configuration的类上作为一个类型注解使用
2.作为元注解
3.作为任何@Bean方法的方法级注解
如果使用@Conditional标记@Configuration类, 则与该类关联的所有@Bean方法, @Import注解和@ComponentScan注解都将受条件限制。
下面有对其更具体的使用分析。
回到@Profile上
先看看类里面是什么,源码如下:
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ProfileCondition.class)
public @interface Profile { String[] value(); }
@Conditional(ProfileCondition.class)这行代码, 关注一下ProfileCondition.class
class ProfileCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata 这个玩意) {
// metadata 这个玩意是你以注解方式配置的Spring的、尚未被IOC容器处理的内容 (又分AnnotationMetadata和MethodMetadata 说多了)
MultiValueMap<String, Object> attrs = metadata.getAllAnnotationAttributes(Profile.class.getName());
if (attrs != null) {
for (Object value : attrs.get("value")) {
if (context.getEnvironment().acceptsProfiles(Profiles.of((String[]) value))) {
return true;
}
}
return false;
}
return true;
}
}
这个方法就是获取你以@Profile注解配置的方法/类, 然后解析其中的value值形成一个MultiValueMap结构。
如果任何一个值通过acceptsProfiles的验证, 则@Conditional(ProfileCondition.class)成立
可通过applicationContext.getEnvironment().setActiveProfiles("chinese");设置配置, 也可以通过注解@ActiveProfiles(..)设置。
下面给出一个示例方便参考:
@Configuration
public class AppConfig {
@Profile("english")
@Bean
public English getEnglish() { return new English(); }
@Profile("chinese")
@Bean
public Chinese getChinese() { return new Chinese(); }
}
class Chinese { }
class English { }
// 测试类
public class Test {
public static void main(String[] args) {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
applicationContext.getEnvironment().setActiveProfiles("chinese");
applicationContext.register(AppConfig.class);
applicationContext.refresh();
String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
for (String beanDefinitionName : beanDefinitionNames) {
System.out.println(beanDefinitionName); // 这里你可以看看打印的bean是否和你想的一样
}
}
}
个人分析结束了, 现在看下文档中的描述。
@Profile({...})表明一个组件在一个或多个特定profile处于活跃状态时是可以注册的
一个profile是一个命名的逻辑分组
可以通过ConfigurableEnvironment.setActiveProfiles(java.lang.String...)以编程的方式激活
也
可以通过将spring.profiles.active属性设置为JVM系统属性,作为环境变量
或
作为Web应用程序的web.xml中的Servlet上下文参数
还
可以通过@ActiveProfiles注解在集成测试中以声明方式激活配置文件
这里稍微说一下
第一种就是我上面代码示例中的方式
第二种System.setProperty
第三种类似下例
<context-param>
<param-name>spring.profiles.default</param-name>
<param-value>dev</param-value>
</context-param>
第四种可以自己搜一下就知道了,不难。
继续看文档
@Profile可以通过以下任何方式使用：
1.在任何直接或间接使用@Component和@Configuration的类上作为一个类型注解使用
2.作为元注解,用于组成自定义构造型注解
3.作为任何@Bean方法的方法级注解
补充:
1.@Service、@Controller都间接使用了@Component
2.元注解(meta-annotation)就是注解类上的注解
接着看文档
如果使用@Profile标记@Configuration类, 如果没有任何的profile符合标准, 则将绕过与该类关联的所有@Bean方法和@Import注解。
profile字符串可以包含简单的profile名称(例如"p1") 或**profile表达式。 **
Profile表达式允许表达更复杂的profile逻辑, 例如"p1＆p2" 。
再次补充:
profile表达式支持以下运算符：
1. ! - 逻辑非
2. & - 逻辑并
3. | - 逻辑或
注意: 当多个混用时, 遇事不决加括号
@Profile({"a", "b"})这种用法等同于使用逻辑或 (我猜的)
最后看一下Note (这一段翻译的也不知道对不对, 但仍需要这一块, 以防跳坑)
对于在@Bean方法上的@Profile, 可能有一个特殊的场景：对于相同Java方法名称的重载@Bean方法(类似于构造函数重载), 需要在所有重载方法上一致地声明@Profile条件, 如果条件不一致, 则只有重载方法中第一个声明上的条件才重要。
因此, @Profile不能用于选择具有特定参数签名的重载方法; 在所有的工厂方法中对于相同的bean的决断遵循在创建时的Spring的构造函数决断算法。
如果要定义具有不同Profile条件的备用bean, 请使用指向同个bean名称的不同Java方法名称。
代码示例:
@Configuration
public class ProfileDatabaseConfig {
@Bean("dataSource")
@Profile("development")
public DataSource embeddedDatabase() { ... }
@Bean("dataSource")
@Profile("production")
public DataSource productionDatabase() { ... }
}
附上文档地址: @Profile
