在SpringBoot2中开发特征切换功能

翻译：吴嘉俊，叩丁狼高级讲师。 

众所周知，软件开发是一个协同的活动。开发中的整合工作往往都被视为邪恶的，开发人员会像魔鬼一样对待这个过程。为了应付这种情况，有非常多的方法和规则被开发出来。特征切换就是其中之一。在本文中，你将会看到什么是特征切换，了解特征标记，以及如何在你的Springboot应用中使用。

什么是特征切换

简单来说，特征切换是控制程序按照某种流程执行的一个变量开关。不用修改代码，就能切换到不同的执行场景的方式。

根据自身需求，用于特征切换的变量值可以在应用启动的时候就设置好，或者在运行期间根据需要进行调整。针对后一种情况，只需要把特征切换变量值持久化下来，在实际运行的时候去获取即可。

你应该了解过特征标志的另一种实现方案：按照特征代码分支。在实际的开发中，这两种技术可以组合起来使用。比如，针对一个新的用户故事（User Story），可以使用特征分支，同时，也可以使用特征切换来控制在针对不同的场景的用户需求。

不过，虽然特征切换有很多适用场景，但是它仍然有自己的缺点。最大的一个问题就在于它的复杂性。如果没有一个良好的管理策略，特征切换会很容易失去控制，变成项目的一个噩梦。幸运的是，如果你遵循几个最佳实践，使用特征切换会变得非常容易。

使用特征切换来选择合适的Bean

在Springboot的应用中，使用特征切换最常见的场景是，给定一个接口，根据特征值切换到一个不同的实现类。我们来简单看下这种场景：

抽象依赖

考虑一个场景：在一个web服务端中，提供了从数据库中筛选一个货品列表的功能。你现在的目标就是创建一个特征切换，允许动态的选择不同的数据库源提供给web服务。

想要使用特征切换，第一个要做的事情，就是把提供给其他类使用的依赖，使用接口抽象。

下面的代码展示了一个商品的REST接口，依赖于ProductRepository接口：

@RestController
@RequestMapping("/products")
class ProductController {

   private final ProductRepository productRepository;

   ProductController(ProductRepository productRepository) {
       this.productRepository = productRepository;
   }

   @GetMapping
   Collection<Product> getAll() {
       return productRepository.findAll();
   }

}

目前，我们只有一个ProductRepository的实现，接下来，当我们要添加另一个ProductRepository实现的时候，我们就需要考虑特征切换了。

@Repository
class DbProductRepository implements ProductRepository {
    //...
}

在application.properties中添加特征切换配置

我们知道Springboot应用使用application.properties文件来完成配置。这个文件是一个非常好的用于放置特征标志的地方。

feature.toggles.productsFromWebService=true

在提交代码的时候，设置该标志值为false。在这种情况下，团队组员默认情况下，是关闭了这个功能的。如果谁想使用这个功能，只需要在本地开发环境中，把值设置为true即可。

创建条件控制Bean

下一步要做的就是创建另一个ProductRepository实现，并且这个实现通过特征切换来激活。你可以使用Springboot提供的@ConditionalOnProperty注解来实现bean和配置文件中的属性的绑定，只需要在注解中设置好配置的属性名称和值即可。

@Repository
@ConditionalOnProperty(
       name = "feature.toggles.productsFromWebService",
       havingValue = "true"
)
class WebServiceProductRepository implements ProductRepository {
    //...
}

在启动应用之前，先把DbProductRepository禁用，否则，我们就会得到一个“multiple active implementations of the interface”的异常。我们回到之前的DbProductRepository的实现，同样修改代码：

@Repository
@ConditionalOnProperty(
       name = "feature.toggles.productsFromWebService",
       havingValue = "false",
       matchIfMissing = true
)
class DbProductRepository implements ProductRepository {

两个实现类使用同一个特征切换名称（feature.toggles.productsFromWebService），只是对应的值做了区分。设置matchIfMissing属性值是可选的，这个配置表明，即使在application.properties文件中删除了feature.toggles.productsFromWebService这个配置项，DbProductRepository实现会作为默认实现被选中。

使用特征切换控制Controller

当然，我们可以使用相同的策略来控制所有的Controller。你不需要创建一个额外的接口，因为对Controller的控制，只需要切换某一个Controller是否可用。

@RestController
@RequestMapping("/coupons")
@ConditionalOnProperty(name = "feature.toggles.coupons", havingValue = "true")
class CouponController {
  //...
}

在application.properties文件里面应该包含如下内容：

feature.toggles.coupons=true

如果这个值设置为false，那么SpringMVC不会去初始化这个Controller，如果访问/coupons，得到404异常。

可惜的是，@ConditionalOnProperty注解不能用于单个的方法之上，所以，如果想要单独控制某个请求，只能将这个请求方法独立到一个Controller中。另一种方案，我们可以把特征切换值直接注入到请求方法参数列表中，通过该值来控制。但是这种方案需要及其小心，后面会介绍。

private final boolean couponsToggled;

CouponController(@Value("${feature.toggles.coupons}") boolean couponsToggled) {
   this.couponsToggled = couponsToggled;
}

@GetMapping
List<String> listCouponNames() {
   if (!couponsToggled) {
       throw new NotSupportedException();
   }
   //...
}

多个特征切换管理

As you can read about feature toggles on Martin Fowler’s bliki, feature flags have a tendency to spread across the codebase and can quickly get unmanageable. Even if you have just a few feature toggles in your application, it’s better to abstract the storage of your flags from decision points in which they are used.

在Martin Flower的博客中有提到过，特征标志极有可能贯穿整个代码库，并且容易快速趋于不可控。所以，即使你应用中只有几个特征切换，最好把特征标志从具体的应用点抽取出来。

避免特征标志耦合

CouponController(@Value("${feature.toggles.coupons}") boolean couponsToggled) {
   this.couponsToggled = couponsToggled;
}

在上文这段代码案例中，我们是直接把标志值从application.properties文件中注入到方法中，并没有抽象出任何的存储层。如果你在应用其他地方同样使用了这个标记（比如另一个.properties文件），那么这个注入会出现冲突的异常。

作为替换的方案，我们可以把所有的特征值全部放到一个单独的类中，把这个类作为唯一的依赖。使用额外的一个类，会给与应用更多的灵活性，比如你可以在这个类中，从数据库中加载特征切换值，而不用从.properties文件中获取，这样我们就可以做到在运行时动态切换特征。

在Springboot中提取特征切换值

当你把特征切换值抽取到独立的bean中，我们就可以使用@ConfigurationProperties注解轻松的从application.properties中加载所有的值。下面是一个简单的示例：

@Component
@ConfigurationProperties("feature")
public class FeatureDecisions {

   private Map<String, Boolean> toggles = new HashMap<>();

   public Map<String, Boolean> getToggles() {
       return toggles;
   }

   public boolean couponEnabled() {
       return toggles.getOrDefault("coupons", false);
   }

}

上面的代码中，我们会把所有application.properties文件中以feature.toggles开头的值自动注入到toggles这个Map中。在类中，我们提供了一个couponEnabled()方法来抽象出特征切换点，通过这个方法，把具体的特征切换值的获取逻辑封装了起来。

当然，你需要引入一个额外的依赖来处理@ConfigurationProperties。

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-configuration-processor</artifactId>
</dependency>

在Actuator中监控特征切换

在讨论了特征切换在普通情况下的使用，接下来我们简单看一下在一个Actuator端点中监控我们的特征切换状态。如下代码所示：

@Component
@Endpoint(id = "feature-toggles")
class FeatureToggleInfoEndpoint {

   private final FeatureDecisions featureDecisions;

   FeatureToggleInfoEndpoint(FeatureDecisions featureDecisions) {
       this.featureDecisions = featureDecisions;
   }

   @ReadOperation
   public Map<String, Boolean> featureToggles() {
       return featureDecisions.getToggles();
   }

}

如果你使用的是Springboot2默认的Actuator设置，这个端点是不会被发布为HTTP服务的。我们需要把这个endpoint的id添加到applicaiton.properties配置中的include filter中：

management.endpoints.web.exposure.include=health,info,feature-toggles

启动应用，访问 http://localhost:8080/actuator/feature-toggles地址，就可以看到我们的特征切换值状态了：

当然，根据自己的需求，我们也可以使用@WriteOperation创建一个可用于在运行时修改特征切换值的Actuator端点。这个例子中只演示了监控。

小结

在本篇文章中，你可以学到如何在Springboot应用中应用特征切换。我们从一个最基础的例子开始，覆盖到了大部分的特征切换需求。接着，我们针对一个特殊的情况，介绍了特征值的抽取和管理，最后，我们介绍了如何通过发布一个Actuator端点来监控应用的特征切换值状态。

原文：http://dolszewski.com/spring/feature-toggle-spring-boot/