Springboot 中使用Sentinel的详细步骤

2025-02-14 05:50
文章标签 java 使用 步骤 springboot spring 详细 sentinel

本文主要是介绍Springboot 中使用Sentinel的详细步骤，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

《Springboot中使用Sentinel的详细步骤》文章介绍了如何在SpringBoot中使用Sentinel进行限流和熔断降级,首先添加依赖,配置Sentinel控制台地址,定义受保护的资源,...

在 Spring Boot 中使用 Sentinel 非常方便，Spring Cloud Alibaba 提供了 spring-cloud-starter-alibaba-sentinel 组件，可以快速将 Sentinel 集成到你的 Spring Boot 应用中，并利用其强大的流量控制和容错能力。

下面是一个详细的步骤指南

步骤 1: 添加 Sentinel 依赖

首先，需要在你的 pom.XML 文件中添加 Spring Cloud Alibaba Sentinel 的依赖。确保你已经配置了 Spring Cloud Alibaba 的依赖管理 (spring-cloud-alibaba-dependencies)。

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>

如果你需要使用 Sentinel 的持久化功能，例如将规则持久化到 Nacos 配置中心，还需要添加相应的依赖，例如：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-datasource-nacos</artifactId>
</dependency>

步骤 2: 配置 Sentinel

在 application.properties 或 application.yml 文件中配置 Sentinel 的基本信息。 至少需要配置 Sentinel 控制台的地址，以便你可以通过控制台查看监控数据和管理规则。

spring:
  application:
    name: your-spring-boot-app # 应用名称，Sentinel 控制台中会显示
  cloud:
    sentinel:
      transport:
        dashboard: localhost:8080 # Sentinel 控制台的地址 (默认端口 8080)
        port: 8719 # Sentinel 客户端与控制台通信的端口，默认 8719，可以自定义，避免冲突
# 如果需要持久化规则到 Nacos，还需要配置 Nacos 相关信息
# nacos:
#  config:
#    server-addr: your-nacos-server-address:8848

注意: 你需要先启动 Sentinel 控制台，才能在控制台中看到你的 Spring Boot 应用的监控数据和配置规则。 你可以从 Sentinel 的 github 仓库下载 Sentinel 控制台的 JAR 包并启动。

步骤 3: 定义受保护的资源

在 Spring Boot 中，你可以使用以下方式来定义需要 Sentinel 保护的资源：

方式一：使用 @SentinelResource 注解

这是最常用的方式，通过在方法上添加 @SentinelResource 注解，可以声明该方法为一个受保护的资源。

import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import org.springframework.stereotype.Service;
@Service
public class MyService {
    @SentinelResource(value = "myResource", blockHandler = "handleBlock")
    public String DOSomething() {
        // 业务逻辑
        return "Success";
    }
    // BlockHandler 方法，用于处理 BlockException，即限流、熔断等 block 情况
    public String handleBlock(BlockExceptphpion e) {
        return "Blocked by Sentinel: " + e.getClass().getSimpleName(); // 返回被 Sentinel 拦截的提示信息
    }
}
  • @SentinelResource(value = "myResource"): value 属性指定资源的名称，在 Sentinel 控制台中会显示这个名称。
  • blockHandler = "handleBlock": blockHandler 属性指定了当资源被限流、熔断等 block 时，应该调用的 blockHandler 方法。 handleBlock 方法的签名需要和被保护的方法一致，但最后一个参数必须是 BlockException 类型。 blpythonockHandler 方法负责处理 block 逻辑，例如返回友好的提示信息或执行降级操作。

方式二：编程式 API 定义资源

除了注解，你也可以使用 Sentinel 提供的编程式 API 来定义资源，这种方式更加灵活，可以更细粒度地控制资源的入口和出口。

import com.alibaba.csp.sentinel.Entry;
http://www.chinasem.cnimport com.alibaba.csp.sentinel.SphU;
import com.alibaba.csp.sentinel.Tracer;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import org.springframework.stereotype.Service;
@Service
public class MyService {
    public String doSomethingProgrammatically() {
     android   Entry entry = null;
        try {
            entry = SphU.entry("myProgrammaticResource"); // 定义资源名
            // 被保护的业务逻辑
            return "Success from Programmatic Resource";
        } catch (BlockException e) {
            // 处理 BlockException，例如限流、熔断等
            return "Blocked by Sentinel (Programmatic): " + e.getClass().getSimpleName();
        } catch (Exception ex) {
            // 业务逻辑异常，需要记录到 Sentinel 的异常统计中
            Tracer.traceEntry(entry, ex);
            throw ex;
        } finally {
            if (entry != null) {
                entry.exit(); // 保证 exit() 被调用，否则会导致统计数据不准确
            }
        }
    }
}
  • SphU.entry("myProgrammaticResource"): SphU.entry() 方法用于定义一个资源入口，参数为资源名称。 它会返回一个 Entry 对象，用于标记资源的入口。
  • entry.exit(): 在 finally 块中调用 entry.exit()，表示资源调用结束。 必须确保 entry.exit() 被调用，否则会导致 Sentinel 的统计数据不准确。
  • BlockException 捕获: 需要捕获 BlockException 异常，并处理限流、熔断等 block 情况。
  • Tracer.traceEntry(entry, ex): 如果业务逻辑发生异常，需要使用 Tracer.traceEntry() 方法将异常信息记录到 Sentinel 的异常统计中。

步骤 4: 配置流控规则

定义了受保护的资源后，你需要配置流控规则，告诉 Sentinel 如何对这些资源进行保护。 你可以通过以下方式配置规则：

方式一：在 Sentinel 控制台配置

这是最推荐的方式，通过 Sentinel 控制台，你可以可视化地配置和管理规则，实时生效，无需重启应用。

  • 访问 Sentinel 控制台: 访问你在 application.properties 中配置的 spring.cloud.sentinel.transport.dashboard 地址（默认 http://localhost:8080）。
  • 找到你的应用: 在控制台的 “簇点链路” 或 “机器列表” 中找到你的 Spring Boot 应用。
  • 配置规则: 在 “流控规则”、“降级规则”、“热点规则” 等菜单中，为你的资源配置相应的规则。 例如，为 “myResource” 配置一个 QPS 为 2 的流控规则。
  • 按如下操作

Springboot 中使用Sentinel的详细步骤

添加“流控”规则

Springboot 中使用Sentinel的详细步骤

添加“熔断”机制

Springboot 中使用Sentinel的详细步骤

方式二：在代码中编程式配置规则

你也可以在代码中编程式地配置规则，这种方式更适合自动化配置或单元测试。

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 org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import Java.util.ArrayList;
import java.util.List;
@Component
public class FlowRuleConfig implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        initFlowRules();
    }
    private void initFlowRules() {
        List<FlowRule> rules = new ArrayList<>();
        FlowRule rule = new FlowRule();
        rule.setResource("myResource"); // 资源名称，与 @SentinelResource 注解中的 value 对应
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS); // 流控类型：QPS
        rule.setCount(2); // QPS 阈值为 2
        rules.add(rule);
        FlowRuleManager.loadRules(rules); // 加载规则
    }
}
  • FlowRule: FlowRule 对象表示一个流控规则。
  • rule.setResource("myResource"): 指定规则应www.chinasem.cn用于哪个资源，需要与 @SentinelResource 注解或编程式 API 中定义的资源名称一致。rule.setGrade(RuleConstant.FLOW_GRADE_QPS): 设置流控类型为 QPS (每秒请求数)。
  • rule.setCount(2): 设置 QPS 阈值为 2，即每秒钟只允许 2 个请求通过。
  • FlowRuleManager.loadRules(rules): 加载配置好的规则列表。

步骤 5: 启动 Sentinel 控制台和 Spring Boot 应用

  • 启动 Sentinel 控制台: 下载 Sentinel 控制台的 JAR 包，并使用 java -jar sentinel-dashboard.jar 命令启动。 默认访问地址为 http://localhost:8080，默认用户名密码都是 sentinel。
  • 启动 Spring Boot 应用: 启动你的 Spring Boot 应用。

步骤 6: 测试和监控

  • 访问受保护的接口: 访问你应用中被 @SentinelResource 或编程式 API 保护的接口。
  • 观察 Sentinel 控制台: 在 Sentinel 控制台中，你可以看到你的应用的监控数据，例如 “簇点链路” 中会显示资源的请求量、通过量、拒绝量、平均响应时间等指标。
  • 测试流控效果: 尝试以超过你配置的流控阈值的速率访问受保护的接口，你会看到部分请求被 Sentinel 拦截，并返回你在 blockHandler 方法中定义的提示信息。

高级特性 (可选)

Sentinel 还提供了很多高级特性，你可以根据实际需求进行探索和使用，例如：

  • 降级规则 (Degrade Rule): 配置熔断降级规则，当服务的错误率或响应时间超过阈值时，自动熔断，防止故障扩散。
  • 热点参数限流 (Hot-spot Param Flow Control): 根据请求的热点参数进行限流，例如根据用户 ID、商品 ID 等。
  • 系统规则 (System Rule): 从系统全局负载角度进行保护，例如根据 CPU 使用率、Load、内存使用率等进行自适应限流。
  • 授权规则 (Authority Rule): 进行黑白名单授权控制，限制特定来源的请求访问。
  • 持久化规则 (Rule Persistence): 将规则持久化到 Nacos、ZooKeeper、Redis 等配置中心，实现规则的动态更新和集群共享。
  • 自定义 BlockHandler 和 Fallback: 更灵活地处理 BlockException 和业务异常，实现更精细的降级策略。
  • 集群流控 (Cluster Flow Control): 对集群中的多个实例进行统一的流量控制。

总结

使用 Spring Cloud Alibaba Sentinel 在 Spring Boot 中实现限流、熔断降级是非常简单的。 通过添加依赖、配置 Sentinel 控制台地址、定义受保护的资源、配置规则，你就可以快速为你的 Spring Boot 应用增加一层强大的保护屏障，提升系统的稳定性和容错能力。 Sentinel 提供的可视化控制台和丰富的特性，也使得流量控制和容错管理更加便捷高效。

到此这篇关于Springboot 中使用Sentinel的详细步骤的文章就介绍到这了,更多相关Springboot 使用Sentinel内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)！

这篇关于Springboot 中使用Sentinel的详细步骤的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1153432。

相关文章

Python虚拟环境终极(含PyCharm的使用教程)

Python虚拟环境终极(含PyCharm的使用教程)

《Python虚拟环境终极(含PyCharm的使用教程)》：本文主要介绍Python虚拟环境终极(含PyCharm的使用教程),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录一、为什么需要虚拟环境？二、虚拟环境创建方式对比三、命令行创建虚拟环境（venv）3.1 基础命令3
阅读更多...
Python Transformer 库安装配置及使用方法

Python Transformer 库安装配置及使用方法

《PythonTransformer库安装配置及使用方法》HuggingFaceTransformers是自然语言处理（NLP）领域最流行的开源库之一,支持基于Transformer架构的预训练模... 目录python 中的 Transformer 库及使用方法一、库的概述二、安装与配置三、基础使用：Pi
阅读更多...
关于pandas的read_csv方法使用解读

关于pandas的read_csv方法使用解读

《关于pandas的read_csv方法使用解读》：本文主要介绍关于pandas的read_csv方法使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录pandas的read_csv方法解读read_csv中的参数基本参数通用解析参数空值处理相关参数时间处理相关
阅读更多...
使用Node.js制作图片上传服务的详细教程

使用Node.js制作图片上传服务的详细教程

《使用Node.js制作图片上传服务的详细教程》在现代Web应用开发中,图片上传是一项常见且重要的功能,借助Node.js强大的生态系统,我们可以轻松搭建高效的图片上传服务,本文将深入探讨如何使用No... 目录准备工作搭建 Express 服务器配置 multer 进行图片上传处理图片上传请求完整代码示例
阅读更多...
SpringBoot条件注解核心作用与使用场景详解

SpringBoot条件注解核心作用与使用场景详解

《SpringBoot条件注解核心作用与使用场景详解》SpringBoot的条件注解为开发者提供了强大的动态配置能力,理解其原理和适用场景是构建灵活、可扩展应用的关键,本文将系统梳理所有常用的条件注... 目录引言一、条件注解的核心机制二、SpringBoot内置条件注解详解1、@ConditionalOn
阅读更多...
Python中使用正则表达式精准匹配IP地址的案例

Python中使用正则表达式精准匹配IP地址的案例

《Python中使用正则表达式精准匹配IP地址的案例》Python的正则表达式(re模块)是完成这个任务的利器,但你知道怎么写才能准确匹配各种合法的IP地址吗,今天我们就来详细探讨这个问题,感兴趣的朋... 目录为什么需要IP正则表达式？IP地址的基本结构基础正则表达式写法精确匹配0-255的数字验证IP地
阅读更多...
通过Spring层面进行事务回滚的实现

通过Spring层面进行事务回滚的实现

《通过Spring层面进行事务回滚的实现》本文主要介绍了通过Spring层面进行事务回滚的实现,包括声明式事务和编程式事务,具有一定的参考价值,感兴趣的可以了解一下... 目录声明式事务回滚：1. 基础注解配置2. 指定回滚异常类型3. ​不回滚特殊场景编程式事务回滚：1. ​使用 TransactionT
阅读更多...
使用Python实现全能手机虚拟键盘的示例代码

使用Python实现全能手机虚拟键盘的示例代码

《使用Python实现全能手机虚拟键盘的示例代码》在数字化办公时代,你是否遇到过这样的场景：会议室投影电脑突然键盘失灵、躺在沙发上想远程控制书房电脑、或者需要给长辈远程协助操作？今天我要分享的Pyth... 目录一、项目概述：不止于键盘的远程控制方案1.1 创新价值1.2 技术栈全景二、需求实现步骤一、需求
阅读更多...
Spring LDAP目录服务的使用示例

Spring LDAP目录服务的使用示例

《SpringLDAP目录服务的使用示例》本文主要介绍了SpringLDAP目录服务的使用示例... 目录引言一、Spring LDAP基础二、LdapTemplate详解三、LDAP对象映射四、基本LDAP操作4.1 查询操作4.2 添加操作4.3 修改操作4.4 删除操作五、认证与授权六、高级特性与最佳
阅读更多...
Spring Shell 命令行实现交互式Shell应用开发

Spring Shell 命令行实现交互式Shell应用开发

《SpringShell命令行实现交互式Shell应用开发》本文主要介绍了SpringShell命令行实现交互式Shell应用开发,能够帮助开发者快速构建功能丰富的命令行应用程序,具有一定的参考价... 目录引言一、Spring Shell概述二、创建命令类三、命令参数处理四、命令分组与帮助系统五、自定义S
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2