基于Spring Cloud Sentinel自研Slot扩展实战
文章目录
- 前言
- 一、Sentinel Slot Chain工作机制
- 二、实战:开发自定义Slot
- 步骤一、创建自定义Slot类
- 步骤二、注册自定义Slot到Slot Chain
- 三、集成到Spring Cloud环境
- 四、高级技巧与注意事项
- 总结
前言
Spring Cloud Sentinel作为微服务架构中流量控制与熔断降级的核心组件,其核心逻辑通过Slot Chain(插槽链) 实现。Sentinel内置了许多Slot(如流量统计、熔断降级、系统保护等),但在实际业务场景中,可能需要扩展自定义逻辑(如参数校验、业务埋点等)。本文将手把手教你如何基于Spring Cloud Sentinel自研Slot,并将其集成到Slot Chain中。
一、Sentinel Slot Chain工作机制
Sentinel的规则校验和流量控制通过责任链模式实现,每个ProcessorSlot负责一项具体任务。当请求进入时,Slot Chain会按顺序执行以下逻辑:
- NodeSelectorSlot:资源节点创建
- ClusterBuilderSlot:集群节点统计
- StatisticSlot:实时指标统计
- FlowSlot:流量控制规则校验
…(其他内置Slot)
Sentinel的设计原理我上一篇博客有详细说过,这里不再深入探讨了。
那么为什么需要自定义Slot? 我觉得有下面几个场景需要自定义Slot扩展:
- 业务埋点监控:在流量入口处采集自定义参数(如用户ID、设备类型)。
- 动态参数路由:根据请求参数动态决策是否触发熔断或限流。
- 规则前置校验:在Sentinel核心规则校验前执行自定义逻辑(如黑名单过滤)。
二、实战:开发自定义Slot
步骤一、创建自定义Slot类
继承AbstractLinkedProcessorSlot并实现核心方法:
public class CustomParamSlot extends AbstractLinkedProcessor<Object> {@Overridepublic void entry(Context context, ResourceWrapper resourceWrapper, Object param, int count, boolean prioritized, EntryType type, Throwable... args) throws Throwable {// 1. 前置处理:获取请求参数String userId = parseUserId(param);System.out.println("[CustomParamSlot] 捕获请求,用户ID: " + userId);// 2. 自定义规则校验(示例:禁止特定用户访问)if ("blocked_user".equals(userId)) {throw new BlockException("用户被限制访问");}// 3. 触发下一个Slot的执行fireEntry(context, resourceWrapper, param, count, prioritized, type, args);}@Overridepublic void exit(Context context, ResourceWrapper resourceWrapper, int count, Object... args) {// 后置处理(可选)fireExit(context, resourceWrapper, count, args);}private String parseUserId(Object param) {// 根据实际业务解析参数,例如从HttpServletRequest中获取return "user123";}
}
步骤二、注册自定义Slot到Slot Chain
通过SPI机制将Slot添加到责任链中:
- 创建SPI配置文件
在resources/META-INF/services目录下新建文件com.alibaba.csp.sentinel.slotchain.ProcessorSlot,内容为自定义Slot的全限定名:com.yourpackage.CustomParamSlot - 调整Slot执行顺序(可选)
若要控制Slot的执行顺序,可通过@SpiOrder注解指定优先级(值越小优先级越高):
@SpiOrder(-100) // 在默认Slot之前执行
public class CustomParamSlot extends AbstractLinkedProcessorSlot<Object> { ... }
三、集成到Spring Cloud环境
- pom文件导入依赖
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-sentinel</artifactId><version>2022.0.0.0</version>
</dependency>
- 验证自定义Slot
编写测试Controller触发Sentinel规则:
@RestController
public class TestController {@GetMapping("/test")@SentinelResource(value = "testResource", blockHandler = "handleBlock")public String test() {return "Hello Sentinel!";}// 限流降级处理public String handleBlock(BlockException ex) {return "请求被拦截:" + ex.getMessage();}
}
测试场景:
- 访问 /test 接口,观察控制台输出自定义Slot的日志。
- 在CustomParamSlot中模拟抛出BlockException,验证请求是否被拦截。
四、高级技巧与注意事项
- 获取真实请求参数
若需要从HTTP请求中获取参数(如Header、Body),可通过以下方式:
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
String userId = request.getHeader("UserId");
- 动态配置开关
结合Nacos或Apollo实现动态启用/禁用Slot:
public void entry(...) {if (dynamicConfig.isCustomSlotEnabled()) {// 执行业务逻辑}fireEntry(...);
}
- 常见问题排查
- Slot未生效: 检查SPI文件路径是否正确,避免Spring Boot的FatJar打包问题。
- 执行顺序不符合预期: 调整@SpiOrder的优先级值。
- 性能影响: 避免在Slot中执行耗时操作(如远程调用)。
总结
通过自定义Slot扩展,开发者可以在Sentinel流量管控的各阶段插入业务逻辑,实现高度定制化防护。这种灵活性正是Sentinel区别于其他流量治理组件的核心优势。建议根据实际业务需求,合理设计Slot职责,并做好性能监控。
扩展思考:
- 如何结合Sentinel Dashboard展示自定义Slot的监控数据?
- 如何实现基于业务QPS的集群限流?
参考:
Sentinel官方Demo-自定义Slot
Spring Cloud Alibaba Sentinel源码解析