【Java】Sentinel规则持久化到Nacos配置中心完全指南

发布日期: 2025-03-02

更新日期: 2025-03-04

文章字数: 1.2k

阅读时长: 5 分

阅读次数:

前言

Sentinel 是阿里巴巴开源的面向分布式服务架构的流量控制组件，而 Nacos 则是一个动态服务发现、配置管理和服务管理平台。将 Sentinel 的规则配置持久化到 Nacos 中，可以实现规则的统一管理和动态更新。本文将详细介绍如何实现这一集成方案。

环境准备

在开始之前，请确保您的环境满足以下要求：

JDK 1.8 或更高版本
Maven 3.x
Nacos Server（推荐 2.x 版本）
Spring Boot（推荐 2.x 版本）
Spring Cloud Alibaba（对应版本）

Maven 依赖配置

在 pom.xml 中添加必要的依赖：

<properties>
    <spring-cloud-alibaba.version>2.2.7.RELEASE</spring-cloud-alibaba.version>
    <spring-boot.version>2.3.12.RELEASE</spring-boot.version>
</properties>

<dependencies>
    <!-- Spring Cloud Alibaba Sentinel -->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
    </dependency>
    
    <!-- Sentinel 数据源 Nacos -->
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-nacos</artifactId>
    </dependency>
    
    <!-- Nacos Config -->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>${spring-cloud-alibaba.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

配置文件设置

1. bootstrap.yml 配置

在 resources 目录下创建 bootstrap.yml 文件：

spring:
  application:
    name: sentinel-service
  cloud:
    nacos:
      config:
        server-addr: localhost:8848
        username: nacos  # 如果开启了认证
        password: nacos  # 如果开启了认证
    sentinel:
      transport:
        dashboard: localhost:8080
      datasource:
        # 流控规则
        flow:
          nacos:
            server-addr: ${spring.cloud.nacos.config.server-addr}
            username: ${spring.cloud.nacos.config.username}
            password: ${spring.cloud.nacos.config.password}
            dataId: ${spring.application.name}-flow-rules
            groupId: SENTINEL_GROUP
            rule-type: flow
        # 降级规则
        degrade:
          nacos:
            server-addr: ${spring.cloud.nacos.config.server-addr}
            username: ${spring.cloud.nacos.config.username}
            password: ${spring.cloud.nacos.config.password}
            dataId: ${spring.application.name}-degrade-rules
            groupId: SENTINEL_GROUP
            rule-type: degrade

规则配置

1. 流控规则配置

在 Nacos 控制台创建配置文件，Data ID 为 sentinel-service-flow-rules，Group 为 SENTINEL_GROUP，配置格式选择 JSON：

[
    {
        "resource": "/test",
        "limitApp": "default",
        "grade": 1,
        "count": 5,
        "strategy": 0,
        "controlBehavior": 0,
        "clusterMode": false
    }
]

参数说明：

resource：资源名称
limitApp：来源应用
grade：阈值类型，1表示QPS，0表示线程数
count：单机阈值
strategy：流控模式，0表示直接，1表示关联，2表示链路
controlBehavior：流控效果，0表示快速失败，1表示Warm Up，2表示排队等待
clusterMode：是否集群模式

2. 降级规则配置

创建配置文件，Data ID 为 sentinel-service-degrade-rules：

[
    {
        "resource": "/test",
        "grade": 0,
        "count": 5,
        "timeWindow": 10,
        "minRequestAmount": 5,
        "statIntervalMs": 1000,
        "slowRatioThreshold": 0.5
    }
]

参数说明：

grade：降级策略，0表示RT，1表示异常比例，2表示异常数
count：阈值
timeWindow：时间窗口，单位为秒
minRequestAmount：最小请求数
statIntervalMs：统计时长
slowRatioThreshold：慢调用比例阈值

代码实现

1. 创建测试接口

@RestController
@RequestMapping("/test")
public class TestController {

    @GetMapping
    public String test() {
        return "Hello Sentinel";
    }

    @GetMapping("/degrade")
    public String testDegrade() throws InterruptedException {
        // 模拟慢调用
        Thread.sleep(100);
        return "Test Degrade";
    }
}

2. 自定义异常处理

@Configuration
public class SentinelConfig {

    @PostConstruct
    public void init() {
        BlockExceptionHandler handler = (request, response, e) -> {
            R r = R.error(429, "请求被限流，请稍后重试");
            response.setStatus(429);
            response.setCharacterEncoding("utf-8");
            response.setHeader("Content-Type", "application/json;charset=utf-8");
            response.getWriter().print(JSON.toJSONString(r));
        };
        WebCallbackManager.setBlockHandler(handler);
    }
}