【自研网关系列】过滤器链 -- 灰度发布过滤器-编程知识

🌈Yu-Gateway：：基于 Netty 构建的自研 API 网关，采用 Java 原生实现，整合 Nacos 作为注册配置中心。其设计目标是为微服务架构提供高性能、可扩展的统一入口和基础设施，承载请求路由、安全控制、流量治理等核心网关职能。

🌈项目代码地址：https://github.com/YYYUUU42/YuGateway-master

如果该项目对你有帮助，可以在 github 上点个 ⭐ 喔 🥰🥰

🌈自研网关系列：可以点开专栏，参看完整的文档

1、什么是灰度发布

1.2、灰度发布关键特点和概念：

1.2、全链路灰度发布

2、网关层实现灰度发布

1、什么是灰度发布

灰度发布（Gray Release）是一种软件部署和发布策略，用于逐步将新版本的应用或服务引入生产环境，以降低潜在的风险并确保系统的稳定性。在灰度发布中，新版本的应用或服务不会一次性全部暴露给所有用户，而是逐渐引入一小部分用户，然后根据观察结果决定是否继续推广新版本或回滚到旧版本。这种策略有助于在生产环境中验证新功能、修复潜在问题以及逐渐接受用户反馈。

1.2、灰度发布关键特点和概念：

渐进式发布：新版本逐渐替代旧版本，从一小部分用户开始，然后逐渐增加新版本的暴露范围。这可以是一个逐步增加百分比的用户，也可以是按照某种规则或条件选择的用户群体。
风险控制：通过逐渐发布，可以在早期发现和解决潜在问题，从而减轻生产环境中可能发生的故障或问题对整体系统的影响。
用户反馈：灰度发布过程中，可以收集用户的反馈和性能数据，帮助开发团队更好地了解新版本的行为和性能，以及用户的满意度。
回滚能力：如果在灰度发布期间发现了严重问题或故障，可以轻松回滚到旧版本，从而减少对用户和业务的负面影响。
分层策略：通常，灰度发布采用多层级策略，从开发环境到测试环境，再到生产环境，逐渐扩大发布的范围。这确保了新版本在不同环境中都经历了测试和验证。
自动化工具：灰度发布通常借助自动化工具和部署管道来简化流程，例如使用容器编排工具、部署蓝绿或金丝雀发布等。

灰度发布是现代软件开发和交付的一种最佳实践，它允许组织更加安全和可控地推出新功能，降低风险，提高可维护性，同时减少对用户的影响。这是特别适用于大规模和高可用性系统的策略，以确保系统的连续性和稳定性。

1.2、全链路灰度发布

全链路发布是一种软件交付策略，它强调在整个软件开发和交付过程中的每个环节都进行逐步验证和控制，以确保新版本的成功发布并降低风险。全链路发布覆盖了整个软件生命周期，包括开发、测试、部署、监控、用户反馈和持续改进等阶段。

灰度发布注重的是部署发布这个过程，而全链路发布则范围更加广，包含了开发的整个生命周期，从开发，测试，到部署，维护等。

2、网关层实现灰度发布

知道了灰度发布的概念之后，就可以实现网关层面的灰度发布

在网关这里实现灰度发布，首先按照灰度发布的概念，只有部分用户会使用的就是灰度发布后的服务，因此，首先需要判断当前请求是否为灰度发布后的版本

在请求头设定 gray_release 字段，如果为 true 表示当前为一个灰度发布的版本

这样就可以在灰度发布过滤器中，将这个请求传递下去，并且在请求头中设定当前请求是否为灰度发布请求

代码层面就比较简单的，就是如果请求头中是为 true，就在 GatewayContext 中设置的 gray 属性为 ture，完整代码：

/*** @author yu* @description 灰度发布过滤器*/
@FilterAspect(id = FilterConst.GRAY_FILTER_ID, name = FilterConst.GRAY_FILTER_NAME, order = FilterConst.GRAY_FILTER_ORDER)
public class GrayFilter implements Filter {private final Logger logger = LoggerFactory.getLogger(GrayFilter.class);private static String GRAY = "true";private static final int HASH_LENGTH = 1024;@Overridepublic void doFilter(GatewayContext ctx) {if (ctx == null || ctx.getRequest() == null) {// 如果ctx或ctx.getRequest()为null，则直接返回，避免NullPointerExceptionreturn;}String gray = ctx.getRequest().getHeaders().get(GRAY_FILTER_KEY);// 测试灰度功能待时候使用，可以手动指定其是否为灰度流量if (StringUtils.hasText(gray) && gray.equalsIgnoreCase(GRAY)) {logger.info("current user {} is set for grayService", ctx.getRequest().getClientIp());ctx.setGray(true);return;}// 选取部分灰度发布用户处理灰度流量String clientIp = ctx.getRequest().getClientIp();if (isValidClientIp(clientIp)) {// 使用取模运算改善边界条件int res = clientIp.hashCode() % HASH_LENGTH;if (res == 1) {logger.info("current client {} is selected for grayService", clientIp);ctx.setGray(true);}}}/*** 验证clientIp是否是有效的*/private boolean isValidClientIp(String clientIp) {// 正则表达式，用于验证IPv4地址的格式String ipv4Pattern = "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$";// 正则表达式，用于验证IPv6地址的格式String ipv6Pattern = "^(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$";// 如果clientIp为null或者为空，那么就返回falseif (clientIp == null || clientIp.isEmpty()) {return false;}// 如果clientIp匹配IPv4或IPv6的正则表达式，那么就返回true，否则返回falsereturn clientIp.matches(ipv4Pattern) || clientIp.matches(ipv6Pattern);}
}

这里主要就是根据服务id那里得到服务的实例，如果是请求头如果是true的话，就只会从服务实例中gray中为true的，如果服务实例中没有true的，就会报错

/*** 根据服务ID获取服务实例*/
public Set<ServiceInstance> getServiceInstanceByUniqueId(String uniqueId, boolean gray) {Set<ServiceInstance> instanceSet = serviceInstanceMap.get(uniqueId);if (CollectionUtils.isEmpty(instanceSet)) {return Collections.EMPTY_SET;}// 为灰度流量,返回灰度服务实例if (gray) {return instanceSet.stream().filter(ServiceInstance::isGray).collect(Collectors.toSet());}return instanceSet;
}

这个的话可以在 nacos 上修改，或者在请求接口中配置文件中修改

server:port: 8201api:registerAddress: 127.0.0.1:8848env: devgray: true