Spring实现Sentinel简单实例

2021-12-21

简介

Sentinel是阿里开源的项目，提供了流量控制、熔断降级、系统负载保护等多个维度来保障服务之间的稳定性。
官网：https://github.com/alibaba/Sentinel/wiki

特征

丰富的应用场景 ：Sentinel 承接了阿里巴巴近 10 年的双十一大促流量的核心场景，例如秒杀（即突发流量控制在系统容量可以承受的范围）、消息削峰填谷、集群流量控制、实时熔断下游不可用应用等。

完备的实时监控 ：Sentinel 同时提供实时的监控功能。您可以在控制台中看到接入应用的单台机器秒级数据，甚至 500 台以下规模的集群的汇总运行情况。

广泛的开源生态 ：Sentinel 提供开箱即用的与其它开源框架/库的整合模块，例如与 SpringCloud、Dubbo、gRPC 的整合。您只需要引入相应的依赖并进行简单的配置即可快速地接入Sentinel。

完善的 SPI 扩展点：Sentinel 提供简单易用、完善的 SPI 扩展接口。您可以通过实现扩展接口来快速地定制逻辑。例如定制规则管理、适配动态数据源等。

特性

与Hystrix区别

总体来说：

Hystrix常用的线程池隔离会造成线程上下切换的overhead比较大；Hystrix使用的信号量隔离对某个资源调用的并发数进行控制，效果不错，但是无法对慢调用进行自动降级；Sentinel通过并发线程数的流量控制提供信号量隔离的功能。

此外，Sentinel支持的熔断降级维度更多，可对多种指标进行流控、熔断，且提供了实时监控和控制面板，功能更为强大。

关于Sentinel与Hystrix的区别详见：https://developer.aliyun.com/article/633786

Sentinel 使用

Sentinel 的使用可以分为两个部分:

控制台（Dashboard）：控制台主要负责管理推送规则、监控、集群限流分配管理、机器发现等。
核心库（Java 客户端）：不依赖任何框架/库，能够运行于 Java 7 及以上的版本的运行时环境，同时对 Dubbo / Spring Cloud 等框架也有较好的支持。

Sentinel管理控制台

获取 Sentinel 控制台

release 页面下载最新版本的控制台 jar 包。

sentinel服务启动

1	java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard-1.8.1.jar

Sentinel客户端

引入依赖

// https://mvnrepository.com/artifact/com.alibaba.csp/sentinel-core
implementation group: 'com.alibaba.csp', name: 'sentinel-core', version: '1.8.1'

// https://mvnrepository.com/artifact/com.alibaba.csp/sentinel-annotation-aspectj
implementation group: 'com.alibaba.csp', name: 'sentinel-annotation-aspectj', version: '1.8.1'

SentinelAspectConfig

import com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Sentinel切面类配置
 */
@Configuration
public class SentinelAspectConfig {

    @Bean
    public SentinelResourceAspect sentinelResourceAspect() {
        return new SentinelResourceAspect();
    }

}

OrderQueryService

import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.slots.block.RuleConstant;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRule;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeRuleManager;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;
import org.springframework.stereotype.Service;

import javax.annotation.PostConstruct;
import java.util.ArrayList;
import java.util.List;

/**
 * 服务层
 */
@Service
public class OrderQueryService {

    /**
     * 通过Sentinel控制台定义限流熔断等规则
     *
     * @param orderId
     * @return
     */
    @SentinelResource("queryOrderInfo")
    public String queryOrderInfo(String orderId) {
        System.out.println("获取订单信息:" + orderId);
        return "return OrderInfo :" + orderId;
    }

    /**
     * 订单查询接口, 使用Sentinel注解实现限流
     *
     * @param orderId
     * @return
     */
    @SentinelResource(value = "getOrderInfo2", blockHandler = "handleFlowQpsException",
            fallback = "queryOrderInfo2Fallback")
    public String queryOrderInfo2(String orderId) {

        // 模拟接口运行时抛出代码异常
        if ("000".equals(orderId)) {
            throw new RuntimeException();
        }

        System.out.println("获取订单信息:" + orderId);
        return "return OrderInfo :" + orderId;
    }

    /**
     * 订单查询接口抛出限流或降级时的处理逻辑
     * 注意: 方法参数、返回值要与原函数保持一致
     *
     * @return
     */
    public String handleFlowQpsException(String orderId, BlockException e) {
        e.printStackTrace();
        return "handleFlowQpsException for queryOrderInfo2: " + orderId;
    }

    /**
     * 订单查询接口运行时抛出的异常提供fallback处理
     * 注意: 方法参数、返回值要与原函数保持一致
     *
     * @return
     */
    public String queryOrderInfo2Fallback(String orderId, Throwable e) {
        return "fallback queryOrderInfo2: " + orderId;
    }

    /**
     * 本类初始化后执行方法
     */
    @PostConstruct
    public void initDegradeRule() {

        // 定义限流规则
        List<FlowRule> rules = new ArrayList<FlowRule>();
        FlowRule rule = new FlowRule();
        rule.setResource("getOrderInfo2");
        // QPS控制在2以内
        rule.setCount(2);
        // QPS限流
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setLimitApp("default");
        rules.add(rule);
        FlowRuleManager.loadRules(rules);

//        // 定义熔断降级
//        List<DegradeRule> rules = new ArrayList<>();
//        DegradeRule rule = new DegradeRule();
//        rule.setResource("getOrderInfo2");
//        // 80s内调用接口出现异常次数超过5的时候, 进行熔断
//        rule.setCount(5);
//        rule.setGrade(RuleConstant.DEGRADE_GRADE_EXCEPTION_COUNT);
//        rule.setTimeWindow(80);
//        rules.add(rule);
//        DegradeRuleManager.loadRules(rules);
    }

}

OrderController

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 控制层
 */
@Controller
@RequestMapping("/order")
public class OrderController {

    @Autowired
    private OrderQueryService orderQueryService;

    @RequestMapping("/getOrder")
    @ResponseBody
    public String queryOrder1(@RequestParam("orderId") String orderId) {

        return orderQueryService.queryOrderInfo(orderId);
    }

    /**
     * 限流实现方式: 注解定义资源
     *
     * @param orderId
     * @return
     */
    @RequestMapping("/getOrder2")
    @ResponseBody
    public String queryOrder2(@RequestParam("orderId") String orderId) {
        return orderQueryService.queryOrderInfo2(orderId);
    }

}

测试

API访问速度超过设置的QPS，执行限流方法。

客户端接入控制台

引入依赖

// https://mvnrepository.com/artifact/com.alibaba.csp/sentinel-transport-simple-http
implementation group: 'com.alibaba.csp', name: 'sentinel-transport-simple-http', version: '1.8.1'

// https://mvnrepository.com/artifact/com.alibaba.cloud/spring-cloud-starter-alibaba-sentinel
implementation group: 'com.alibaba.cloud', name: 'spring-cloud-starter-alibaba-sentinel', version: '2.2.7.RELEASE'

application.yml

spring:
  application:
    name: demo

  cloud:
    sentinel:
      transport:
        port: 8720
        dashboard: localhost:8080

注意

为所有的 HTTP 服务提供限流埋点的是 CommonFilter。

有时候，需要多次访问应用中暴露的url，控制台dashboard中才会有对应的数据。

通过控制台配置流控规则

测试

参考

sentinel（史上最全+入门教程）

Quick Start Demo - github代码

Sentinel介绍与使用

简介

特征

特性

与Hystrix区别

Sentinel 使用

Sentinel管理控制台

获取 Sentinel 控制台

sentinel服务启动

登录

Sentinel客户端

引入依赖

SentinelAspectConfig

OrderQueryService

OrderController

测试

客户端接入控制台

引入依赖

application.yml

注意

通过控制台配置流控规则

测试

参考