Sentinel+Nacos限流规则持久化资料入门教程

本文介绍了如何将Sentinel的限流规则持久化到Nacos中，通过集成Nacos作为配置中心，实现对限流策略的实时更新和管理。Sentinel+Nacos的结合为构建高性能、高可用的分布式系统提供了灵活的限流解决方案。文中详细讲解了Sentinel和Nacos的安装配置以及如何通过Nacos动态管理Sentinel的限流规则。

Sentinel是阿里巴巴开源的一款轻量级、高性能的Java流量控制框架。它具有多种功能，包括流量控制、熔断降级、系统保护和权限适配等。Sentinel的核心在于实时监控、防护和流控的实现，可以有效地防止系统的过载和崩溃。

Sentinel的特点包括：

• 实时监控：可以监控应用的流量、请求延迟、系统运行情况等关键指标。
• 流量控制：可以灵活地定义QPS、并发数、请求时间等多种限流策略。
• 熔断降级：当系统出现故障时，可以通过熔断降级机制保护系统不被进一步影响。
• 系统保护：可以根据系统的CPU、系统负载等资源使用情况，设置保护策略。

Nacos（Dynamic Naming and Configuration Service）是阿里巴巴开源的一款动态服务发现、配置管理和服务管理平台。它提供了一套完整的服务发现和配置管理解决方案，可以帮助开发者更好地管理和维护分布式系统中的服务发现和配置数据。

Nacos的特点包括：

• 服务发现与负载均衡：支持Dubbo、Spring Cloud等微服务框架的服务发现和负载均衡。
• 动态配置服务：可以实时推送配置变更，支持多环境、多实例的配置管理。
• 动态DNS服务：基于域名的服务发现机制，支持动态服务地址变更。
• 服务管理：提供了详尽的服务治理和管控能力。

Sentinel和Nacos的结合，可以实现对限流规则的动态管理和持久化。借助Nacos作为配置中心的能力，Sentinel的限流规则可以实时更新和持久化，实现了对限流策略的灵活调整。这对于构建高性能、高可用的分布式系统尤为重要。

通过集成Nacos，Sentinel能够更加灵活地调整限流策略，避免固定在代码中的限流规则带来的不便。同时，这种集成也使得运维人员可以通过Nacos界面直观地查看和修改限流策略，提高了系统的灵活性和可靠性。

Nacos的安装和配置步骤如下：

1. 下载Nacos：
   Nacos发布版本可以从Nacos官网下载，选择适合你系统的版本进行下载。这里以Linux系统为例：

   wget https://nexus-devops.oss-cn-shanghai.aliyuncs.com/repository/github.com/alibaba/nacos/releases/nacos-server-2.0.3.tar.gz
   tar -xvf nacos-server-2.0.3.tar.gz
   cd nacos

2. 启动Nacos：
   Nacos支持单机模式和集群模式，这里以单机模式为例启动Nacos。首先，进入conf目录复制配置文件：

   cp application.properties.example application.properties

   然后启动Nacos服务：

   sh bin/startup.sh -m standalone

   打开浏览器访问http://localhost:8848/nacos，默认账号密码为nacos/nacos，验证Nacos是否启动成功。

1. 下载Sentinel：
   Sentinel可以通过Maven仓库获取依赖。在你的项目pom.xml中添加如下依赖：

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

2. 集成Sentinel：
   在项目中集成Sentinel需要在启动类中添加必要的配置。例如，在Spring Boot项目中，使用如下配置：

   import com.alibaba.csp.sentinel.init.SentinelInitializer;
   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 org.springframework.beans.factory.annotation.Value;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   
   @Configuration
   public class SentinelConfig {
   
      @Value("${nacos.server}")
      private String nacosServer;
   
      @Value("${nacos.namespace}")
      private String nacosNamespace;
   
      @Value("${nacos.dataId}")
      private String dataId;
   
      @Bean
      public void initSentinel() {
          SentinelInitializer.init();
      }
   
      @Bean
      public NacosDataSource<FlowRule> nacosDataSource() {
          return new NacosDataSource<>(nacosServer, nacosNamespace, dataId,
              flow -> {
                  List<FlowRule> rules = new ArrayList<>();
                  for (Map.Entry<String, Object> item : flow.entrySet()) {
                      FlowRule rule = new FlowRule();
                      rule.setResource(item.getKey());
                      rule.setCount(Integer.parseInt(item.getValue().toString()));
                      rules.add(rule);
                  }
                  return rules;
              });
      }
   
      @Bean
      public void loadRules(NacosDataSource<FlowRule> dataSource) {
          dataSource.registerCallback(rules -> {
              FlowRuleManager.loadRules(rules);
          });
      }
   }

   请确保在application.properties中配置相应的Nacos服务器地址、命名空间和数据ID：

   nacos.server=127.0.0.1:8848
   nacos.namespace=public
   nacos.dataId=sentinel-flow-rules

Sentinel的流量控制机制可以根据不同的场景定义多种限流策略。以下是几种常见的限流策略：

• QPS限流：设定每秒请求的最大值。
• 并发数限流：设定同一时间内的最大请求并发数。
• 请求时间：根据请求的耗时来限制请求的频率。

这些限流规则的定义可以使用Sentinel的API来实现，也可以通过Nacos动态配置中间件进行管理。

import com.alibaba.csp.sentinel.Entry;
import com.alibaba.csp.sentinel.Sentinel;
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.flow.FlowRule;
import com.alibaba.csp.sentinel.slots.block.flow.FlowRuleManager;

public class SimpleFlowController {

    static {
        FlowRule rule = new FlowRule();
        rule.setResource("simpleFlowController");
        rule.setCount(10);
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setLimitApp("default");
        FlowRuleManager.loadRules(Collections.singletonList(rule));
    }

    @SentinelResource(value = "simpleFlowController", blockHandler = "handleException")
    public int simpleFlow() {
        return 1;
    }

    public int handleException(BlockException e) {
        return -1;
    }
}

上述代码中，simpleFlowController方法指定了资源名称，限流规则是每秒10次请求。当超过限流阈值时，handleException方法会被调用，返回-1。

Nacos作为配置中心，主要提供了以下功能：

• 动态配置变更推送：可以实时推送配置变更，支持多环境、多实例的配置管理。
• 服务发现与注册：支持服务的注册与发现，实现服务之间的通信。
• 动态DNS服务：提供基于域名的服务发现机制，支持动态服务地址变更。
• 服务治理：支持服务的治理和管控，包括服务的扩容、缩容、熔断等操作。

这些功能使得Nacos成为了微服务框架中不可或缺的组件，能够帮助开发者更好地管理和维护分布式系统中的服务发现和配置数据。

为了将Sentinel的限流规则存储至Nacos，需要以下步骤：

1. 定义配置文件：
   在Nacos中定义一个配置文件，用于存储限流规则。例如，创建一个名为sentinel-flow-rules的数据ID。

2. 在项目中配置Nacos数据源：
   在项目中配置Nacos数据源，使Sentinel可以从Nacos中读取限流规则。这可以通过NacosDataSource实现，如前文示例代码所示。

3. 测试配置的加载：
   启动应用后，Sentinel会从Nacos中读取配置文件中的限流规则，并应用到实际的限流操作中。

以下是一个完整的代码示例，展示了如何将Sentinel的限流规则持久化至Nacos。

创建一个Spring Boot项目

首先，创建一个Spring Boot项目，并在pom.xml中添加必要的依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-core</artifactId>
        <version>1.8.6</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-nacos</artifactId>
        <version>1.8.6</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba.nacos</groupId>
        <artifactId>nacos-client</artifactId>
        <version>2.0.3</version>
    </dependency>
</dependencies>

配置Nacos数据源

在application.properties中添加如下配置：

nacos.server=127.0.0.1:8848
nacos.namespace=public
nacos.dataId=sentinel-flow-rules

实现Sentinel的配置加载

创建一个配置类SentinelConfig，实现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 org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.concurrent.ConcurrentHashMap;

@Configuration
public class SentinelConfig {

    @Value("${nacos.server}")
    private String nacosServer;

    @Value("${nacos.namespace}")
    private String nacosNamespace;

    @Value("${nacos.dataId}")
    private String dataId;

    @Bean
    public NacosDataSource<FlowRule> nacosDataSource() {
        return new NacosDataSource<>(nacosServer, nacosNamespace, dataId,
            flow -> {
                List<FlowRule> rules = new ArrayList<>();
                for (Map.Entry<String, Object> item : flow.entrySet()) {
                    FlowRule rule = new FlowRule();
                    rule.setResource(item.getKey());
                    rule.setCount(Integer.parseInt(item.getValue().toString()));
                    rules.add(rule);
                }
                return rules;
            });
    }

    @Bean
    public void loadRules(NacosDataSource<FlowRule> dataSource) {
        dataSource.registerCallback(rules -> {
            FlowRuleManager.loadRules(rules);
        });
    }
}

测试持久化效果

创建一个简单的Service类SimpleFlowController，使用注解@SentinelResource标记需要限流的方法：

import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import org.springframework.stereotype.Service;

@Service
public class SimpleFlowController {

    @SentinelResource(value = "simpleFlowController", blockHandler = "handleException")
    public int simpleFlow() {
        return 1;
    }

    public int handleException(BlockException e) {
        return -1;
    }
}

创建一个简单的Controller类SimpleFlowControllerTest，调用SimpleFlowController中的方法进行测试：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class SimpleFlowControllerTest {

    @Autowired
    private SimpleFlowController simpleFlowController;

    @GetMapping("/simple-flow")
    public int testSimpleFlow() {
        return simpleFlowController.simpleFlow();
    }
}

启动应用并访问http://localhost:8080/simple-flow接口，观察限流规则是否生效。

1. Sentinel加载规则失败：如果Sentinel无法从Nacos加载限流规则，可以检查Nacos的数据ID是否正确，以及规则格式是否符合要求。
2. 请求被限流后返回错误码：需要确保@SentinelResource的blockHandler方法的返回类型与实际方法一致。
3. Nacos配置未更新：确认Nacos配置文件中的数据是否正确推送，并检查Nacos服务是否正常运行。

1. 检查配置文件：
   确保Nacos配置文件中的nacos.server、nacos.namespace和nacos.dataId配置正确。

2. 确认规则格式：
   检查Nacos配置文件中的规则格式是否与Sentinel要求的格式一致。

3. 调试日志：
   启动应用时开启Sentinel的调试日志，查看具体的错误信息。可以通过在application.properties中添加如下配置开启调试日志：

   logging.level.com.alibaba.csp.sentinel=DEBUG

4. 手动测试：
   通过手动修改Nacos中的规则，验证规则是否能正确加载和生效。可以通过Nacos控制台直接修改配置文件，然后观察应用的限流效果。

以上是Sentinel+Nacos限流规则持久化资料入门教程，希望能够帮助你更好地理解和使用Sentinel和Nacos进行分布式系统的限流规则管理。