故事一: 绝代有佳人,幽居在空谷

美女同学小张,在工作中遇到了烦心事。心情那是破凉破凉的,无法言喻。

故事背景是最近由于需求变动,小张在项目中加入了MQ的集成,刚开始还没什么问题,后面慢慢问题的显露出来了。

自己在本地Debug的时候总是能消费到消息,由于历史原因,公司的项目只区分了两套环境,也就是测试和线上。本地启动默认就是测试环境,所以会消费测试环境的消息。

MQ的配置代码如下:

@Configuration
public class MqConfig {
@Bean(initMethod = "start", destroyMethod = "shutdown")
public ConsumerBean consumerBean() {
// ....
}
}

想要解决小张的问题,那么就必须得有第三个环境的区分,也就是增加一个本地开发环境,然后通过环境来决定是否需要初始化MQ。

这个时候就可以用到Spring Boot为我们提供的Conditional家族的注解了,@Conditional注解会根据具体的条件决定是否创建 bean 到容器中, 如下图:

通过@ConditionalOnProperty来决定MqConfig是否要加载,@ConditionalOnProperty的name就是配置项的名称,havingValue就是匹配的值,也就是在application配置中存在env=dev才会初始化MqConfig。代码如下:

@Configuration
@ConditionalOnProperty(name = "env", havingValue = "dev")
public class MqConfig {
@Bean(initMethod = "start", destroyMethod = "shutdown")
public ConsumerBean consumerBean() {
// ....
}
}

但这好像不符合小张同学的需求呀,需求是dev环境不加载才对。还有一个就是历史原因,增加一个环境有风险,因为对应的环境加载的内容什么的,都需要有变动,所以还是保留历史情况,环境不变,看能不能从其他的点解决这个问题。

现在面临的问题是不能增加新的环境,保留之前的test和prod。只需要在test和prod初始化Mq。

方案一:@ConditionalOnProperty

还是坚持使用@ConditionalOnProperty,既然不能通过环境来,我们可以单独增加一个属性来决定是否要启用Mq, 比如定义为:mq.enabled=true表示开启,mq.enabled=false表示不开启。

然后在test和prod启动的时候增加-Dmq.enabled=true或者在对应的配置文件中增加也可以,本地开发的时候-Dmq.enabled=false就可以了。

虽然能够解决问题,但是不是最佳的方案,因为已有的环境和开发人员本地都得增加启动参数。

方案二:继承SpringBootCondition自定义条件

可以使用@Conditional(MqConditional.class)注解,自定义一个条件类,在类中去判断是否要加载bean。

public class MqConditional extends SpringBootCondition {
@Override
public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
Environment environment = context.getEnvironment();
String env = environment.getProperty("env");
if (StringUtils.isBlank(env)) {
return ConditionOutcome.noMatch("no match");
}
if (env.equals("test") || env.equals("prod")) {
return ConditionOutcome.match();
}
return ConditionOutcome.noMatch("no match");
}
}

方案三:继承AnyNestedCondition自定义条件

可以使用@Conditional(MqAvailableCondition.class)注解,自定义一个条件类,在类中可以使用其他的Conditional注解来进行判断,比如使用@ConditionalOnProperty。

@Order(Ordered.LOWEST_PRECEDENCE)
public class MqAvailableCondition extends AnyNestedCondition {
public MqAvailableCondition() {
super(ConfigurationPhase.REGISTER_BEAN);
}
@ConditionalOnProperty(name = "env", havingValue = "test")
static class EnvTest {
}
@ConditionalOnProperty(name = "env", havingValue = "prod")
static class EnvProd {
}
}

方案四:@ConditionalOnExpression

支持SpEL进行判断,如果满足SpEL表达式条件则加载这个bean。这个就相当灵活了,可以将需要满足的条件都写进来。

@ConditionalOnExpression("#{'test'.equals(environment['env']) || 'prod'.equals(environment['env'])}")

上面的表达式定义了Spring Environment中只要有env为test或者prod的时候就会初始化MqConfig。这样一来老的启动命令都不用改变,本地开发的时候也不用增加参数,可以说是最佳的方案,因为改动的点变少了,出错的几率小,使用难度低。

故事二: 北方有佳人,绝世而独立

美女小杨同学最近也遇到了烦心事,虽然是女生,但是也工作了几年了。最近受到领导重用,让她搭一套Spring Cloud的框架给同事们分享一下。

她有个想法是将某些信息可以通过Feign或者RestTemplate进行传递,天然友好的方式就是在拦截器中统一实现。

如果在每个服务中都写一份一样的代码,就显得很低级了,所以她将这两个拦截器统一写在一个模块中,作为Spring Boot Starter的方式引入。

问题一

遇到的第一个问题是这个模块引入了Feign和spring-web两个依赖,想做的通用一点,就是使用者可能会用Feign来调用接口,也可能会用RestTemplate来调用接口,如果使用者不用Feign, 但是引入了这个Starter也会依赖Feign。

所以需要在依赖的时候设置Feign的Maven依赖optional=true,让使用者自己去引入依赖。

<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<optional>true</optional>
</dependency>

问题二

第二个问题是拦截器的初始化,如果不做任何处理的话两个拦截器都会被初始化,如果使用者没有依赖Feign,那么就会报错,所以我们需要对拦截器的初始化进行处理。

下面是默认的配置:

@Bean
public FeignRequestInterceptor feignRequestInterceptor() {
return new FeignRequestInterceptor();
}
@Bean
public RestTemplateRequestInterceptor restTemplateRequestInterceptor() {
return new RestTemplateRequestInterceptor();
}

两个拦截器都是实现框架自带的接口,所以我们可以在最外层使用@ConditionalOnClass来判断如果项目中存在这个Class再装置配置。

第二层可以通过@ConditionalOnProperty来决定是否要启用,将控制权交给使用者。

@Configuration
@ConditionalOnClass(name = "feign.RequestInterceptor")
protected static class FeignRequestInterceptorConfiguration {
@Bean
@ConditionalOnProperty("feign.requestInterceptor.enabled")
public FeignRequestInterceptor feignRequestInterceptor() {
return new FeignRequestInterceptor();
}
}
@Configuration
@ConditionalOnClass(name = "org.springframework.http.client.ClientHttpRequestInterceptor")
protected static class RestTemplateRequestInterceptorConfiguration { @Bean
@ConditionalOnProperty("restTemplate.requestInterceptor.enabled")
public RestTemplateRequestInterceptor restTemplateRequestInterceptor() {
return new RestTemplateRequestInterceptor();
} }

故事三:自己去学习

文章里只根据案例讲了一个使用的方式,当然还有很多没有讲的,大家可以自己去尝试了解一些作用以及在什么场景可以使用,像@ConditionalOnBean,@ConditionalOnMissingBean等注解。

另一种学习的方式就是鼓励大家去看一些框架的源码,特别在Spring Cloud这些框架中大量的自动配置,都有用到这些注解,我贴几个图给大家看看。

为了控制Bean的加载我使出了这些杀手锏的更多相关文章

  1. 如果你还不知道如何控制springboot中bean的加载顺序,那你一定要看此篇

    1.为什么需要控制加载顺序 springboot遵从约定大于配置的原则,极大程度的解决了配置繁琐的问题.在此基础上,又提供了spi机制,用spring.factories可以完成一个小组件的自动装配功 ...

  2. spring源码学习之bean的加载(二)

    这是接着上篇继续写bean的加载过程,好像是有点太多了,因为bean的加载过程是很复杂的,要处理的情况有很多,继续... 7.创建bean 常规的bean的创建时通过doCreateBean方法来实现 ...

  3. 【Spring】详解Spring中Bean的加载

    之前写过bean的解析,这篇来讲讲bean的加载,加载要比bean的解析复杂些,该文之前在小编原文中有发表过,要看原文的可以直接点击原文查看,从之前的例子开始,Spring中加载一个bean的方式: ...

  4. Spring 系列教程之 bean 的加载

    Spring 系列教程之 bean 的加载 经过前面的分析,我们终于结束了对 XML 配置文件的解析,接下来将会面临更大的挑战,就是对 bean 加载的探索.bean 加载的功能实现远比 bean 的 ...

  5. 【Spring源码深度解析学习系列】Bean的加载(六)

    Bean的加载所涉及到的大致步骤: 1)转换对应beanName 为什么需要转换beanName呢?因为传入的参数可能是别名,也可能是FactoryBean,所以需要一系列的解析,这些解析内容包括如下 ...

  6. Spring源码分析(十一)bean的加载

    摘要:本文结合<Spring源码深度解析>来分析Spring 5.0.6版本的源代码.若有描述错误之处,欢迎指正. 经过前面的分析,我们终于结束了对XML配置文件的解析,接下来将会面临更大 ...

  7. Spring之23:AbstractBeanFactory,Bean的加载

    <spring源码之:循环依赖> AbstractBeanFactory的作用:别名管理,单例创建与注册,工厂方法FactoryBean支持. 由图我们直接的看出,AbstractBean ...

  8. spring源码学习之bean的加载(一)

    对XML文件的解析基本上已经大致的走了一遍,虽然没有能吸收多少,但是脑子中总是有些印象的,接下来看下spring中的bean的加载,这个比xml解析复杂的多.这个加载,在我们使用的时候基本上是:Bea ...

  9. Js控制iFrame切换加载网址

    <html> <head> <title>Js控制 iFrame 切换加载网址</title> </head> <body> & ...

随机推荐

  1. SQL server 基本语句

    --查询数据库是否存在 if exists ( select * from sysdatabases where [name]='TestDB') print 'Yes, the DB exists' ...

  2. linux入门系列5--新手必会的linux命令

    上一篇文章"linux入门系列4--vi/vim编辑器"我们讨论了在linux下如何快速高效对文本文件进行编辑和管理,本文将进一步学习必须掌握的linux命令,掌握这些命令才能让计 ...

  3. 解决elment 动态多选框组(el-checkbox-group)无法设置默认值问题

    <el-checkbox-group v-model="form.showProperty"> <el-checkbox v-for="(item,id ...

  4. C#调用JS的WebService的方法返回null

    连上了别人的VPN后,使用WebService测试软件测试了一下,结果正常,但是当我在vs里面添加WebService服务,调用的时候就出现了问题,问题如下图: 后来问了一下服务端那边的同事,他们说服 ...

  5. 如何在ArcGIS中恢复注记文字

    文字标注是地图上一种特殊的视觉元素,可通过文字表达图形符号难以说明的地图内容,它与图形符号结合在一起存在于地图上,是关乎地图构图美的关键因素之一. MapGIS软件下子图对象和注释对象统统保存在点文件 ...

  6. Manacher 学习

    推荐博客 :https://blog.csdn.net/zzkksunboy/article/details/72600679 作用 线性时间解决最长回文子串问题. 思想 Manacher充分利用了回 ...

  7. Linux.vim.多行复制、删除、剪切

    复制: //单行复制+粘贴 yy + p:复制光标所处当前行, 敲p粘贴在光标处. //多行复制+粘贴 n + yy + p:复制光标所在行起以下n行(含当前行), 敲yy复制光标所处当前行, 敲p粘 ...

  8. MySQL 相关规约(v1.0) (转)

    0)前言 a. 基本规约 [强制]表存储引擎必须使用InnoDB(针对主库一般是强制要求的) [强制]表字符集默认使用utf8,必要时候使用utf8mb4(个人踩坑:emoji表情存储问题)•说明:• ...

  9. mongo 的 中文社区的 文档还是 挺不错的

    英文文档也奉上: http://api.mongodb.com/csharp/2.2/html/T_MongoDB_Bson_Serialization_Attributes_BsonIdAttrib ...

  10. GCC编译Win图形程序不显示控制台方法

    用VS编译openCV这些有控制台又有图形显示的程序,如果想隐藏控制台,只需要使用一行代码: #pragma comment( linker, "/subsystem:/"wind ...