首页手记 Sentinel+Nacos限流规则持久化教程

Sentinel+Nacos限流规则持久化教程

标签：

Spring Cloud 运维微服务

概述

本文将详细介绍如何将Sentinel限流规则持久化到Nacos中，确保在应用重启后能够自动加载之前配置的规则。通过Sentinel与Nacos的集成，可以实现动态管理和实时更新限流规则，提高系统的稳定性和灵活性。Sentinel提供了多种类型的限流规则，如基于QPS、并发线程数和请求入队的限流策略，适用于不同的应用场景。

Sentinel与Nacos简介

Sentinel简介

Sentinel 是阿里巴巴开源的一款轻量级的、高性能的流量控制组件，主要应用于微服务架构中。它能够对流量进行实时监控、控制，从而实现了流量的精细化治理和系统保护。Sentinel 支持多种主流微服务框架和云平台，包括Spring Cloud、Dubbo、Hystrix等，并且支持多种编程语言，如Java、Go、PHP、Swift等。

Sentinel的核心功能包括：

流量控制：通过设置规则，对进入系统的流量进行限流，避免系统过载。
热点防护：对热点数据和热点接口进行保护，防止频繁访问导致系统资源耗尽。
系统保护：根据系统的实时状态（如CPU、内存、线程数等），自动进行系统保护。
API限流：可以针对特定的API进行细粒度的流量控制。
控制台：提供了可视化界面，方便用户配置和管理各种规则。

Nacos简介

Nacos 是阿里巴巴开源的一个动态服务发现、配置管理和服务管理平台。它可以帮助开发者更简单地开发、配置、管理微服务。

Nacos的核心功能包括：

服务发现与服务健康检测：支持Dubbo、Spring Cloud等微服务框架。
动态配置服务：可以动态地修改应用配置，使得配置修改可以实时生效。
动态DNS服务：支持基于权重的路由，支持多中心的配置同步。
服务和服务元数据管理：支持服务的注册、发现和管理。

Nacos相比于传统的配置管理工具，如ZooKeeper和Consul，最大的特点是支持动态配置和动态DNS服务，可以更灵活地满足现代微服务架构的需求。

Sentinel与Nacos集成环境搭建

Sentinel环境搭建

下载并引入Sentinel依赖

首先，您需要在您的Maven项目中添加Sentinel的依赖。以下是pom.xml文件中的依赖配置示例：

<dependencies>
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-core</artifactId>
        <version>1.8.2</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-nacos</artifactId>
        <version>1.8.2</version>
    </dependency>
</dependencies>

初始化Sentinel

接下来，您需要在您的应用启动时初始化Sentinel。这可以通过在Spring Boot应用的配置文件或Java代码中完成。以下是在Java代码中初始化Sentinel的一个示例：

import com.alibaba.csp.sentinel.init.InitFunc;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;

public class SentinelInitializer implements InitFunc {

    @Override
    public void init() throws Throwable {
        FlowRule rule = new FlowRule();
        rule.setResource("test");
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setCount(10);
        rule.setLimitApp("default");
        FlowRuleManager.loadRules(Collections.singletonList(rule));
    }
}

配置Sentinel Dashboard

Sentinel提供了Dashboard，用于可视化地管理和监控Sentinel的规则。您可以在Sentinel的GitHub页面找到详细的安装和配置说明。以下是一个简单的启动命令：

java -jar sentinel-dashboard-1.8.2.jar

Spring Boot配置文件示例

在Spring Boot应用中，可以通过以下配置文件来初始化Sentinel：

spring:
  application:
   name: sentinel-nacos-example
sentinel:
  nacos:
   server-addr: localhost
   namespace: default
   data-id: sentinelRules
   group-id: DEFAULT_GROUP

Nacos环境搭建

下载并安装Nacos

Nacos的安装过程与Sentinel类似，首先下载Nacos的安装包，然后解压并启动Nacos服务器。

# 解压Nacos
tar -zxvf nacos-server-2.0.3.tar.gz

# 进入Nacos目录
cd nacos

# 启动Nacos
sh bin/startup.sh -m standalone

配置Nacos

配置Nacos主要是通过编辑application.properties文件完成的。例如，要更改配置文件的读取路径，可以修改spring.datasource.platform和db.num等属性。

spring.datasource.platform=mysql
db.num=1
db.sport=3306
db.url.jk=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=nacos
db.password=nacos

Sentinel与Nacos集成配置

为了将Sentinel与Nacos集成，您需要在Sentinel的配置文件或Java代码中设置Nacos作为数据源。以下是一个示例配置：

import com.alibaba.csp.sentinel.datasource.Converter;
import com.alibaba.csp.sentinel.datasource.nacos.NacosDataSource;
import com.alibaba.csp.sentinel.init.InitFunc;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;

import java.util.List;
import java.util.Properties;

public class NacosDataSourceInitializer implements InitFunc {

    @Override
    public void init() throws Exception {
        String serverAddr = "localhost";
        String dataId = "sentinel-dashboard-reload-rule";
        String groupId = "DEFAULT_GROUP";
        String appName = "testApp";

        NacosDataSource nacosDataSource = new NacosDataSource(
                serverAddr,
                appName,
                dataId,
                groupId,
                new GsonConverter()
        );

        nacosDataSource.registerListener((configs, context) -> {
            List<FlowRule> rules = GsonUtil.fromJson(configs, new TypeToken<List<FlowRule>>(){}.getType());
            FlowRuleManager.loadRules(rules);
        });

        Properties properties = new Properties();
        properties.put("serverAddr", serverAddr);
        properties.put("dataId", dataId);
        properties.put("groupId", groupId);
        properties.put("appName", appName);
        nacosDataSource.init(properties);

        // 示例规则
        FlowRule rule = new FlowRule();
        rule.setResource("exampleService");
        rule.setGrade(FlowRuleConstant.FLOW_GRADE_QPS);
        rule.setCount(100);
        List<FlowRule> rules = new ArrayList<>();
        rules.add(rule);

        Gson gson = new Gson();
        String jsonRules = gson.toJson(rules);
        nacosDataSource.publishConfig(dataId, groupId, jsonRules);
    }
}

通过上述配置，Sentinel将能够从Nacos中读取并应用限流规则。

限流规则介绍

Sentinel限流规则概述

Sentinel支持多种类型的限流规则，包括基于QPS（每秒查询率）的限流，基于并发线程数的限流，基于请求入队的限流等。这些规则可以根据不同的场景进行灵活配置。

基于QPS的限流

基于QPS的限流是指指定一段时间内允许通过的最大请求数。当超过该阈值时，Sentinel将开始限流。

FlowRule flowRule = new FlowRule();
flowRule.setResource("exampleService");
flowRule.setGrade(FlowRuleConstant.FLOW_GRADE_QPS);
flowRule.setCount(10);
flowRule.setStrategy(FlowRuleConstant.STREAM_STRATEGY_DEFAULT);
flowRule.setControlBehavior(FlowRuleConstant.CONTROL_BEHAVIOR_DEFAULT);
flowRule.setWarmUpPeriodMs(1000);

基于并发线程数的限流

基于并发线程数的限流是指在任何时刻只能允许固定数量的并发请求。

FlowRule flowRule = new FlowRule();
flowRule.setResource("exampleService");
flowRule.setGrade(FlowRuleConstant.FLOW_GRADE_THREAD);
flowRule.setCount(10);
flowRule.setStrategy(FlowRuleConstant.STREAM_STRATEGY_DEFAULT);
flowRule.setControlBehavior(FlowRuleConstant.CONTROL_BEHAVIOR_DEFAULT);

基于请求入队的限流

基于请求入队的限流是指在请求超过阈值时，将请求放入队列中等待处理。

FlowRule flowRule = new FlowRule();
flowRule.setResource("exampleService");
flowRule.setGrade(FlowRuleConstant.FLOW_GRADE_THREAD);
flowRule.setCount(10);
flowRule.setStrategy(FlowRuleConstant.STREAM_STRATEGY_WARM_UP);
flowRule.setControlBehavior(FlowRuleConstant.CONTROL_BEHAVIOR_WARM_UP);
flowRule.setWarmUpPeriodMs(1000);

常用限流规则解析

QPS限流规则

QPS限流规则是最常见的限流方式之一，适用于大部分场景。它根据每秒请求数来控制流量。例如，我们可以配置一个服务在每秒最多处理100个请求：

FlowRule flowRule = new FlowRule();
flowRule.setResource("exampleService");
flowRule.setGrade(FlowRuleConstant.FLOW_GRADE_QPS);
flowRule.setCount(100);
flowRule.setStrategy(FlowRuleConstant.STREAM_STRATEGY_DEFAULT);
flowRule.setControlBehavior(FlowRuleConstant.CONTROL_BEHAVIOR_DEFAULT);

并发线程数限流规则

并发线程数限流规则用于控制特定资源在同一时刻的最大并发数。这种规则适用于对内存占用较高的场景。

FlowRule flowRule = new FlowRule();
flowRule.setResource("exampleService");
flowRule.setGrade(FlowRuleConstant.FLOW_GRADE_THREAD);
flowRule.setCount(20);
flowRule.setStrategy(FlowRuleConstant.STREAM_STRATEGY_DEFAULT);
flowRule.setControlBehavior(FlowRuleConstant.CONTROL_BEHAVIOR_DEFAULT);

请求入队限流规则

请求入队限流规则允许超过阈值的请求被放入队列中，然后按顺序处理。这种规则适用于需要平滑处理请求的场景。

FlowRule flowRule = new FlowRule();
flowRule.setResource("exampleService");
flowRule.setGrade(FlowRuleConstant.FLOW_GRADE_THREAD);
flowRule.setCount(20);
flowRule.setStrategy(FlowRuleConstant.STREAM_STRATEGY_WARM_UP);
flowRule.setControlBehavior(FlowRuleConstant.CONTROL_BEHAVIOR_WARM_UP);
flowRule.setWarmUpPeriodMs(1000);

限流规则持久化原理

为什么要进行限流规则持久化

限流规则持久化的主要目的是为了在应用重启或故障恢复后能够自动加载之前定义的限流规则。如果不进行持久化，每次重启应用后都需要手动重新配置限流规则。

持久化还可以帮助我们在不同环境中（如开发、测试和生产环境）保持一致的限流规则配置。例如，开发环境和生产环境的流量控制规则可能不同，持久化可以方便地在不同环境中切换规则。

Sentinel+Nacos持久化实现原理

Sentinel通过Nacos作为数据源，可以将限流规则持久化到Nacos中。当Sentinel启动时，会自动从Nacos中读取并应用持久化的规则。这样即使Sentinel服务重启，也能通过Nacos恢复之前的规则配置。

具体的持久化过程如下：

规则配置：在Sentinel的控制台或Java代码中配置限流规则。
保存规则：将规则保存到Nacos的持久化存储中（通常是数据库）。
规则加载：当Sentinel服务启动时，从Nacos中读取并加载规则。

以下是一个保存规则到Nacos的示例代码：

import com.alibaba.csp.sentinel.datasource.Converter;
import com.alibaba.csp.sentinel.datasource.nacos.NacosDataSource;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;

import java.util.List;
import java.util.Properties;

public class NacosDataSourceInitializer implements InitFunc {

    @Override
    public void init() throws Exception {
        String serverAddr = "localhost";
        String dataId = "sentinel-dashboard-reload-rule";
        String groupId = "DEFAULT_GROUP";
        String appName = "testApp";

        NacosDataSource nacosDataSource = new NacosDataSource(
                serverAddr,
                appName,
                dataId,
                groupId,
                new GsonConverter()
        );

        nacosDataSource.registerListener((configs, context) -> {
            List<FlowRule> rules = GsonUtil.fromJson(configs, new TypeToken<List<FlowRule>>(){}.getType());
            FlowRuleManager.loadRules(rules);
        });

        Properties properties = new Properties();
        properties.put("serverAddr", serverAddr);
        properties.put("dataId", dataId);
        properties.put("groupId", groupId);
        properties.put("appName", appName);
        nacosDataSource.init(properties);

        // 示例规则
        FlowRule rule = new FlowRule();
        rule.setResource("exampleService");
        rule.setGrade(FlowRuleConstant.FLOW_GRADE_QPS);
        rule.setCount(100);
        List<FlowRule> rules = new ArrayList<>();
        rules.add(rule);

        Gson gson = new Gson();
        String jsonRules = gson.toJson(rules);
        nacosDataSource.publishConfig(dataId, groupId, jsonRules);
    }
}

GsonUtil类说明

GsonUtil类负责将字符串转换为List<FlowRule>对象。以下是GsonUtil类的实现：

import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;

import java.lang.reflect.Type;
import java.util.List;

public class GsonUtil {

    private static Gson gson = new Gson();

    public static <T> T fromJson(String json, Class<T> classOfT) {
        return gson.fromJson(json, classOfT);
    }

    public static <T> T fromJson(String json, Type type) {
        return gson.fromJson(json, type);
    }
}

实战演练：限流规则持久化配置

创建Nacos持久化配置

首先，您需要在Nacos中创建一个持久化规则的数据ID和组。这些配置可以在Nacos的配置管理界面中完成。

创建数据ID和组

在Nacos控制台中，导航到配置管理 -> 配置列表，点击新建配置按钮。填写以下信息：

数据ID：sentinel-dashboard-reload-rule
配置分组：DEFAULT_GROUP
配置内容：[]

点击提交按钮。

之后，您需要在Sentinel的启动代码中配置数据源，使其能够读取和写入Nacos中的规则。

在Sentinel中配置持久化规则

接下来，您需要在Sentinel中配置持久化规则。以下是一个完整的示例代码，展示了如何初始化Sentinel并从Nacos中读取和写入规则：

import com.alibaba.csp.sentinel.datasource.Converter;
import com.alibaba.csp.sentinel.datasource.nacos.NacosDataSource;
import com.alibaba.csp.sentinel.init.InitFunc;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;

import java.util.List;
import java.util.Properties;

public class NacosDataSourceInitializer implements InitFunc {

    @Override
    public void init() throws Exception {
        String serverAddr = "localhost";
        String dataId = "sentinel-dashboard-reload-rule";
        String groupId = "DEFAULT_GROUP";
        String appName = "testApp";

        NacosDataSource nacosDataSource = new NacosDataSource(
                serverAddr,
                appName,
                dataId,
                groupId,
                new GsonConverter()
        );

        nacosDataSource.registerListener((configs, context) -> {
            List<FlowRule> rules = GsonUtil.fromJson(configs, new TypeToken<List<FlowRule>>(){}.getType());
            FlowRuleManager.loadRules(rules);
        });

        Properties properties = new Properties();
        properties.put("serverAddr", serverAddr);
        properties.put("dataId", dataId);
        properties.put("groupId", groupId);
        properties.put("appName", appName);
        nacosDataSource.init(properties);

        // 示例规则
        FlowRule rule = new FlowRule();
        rule.setResource("exampleService");
        rule.setGrade(FlowRuleConstant.FLOW_GRADE_QPS);
        rule.setCount(100);
        List<FlowRule> rules = new ArrayList<>();
        rules.add(rule);

        Gson gson = new Gson();
        String jsonRules = gson.toJson(rules);
        nacosDataSource.publishConfig(dataId, groupId, jsonRules);
    }
}

运行代码

上述代码将在启动时将规则保存到Nacos中，并在应用启动时从Nacos中读取规则。请确保您的Nacos和Sentinel配置正确无误。

测试持久化效果

为了验证持久化是否成功，您可以重启您的Sentinel服务，然后检查规则是否已经被正确加载。

重启Sentinel服务：您可以直接重启您的应用服务。
验证规则是否加载成功：您可以在Sentinel的控制台查看已加载的规则，或者通过Java代码检查规则是否正确加载。

import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;

public class SentinelRuleCheck {

    public static void main(String[] args) {
        List<FlowRule> rules = FlowRuleManager.getRules();
        for (FlowRule rule : rules) {
            System.out.println("Resource: " + rule.getResource() + ", Grade: " + rule.getGrade() + ", Count: " + rule.getCount());
        }
    }
}

运行上述代码，您应该能够看到之前保存到Nacos中的规则。

常见问题及解决方案

持久化配置常见问题

规则无法从Nacos中加载：请确保Nacos和Sentinel的数据源配置正确，并且配置文件中的数据ID和组名一致。
规则保存失败：检查Nacos的权限设置，确保应用有足够的权限修改配置文件。
规则更新不及时：请检查Nacos的配置管理界面中的配置是否实时更新。

解决方案与注意事项

确保Nacos和Sentinel配置一致：确保Nacos和Sentinel的数据源配置一致，包括数据ID、组名和应用名。
检查Nacos权限：确保您的应用有足够的权限在Nacos中读写配置文件。
使用正确的转换器：根据您的需求选择合适的转换器（如GsonConverter），确保规则能够正确转换为配置文件中的JSON格式。
测试不同的限流规则：在不同的测试环境中测试不同的限流规则，确保规则能够在不同情况下正常工作。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

慕森王

手记
篇

粉丝

107

获赞与收藏

552

关注作者，订阅最新文章

阅读免费教程

Spring Cloud Hystrix

15个小节 6139 120

后端通用面试教程

41个小节 30583 343

网络编程入门教程

20个小节 12561 237

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空