为了账号安全，请及时绑定邮箱和手机立即绑定
首页 手记 Sentinel+Nacos限流规则持久化教程

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

标签：
Spring Cloud 运维工具 中间件
概述

本文介绍了如何将Sentinel限流规则持久化到Nacos中，通过这种方式可以实现动态调整限流规则，提高系统的灵活性和可用性。文章详细讲解了环境搭建、基本概念以及具体的持久化代码实现，帮助读者轻松掌握Sentinel+Nacos限流规则持久化教程。

引入

Sentinel是阿里巴巴开源的一款高可用的分布式服务保护框架，提供流量控制、熔断降级、系统保护等功能。它能够以非常低的开销保护应用流量，同时提供了可扩展、高性能、透明化的接入方式，与Dubbo、Spring Cloud等框架无缝整合。

Nacos是阿里巴巴开源的一个动态服务发现、配置管理和服务管理平台，主要功能包括服务发现、配置管理、动态服务提供、服务管理等，能够帮助实现系统的微服务治理。

为何要将限流规则持久化？在实际项目开发中，限流规则并非一成不变，通常需要根据业务场景和系统负载的变化进行调整。但是，每次调整后都需要重新部署服务，这不仅增加了运维难度，还会导致服务短暂中断。通过将限流规则持久化，可以在不重启服务的情况下动态调整规则，提高系统的灵活性和可用性。

环境搭建

在进行Sentinel和Nacos的集成开发之前，首先需要搭建合适的开发环境。

安装Java开发环境

  1. 安装Java：确保安装了Java 8或更高版本。可以通过命令java -version检查Java是否已正确安装。
  2. 配置环境变量：编辑环境变量配置文件，如.bashrc或.zshrc，添加Java安装路径。 
    export JAVA_HOME=/path/to/java
export PATH=$JAVA_HOME/bin:$PATH
  3. 安装Maven：Maven是一个项目管理和构建工具，可以简化依赖管理和编译过程。下载Maven并配置环境变量。 
    export MAVEN_HOME=/path/to/maven
export PATH=$MAVEN_HOME/bin:$PATH
  4. 验证安装：运行mvn -version查看Maven版本。

下载并配置Sentinel

  1. 下载Sentinel：通过Maven依赖管理，可以在项目中引入Sentinel。 
    <dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-core</artifactId>
    <version>1.8.0</version>
</dependency>
  2. 集成Sentinel：在项目中引入Sentinel的相关功能模块。 
    <dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-web-spring-cloud-starter</artifactId>
    <version>1.8.0</version>
</dependency>
  3. 配置Sentinel：在Spring Boot项目中，通过配置文件启用Sentinel。 
    spring:
  cloud:
    sentinel:
      transport:
        dashboard: localhost:8080

下载并配置Nacos

  1. 下载Nacos：从官网下载Nacos指定版本的压缩包或Docker镜像。
  2. 启动Nacos：解压Nacos压缩包并运行启动脚本启动Nacos服务。 
    cd nacos
sh bin/startup.sh -m standalone
  3. 访问Nacos管理界面：在浏览器中访问http://localhost:8848/nacos，默认账号密码是nacos/nacos。

基本概念

限流规则介绍

限流是微服务治理中的一个重要部分，通过限制并发访问量来保护系统免受过载。常见的限流算法包括令牌桶算法、漏桶算法、计数器算法等。限流规则通常定义了哪些资源可以被限流，每个资源的限流阈值是多少，以及达到阈值时应该采取的措施（例如返回错误码或降级）。

// 示例代码：创建限流规则
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 RuleExamples {
    public static void main(String[] args) {
        // 创建一个限流规则
        FlowRule rule = new FlowRule();
        rule.setResource("exampleResource");
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setCount(10);
        rule.setLimitApp("default");

        // 加载规则到Sentinel
        FlowRuleManager.loadRules(Collections.singletonList(rule));
    }
}

Sentinel的流控规则

Sentinel提供了多种流控规则：

  • 流控模式：

    • 链路模式：基于调用链路进行限流，适用于分布式系统。
    • 资源模式：基于资源名称进行限流，适用于单体应用。

  • 流控策略：

    • 直接流量阈值：设置一个固定的流量阈值。
    • 控制并发数：限制并发请求数量。
    • 关联关系流控：通过关联其他资源来进行流控。
  • 流控效果：
    • 快速失败：直接返回错误码。
    • Warm Up（预热）：逐渐增加流量。
    • 匀速流量：保持一个稳定的QPS。

Nacos的作用与功能

Nacos提供了丰富的功能，用于动态配置管理和服务发现：

  • 配置管理：可以动态更新配置，支持多环境和多环境之间配置的切换。
  • 服务发现：支持动态注册和发现服务，帮助实现服务间的通信。
  • 健康检查：自动感知服务的健康状态，确保服务间的通信顺利。
// 示例代码：配置Nacos监听器
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.listener.Listener;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.Properties;

@Component
public class NacosConfigListener {

    @Autowired
    private ConfigService configService;

    public void addListener() throws Exception {
        configService.addListener("sentinel-rules", "DEFAULT_GROUP", new Listener() {
            @Override
            public void receiveConfigInfo(String configInfo) {
                // 处理配置信息
                System.out.println("Received new config: " + configInfo);
            }

            @Override
            public void receiveConfigInfo(String configInfo, int configVersion) {
                // 处理配置信息和版本
                System.out.println("Received new config: " + configInfo + ", Version: " + configVersion);
            }

            @Override
            public void init() {
                // 初始化监听器
            }

            @Override
            public void doChangeProperties(Properties newProps) {
                // 处理新的属性
            }
        });
    }
}

编写持久化代码

初始化Sentinel与Nacos连接

在项目中集成Nacos和Sentinel后，需要实现它们之间的通信，以便将限流规则持久化到Nacos。

  1. 引入Nacos依赖： 
    <dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>2.2.8.RELEASE</version>
</dependency>

  2. 配置Nacos连接：在application.yml中配置Nacos的连接信息。

    spring:
  cloud:
    nacos:
      config:
        server-addr: localhost:8848
        namespace: default
        group: DEFAULT_GROUP
        auto-refresh: true

  3. 初始化Nacos客户端：创建Nacos的配置客户端。

    import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.exception.NacosException;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class NacosConfigClient {

    @Value("${spring.cloud.nacos.config.server-addr}")
    private String serverAddr;

    @Value("${spring.cloud.nacos.config.namespace}")
    private String namespace;

    @Value("${spring.cloud.nacos.config.group}")
    private String group;

    @Value("${spring.cloud.nacos.config.auto-refresh}")
    private boolean autoRefresh;

    @Bean
    public ConfigService nacosConfigService() throws NacosException {
        return new ConfigService(serverAddr, namespace);
    }
}

创建规则持久化方法

将限流规则保存到Nacos中，可以通过Nacos的配置客户端实现。

  1. 创建持久化方法：定义一个方法将Sentinel规则写入Nacos配置文件。

    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;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.ConfigTypeConstants;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

@Component
public class RulePersister {

    @Autowired
    private ConfigService configService;

    public void persistRules() throws NacosException {
        List<FlowRule> rules = new ArrayList<>();
        // 创建规则
        FlowRule rule = new FlowRule("exampleResource");
        rule.setCount(10);
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setLimitApp("default");
        rules.add(rule);

        // 转换为JSON格式
        String jsonRules = JSON.toJSONString(rules);
        // 写入Nacos配置
        configService.publishConfig("sentinel-rules", ConfigTypeConstants.JSON, jsonRules);
    }
}

读取规则并应用到Sentinel

在应用启动时，从Nacos中读取规则，并将其应用到Sentinel中。

  1. 读取规则方法：从Nacos中读取配置文件。

    import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.fastjson.JSON;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.listener.Listener;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

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

@Component
public class RuleLoader {

    @Autowired
    private ConfigService configService;

    public void loadRules() throws Exception {
        configService.getConfig("sentinel-rules", "DEFAULT_GROUP", (config, properties) -> {
            List<FlowRule> rules = JSON.parseArray(config, FlowRule.class);
            FlowRuleManager.loadRules(rules);
        });
    }
}

测试与验证

为了验证限流规则持久化的正确性，可以添加一些测试规则并观察其行为。

添加测试规则

首先，创建并添加测试规则，确保规则被持久化到Nacos中。

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;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.fastjson.JSON;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.ArrayList;
import java.util.List;

@SpringBootTest
public class RulePersistenceTest {

    @Autowired
    private RulePersister rulePersister;

    @Autowired
    private ConfigService configService;

    @Test
    public void testPersistRules() throws NacosException {
        rulePersister.persistRules();

        // 确认规则已持久化
        String config = configService.getConfig("sentinel-rules", "DEFAULT_GROUP");
        System.out.println("Persisted rules: " + config);
    }
}

验证规则持久化效果

在持久化规则后，从Nacos中读取并应用规则，验证其效果。

import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.fastjson.JSON;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.listener.Listener;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Import;

import java.util.Properties;

@SpringBootTest
@Import(RuleLoader.class)
public class RuleVerificationTest {

    @Autowired
    private ConfigService configService;

    @Test
    public void testLoadRules() throws Exception {
        configService.addListener("sentinel-rules", "DEFAULT_GROUP", (config, properties) -> {
            List<FlowRule> rules = JSON.parseArray(config, FlowRule.class);
            System.out.println("Loaded rules: " + JSON.toJSONString(rules));
        });

        // 确保规则已加载
        Thread.sleep(5000);
    }
}

调整规则并观察变化

调整持久化的规则，并观察其变化。例如，修改QPS阈值，观察其对应用运行的影响。

import com.alibaba.csp.sentinel.slots.block.flow.FlowRule;
import com.alibaba.fastjson.JSON;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.exception.NacosException;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;

import java.util.List;

@SpringBootTest
public class RuleAdjustmentTest {

    @Autowired
    private ConfigService configService;

    @Test
    public void testAdjustRules() throws NacosException {
        // 修改规则
        String config = configService.getConfig("sentinel-rules", "DEFAULT_GROUP");
        List<FlowRule> rules = JSON.parseArray(config, FlowRule.class);

        // 修改第一个规则的QPS阈值
        FlowRule rule = rules.get(0);
        rule.setCount(5); // 修改为5

        // 重新保存规则
        String jsonRules = JSON.toJSONString(rules);
        configService.publishConfig("sentinel-rules", ConfigTypeConstants.JSON, jsonRules);

        // 验证规则更新
        String updatedConfig = configService.getConfig("sentinel-rules", "DEFAULT_GROUP");
        System.out.println("Updated rules: " + updatedConfig);
    }
}

常见问题与解决方法

遇到的问题及解决策略

  1. 持久化失败：确保Nacos服务正常运行，并且配置文件路径正确。

    • 解决方法：检查Nacos服务状态，确认配置文件路径是否正确。

  2. 规则加载失败：检查Nacos中的配置文件是否格式正确。

    • 解决方法：验证配置文件格式是否正确，确保JSON格式无误。
  3. 规则应用失败：确保Sentinel和Nacos的版本兼容。
    • 解决方法：检查版本兼容性，更新依赖版本。

注意事项与小贴士

  • 在生产环境中，务必保证Nacos配置的安全性，避免敏感信息泄露。
  • 在部署过程中，确保所有相关服务（如Sentinel、Nacos服务）的版本兼容性。
  • 持久化规则时，确保规则文件格式正确，避免出现JSON解析错误。
  • 在调整规则后，尽量在非高峰时段进行操作，避免影响用户体验。

通过将限流规则持久化到Nacos中，能够简化运维操作，提高系统的灵活性。同时，需要注意配置文件的安全性，以确保系统的稳定性和安全性。

点击查看更多内容
发表于 2024.12.30 17:09， 共 24 人浏览

本文原创发布于慕课网 ，转载请注明出处，谢谢合作

举报
为 TA 点赞

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

评论

作者其他优质文章

正在加载中

慕桂英3389331

手记
篇
粉丝
43
获赞与收藏
187

关注作者，订阅最新文章

阅读免费教程

  • 推荐
  • 评论
  • 收藏
  • 共同学习，写下你的评论
感谢您的支持，我会继续努力的～
扫码打赏，你说多少就多少
赞赏金额会直接到老师账户
支付方式
打开微信扫一扫，即可进行扫码打赏哦
今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与 放弃机会
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消