前言:作者查阅了Sentinel官网、51CTO、CSDN、码农家园、博客园等很多技术文章都没有很准确的springmvc集成Sentinel的示例,因此整理了本文,主要介绍SpringMvc集成Sentinel

SpringMvc集成Sentinel

一、Sentinel 介绍

随着微服务的流行,服务和服务之间的稳定性变得越来越重要。Sentinel 是面向分布式、多语言异构化服务架构的流量治理组件,主要以流量为切入点,从流量路由、流量控制、流量整形、熔断降级、系统自适应过载保护、热点流量防护等多个维度来帮助开发者保障微服务的稳定性。

GitHub主页:https://github.com/alibaba/Sentinel

中文文档:https://sentinelguard.io/zh-cn/docs/introduction.html

控制台文档:https://sentinelguard.io/zh-cn/docs/dashboard.html

核心类解析:https://github.com/alibaba/Sentinel/wiki/Sentinel-核心类解析

Sentinel示例项目:https://github.com/alibaba/Sentinel/tree/master/sentinel-demo

https://github.com/alibaba/spring-cloud-alibaba/tree/master/spring-cloud-alibaba-examples/sentinel-example

二、Sentinel 基本概念

资源

资源是 Sentinel 的关键概念。它可以是 Java 应用程序中的任何内容,例如,由应用程序提供的服务,或由应用程序调用的其它应用提供的服务,甚至可以是一段代码。在接下来的文档中,我们都会用资源来描述代码块。

只要通过 Sentinel API 定义的代码,就是资源,能够被 Sentinel 保护起来。大部分情况下,可以使用方法签名,URL,甚至服务名称作为资源名来标示资源。

规则

围绕资源的实时状态设定的规则,可以包括流量控制规则、熔断降级规则以及系统保护规则。所有规则可以动态实时调整。

三、springMVC集成Sentinel

这里用的是spring

<spring.version>5.3.18</spring.version>

<servlet.api.version>2.5</servlet.api.version> <sentinel.version>1.8.6</sentinel.version>

1、springmvc项目引入依赖pom

  1. <!-- 这是sentinel的核心依赖 -->
  2. <dependency>
  3. <groupId>com.alibaba.csp</groupId>
  4. <artifactId>sentinel-core</artifactId>
  5. <version>${sentinel.version}</version>
  6. </dependency>
  7. <!-- 这是将自己项目和sentinel-dashboard打通的依赖 -->
  8. <dependency>
  9. <groupId>com.alibaba.csp</groupId>
  10. <artifactId>sentinel-transport-simple-http</artifactId>
  11. <version>${sentinel.version}</version>
  12. </dependency>
  13. <!-- 这是使用sentinel对限流资源进行AOP -->
  14. <dependency>
  15. <groupId>com.alibaba.csp</groupId>
  16. <artifactId>sentinel-annotation-aspectj</artifactId>
  17. <version>${sentinel.version}</version>
  18. </dependency>
  19. <!--这是使用sentinel适配Web Servlet的依赖-->
  20. <dependency>
  21. <groupId>com.alibaba.csp</groupId>
  22. <artifactId>sentinel-web-servlet</artifactId>
  23. <version>${sentinel.version}</version>
  24. </dependency>
  25. <!-- 这是使用sentinel热点参数限流功能依赖 -->
  26. <dependency>
  27. <groupId>com.alibaba.csp</groupId>
  28. <artifactId>sentinel-parameter-flow-control</artifactId>
  29. <version>${sentinel.version}</version>
  30. </dependency>

2、添加配置文件

在application.properties下创建同级文件sentinel.properties,内容如下

  1. # 集成到sentinel的项目名称
  2. project.name=spring-sentinel-demo
  3. # 对应的sentinel-dashboard地址
  4. csp.sentinel.dashboard.server=localhost:8080

3、添加配置类引入配置文件

创建配置类SentinelAspectConfiguration并引入配置文件sentinel.properties

  1. import com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.context.annotation.PropertySource;
  5. import org.springframework.context.annotation.PropertySources;
  6. @Configuration
  7. @PropertySources({@PropertySource("classpath:/sentinel.properties")})
  8. public class SentinelAspectConfiguration {
  9. @Bean
  10. public SentinelResourceAspect sentinelResourceAspect() {
  11. return new SentinelResourceAspect();
  12. }
  13. }

4、web.xml新增如下过滤器配置

  1. <filter>
  2. <filter-name>SentinelCommonFilter</filter-name>
  3. <filter-class>com.alibaba.csp.sentinel.adapter.servlet.CommonFilter</filter-class>
  4. </filter>
  5. <filter-mapping>
  6. <filter-name>SentinelCommonFilter</filter-name>
  7. <url-pattern>/*</url-pattern>
  8. </filter-mapping>

接入 filter 之后,所有访问的 Web URL 就会被自动统计为 Sentinel 的资源---来源于 https://sentinelguard.io/zh-cn/docs/open-source-framework-integrations.html

开源框架适配的Web 适配下的Web Servlet

5、创建Controller接口

  1. @Controller
  2. public class WebMvcTestController {
  3. @GetMapping("/hello")
  4. @ResponseBody
  5. public String apiHello(String id) {
  6. System.out.println("id = " + id);
  7. Date date = new Date();
  8. System.out.println("date = " + date);
  9. return "Hello!";
  10. }
  11. @GetMapping("/doBusiness")
  12. @ResponseBody
  13. public String doBusiness(String id) {
  14. System.out.println("doBusiness = ");
  15. return "Oops...";
  16. }
  17. }

6、下载控制台-即图形化实时监控平台

参考 https://sentinelguard.io/zh-cn/docs/dashboard.html Sentinel 控制台的下载和启动

访问 https://github.com/alibaba/Sentinel/releases/tag/1.8.6

点击下载

7、运行控制台

  1. java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar

运行控制台后运行springmvc项目,然后访问某一个路径,就可以在控制台看到了,实时监控如果这个路径没有被访问是显示不出来的

这个时候我们配置限流为即Qps为2

8、测试限流

这里我们用postman进行压测,填写请求的路径保存。并点击run调出压测执行器

执行后查看结果如下

四、自定义异常返回

1、定义如下接口(这里只进行了常见的url定义方式的定义)

  1. import org.springframework.stereotype.Controller;
  2. import org.springframework.web.bind.annotation.*;
  3. @Controller
  4. @RequestMapping("/test")
  5. public class WebMvcTestController {
  6. /**
  7. * 1.未配置流控规则 1000次请求没有间隔发起请求,应该在1秒中完成09:44:33
  8. * @param id
  9. * @return
  10. */
  11. @RequestMapping("/RequestMapping")
  12. @ResponseBody
  13. public String RequestMapping(String id) {
  14. return "RequestMapping!";
  15. }
  16. @GetMapping("/GetMapping")
  17. @ResponseBody
  18. public String GetMapping(String id) {
  19. return "GetMapping...";
  20. }
  21. @PostMapping("/PostMapping")
  22. @ResponseBody
  23. public String PostMapping(String id) {
  24. return "PostMapping...";
  25. }
  26. /*
  27. * 路径变量(Path Variables):使用花括号 {} 来标记路径中的变量,并通过 @PathVariable 注解将其绑定到方法参数上
  28. * */
  29. @GetMapping("/GetMapping/{id}")
  30. @ResponseBody
  31. public String apiFoo(@PathVariable("id") Long id) {
  32. return "Hello " + id;
  33. }
  34. /*
  35. * Ant风格的路径匹配:
  36. * 使用 ? 表示任意单个字符,
  37. * * 表示任意多个字符(不包含路径分隔符 /),
  38. * ** 表示任意多个字符(包含路径分隔符 /)。
  39. * */
  40. @GetMapping("/Ant/*/{id}")
  41. @ResponseBody
  42. public String Ant(@PathVariable("id") Long id) {
  43. return "Ant " + id;
  44. }
  45. /*
  46. * 正则表达式路径匹配:使用 @RequestMapping 注解的 value 属性结合正则表达式来定义请求路径。
  47. * */
  48. @GetMapping(value = "/users/{id:\\d+}")
  49. @ResponseBody
  50. public String pattern(@PathVariable("id") int id) {
  51. return "Ant " + id;
  52. }
  53. }

2、自定义限流返回处理Handler

  1. import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlBlockHandler;
  2. import com.alibaba.csp.sentinel.slots.block.BlockException;
  3. import com.alibaba.csp.sentinel.slots.block.authority.AuthorityException;
  4. import com.alibaba.csp.sentinel.slots.block.degrade.DegradeException;
  5. import com.alibaba.csp.sentinel.slots.block.flow.FlowException;
  6. import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowException;
  7. import com.alibaba.csp.sentinel.slots.system.SystemBlockException;
  8. import com.alibaba.fastjson.JSON;
  9. import org.springframework.context.ApplicationContext;
  10. import org.springframework.web.method.HandlerMethod;
  11. import org.springframework.web.servlet.mvc.condition.PatternsRequestCondition;
  12. import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
  13. import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
  14. import org.springframework.web.util.UrlPathHelper;
  15. import javax.servlet.http.HttpServletRequest;
  16. import javax.servlet.http.HttpServletResponse;
  17. import java.io.IOException;
  18. import java.util.*;
  19. public class SentinelExceptionHandler implements UrlBlockHandler {
  20. @Override
  21. public void blocked(HttpServletRequest request, HttpServletResponse httpServletResponse, BlockException e) throws IOException {
  22. String contextPath = request.getContextPath();
  23. String servletPath = request.getServletPath();
  24. String requestURI = request.getRequestURI();
  25. String url = request.getRequestURL().toString();
  26. System.out.println("servletPath = " + servletPath);
  27. System.out.println("requestURI = " + requestURI);
  28. System.out.println("url = " + url);
  29. if (contextPath == null) {
  30. contextPath = "";
  31. }
  32. ApplicationContext controllerApplicationContext = LiteFlowApplicationContext.getControllerApplicationContext();
  33. RequestMappingHandlerMapping handlerMapping = controllerApplicationContext.getBean(RequestMappingHandlerMapping.class);
  34. // 查找匹配的处理方法
  35. Class<?> returnType = null;
  36. Map<RequestMappingInfo, HandlerMethod> handlerMethods = handlerMapping.getHandlerMethods();
  37. for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethods.entrySet()) {
  38. RequestMappingInfo requestMappingInfo = entry.getKey();
  39. HandlerMethod handlerMethod = entry.getValue();
  40. //匹配url
  41. if (requestMappingInfo.getPatternsCondition().getPatterns().contains(requestURI)) {
  42. System.out.println("Controller: " + handlerMethod.getBeanType().getName());
  43. System.out.println("Method: " + handlerMethod.getMethod().getName());
  44. System.out.println("getReturnType: " + handlerMethod.getMethod().getReturnType());
  45. returnType = handlerMethod.getMethod().getReturnType();
  46. break;
  47. }
  48. //匹配路径带参数的url
  49. UrlPathHelper pathHelper = new UrlPathHelper();
  50. String lookupPath = pathHelper.getPathWithinApplication(request);
  51. PatternsRequestCondition patternsCondition = requestMappingInfo.getPatternsCondition();
  52. if (patternsCondition != null && patternsCondition.getMatchingPatterns(lookupPath).size() > 0) {
  53. System.out.println("Controller1111: " + handlerMethod.getBeanType().getName());
  54. System.out.println("Method111: " + handlerMethod.getMethod().getName());
  55. System.out.println("getReturnType: " + handlerMethod.getMethod().getReturnType());
  56. returnType = handlerMethod.getMethod().getReturnType();
  57. break;
  58. }
  59. }
  60. httpServletResponse.setContentType("application/json;charset=utf-8");
  61. ResponseData data = null;
  62. if (returnType != null) {
  63. if (returnType == String.class) {
  64. String str = "返回类型为字符串方法限流";
  65. httpServletResponse.getWriter().write(str);
  66. return;
  67. } else if (returnType == Integer.class) {
  68. httpServletResponse.getWriter().write(new Integer(1));
  69. return;
  70. } else if (returnType == Long.class) {
  71. httpServletResponse.getWriter().write(2);
  72. return;
  73. } else if (returnType == Double.class) {
  74. } else if (returnType == Boolean.class) {
  75. } else if (returnType == Float.class) {
  76. } else if (returnType == Byte.class) {
  77. }
  78. }
  79. //BlockException 异常接口,包含Sentinel的五个异常
  80. // FlowException 限流异常
  81. // DegradeException 降级异常
  82. // ParamFlowException 参数限流异常
  83. // AuthorityException 授权异常
  84. // SystemBlockException 系统负载异常
  85. if (e instanceof FlowException) {
  86. data = new ResponseData(-1, "流控规则被触发......");
  87. } else if (e instanceof DegradeException) {
  88. data = new ResponseData(-2, "降级规则被触发...");
  89. } else if (e instanceof AuthorityException) {
  90. data = new ResponseData(-3, "授权规则被触发...");
  91. } else if (e instanceof ParamFlowException) {
  92. data = new ResponseData(-4, "热点规则被触发...");
  93. } else if (e instanceof SystemBlockException) {
  94. data = new ResponseData(-5, "系统规则被触发...");
  95. }
  96. httpServletResponse.getWriter().write(JSON.toJSONString(data));
  97. }
  98. }

3、使用自定义限流处理类

  1. import com.alibaba.csp.sentinel.adapter.servlet.callback.WebCallbackManager;
  2. import org.springframework.context.annotation.Configuration;
  3. @Configuration
  4. public class SentinelConfig {
  5. public SentinelConfig() {
  6. WebCallbackManager.setUrlBlockHandler(new SentinelExceptionHandler());
  7. }
  8. }

4、配置限流并测试结果

当开启限流后访问触发自定义UrlBlockHandler后结果如下

访问对应得url后控制台打印

  1. servletPath = /test/RequestMapping
  2. requestURI = /test/RequestMapping
  3. url = http://localhost:8081/test/RequestMapping
  4. Controller: org.example.WebMvcTestController
  5. Method: RequestMapping
  6. getReturnType: class java.lang.String
  7. servletPath = /test/GetMapping
  8. requestURI = /test/GetMapping
  9. url = http://localhost:8081/test/GetMapping
  10. Controller: org.example.WebMvcTestController
  11. Method: GetMapping
  12. getReturnType: class java.lang.String
  13. servletPath = /test/PostMapping
  14. requestURI = /test/PostMapping
  15. url = http://localhost:8081/test/PostMapping
  16. Controller: org.example.WebMvcTestController
  17. Method: PostMapping
  18. getReturnType: class java.lang.String
  19. servletPath = /test/GetMapping/4
  20. requestURI = /test/GetMapping/4
  21. url = http://localhost:8081/test/GetMapping/4
  22. Controller1111: org.example.WebMvcTestController
  23. Method111: apiFoo
  24. getReturnType: class java.lang.String
  25. servletPath = /test/Ant/a/5
  26. requestURI = /test/Ant/a/5
  27. url = http://localhost:8081/test/Ant/a/5
  28. Controller1111: org.example.WebMvcTestController
  29. Method111: Ant
  30. getReturnType: class java.lang.String
  31. servletPath = /test/users/5
  32. requestURI = /test/users/5
  33. url = http://localhost:8081/test/users/5
  34. Controller1111: org.example.WebMvcTestController
  35. Method111: pattern
  36. getReturnType: class java.lang.String

5、页面效果如下

五、springboot集成Sentinel

因为springboot集成文章较多,这里不多做赘述

Sentinel 与 Spring Boot/Spring Cloud 的整合见 Sentinel Spring Cloud Starter

作者:京东健康 马仁喜

来源:京东云开发者社区 转载请注明来源

SpringMvc集成开源流量监控、限流、熔断降级、负载保护组件Sentinel的更多相关文章

  1. Sentinel入门到实操 (限流熔断降级)

    微服务保护--Sentinel 介绍Sentinel 1.背景 Sentinel是阿里巴巴开源的一款微服务流量控制组件.官网地址:https://sentinelguard.io/zh-cn/inde ...

  2. springBoot整合Sentinel实现降级限流熔断

    由于hystrix的停止更新,以及阿里Sentinel在历年双十一的贡献.项目中使用了Sentinel,今天我们来讲讲Sentinel的入门教程,本文使用1.6.3版本进行讲解 本文通过Sentine ...

  3. Hystrix介绍以及服务的降级限流熔断

    (dubbo熔断,Hystrix问的少) 无论是缓存层还是存储层都会有出错的概率,可以将它们视同为资源.作为并发量较大的系统,假如有一个资源不可用,可能会造成线程全部 hang (挂起)在这个资源上, ...

  4. DBPack 限流熔断功能发布说明

    上周我们发布了 v0.4.0 版本,增加了限流熔断功能,现对这两个功能做如下说明. 限流 DBPack 限流熔断功能通过 filter 实现.要设置限流规则,首先要定义 RateLimitFilter ...

  5. dubbo 熔断,限流,降级

    1 写在前面 1.1 名词解释 consumer表示服务调用方 provider标示服务提供方,dubbo里面一般就这么讲. 下面的A调用B服务,一般是泛指调用B服务里面的一个接口. 1.2 拓扑图 ...

  6. .net core使用ocelot---第四篇 限流熔断

    简介 .net core使用ocelot---第一篇 简单使用 .net core使用ocelot---第二篇 身份验证 .net core使用ocelot---第三篇 日志记录 前几篇文章我们陆续介 ...

  7. .Net微服务实践(四)[网关]:Ocelot限流熔断、缓存以及负载均衡

    目录 限流 熔断 缓存 Header转化 HTTP方法转换 负载均衡 注入/重写中间件 后台管理 最后 在上篇.Net微服务实践(三)[网关]:Ocelot配置路由和请求聚合中我们介绍了Ocelot的 ...

  8. 高可用服务设计之二:Rate limiting 限流与降级

    <高可用服务设计之二:Rate limiting 限流与降级> <nginx限制请求之一:(ngx_http_limit_conn_module)模块> <nginx限制 ...

  9. 0.9.0.RELEASE版本的spring cloud alibaba sentinel限流、降级处理实例

    先看服务提供方的,我们在原来的sentinel实例(参见0.9.0.RELEASE版本的spring cloud alibaba sentinel实例)上加上限流.降级处理,三板斧只需在最后那一斧co ...

  10. Spring Cloud alibaba网关 sentinel zuul 四 限流熔断

    spring cloud alibaba 集成了 他内部开源的 Sentinel 熔断限流框架 Sentinel 介绍 官方网址 随着微服务的流行,服务和服务之间的稳定性变得越来越重要.Sentine ...

随机推荐

  1. Jmeter+Ant+Jenkins接口自动化测试平台

    一个完整的接口自动化测试平台需要支持接口的自动执行,自动生成测试报告,以及持续集成. Jmeter 支持接口的测试, Ant 支持自动构建,而 Jenkins 支持持续集成,所以三者组合在一起可以构成 ...

  2. 三维模型OSGB格式轻量化的纹理压缩和质量保持分析

    三维模型OSGB格式轻量化的纹理压缩和质量保持分析 在三维模型应用中,纹理数据是一个重要的部分,可以为模型增加更多的真实感和细节.但是,由于纹理数据通常会占用大量的存储空间和传输带宽,因此,在OSGB ...

  3. 搭建 QT6+OpenCv4.7+CMake的环境

    本文主要介绍如何搭建QT6+OpenCv的开发环境,基本流程如下 先安装CMake3.27.3,用来编译适用用QT的OpenCv的源码,安装完成后要配置系统的环境变量 安装Qt6的开发环境,并配置环境 ...

  4. @Async注解详解 以及 可能遇到的各种问题

    一.简介1)在方法上使用该@Async注解,申明该方法是一个异步任务:2)在类上面使用该@Async注解,申明该类中的所有方法都是异步任务:3)方法上一旦标记了这个@Async注解,当其它线程调用这个 ...

  5. 使用 Sealos 一键部署高可用 MinIO,开启对象存储之旅

    大家好!今天这篇文章主要向大家介绍如何通过 Sealos 一键部署高可用 MinIO 集群. MinIO 对象存储是什么? 对象是二进制数据,例如图像.音频文件.电子表格甚至二进制可执行代码.对象的大 ...

  6. 一款广受社区好评的 WAF

    大家好,我是 Java陈序员,我们有时会搭建一个属于自己的网站,但是自建网站很容易被收到攻击,今天给大家介绍一款简单免费好用的 WAF 网站防护工具. WAF 是 Web Application Fi ...

  7. 本计划在 .NET 8 中推出的 WASI 推迟到 .NET 9

    本计划在 .NET 8 中推出的 WASI  已推迟到 .NET 9,请参阅 Github 上的 WASI 跟踪问题. 在.NET 8 Preview 4 开始支持生成与 WASI 兼容的 .wasm ...

  8. Python并发编程——协程、Greenlet模块、Gevent模块、Gevent之同步与异步、Gevent应用

    文章目录 一 引子 二 协程介绍 三 Greenlet 四 Gevent介绍 五 Gevent之同步与异步 六 Gevent之应用举例一 七 Gevent之应用举例二 一 引子 本节的主题是基于单线程 ...

  9. 造轮子之ORM集成

    Dotnet的ORM千千万,还是喜欢用EF CORE 前面一些基础完成的差不多了,接下来可以集成数据库了,官方出品的ORM还是比较香.所以接下来就是来集成EF CORE. 安装包 首先我们需要安装一下 ...

  10. linux内核离线升级步骤详解【亲测可用】

    由于种种原因,linux的内核版本需要升级,但由于生产原因往往不能在线升级,在此记录笔者本人昨晚的的离线升级步骤,亲测可用. 我们知道,红帽和CentOS同源同宗,内核升级步骤也是一样的. 目录 ■ ...