设计模式学习笔记 - 项目实战三：设计实现一个支持自定义规则的灰度发布组件（分析）

概述

到现在为止，我们已经学习了接口限流框架和接口幂等框架两个实战项目。接下来，再带你实战一个新的项目：灰度发布组件。这是最后一个实战项目。还是老套路，把它分为分析、设计、实现三个部分，对应三篇文章来讲解。本章，我们对灰度发布组件进行需求分析，搞清楚这个组件应该具有哪些公功能性需求和非功能性需求。

---

需求场景

还记得之前接口限流和幂等框架的项目背景吗？我们开发了一个公共服务平台，提供公共业务功能，给其他产品的后端系统使用，避免重复开发相同的业务。

最初，公共服务平台提供的是，基于某个开源 RPC 框架的 RPC 格式的接口。在上线一段时间后，发现这个开源 RPC 框架的 Bug 很多，多次因为框架本身的 Bug，导致整个公共服务平台的接口不可用，但因因为团队成员对框架源码不熟悉，并且框架的代码质量本身也不高，排查、修复起来花费了很长时间，影响面非常大。所以，评估下来之后，决定最终替换掉它。

对于引入新框架，我们的要求是成熟、简单，并且与我们现有的技术栈（Spring）相吻合。这样，即便除了问题，我们也能利用之前积累的知识、经验来快速解决。所以，我们决定直接使用 Spring 框架来提供 RESTful 格式的远程接口。

把 RPC 接口替换成 RESTful 接口，除了需要修改公共服务平台的代码之外，调用方的接口调用代码也要做相应的修改。此外，对于公共服务平台的代码，尽管我们只是改动接口暴露方式，对业务代码基本上没有改动，但是，我们也并不能保证就完全不出问题。所以，为了保险起见，我们希望灰度替换掉老的 RPC 服务，而不是一刀切。

我们来看下具体如何来做。

因为替换的过程是灰度的，所以老的 RPC 服务不能下线，同时还要部署另外一套新的 RESTful 服务。我们先让业务不是很重要、流量不大的某个调用方，替换成调用新的 RESTful 接口。经过这个调用方一段时间的验证之后，如果新的 RESTful 接口没有问题，我们再逐步让其他调用方，替换成调用新的 RESTful 接口。

但是，如果万一中途出现问题，我们就需要将调用方的代码回滚，再重新部署，这就会导致调用方一段时间内服务不可用。而且，如果新的代码还包含调用方自身新的业务代码，简单通过 Git 回滚代码重新部署，会导致新的业务代码也被回滚。所以，为了避免这种情况发生，我们就得手动将调用新的 RESTful 接口的代码删除，再改回为调用老的 RPC 接口。

此外，为了不影响调用方本身业务的开发进度，调用方基于回滚之后的老代码，来做新功能开发，那替换成 RESTful 接口的那部分代码，要想再重新 merge 回去就比较难了，有可能会出现代码冲突，需要再重新开发。

怎么解决代码回滚成本比较高的问题呢？

在替换新的接口调用方式时，调用方不用直接将 RPC 接口的代码逻辑删除，而是新增调用 RESTful 接口的代码，通过一个功能开关，灵活切换走老的代码逻辑。代码示例如下所示。如果 callRestfulApi 为 true，就会走新的代码逻辑，调用 RESTful 接口，相反，就会走老的代码逻辑，继续调用 RPC 接口。

boolean callRestfulApi = true;
if (!callRestfulApi) {
	// 老的调用RPC接口的代码逻辑
} else {
	// 老新调用RESTful接口的代码逻辑
}

不过，更改 callRestfulApi 的值需要修改代码，而修改代码需要重新部署，这样的设计还不够灵活。优化的方法是，把这个值放到配置文件或者配置中心就可以了。

为了更加保险，不只是使用功能开关做新老接口调用方式的切换，我们还希望调用方在替换某个接口时，先让小部分接口请求，调用新的 RESTful 接口，剩下的大部分接口请求，还是调用老的 RPC 接口，验证没问题后，在逐步加大调用新接口的比例，最终，将所有的接口请求都替换成调用新的接口。这就是所谓的 “灰度”。

那这个灰度功能又该如何实现呢？

首先，我们要决定使用什么来做灰度，也就是灰度的对象。我们可以针对携带时间戳信息、业务 ID 等信息，按照区间、比例或者具体的值来做灰度。我举个例子来解释下。

假设，我们要灰度的是根据用户 ID 查询用户信息接口。接口请求会携带用户 ID 信息，所以，我们可以把用户 ID 作为灰度的对象。为了实现逐渐放量，我们先配置用户 ID 是 918、879、123（具体的值）的查询请求调用新接口，验证没有问题之后，再扩大范围，让用户 ID 再 1020~1120 （区间值）之间的查询请求调用新接口。

如果验证之后还是没有问题，我们再继续扩大范围，让 10%（比例值）的查询请求调用新接口（对应用户 ID 跟 10 取模求余小于 1 的请求）。依此类推，灰度范围逐步扩大到 20%、30%、50% 直到 100%，并且运行一段时间没有问题之后，调用方就可以把老代码逻辑删除了。

实际上，类似的灰度需求场景还是很多的。比如，在金融产品的清结算系统中，我们修改了清结算的算法。为了安全起见，我们可以灰度替换新的算法，把贷款 ID 作为灰度对象，先对某几个贷款应用新的算法，如果没有问题，再继续按照区间或者比例，扩大灰度范围。

此外，为了保证万无一失，提前做好预案，添加或修改一些复杂功能、核心功能，即便不做灰度，我们也建议通过功能开关，灵活控制这些功能的上下线。在不需要重新部署或重启系统的情况下，做到快速回滚或新老代码逻辑的切换。

需求分析

从实现角度来讲，调用方只需要把灰度规则和功能开关，按照某种事先约定好的格式，存储到配置文件或者配置中心，在系统启动时，从中读取配置到内存后，看灰度对象是否落在灰度范围内，依此来判定是否执行新的代码逻辑。但为了避免每个调用方都重复开发，我们把功能开关和灰度相关的代码，抽象封装为一个灰度组件，提供给各个调用方来服用。

这里需要强调一点，这里的灰度，是代码级别的灰度，目的是保证项目质量，规避重大代码修改带来的不确定性风险。实际上，我们平时经常将的灰度，一般都是产品层面或者系统层面的灰度。

• 所谓产品层面，有限类似 A/B Testing，让不同的用户看到不同的功能，对比两组用户的使用体验，收集数据，改进产品。
• 所谓系统层面的灰度，往往不在代码层面上实现，一般是通过配置负载均衡或者 API-Gateway，来实现流量分配到不同版本的系统上。

系统层面的灰度是为了平滑上线功能，但比起我们讲到的代码层面的灰度，就没有那么细粒度了，开发和运维成本也相对要高些。

现在，我们就来具体看下，灰度组件有哪些功能性需求。

我们还是从使用的角度来分析。组件使用者需要设置一个 key 值，来唯一标识要灰度的功能，然后根据自己业务的特点，选择一个灰度对象（比如用户 ID），在配置文件或者配置中心，配置这个 key 对应地灰度规则和功能开关。配置的格式类似下面这个样子。

features：
- key: call_newapi_getUserById
  enabled: true // enabled为true时，rule才生效
  rule: {893,342,1020-1120,%30} // 按用户ID来做灰度
- key: call_newapi_registerUser
  enabled: true
  rule: {1391198723, %10} // 按手机号来做灰度
- key: newlog_loan
  enabled: true
  rule: {0-1000} // 按照贷款的金额(loan)来做灰度

灰度㢟在业务系统启动时，会将这个灰度配置，按照实现定义的语法，解析并加载到内存对象中，业务系统直接使用组件提供的灰度判定接口，来判定某个灰度对象是否灰度执行新的代码逻辑。配置的加载、灰度判定逻辑这部分代码，都不需要业务系统来从零开发。

public interface DarkFeature {
	boolean enabled();
	boolean dark(String darkTarget); // darkTarget 是灰度对象，比如前面提到的用户ID、手机号码、金额等
}

所以，总结一下的话，灰度组件跟限流框架很类似，它也主要包含两部分功能：灰度规则配置解析和提供编程接口（DarkFeature）判定是否灰度。

跟限流框架类似，除了功能性需求，我们还要分析非功能性需求。不过，因为前面已经有了限流框架的非功能性需求的讲解，对灰度组件的非功能性需求，其实和它类似，你可以先自己分析下。在下篇文章，到时再给出分析思路。

总结

灰度发布可以分为三个层面的灰度：产品层面的灰度、系统层面的灰度和代码层面的灰度。本章重点讲解代码层面的灰度，通过编程来控制是否执行新的代码逻辑，以及灰度执行新的代码逻辑。

代码层面的灰度，主要解决代码质量问题，通过逐渐放量灰度执行，两降低重大代码改动带来的风险。在出问题之后，在不需要修改代码、重新部署、重启系统的情况下，实现快速的回滚。相对于系统层面的灰度，它可以做的更加细粒度，更加灵活、简单、好维护，但也存在着代码侵入的问题，灰度代码跟业务代码耦合在一起。

灰度组件跟之前讲过的限流框架类似，主要包含配置的解析加载和灰度判定逻辑。此外，对于非功能性需求，在下篇文章讲解。