经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » Java相关 » Spring » 查看文章
SpringMvc集成开源流量监控、限流、熔断降级、负载保护组件Sentinel
来源：cnblogs　　作者：京东云开发者　　时间：2023/12/1 11:34:41　　对本文有异议

前言：作者查阅了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;
  7. @Configuration
  8. @PropertySources({@PropertySource("classpath:/sentinel.properties")})
  9. public class SentinelAspectConfiguration {
  11.     @Bean
  12.     public SentinelResourceAspect sentinelResourceAspect() {
  13.         return new SentinelResourceAspect();
  14.     }
  15. }

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>
  6.     <filter-mapping>
  7.         <filter-name>SentinelCommonFilter</filter-name>
  8.         <url-pattern>/*</url-pattern>
  9.     </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 {
  4.     @GetMapping("/hello")
  5.     @ResponseBody
  6.     public String apiHello(String id) {
  7.         System.out.println("id = " + id);
  8.         Date date = new Date();
  9.         System.out.println("date = " + date);
  10.         return "Hello!";
  11.     }
  13.     @GetMapping("/doBusiness")
  14.     @ResponseBody
  15.     public String doBusiness(String id) {
  16.         System.out.println("doBusiness = ");
  17.         return "Oops...";
  18.     }
  19.  }

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

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

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

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

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。

作者：京东健康 马仁喜

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

原文链接：https://www.cnblogs.com/Jcloud/p/17866553.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Spring热门文章

  • 解决springboot+activemq启动报注解错误的问题
  • Springboot整合Rabbitmq之Confirm和Return机制
  • SpringBoot SpringEL表达式的使用
  • SpringBoot自动配置原理,你真的懂吗?(简单易懂)
  • Spring源码：Bean生命周期（终章）
  • Springboot-Management的项目实践
  • 解决springboot 启动找不到主类的问题
  • Spring5路径匹配器PathPattern解析
  • SpringAOP如何获取方法参数上的注解
  • java与es8实战之五：SpringBoot应用中操作es8(带安全检查：https、账号密码、API Key)

    • Spring推荐文章

  • SpringBoot Session共享，配置不生效问题排查 → 你竟然在代码里下毒！
  • 【Spring源码分析】Spring Scope功能中的动态代理 - Scoped Proxy
  • Spring AOP概念及原理
  • SpringBoot2.7还是任性的，就是不支持Logback1.3，你能奈他何
  • SpringBoot+ Sharding Sphere 轻松实现数据库字段加解密
  • Spring MVC 中视图的实现原理，在Spring MVC 中实现重定向和转发，以及访问静态资源 - Rainbow-Sea
  • Spring MVC 中 HttpMessageConverter 转换器 - Rainbow-Sea
  • SpringBoot+mail 轻松实现各类邮件自动推送
  • Spring MVC 获取三个域(request请求域，session 会话域，application 应用域)对象的方式 - Rainbow-Sea
  • SpringBoot3整合SpringDoc实现在线接口文档

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号