第一章 Sentine 实现单机限流

引包

    com.alibaba.csp
    sentinel-core
    1.8.4



    com.alibaba.csp
    sentinel-transport-simple-http
    1.8.4

sentinel-transport-simple-http：该模块会启动一个内嵌的 http-server，用于接收和处理 dashboard 发送来的数据请求；同时每隔 10s，主动向 dashboard-server 发送心跳，表明当前应用的健康程度。

使用 sentinel 进行限流

public class HelloSentinel {
    public static void main(String[] args) throws InterruptedException {
//        initFlowRules();
        for (int i = 0; i < 10000; i++) {
            Entry entry = null;
            try {
                // 根据资源名获取Entry，如果获取到，说明可正常执行；如果被流控，该行代码抛出异常
                entry = SphU.entry("resource1");
                // 被保护的业务逻辑
                System.out.println(new HelloSentinel().sayHello(String.valueOf(i)));
            } catch (BlockException ex) {
                // 资源访问阻止，被限流或被降级
                // 进行相应的处理操作
                System.out.println("block, " + i);
                Thread.sleep(500);
            } catch (Exception ex) {
                // 若需要配置降级规则，需要通过这种方式记录业务异常
                Tracer.traceEntry(ex, entry);
                System.out.println("ex, " + i);
            } finally {
                // 务必保证 exit，务必保证每个 entry 与 exit 配对
                if (entry != null) {
                    entry.exit();
                }
            }
        }
    }
    
    public String sayHello(String receiver) {
        return "hi, " + receiver;
    }

    /**
     * 添加流控规则（此代码就是 dashboard 上配置的规则加载到应用内存的底层实现）
     */
//    private static void initFlowRules() {
//        List rules = new ArrayList<>();
//        FlowRule rule = new FlowRule();
//        rule.setResource("resource1");
//        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
//        // Set limit QPS to 10.
//        rule.setCount(10);
//        rules.add(rule);
//        FlowRuleManager.loadRules(rules);
//    }
}

启动 sentinel-dashboard

从github下载或者使用源码编译出 sentinel-dashboard-1.8.4.jar，之后使用如下命令启动
java -Dserver.port=8888 -Dcsp.sentinel.dashboard.server=localhost:8888 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard-1.8.4.jar

• -Dcsp.sentinel.dashboard.server：会将 sentinel-dashboard 自身的信息注册到 dashboard 界面上

浏览器访问：http://localhost:8888，用户名和密码都是 sentinel（具体看sentinel-dashboard 源码配置文件）

image.png

此时，如果启动应用程序 HelloSentinel 后，我们会在 dashboard 看到相应的应用。HelloSentinel 启动参数：

-Dcsp.sentinel.dashboard.server=127.0.0.1:8888 -Dproject.name=sentinel-demo

• -Dcsp.sentinel.dashboard.server：指定 dashboard server 地址，应用会每隔 10s 向 dashboard 发送心跳，dashboard 上有机器的健康检查列表。
• -Dproject.name：指定当前应用名

之后我们就可以在 dashboard 进行流控规则的配置了。

image.png

但是当我们关闭应用程序时，发现在 dashboard 配置的流控规则没了，因为此时配置的流控规则仅推送到了应用的内存中，需要进行持久化操作。
为了实现持久化，官方有 两种方式，此处使用最简单的本地文件存储。

规则数据持久化到文件

public class FileDataSourceInit implements InitFunc {

    @Override
    public void init() throws Exception {
        String flowRuleDir = System.getProperty("user.home") + File.separator + "Desktop"  + File.separator + "dev" + File.separator + "sentinel" + File.separator + System.getProperty("project.name") + File.separator + "rules";
        String flowRuleFile = "flowRule.json";
        String flowRulePath = flowRuleDir + File.separator + flowRuleFile;

        // 如果文件不存在，创建文件
        File dir = new File(flowRuleDir);
        File file = new File(flowRulePath);
        if (!dir.exists()) {
            dir.mkdirs();
        }
        if (!file.exists()) {
            file.createNewFile();
        }

        // 注册读数据源：启动时读取文件中的流控规则，注册到FlowRuleManager中
        ReadableDataSource> ds = new FileRefreshableDataSource<>(
            flowRulePath, source -> JSON.parseObject(source, new TypeReference>() {})
        );
        FlowRuleManager.register2Property(ds.getProperty());

        // 注册写数据源：dashboard修改规则配置后，通知应用，应用先更新到内存，然后写到文件中
        WritableDataSource> wds = new FileWritableDataSource<>(flowRulePath, this::encodeJson);
        WritableDataSourceRegistry.registerFlowDataSource(wds);
    }

    private  String encodeJson(T t) {
        return JSON.toJSONString(t);
    }
}

配置到 spi 文件：META-INF/services/com.alibaba.csp.sentinel.init.InitFunc

io.study.sentineldemo.datasource.FileDataSourceInit

重启应用后，再在 dashboard 设置规则，该规则会推送给应用，应用首先将其放置到内存中，之后持久化到文件中。应用再次重启后，就会从文件进行规则数据读取了。

sentinel-dashboard

dashboard 主要包括四部分内容：指标配置；机器健康检查；簇点链路分析；实时监控。
对于实时监控，应用会每隔一段时间将统计数据聚合写入类似 metrics.log 的文件中，同时为了 dashboard 实现迅速搜索，会建立数据索引文件，之后 dashboard 每隔一段时间从数据索引文件和 metrics.log 中查询相关信息，之后将信息按照一定规则（比如，资源名）进行聚合，写入内存，进行展示。由于存储在内存中，空间有限，dashboard 默认每隔资源只存储3min数据，如果需要持久化，也提供了相关扩展，可自行实现 MetricsRepository 进行持久化。