SpringCloudAlibaba之Sentinel简单使用

2024-04-23 21:52

本文主要是介绍SpringCloudAlibaba之Sentinel简单使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

SpringCloudAlibaba之Sentinel简单使用

文章目录

    • SpringCloudAlibaba之Sentinel简单使用
      • sentinel入门
      • 资源定义
        • SphU(抛出异常方式)
        • SphO(布尔类型方式)
        • @SentinelResource(注解的方式定义)
          • @SentinelResource使用前置条件
          • 使用@SentinelResource定义资源
          • 定义blockHandler和fallback方法(方法名称和@sentinelResoruce的参数名称需要一直,并且方法必须是public修饰)
          • @SentinelResoruce参数释义
          • 完整的service代码(资源定义)
      • 定义sentinel规则
      • 校验规则是否生效

使用sentinel三部曲,

  1. 定义资源
  2. 定义规则
  3. 检验规则是否生效

sentinel入门

  1. 创建基础模块sentinel-boot-service
  • 引入依赖
<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.0</version>
</dependency>
  • 创建主类
@SpringBootApplication
public class SentinelBootServiceApplication {public static void main(String[] args) {SpringApplication.run(SentinelBootServiceApplication.class,args);}
}
  • 创建application.yml
server:port: 8080

资源定义

  1. 定义sentinel资源,sentinel中的资源可以是一段代码,一个方法,甚至是整个应用。sentinel可以保护整个应用

资源必须定义资源名称

  • 创建service/SentinelTestService
SphU(抛出异常方式)
public String sphuTest(){// 1.5.0 版本开始可以直接利用 try-with-resources 特性try(Entry ignored = SphU.entry("sphuTest")) {// 被保护的逻辑return "hello world";} catch (BlockException ex) {// 处理被流控的逻辑return "blocked";}
}

Sphu.entry(resourceName) 可以定义一段sentinel资源,当访问超出sentinel定义的规则后,Sphu.entry方法会抛出BlockException

所以可以在try语句块中定义sentinel的资源,也就是被保护的逻辑。在catch块中捕获BlockException,用来对降级进行处理

SphO(布尔类型方式)
public String sphoTest() {if(SphO.entry("sphoTest")){try {return "hello world";} finally{SphO.exit();}}else{//被限流了,逻辑处理return "被限流了";}
}

SphO.entry(resourceName) 方法可以返回一个boolean值,用于是否通过sentinel管控,必须与SphO.exit()搭配使用

@SentinelResource(注解的方式定义)
@SentinelResource使用前置条件

由于@SentinelResource是通过aop方式进行管控,所以需要引入aspectj模块

<dependency><groupId>com.alibaba.csp</groupId><artifactId>sentinel-annotation-aspectj</artifactId><version>1.8.0</version>
</dependency>
  • SentinelResourceAspect注入到Spring容器中

sentinel-boot-service 的config包下创建SentinelConfig

@Configuration
public class SentinelConfig {//注入@Beanpublic SentinelResourceAspect sentinelResourceAspect(){return new SentinelResourceAspect();}
}
使用@SentinelResource定义资源
private static AtomicInteger atomicInteger = new AtomicInteger(0);@SentinelResource(value = "annotationTest",blockHandler = "blockHandler",fallback = "fallback")public String annotationTest(){int i = atomicInteger.incrementAndGet();if(i % 2 == 0){return "hello world";}else{throw new RuntimeException("something wrong");}}

blockHandler和fallback是两个概念

blockHandler是sentinel对资源进行限流或者熔断时的处理规则

fallback是资源抛出异常后,对异常捕获后的处理

定义blockHandler和fallback方法(方法名称和@sentinelResoruce的参数名称需要一直,并且方法必须是public修饰)
	public String blockHandler(BlockException ex){ex.printStackTrace();return "block handler";}public String fallback(){return "fallback";}

所以上述代码有三段逻辑,第一段正常逻辑返回hello world,第二段,抛出异常,被fallback捕获,返回fallback,第三段,被sentinel限流,被blockHandler处理,返回block handler

@SentinelResoruce参数释义
参数名称类型描述
valueString必需项,用于指定资源的名称。这个名称通常用于在 Sentinel Dashboard 中进行监控和管理。
entryTypeEntryType可选项,指定 entry 的类型。默认为 EntryType.OUT,表示这是一个出站调用。
blockHandlerString可选项,指定处理 BlockException 的函数名称。当原方法被限流或熔断时,会调用这个函数进行异常处理。该函数的访问范围需要是 public,返回类型需要与原方法相匹配,参数类型需要和原方法相匹配并且最后加一个额外的参数,类型为 BlockException。默认情况下,这个函数需要和原方法在同一个类中。
blockHandlerClassClass<?>可选项,当希望使用其他类的函数作为 blockHandler 时,可以指定这个类的 Class 对象。注意,对应的函数必须为 static 函数。
fallbackString可选项,指定回退函数名称,当原方法调用失败时,会调用这个回退函数。回退函数的签名(返回值类型、参数类型)需要与原方法一致。
fallbackClassClass<?>可选项,当希望使用其他类的函数作为回退函数时,可以指定这个类的 Class 对象。同样,对应的函数必须为 static 函数。
resourceTypeint可选项,用于指定资源的类型。这通常用于区分不同类型的资源,以便进行更精细的控制。
exceptionsToIgnoreClass<? extends Throwable>[]可选项,指定需要忽略的异常类型。当原方法抛出这些异常时,Sentinel 不会触发限流或熔断逻辑。

这个注解允许开发者对方法进行细粒度的流量控制,同时提供了异常处理和回退机制,确保系统的可靠性和稳定性。通过合理配置这些参数,可以更加精准地控制应用的流量,避免由于流量过大或异常导致的系统崩溃。

完整的service代码(资源定义)
@Service
public class SentinelTestService {private static AtomicInteger atomicInteger = new AtomicInteger(0);public String sphuTest(){// 1.5.0 版本开始可以直接利用 try-with-resources 特性try(Entry ignored = SphU.entry("sphuTest")) {// 被保护的逻辑return "hello world";} catch (BlockException ex) {// 处理被流控的逻辑return "blocked";}}public String sphoTest() {if(SphO.entry("sphoTest")){try {return "hello world";} finally{SphO.exit();}}else{//被限流了,逻辑处理return "被限流了";}}@SentinelResource(value = "annotationTest",blockHandler = "blockHandler",fallback = "fallback")public String annotationTest(){int i = atomicInteger.incrementAndGet();if(i % 2 == 0){return "hello world";}else{throw new RuntimeException("something wrong");}}public String blockHandler(BlockException ex){ex.printStackTrace();return "block handler";}public String fallback(){return "fallback";}
}

定义sentinel规则

sentinel的规则有很多种,此文章示例,仅用流控来测试sentinel定义的资源信息

在config/SentinelRuleConfig下分别创建上面三个资源的流控规则,如下

@Configuration
public class SentinelRuleConfig {@PostConstructpublic void init(){List<FlowRule> rules = new ArrayList<>();FlowRule rule = new FlowRule();//定义规则适用的资源名称rule.setResource("sphuTest");rule.setGrade(RuleConstant.FLOW_GRADE_QPS);//定义每秒被保护的代码块最多运行2次rule.setCount(2);rules.add(rule);FlowRule sphoTestRule = new FlowRule();//定义规则适用的资源名称sphoTestRule.setResource("sphoTest");sphoTestRule.setGrade(RuleConstant.FLOW_GRADE_QPS);//定义每秒被保护的代码块最多运行2次sphoTestRule.setCount(2);rules.add(sphoTestRule);FlowRule annotationTestRule = new FlowRule();//定义规则适用的资源名称annotationTestRule.setResource("annotationTest");annotationTestRule.setGrade(RuleConstant.FLOW_GRADE_QPS);//定义每秒被保护的代码块最多运行2次annotationTestRule.setCount(2);rules.add(annotationTestRule);FlowRuleManager.loadRules(rules);}
}
  • setResource:设置资源名称
  • setGrade:设置流控的类型,此处通过QPS,即每秒的访问量
  • setCount: 设置每秒访问量的阈值,当大于2时,触发sentinel流控

校验规则是否生效

  • 新建入口SentinelTestController,并分别创建三个uri对应三个资源的访问
public class SentinelTestController {@Resourceprivate SentinelTestService sentinelTestService;@GetMapping("/sphuTest")public String sphuTest(){return sentinelTestService.sphuTest();}@GetMapping("/sphoTest")public String sphoTest(){return sentinelTestService.sphoTest();}@GetMapping("/annotationTest")public String annotationTest(){return sentinelTestService.annotationTest();}
}
  • 启动sentinel-boot-service项目模块,并通过浏览器访问
  1. sphuTest
  • 访问sphuTest,可以看到正常返回hello world
http://localhost:8080/sentinel/sphuTest
-> hello world
  • 快速刷新sphuTest,可以看到blockedhello world出现
http://localhost:8080/sentinel/sphuTest
-> hello world
-> blocked    
  1. sphotest
  • 访问sphOTest,可以看到正常返回hello world
http://localhost:8080/sentinel/sphoTest
-> hello world
  • 快速刷新sphoTest,可以看到被限流了hello world出现
http://localhost:8080/sentinel/sphoTest
-> hello world
-> 被限流了
  1. annotationTest
  • 低频率刷新annotationTest,可以看到hello world和fallback交替出现,这里由于业务逻辑是执行一次,抛一次异常,异常捕获被fallback执行,所以交替出现
http://localhost:8080/sentinel/annotationTest
-> hello world
-> fallback
-> hello world
-> fallback
-> hello world
-> fallback
  • 高频率刷新,可以看到hello worldfallbackblock handler都会出现。

在高频率刷新中,可能会执行正常逻辑(未限流,未异常情况),可能执行到fallback逻辑(异常情况),block handler(达到设定的流控QPS阈值)

这篇关于SpringCloudAlibaba之Sentinel简单使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/929987

相关文章

Spring Boot中的路径变量示例详解

《SpringBoot中的路径变量示例详解》SpringBoot中PathVariable通过@PathVariable注解实现URL参数与方法参数绑定,支持多参数接收、类型转换、可选参数、默认值及... 目录一. 基本用法与参数映射1.路径定义2.参数绑定&nhttp://www.chinasem.cnbs

C++中assign函数的使用

《C++中assign函数的使用》在C++标准模板库中,std::list等容器都提供了assign成员函数,它比操作符更灵活,支持多种初始化方式,下面就来介绍一下assign的用法,具有一定的参考价... 目录​1.assign的基本功能​​语法​2. 具体用法示例​​​(1) 填充n个相同值​​(2)

JAVA中安装多个JDK的方法

《JAVA中安装多个JDK的方法》文章介绍了在Windows系统上安装多个JDK版本的方法,包括下载、安装路径修改、环境变量配置(JAVA_HOME和Path),并说明如何通过调整JAVA_HOME在... 首先去oracle官网下载好两个版本不同的jdk(需要登录Oracle账号,没有可以免费注册)下载完

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

Spring Boot 结合 WxJava 实现文章上传微信公众号草稿箱与群发

《SpringBoot结合WxJava实现文章上传微信公众号草稿箱与群发》本文将详细介绍如何使用SpringBoot框架结合WxJava开发工具包,实现文章上传到微信公众号草稿箱以及群发功能,... 目录一、项目环境准备1.1 开发环境1.2 微信公众号准备二、Spring Boot 项目搭建2.1 创建

Java中Integer128陷阱

《Java中Integer128陷阱》本文主要介绍了Java中Integer与int的区别及装箱拆箱机制,重点指出-128至127范围内的Integer值会复用缓存对象,导致==比较结果为true,下... 目录一、Integer和int的联系1.1 Integer和int的区别1.2 Integer和in

SpringSecurity整合redission序列化问题小结(最新整理)

《SpringSecurity整合redission序列化问题小结(最新整理)》文章详解SpringSecurity整合Redisson时的序列化问题,指出需排除官方Jackson依赖,通过自定义反序... 目录1. 前言2. Redission配置2.1 RedissonProperties2.2 Red

IntelliJ IDEA2025创建SpringBoot项目的实现步骤

《IntelliJIDEA2025创建SpringBoot项目的实现步骤》本文主要介绍了IntelliJIDEA2025创建SpringBoot项目的实现步骤,文中通过示例代码介绍的非常详细,对大家... 目录一、创建 Spring Boot 项目1. 新建项目2. 基础配置3. 选择依赖4. 生成项目5.

JSONArray在Java中的应用操作实例

《JSONArray在Java中的应用操作实例》JSONArray是org.json库用于处理JSON数组的类,可将Java对象(Map/List)转换为JSON格式,提供增删改查等操作,适用于前后端... 目录1. jsONArray定义与功能1.1 JSONArray概念阐释1.1.1 什么是JSONA

Java JDK1.8 安装和环境配置教程详解

《JavaJDK1.8安装和环境配置教程详解》文章简要介绍了JDK1.8的安装流程,包括官网下载对应系统版本、安装时选择非系统盘路径、配置JAVA_HOME、CLASSPATH和Path环境变量,... 目录1.下载JDK2.安装JDK3.配置环境变量4.检验JDK官网下载地址:Java Downloads