关于sentinel:聊聊因不恰当使用alibaba-sentinel而踩到的坑

前言

sentinel 是面向分布式服务架构的流量管制组件，次要以流量为切入点，从限流、流量整形、熔断降级、零碎负载爱护、热点防护等多个维度来帮忙开发者保障微服务的稳定性。自从 hytrix 2018 年进入保护状态，再到 springcloud 2020.0 版本 hytrix 被移除，就能够预想将来一段时间 springcloud 全家桶的熔断降级组件基本上的首选就是 alibaba sentinel。

明天就来聊聊因不失当应用 alibaba sentinel，而导致熔断降级生效的一些例子。因为 sentinel 还在一直迭代更新中，不同版本会有一些差别，而且在版本的迭代中，有些问题可能也曾经修复。

本文演示的版本应用的 sentinel-dashboard 是1.8.0。应用 springcloud alibaba 的版本为2.2.3.RELEASE

生效场景例子

1、降级不失效问题

a、起因剖析

我的项目中应用了自定义全局异样解决，而异样数或者异样比例的统计在

com.alibaba.csp.sentinel.adapter.spring.webmvc.AbstractSentinelInterceptor.afterCompletion

这个办法执行，
自定义全局异样的解决会先于

com.alibaba.csp.sentinel.adapter.spring.webmvc.AbstractSentinelInterceptor.afterCompletion

这个办法执行执行，
因为咱们在全局异样外面曾经对异样进行解决，比方转换为一个对象，这样导致 AbstractSentinelInterceptor.afterCompletion 无奈获取到异样，进而无奈统计异样数或者异样比例。

b、解决方案

在官网的 issue 中曾经有网友提出了解决思路
https://github.com/alibaba/Sentinel/issues/1281
和
https://github.com/alibaba/Sentinel/issues/404

因为我是在查 issue 的之前，就通过源码跟踪，找到答案，这边说下我的实现思路。我的思路是定义一个切面，在切面的 AfterThrowing 进行异样统计。因为切面会在全局异样之前执行。统计的源码我是间接把 sentinel 统计的源拷贝过去，外围代码如下

@Aspect
@Component
@Slf4j
public class StatisticsExceptionCountAspect {

    @Autowired
    @Lazy
    private BaseWebMvcConfig baseWebMvcConfig;

    @Pointcut("execution(* com.github.lybgeek.sentinel.controller..*.*(..))")
    public void pointcut(){}

    @AfterThrowing(pointcut = "pointcut()",throwing = "ex")
    public void afterAfterThrowing(Throwable ex){log.info("statisticsExceptionCount...");
        traceException(ex);
    }

    /**
     * 统计异样
     * @param ex
     */
    private void traceException(Throwable ex) {Entry entry = getEntryInRequest();
        if (entry != null) {Tracer.traceEntry(ex, entry);
        }
    }
    protected Entry getEntryInRequest() {RequestAttributes requestAttributes = RequestContextHolder.currentRequestAttributes();
        ServletRequestAttributes attributes = (ServletRequestAttributes)requestAttributes;
        HttpServletRequest request = attributes.getRequest();
        Object entryObject = request.getAttribute(baseWebMvcConfig.getRequestAttributeName());
        return entryObject == null ? null : (Entry)entryObject;
    }
}

2、受权规定不失效问题

a、起因剖析

我的项目中没有实现

com.alibaba.csp.sentinel.adapter.spring.webmvc.callback.RequestOriginParser

接口，导致无奈解析申请起源

b、解决方案

在我的项目中自定义申请起源解析器。示例代码如下

**
 * @description: 解析拜访起源，用于受权规定 -- 黑白名单。* 当要进行受权规定时，则必须配置 RequestOriginParser，否则受权规定无奈失效
 *
 **/
@Component
public class CustomRequestOriginParser implements RequestOriginParser {

    @Override
    public String parseOrigin(HttpServletRequest request) {String origin = request.getParameter("origin");
        if(!StringUtils.isEmpty(origin)){
            // 依据接口是否携带 origin 参数，如果携带参数为 origin=pc，// 且 sentinel-dashbord 受权规定，起源设置为 pc 时，则示意要对申请起源为 pc，进行黑白名单配置

            return origin;
        }
        // 如果没申请参数接口没有携带，则示意按 ip 进行黑白名单设置
        return request.getRemoteAddr();}
}

3、热点规定不失效问题

a、起因剖析

web 埋点如果以 url 作为资源名，规定不失效

b、解决方案

以 @SentinelResource 注解定义的 name 作为资源名

参考官网 issue
https://github.com/alibaba/Sentinel/issues/1734

配置热点规定配置 @SentinelResource 后，可能还会呈现

java.lang.reflect.UndeclaredThrowableException: null

解决办法：须要在办法中增加 throws BlockException 或增加 blockHandler 来解决异样

参考官网 issue

https://github.com/alibaba/Sentinel/issues/776

示例代码

    @GetMapping(value = "/paramFlowRule/{msg}")
    @ApiImplicitParams({@ApiImplicitParam(name="msg",defaultValue = "hello",value="信息", paramType = "path"),
    })
    @ApiOperation(value = "测试热点规定")
    @SentinelResource(value = "testParamFlowRule")
    public AjaxResult<String> testParamFlowRule(@PathVariable("msg") String msg) throws BlockException {System.out.println(String.format("msg : %s",msg));
        return AjaxResult.success("测试热点规定");
    }

总结

本文次要介绍了常见应用 alibaba sentinel 可能遇到的问题，不得说下阿里在国内开源做的真的挺好的，大部分问题在官网 issue 都能找到解答

文章下方的 demo 链接，提供其余熔断降级例子以及基于文件长久熔断降级配置的性能例子。感兴趣的敌人能够蛮看看。

demo 链接

https://github.com/lyb-geek/springboot-learning/tree/master/springboot-sentinel