@Conditional on properties 用法

需求：如何封装spring cloud 的不同的注册中心，比如eureka， zookeeper，consul。 如何封装不同的http rpc 客户端，比如 Ribbon.

实现：

这个需求其实很简单，下面记录自己解决问题的探索过程。

如何封装不同的配置中心呢？ 首先我们得了解下spring cloud 的自动装配简单常识。（1）. 在maven 或者 gradle 加入相关的依赖之后，springboot 就会自动的加载相关的类到classpath，比如eureka，会自动的装载 EurekaClientAutoConfiguration.class，并生成相关beans。（2）生成相关的bean有各种注解，比如@imported，@ComponentScan，@Service，@Compoent，@Repository 等。 @Order 可以控制类的加载顺序，@order 越小，越先运行

其实对于这样的需求，程序员第一反应应该都是根据条件加载，但是我们应该如何做呢？@Conditional 有各种， 比如@ConditionalOnClass， @ConditionalOnBean，@ConditionalOnMissingbean，@ConditionalOnProperty， 他们都应该去继承SpringBootCondition，实现接口Condition。因为我们想写成SDK的方式，所以最后能够通过配置的方式来启动不同的bean，实现SDK 支持多个配置中心，而且可以支持多种的http rpc 客户端。因此我选择了@ConditionalOnProperty的方式来加载不同的beans。

因此第一步，我打算extends SpringBootCondition，不是使用@ConditionalOnProperty。重写了method getMatchOutcome。因此写了个annotation ConditionOnMyProperties，并需要注解@Conditional。@Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnMyPropertiesCondition.class)public @interface ConditionOnMyProperties {Stringname();}，  然后define OnMyPropertiesCondition extends SpringBootCondition

public ConditionOutcomegetMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {

Object propertiesName = metadata.getAnnotationAttributes(ConditionOnMyProperties.class.getName()).get("name");String applicationFrameworkName = context.getEnvironment().getProperty("application.framework.name");

其中application.framework.name 就是 配置的key，应用程序可以根据这个配置来切换加载不同的beans。 return new ConditionOutcome(true, "application framework " + applicationFrameworkName +" beans loaded");  当return ConditionOutcome 是true 的时候，表示加载这个beans， 当返回false的时候，不加载这个beans。 所以我们就可以重写ConditionOutcomegetMatchOutcome打显身手。

第二步： 

For eureka, 

@Configuration

@ConditionOnMyProperties(name = HttpClientNameType.SPRINGCLOUD_EUREKA)

@EnableSpringCloudStarter

@EnableAutoConfiguration

public class SpringCloudEurekaConfig {

}

其中@ConditionOnMyProperties(name = HttpClientNameType.SPRINGCLOUD_EUREKA)，就可以依据 application 配置的值application.framework.name 来判断是否要不要加载。 此外@EnableSpringCloudStarter是我自己写的annotation，里面加了@EnableDiscoveryClient， @EnableCircuitBreaker。其中SpringCloudZookeeperConfig 也可以这么配置。但是当启动的springboot的时候，新的问题来了， 你会发现eureka的注册中心，会去连zookeeper的注册中心。这个时候你会发现 前面说的（1）常识是多么重要。那肯定是有别的bean自动的加载到context中去了， 经过调试，对于eureka，需要这样配置@EnableAutoConfiguration(exclude = {ZookeeperAutoConfiguration.class, RibbonZookeeperAutoConfiguration.class})， 剔除ZookeeperAutoConfiguration 和RibbonZookeeperAutoConfiguration的自动注解。另外 需要在OnMyPropertiesCondition class中加入环境变量System.setProperty("spring.cloud.zookeeper.discovery.enabled", "false"); 对于zookeeper，就需要加入System.setProperty("eureka.client.enabled", "false"); 这样问题就很容易的解决了，是不是觉得很简单？ springboot 封装的东西太多，都不知道里面发生了啥。

缺点：无关的class 会加载到jvm中，jar 冲突的时候，可能不好解决。

后面会继续介绍些vertx的心得。