SpringMvc集成開源流量監控、限流、熔斷降級、負載保護組件Sentinel

来源:https://www.cnblogs.com/Jcloud/archive/2023/11/30/17866553.html
-Advertisement-
Play Games

作者查閱了Sentinel官網、51CTO、CSDN、碼農家園、博客園等很多技術文章都沒有很準確的springmvc集成Sentinel的示例,因此整理了本文,主要介紹SpringMvc集成Sentinel ...


前言:作者查閱了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

        <!-- 這是sentinel的核心依賴 -->
        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-core</artifactId>
            <version>${sentinel.version}</version>
        </dependency>
        <!-- 這是將自己項目和sentinel-dashboard打通的依賴 -->
        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-transport-simple-http</artifactId>
            <version>${sentinel.version}</version>
        </dependency>
        <!-- 這是使用sentinel對限流資源進行AOP -->
        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-annotation-aspectj</artifactId>
            <version>${sentinel.version}</version>
        </dependency>
        <!--這是使用sentinel適配Web Servlet的依賴-->
        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-web-servlet</artifactId>
            <version>${sentinel.version}</version>
        </dependency>
        <!-- 這是使用sentinel熱點參數限流功能依賴 -->
        <dependency>
            <groupId>com.alibaba.csp</groupId>
            <artifactId>sentinel-parameter-flow-control</artifactId>
            <version>${sentinel.version}</version>
        </dependency>

2、添加配置文件

在application.properties下創建同級文件sentinel.properties,內容如下

# 集成到sentinel的項目名稱
project.name=spring-sentinel-demo
# 對應的sentinel-dashboard地址
csp.sentinel.dashboard.server=localhost:8080

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

創建配置類SentinelAspectConfiguration並引入配置文件sentinel.properties

import com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.annotation.PropertySources;

@Configuration
@PropertySources({@PropertySource("classpath:/sentinel.properties")})
public class SentinelAspectConfiguration {

    @Bean
    public SentinelResourceAspect sentinelResourceAspect() {
        return new SentinelResourceAspect();
    }
}

4、web.xml新增如下過濾器配置

 <filter>
        <filter-name>SentinelCommonFilter</filter-name>
        <filter-class>com.alibaba.csp.sentinel.adapter.servlet.CommonFilter</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>SentinelCommonFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

接入 filter 之後,所有訪問的 Web URL 就會被自動統計為 Sentinel 的資源---來源於 https://sentinelguard.io/zh-cn/docs/open-source-framework-integrations.html

開源框架適配的Web 適配下的Web Servlet

5、創建Controller介面

@Controller
public class WebMvcTestController {

    @GetMapping("/hello")
    @ResponseBody
    public String apiHello(String id) {
        System.out.println("id = " + id);
        Date date = new Date();
        System.out.println("date = " + date);
        return "Hello!";
    }

    @GetMapping("/doBusiness")
    @ResponseBody
    public String doBusiness(String id) {
        System.out.println("doBusiness = ");
        return "Oops...";
    }
 }

6、下載控制台-即圖形化實時監控平臺

參考 https://sentinelguard.io/zh-cn/docs/dashboard.html Sentinel 控制台的下載和啟動

訪問 https://github.com/alibaba/Sentinel/releases/tag/1.8.6

點擊下載

7、運行控制台

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定義方式的定義)

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
@RequestMapping("/test")
public class WebMvcTestController {
  
    /**
     * 1.未配置流控規則 1000次請求沒有間隔發起請求,應該在1秒中完成09:44:33
     * @param id
     * @return
     */
    @RequestMapping("/RequestMapping")
    @ResponseBody
    public String RequestMapping(String id) {
        return "RequestMapping!";
    }

    @GetMapping("/GetMapping")
    @ResponseBody
    public String GetMapping(String id) {
        return "GetMapping...";
    }

    @PostMapping("/PostMapping")
    @ResponseBody
    public String PostMapping(String id) {
        return "PostMapping...";
    }

    /*
    * 路徑變數(Path Variables):使用花括弧 {} 來標記路徑中的變數,並通過 @PathVariable 註解將其綁定到方法參數上
    * */
    @GetMapping("/GetMapping/{id}")
    @ResponseBody
    public String apiFoo(@PathVariable("id") Long id) {
        return "Hello " + id;
    }

    /*
    * Ant風格的路徑匹配:
    *   使用 ? 表示任意單個字元,
    *   * 表示任意多個字元(不包含路徑分隔符 /),
    *   ** 表示任意多個字元(包含路徑分隔符 /)。
    * */
    @GetMapping("/Ant/*/{id}")
    @ResponseBody
    public String Ant(@PathVariable("id") Long id) {
        return "Ant " + id;
    }

    /*
    * 正則表達式路徑匹配:使用 @RequestMapping 註解的 value 屬性結合正則表達式來定義請求路徑。
    * */
    @GetMapping(value = "/users/{id:\\d+}")
    @ResponseBody
    public String pattern(@PathVariable("id") int id) {
        return "Ant " + id;
    }
}


2、自定義限流返回處理Handler

import com.alibaba.csp.sentinel.adapter.servlet.callback.UrlBlockHandler;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.alibaba.csp.sentinel.slots.block.authority.AuthorityException;
import com.alibaba.csp.sentinel.slots.block.degrade.DegradeException;
import com.alibaba.csp.sentinel.slots.block.flow.FlowException;
import com.alibaba.csp.sentinel.slots.block.flow.param.ParamFlowException;
import com.alibaba.csp.sentinel.slots.system.SystemBlockException;
import com.alibaba.fastjson.JSON;
import org.springframework.context.ApplicationContext;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.mvc.condition.PatternsRequestCondition;
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
import org.springframework.web.util.UrlPathHelper;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.*;


public class SentinelExceptionHandler implements UrlBlockHandler {

    @Override
    public void blocked(HttpServletRequest request, HttpServletResponse httpServletResponse, BlockException e) throws IOException {
        String contextPath = request.getContextPath();
        String servletPath = request.getServletPath();
        String requestURI = request.getRequestURI();
        String url = request.getRequestURL().toString();
        System.out.println("servletPath = " + servletPath);
        System.out.println("requestURI = " + requestURI);
        System.out.println("url = " + url);
        if (contextPath == null) {
            contextPath = "";
        }
        ApplicationContext controllerApplicationContext = LiteFlowApplicationContext.getControllerApplicationContext();
        RequestMappingHandlerMapping handlerMapping = controllerApplicationContext.getBean(RequestMappingHandlerMapping.class);
        // 查找匹配的處理方法
        Class<?> returnType = null;
        Map<RequestMappingInfo, HandlerMethod> handlerMethods = handlerMapping.getHandlerMethods();
        for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethods.entrySet()) {
            RequestMappingInfo requestMappingInfo = entry.getKey();
            HandlerMethod handlerMethod = entry.getValue();
            //匹配url
            if (requestMappingInfo.getPatternsCondition().getPatterns().contains(requestURI)) {
                System.out.println("Controller: " + handlerMethod.getBeanType().getName());
                System.out.println("Method: " + handlerMethod.getMethod().getName());
                System.out.println("getReturnType: " + handlerMethod.getMethod().getReturnType());
                returnType = handlerMethod.getMethod().getReturnType();
                break;
            }
            //匹配路徑帶參數的url
            UrlPathHelper pathHelper = new UrlPathHelper();
            String lookupPath = pathHelper.getPathWithinApplication(request);
            PatternsRequestCondition patternsCondition = requestMappingInfo.getPatternsCondition();
            if (patternsCondition != null && patternsCondition.getMatchingPatterns(lookupPath).size() > 0) {
                System.out.println("Controller1111: " + handlerMethod.getBeanType().getName());
                System.out.println("Method111: " + handlerMethod.getMethod().getName());
                System.out.println("getReturnType: " + handlerMethod.getMethod().getReturnType());
                returnType = handlerMethod.getMethod().getReturnType();
                break;
            }
        }
        httpServletResponse.setContentType("application/json;charset=utf-8");
        ResponseData data = null;
        if (returnType != null) {
            if (returnType == String.class) {
                String str = "返回類型為字元串方法限流";
                httpServletResponse.getWriter().write(str);
                return;
            } else if (returnType == Integer.class) {
                httpServletResponse.getWriter().write(new Integer(1));
                return;
            } else if (returnType == Long.class) {
                httpServletResponse.getWriter().write(2);
                return;
            } else if (returnType == Double.class) {

            } else if (returnType == Boolean.class) {

            } else if (returnType == Float.class) {

            } else if (returnType == Byte.class) {

            }
        }
        //BlockException 異常介面,包含Sentinel的五個異常
        // FlowException 限流異常
        // DegradeException 降級異常
        // ParamFlowException 參數限流異常
        // AuthorityException 授權異常
        // SystemBlockException 系統負載異常
        if (e instanceof FlowException) {
            data = new ResponseData(-1, "流控規則被觸發......");
        } else if (e instanceof DegradeException) {
            data = new ResponseData(-2, "降級規則被觸發...");
        } else if (e instanceof AuthorityException) {
            data = new ResponseData(-3, "授權規則被觸發...");
        } else if (e instanceof ParamFlowException) {
            data = new ResponseData(-4, "熱點規則被觸發...");
        } else if (e instanceof SystemBlockException) {
            data = new ResponseData(-5, "系統規則被觸發...");
        }
        httpServletResponse.getWriter().write(JSON.toJSONString(data));
    }
}

3、使用自定義限流處理類

import com.alibaba.csp.sentinel.adapter.servlet.callback.WebCallbackManager;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SentinelConfig {


    public SentinelConfig() {
        WebCallbackManager.setUrlBlockHandler(new SentinelExceptionHandler());
    }
}

4、配置限流並測試結果

當開啟限流後訪問觸發自定義UrlBlockHandler後結果如下

訪問對應得url後控制台列印

servletPath = /test/RequestMapping
requestURI = /test/RequestMapping
url = http://localhost:8081/test/RequestMapping
Controller: org.example.WebMvcTestController
Method: RequestMapping
getReturnType: class java.lang.String
servletPath = /test/GetMapping
requestURI = /test/GetMapping
url = http://localhost:8081/test/GetMapping
Controller: org.example.WebMvcTestController
Method: GetMapping
getReturnType: class java.lang.String
servletPath = /test/PostMapping
requestURI = /test/PostMapping
url = http://localhost:8081/test/PostMapping
Controller: org.example.WebMvcTestController
Method: PostMapping
getReturnType: class java.lang.String
servletPath = /test/GetMapping/4
requestURI = /test/GetMapping/4
url = http://localhost:8081/test/GetMapping/4
Controller1111: org.example.WebMvcTestController
Method111: apiFoo
getReturnType: class java.lang.String
servletPath = /test/Ant/a/5
requestURI = /test/Ant/a/5
url = http://localhost:8081/test/Ant/a/5
Controller1111: org.example.WebMvcTestController
Method111: Ant
getReturnType: class java.lang.String
servletPath = /test/users/5
requestURI = /test/users/5
url = http://localhost:8081/test/users/5
Controller1111: org.example.WebMvcTestController
Method111: pattern
getReturnType: class java.lang.String

5、頁面效果如下

五、springboot集成Sentinel

因為springboot集成文章較多,這裡不多做贅述

Sentinel 與 Spring Boot/Spring Cloud 的整合見 Sentinel Spring Cloud Starter

作者:京東健康 馬仁喜

來源:京東雲開發者社區 轉載請註明來源


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Sun公司提供了JavaMail用來實現郵件發送,但是配置煩瑣,Spring中提供了JavaMailSender用來簡化郵件配置,Spring Boot則提供了MailSenderAutoConfiguration對郵件的發送做了進一步簡化。 v準備工作 開通POP3/SMTP服務或者IMAP/SM ...
  • C語言分支結構詳解 1. if 語句 在本篇博客文章中,我們將深入探討C語言中的if語句及其相關用法。if語句是一種用於條件判斷的分支語句,它允許我們根據條件的真假來執行不同的代碼塊。 1.1 if 語句的基本語法和用法 if語句的基本語法如下所示: if (條件) { // 條件為真時執行的代碼塊 ...
  • CF786 我不會告訴你鏈接在圖片里 CF786A CF786A題意 給出一個大小為 \(n\) 的環,點順時針從 \(1\to n\) 編號,兩個人(設為 \(0,1\))輪流移動其中的一個棋子。 對於第 \(opt\) 人,他能夠將這個棋子順時針移動 \(x\in S_{opt}\)(\(S_{ ...
  • public class RandomNickName { public enum Gender{ MAN, WOMAN, UNKNOWN, ; } public static void main(String[] args) { String nickName = nickName(Gender. ...
  • 1 簡介 任務是需要資源(CPU 時間、記憶體、存儲、網路帶寬等)在指定時間內完成的一段計算工作。 通過智能地將資源分配給任務以滿足任務級和系統級目標的系統稱為任務調度程式。 任務調度程式: 及時決定和分配資源給任務的過程稱為任務調度。 當我們在 Facebook 發表評論時。我們不會讓評論發佈者等待 ...
  • 本文從源碼層面主要分析了線程池的創建、運行過程,通過上述的分析,可以看出當線程池中的線程數量超過核心線程數後,會先將任務放入等待隊列,隊列放滿後當最大線程數大於核心線程數時,才會創建新的線程執行。 ...
  • 大家好,夜鶯項目發佈 v6.4.0 版本,新增全局巨集變數功能,本文為大家簡要介紹一下相關更新內容。 全局巨集變數功能 像 SMTP 的配置中密碼類型的信息,之前都是以明文的方式在頁面展示,夜鶯支持全局巨集變數之後,可以在變數管理配置一個 smtp_password 的密碼類型的變數,在 SMTP 配置頁 ...
  • Crypto++ (CryptoPP) 是一個用於密碼學和加密的 C++ 庫。它是一個開源項目,提供了大量的密碼學演算法和功能,包括對稱加密、非對稱加密、哈希函數、消息認證碼 (MAC)、數字簽名等。Crypto++ 的目標是提供高性能和可靠的密碼學工具,以滿足軟體開發中對安全性的需求。高級加密標準(... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...