SpringCloud--Sentinel使用

一、快速开始

Sentinel 的使用可以分为两个部分：

  • 核心库（Java 客户端）：不依赖任何框架/库，能够运行于 Java 8 及以上的版本的运行时环境，同时对 Dubbo / Spring Cloud 等框架也有较好的支持。
  • 控制台（Dashboard）：Dashboard 主要负责管理推送规则、监控、管理机器信息等。
1.1、客户端引入 Spring Cloud Alibaba Sentinel 依赖

在客户端 Spring Boot 项目的pom.xml文件中添加Sentinel的依赖。

	<!-- Sentinel 核心依赖 --><dependency><groupId>com.alibaba.csp</groupId><artifactId>sentinel-core</artifactId><version>最新版本号</version></dependency><!-- Spring Boot 集成 --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-sentinel</artifactId><version>最新版本号</version></dependency>
1.2、启动 Sentinel Dashboard

Sentinel Dashboard是一个可视化的控制台，用于查看流量数据和管理规则。可以从GitHub上下载最新版本的控制台 jar 包再通过命令将其启动。或者也可以下载 Sentinel 控制台源码自行构建运行。

1.下载地址：
https://github.com/alibaba/Sentinel/releases2.启动命令，-Dserver.port=8080 用于指定 Sentinel 控制台端口为 8080
java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar3.启动成功后，在浏览器中输入 http://localhost:8080 打开控制台。4.输入默认的用户名和密码都是 sentinel进行登录。
1.3、配置客户端连接到 Sentinel Dashboard

在客户端项目的application.properties或application.yml配置文件中设置Sentinel Dashboard的地址。

spring:cloud:sentinel:transport:port: 8719dashboard: localhost:8080
1.4、定义资源

在客户端代码中，可以通过编程的方式调用 Sentinel 的 API 来定义资源。也可以通过@SentinelResource注解对某个方法进行标注成资源。
（1）API 方式：

@GetMapping("/example")
public String example() {// 定义资源名称String resource = "example";// 调用Sentinel API进行流量控制SphU.entry(resource, () -> {// 这里是你的业务逻辑return "Hello Sentinel";});return "success";
}

（2）注解方式：

@SentinelResource(value = "productDetails", blockHandler = "blockHandler")
public ProductDetails getProductDetails(String productId) {// 业务逻辑
}
1.5、配置规则

在Sentinel Dashboard控制台中进行图形化配置规则。进入控制台后，选择左侧菜单栏的具体规则菜单，然后点击右上方"新增"按钮来定义规则。也可以通过编程方式动态添加GatewayFlowRule到Sentinel的规则仓库中。
（1）控制台图形化配置：
在这里插入图片描述
（2）编程式动态添加：

public class RuleConfig {public static void main(String[] args) {// 创建一个限流规则FlowRule rule = new FlowRule();rule.setResource("product_route"); // 设置资源名称rule.setGrade(RuleConstant.FLOW_GRADE_QPS); // 设置限流策略等级为QPSrule.setCount(10); // 设置每秒最大请求数为10// 将规则添加到内存中GatewayRuleManager.loadRules(Collections.singletonList(rule));}
}

二、简单使用实例

通过@SentinelResource注解将需要使用 Sentinel 进行控制的方法定义成资源，后续对该方法的访问都会受到Sentinel 所配置的相关规则控制。

@RestController
public class TestController {@Autowiredprivate TestService service;@GetMapping(value = "/hello/{name}")public String apiHello(@PathVariable String name) {return service.sayHello(name);}
}@Service
public class TestService {@SentinelResource(value = "sayHello")public String sayHello(String name) {return "Hello, " + name;}
}
2.1 @SentinelResource 注解

@SentinelResource 注解用来标识资源是否被限流、降级。该注解有如下属性：

  • value：资源名称，必需项（不能为空）。
  • entryType：entry 类型，可选项（默认为 EntryType.OUT）。
  • blockHandler：blockHandler 对应处理 BlockException 的函数名称，可选项。blockHandler 函数签名和位置要求：
    • 函数访问范围需要是 public，返回类型需要与原方法相匹配；
    • 方法参数类型需要和原方法相匹配并且最后加一个额外的参数，类型为 BlockException；
    • blockHandler 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定 blockHandlerClass 为对应的类的 Class 对象，注意对应的函数必需为 static 函数，否则无法解析；
  • fallback：fallback 函数名称，可选项，用于在抛出异常的时候提供 fallback 处理逻辑。fallback 函数可以针对所有类型的异常（除了 exceptionsToIgnore 里面排除掉的异常类型）进行处理。fallback 函数签名和位置要求：
    • 函数访问范围需要是 public，返回值类型必须与原函数返回值类型一致；
    • 方法参数列表需要和原函数一致，或者可以额外多一个 Throwable 类型的参数用于接收对应的异常；
    • fallback 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定 fallbackClass 为对应的类的 Class 对象，注意对应的函数必需为 static 函数，否则无法解析；
  • defaultFallback（since 1.6.0）：默认的 fallback 函数名称，可选项，通常用于通用的 fallback 逻辑。默认 fallback 函数可以针对所有类型的异常（除了 exceptionsToIgnore 里面排除掉的异常类型）进行处理。若同时配置了 fallback 和 defaultFallback，则只有 fallback 会生效。defaultFallback 函数签名要求与fallback一样。
  • exceptionsToIgnore（since 1.6.0）：用于指定哪些异常被排除掉，不会计入异常统计中，也不会进入 fallback 逻辑中，而是会原样抛出。

示例：

public class TestService {// 原函数@SentinelResource(value = "hello", blockHandler = "exceptionHandler", fallback = "helloFallback")public String hello(long s) {return String.format("Hello at %d", s);}// Fallback 函数，函数签名与原函数一致或加一个 Throwable 类型的参数.public String helloFallback(long s) {return String.format("Halooooo %d", s);}// Block 异常处理函数，参数最后多一个 BlockException，其余与原函数一致.public String exceptionHandler(long s, BlockException ex) {// Do some log here.ex.printStackTrace();return "Oops, error occurred at " + s;}
}
2.2 注解埋点使用限制
  • 确保项目引入了 Spring AOP（或相关 starter）
  • 确保注解方法所在的类已注册为 Spring bean，非 Spring bean 不支持
  • 注意注解埋点不支持 private 方法，不支持内部调用
  • static 方法受 AOP 限制，无法进行代理，暂不支持
  • 若 blockHandler/fallback 不生效，则排查函数签名是否符合要求
  • 如果是不支持 AOP 的场景（比如 javax WebSocket），则无法使用注解方式埋点，需要使用 SphU 方式埋点

三、Spring Cloud Gateway 支持

3.1 引入相关依赖

若想让Spring Cloud Gateway 跟 Sentinel Starter 配合使用，需要加上 spring-cloud-alibaba-sentinel-gateway 依赖，同时需要添加 spring-cloud-starter-gateway 依赖来让 spring-cloud-alibaba-sentinel-gateway 模块里的 Spring Cloud Gateway 自动化配置类生效。

<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>
<dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
</dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
3.2 Sentinel 对 Spring Cloud Gateway 进行限流

在Spring Cloud Gateway中，SentinelGatewayFilter作为一个全局过滤器被集成进来，用于拦截流经网关的请求，并应用Sentinel的流量控制规则。Sentinel 提供了 Spring Cloud Gateway 两种资源维度的限流，默认的粒度是 route 维度以及自定义 API 分组维度。默认不支持 URL 粒度，所以需要将 spring.cloud.sentinel.filter.enabled 配置项置为 false。

  • route 维度：即在 Spring 配置文件中配置的路由条目，资源名为对应的 routeId
  • 自定义 API 维度：用户可以利用 Sentinel 提供的 API 来自定义一些 API 分组

使用时首先需引入以下模块：

<dependency><groupId>com.alibaba.csp</groupId><artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
</dependency>

然后再注入对应的 SentinelGatewayFilter 实例以及 SentinelGatewayBlockExceptionHandler 实例即可。

@Configuration
public class GatewayConfiguration {private final List<ViewResolver> viewResolvers;private final ServerCodecConfigurer serverCodecConfigurer;public GatewayConfiguration(ObjectProvider<List<ViewResolver>> viewResolversProvider,ServerCodecConfigurer serverCodecConfigurer) {this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);this.serverCodecConfigurer = serverCodecConfigurer;}@Bean@Order(Ordered.HIGHEST_PRECEDENCE)public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {// Register the block exception handler for Spring Cloud Gateway.return new SentinelGatewayBlockExceptionHandler(viewResolvers, serverCodecConfigurer);}@Bean@Order(-1)public GlobalFilter sentinelGatewayFilter() {return new SentinelGatewayFilter();}
}
3.3 自定义SentinelGatewayFilter

如果需要自定义流量控制逻辑，可以创建一个自定义的SentinelGatewayFilter实现类。通常涉及以下步骤：

  1. 添加依赖：首先，确保你的项目中已经加入了Sentinel的相关依赖。
  2. 启用Sentinel：在你的Spring Boot应用中添加@EnableSentinel注解来开启Sentinel。
  3. 创建自定义过滤器：创建一个实现GlobalFilter接口的类。这个接口用于定义过滤器的名称、描述和执行逻辑。
  4. 注入SentinelGatewayFilter：在你的自定义过滤器中注入SentinelGatewayFilter，以便能够调用Sentinel的处理逻辑。
  5. 实现过滤逻辑：在实现类中，覆盖apply方法，在其中编写具体的过滤逻辑。
  6. 注册过滤器：将自定义的GlobalFilter实现类作为Bean注册到Spring应用上下文中。

示例：

/*** 创建自定义过滤器**/
@Component
public class CustomSentinelGatewayFilter implements GlobalFilter, Ordered {private final SentinelGatewayFilter sentinelGatewayFilter;// 注入SentinelGatewayFilterpublic CustomSentinelGatewayFilter(SentinelGatewayFilter sentinelGatewayFilter) {this.sentinelGatewayFilter = sentinelGatewayFilter;}/*** 实现自定义过滤逻辑**/@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {try {// 在执行Sentinel的过滤逻辑之前，可以添加自定义的预处理逻辑// ...// 执行Sentinel的过滤逻辑return sentinelGatewayFilter.filter(exchange, chain);} catch (BlockException ex) {// 当Sentinel拦截请求时，可以在这里添加自定义的处理逻辑// ...return Mono.empty();}}@Overridepublic int getOrder() {// 设置过滤器的执行顺序，数值越小越先执行return SentinelGatewayFilter.ORDER - 1;}
}

在Spring Boot的配置类中注册自定义过滤器。

@Configuration
public class GatewayConfig {@Beanpublic GlobalFilter customFilter() {return new CustomSentinelGatewayFilter(new SentinelGatewayFilter());}
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/513680.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

重构、重构、不小心把截图弄掉了，又要重新⏲

重构、重构、不小心把截图弄掉了，又要重新⏲

这里卡了一天的命令行了&#xff0c;都是vue,react的&#xff0c;也是服了。 参考文章&#xff0c;vue的响应式&#xff0c;以下是链接 https://blog.csdn.net/jieyucx/article/details/134534625 #mermaid-svg-H5Ltjf334Cx7lPuR {font-family:"trebuchet ms",verda…
阅读更多...
HarmonyOS通过 axios发送HTTP请求

HarmonyOS通过 axios发送HTTP请求

我之前的文章 HarmonyOS 发送http网络请求 那么今天 我们就来说说axios 这个第三方工具 想必所有的前端开发者都不会陌生 axios 本身也属于 HTTP请求 所以鸿蒙开发中也支持它 但首先 想在HarmonyOS中 使用第三方工具库 就要先下载安装 ohpm 具体可以参考我的文章 HarmonyOS 下…
阅读更多...
IntelliJ IDEA 2020.2.4试用方法

IntelliJ IDEA 2020.2.4试用方法

打开idea&#xff0c;准备好ide-eval-resetter压缩包。 将准备好的压缩包拖入idea中 选中弹窗中的自动重置选项&#xff0c;并点击重置 查看免费试用时长
阅读更多...
rabbitmq基础（1）

rabbitmq基础（1）

1、背景 能实现消息队列的框架软件有很多&#xff0c;kafka、rabbitmq、RocketMq、activeMq、Redis&#xff08;非专业&#xff09;&#xff0c;各有各的特点和优缺点。但是之前的公司数据需求规模并非很大&#xff0c;所以采用rabbitmq作为消息队列。 2、rabbitMq的基础架构…
阅读更多...
结构体嵌套

结构体嵌套

在C或C编程中&#xff0c;结构体嵌套是指一个结构体内部包含了另一个结构体的实例作为其成员。 // 结构体嵌套.cpp : 此文件包含 "main" 函数。程序执行将在此处开始并结束。 #define _CRT_SECURE_NO_WARNINGS#include <iostream>// 定义一个地址结构体 type…
阅读更多...
矩阵爆破逆向-条件断点的妙用

矩阵爆破逆向-条件断点的妙用

不知道你是否使用过IDA的条件断点呢&#xff1f;在IDA进阶使用中&#xff0c;它的很多功能都有大作用&#xff0c;比如&#xff1a;ida-trace来跟踪调用流程。同时IDA的断点功能也十分强大&#xff0c;配合IDA-python的输出语句能够大杀特杀&#xff01; 那么本文就介绍一下这…
阅读更多...
SpringBoot集成flink

SpringBoot集成flink

Flink是一个批处理和流处理结合的统一计算框架&#xff0c;其核心是一个提供了数据分发以及并行化计算的流数据处理引擎。 最大亮点是流处理&#xff0c;最适合的应用场景是低时延的数据处理。 场景&#xff1a;高并发pipeline处理数据&#xff0c;时延毫秒级&#xff0c;且兼具…
阅读更多...
【Python】新手入门（2）：避免将关键字作为标识符

【Python】新手入门（2）：避免将关键字作为标识符

Python新手入门&#xff08;2&#xff09;&#xff1a;避免将关键字作为标识符 &#x1f308; 个人主页&#xff1a;高斯小哥 &#x1f525; 高质量专栏&#xff1a;Matplotlib之旅&#xff1a;零基础精通数据可视化、Python基础【高质量合集】、PyTorch零基础入门教程&#x1…
阅读更多...
【Redis】Redis持久化模式RDB

【Redis】Redis持久化模式RDB

目录 引子 RDB RDB的优缺点 小节一下 引子 不论把Redis作为数据库还是缓存来使用&#xff0c;他肯定有数据需要持久化&#xff0c;这里我们就来聊聊两种持久化机制。这两种机制&#xff0c;其实是 快照 与 日志 的形式。快照:就是当前数据的备份&#xff0c;我可以拷贝到磁…
阅读更多...
Win UI3开发笔记（四）设置主题续2

Win UI3开发笔记（四）设置主题续2

本机深色主题下设置的背景颜色可以作用于整个对话框&#xff0c;本机浅色模式下设置的背景颜色只作用与下边的部分。 如果本机选深色&#xff0c;程序选浅色&#xff0c;设置为light只对上部分管用&#xff0c;下部分不管用。如图&#xff0c;左边那个hello按钮要看不见了。。…
阅读更多...
GIS软件应用（一）

GIS软件应用（一）

任务&#xff1a; 1.加载南京市边界数据、查看投影坐标系并完成投影转换 2.加载科教文卫POI数据、查看投影坐标系并完成投影转换 3.出图要求添加完整出图要素 步骤&#xff1a; 选中shp文件&#xff0c;加载南京市边界数据 在ArcToolbox工具箱中选中Projections and Transf…
阅读更多...
5G 网络切片VLAN ID配置错误导致业务不可用

5G 网络切片VLAN ID配置错误导致业务不可用

【摘要】随着电联5G共建共享工作的开展&#xff0c;无法及时有效观测到单逻辑站点的相关指标&#xff0c;导致单运营商用户业务出现异常。本案例中着重对单运营商用户无法使用网络进行相关参数排查&#xff0c;从KPI性能指标结合故障告警发生时间&#xff0c;从而分析由于网络切…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023