Spring Cloud Alibaba | Sentinel:分布式系統的流量防衛兵基礎實戰
Springboot: 2.1.8.RELEASE
SpringCloud: Greenwich.SR2
1. Sentinel控制台概述
在介紹入門實戰之前,先來介紹一下Sentinel。Sentinel控制台提供一個輕量級的開源控制台,它提供機器發現以及健康情況管理、監控(單機和叢集),規則管理和推送的功能。
Sentinel控制台主要功能:
- 檢視機器清單以及健康情況:收集 Sentinel 用戶端發送的心跳包,用于判斷機器是否線上。
- 監控 (單機和叢集聚合):通過 Sentinel 用戶端暴露的監控 API,定期拉取并且聚合應用監控資訊,最終可以實作秒級的實時監控。
- 規則管理和推送:統一管理推送規則。
- 鑒權:生産環境中鑒權非常重要,每個使用者都需要相應的權限可以對控制台的資訊進行修改。
2. Sentinel控制台部署:
Sentinel控制台部署有兩種方案:
2.1 下載下傳
直接使用官方編譯好的Release版本部署啟動,下載下傳位址:https://github.com/alibaba/Sentinel/releases ,目前最新版本是v1.6.3,下載下傳
sentinel-dashboard-1.6.3.jar
,如圖:
2.2 啟動
可以使用最新版本的源碼自行建構Sentinel控制台,首先需要下載下傳控制台工程,下載下傳路徑:https://github.com/alibaba/Sentinel/tree/master/sentinel-dashboard ,使用指令
mvn clean package
将代碼打成jar包即可。
在CentOS中使用如下指令啟動Sentinel控制台工程:
注意:啟動 Sentinel 控制台需要 JDK 版本為 1.8 及以上版本。
nohup java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard-1.6.3.jar >sentinel-dashboard.out 2>&1 &
-Dserver.port=8080
用于指定 Sentinel 控制台端口為 8080。啟動完成後,使用浏覽器通路:http://ip:8080/ ,這時會進入登入頁面,從 Sentinel 1.6.0 起,Sentinel 控制台引入基本的登入功能,預設使用者名和密碼都是
sentinel
Sentinel Dashboard可以通過如下參數進行配置:
- -Dsentinel.dashboard.auth.username=sentinel 用于指定控制台的登入使用者名為 sentinel;
- -Dsentinel.dashboard.auth.password=123456 用于指定控制台的登入密碼為 123456;如果省略這兩個參數,預設使用者和密碼均為 sentinel;
- -Dserver.servlet.session.timeout=7200 用于指定 Spring Boot 服務端 session 的過期時間,如 7200 表示 7200 秒;60m 表示 60 分鐘,預設為 30 分鐘;
同樣也可以直接在Spring的application.properties檔案中進行配置。
3. Spring Cloud
Sentinel目前已支援Spring Cloud,需要引入
spring-boot-starter-web
來觸發sentinel-starter中相關的自動配置。
3.1 建立父工程sentinel-springcloud
工程依賴pom.xml如下:
代碼清單:Alibaba/sentinel-springcloud/pom.xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>${spring-cloud-alibaba.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
spring-cloud-alibaba-dependencies
引入Spring Cloud Alibaba版本控制。
spring-cloud-starter-alibaba-sentinel
引入Sentinel元件。
3.2 建立子工程web_mvc:
代碼清單:Alibaba/sentinel-springcloud/web_mvc/pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
工程配置application.yml如下:
代碼清單:Alibaba/sentinel-springcloud/web_mvc/src/main/resources/application.yml
server:
port: 8000
spring:
application:
name: web-mvc
cloud:
sentinel:
transport:
dashboard: 192.168.44.129:8080
port: 8719
- spring.cloud.sentinel.transport.dashboard:配置Sentinel控制台的ip和端口
- spring.cloud.sentinel.transport.port:這個端口配置會在應用對應的機器上啟動一個 Http Server,該 Server 會與 Sentinel 控制台做互動。比如 Sentinel 控制台添加了1個限流規則,會把規則資料 push 給這個 Http Server 接收,Http Server 再将規則注冊到 Sentinel 中。
建立測試接口HelloController.java如下:
代碼清單:Alibaba/sentinel-springcloud/web_mvc/src/main/java/com/springcloud/web_mvc/controller/HelloController.java
@RestController
public class HelloController {
@GetMapping(value = "/hello")
@SentinelResource("hello")
public String hello() {
return "Hello Web MVC";
}
}
@SentinelResource
注解用來辨別資源是否被限流、降級。上述例子上該注解的屬性 'hello' 表示資源名。該注解還有一些其他更精細化的配置,比如忽略某些異常的配置、預設降級函數等等,具體可見如下說明:
- value:資源名稱,必需項(不能為空)
- entryType:entry 類型,可選項(預設為 EntryType.OUT)
- blockHandler / blockHandlerClass: blockHandler 對應處理 BlockException 的函數名稱,可選項。blockHandler 函數通路範圍需要是 public,傳回類型需要與原方法相比對,參數類型需要和原方法相比對并且最後加一個額外的參數,類型為 BlockException。blockHandler 函數預設需要和原方法在同一個類中。若希望使用其他類的函數,則可以指定 blockHandlerClass 為對應的類的 Class 對象,注意對應的函數必需為 static 函數,否則無法解析。
- fallback:fallback 函數名稱,可選項,用于在抛出異常的時候提供 fallback 處理邏輯。fallback 函數可以針對所有類型的異常(除了 exceptionsToIgnore 裡面排除掉的異常類型)進行處理。fallback 函數簽名和位置要求:
- 傳回值類型必須與原函數傳回值類型一緻;
- 方法參數清單需要和原函數一緻,或者可以額外多一個 Throwable 類型的參數用于接收對應的異常。
- fallback 函數預設需要和原方法在同一個類中。若希望使用其他類的函數,則可以指定 fallbackClass 為對應的類的 Class 對象,注意對應的函數必需為 static 函數,否則無法解析。
- defaultFallback(since 1.6.0):預設的 fallback 函數名稱,可選項,通常用于通用的 fallback 邏輯(即可以用于很多服務或方法)。預設 fallback 函數可以針對所有類型的異常(除了 exceptionsToIgnore 裡面排除掉的異常類型)進行處理。若同時配置了 fallback 和 defaultFallback,則隻有 fallback 會生效。defaultFallback 函數簽名要求:
- 方法參數清單需要為空,或者可以額外多一個 Throwable 類型的參數用于接收對應的異常。
- defaultFallback 函數預設需要和原方法在同一個類中。若希望使用其他類的函數,則可以指定 fallbackClass 為對應的類的 Class 對象,注意對應的函數必需為 static 函數,否則無法解析。
- exceptionsToIgnore(since 1.6.0):用于指定哪些異常被排除掉,不會計入異常統計中,也不會進入 fallback 邏輯中,而是會原樣抛出。
注:1.6.0 之前的版本 fallback 函數隻針對降級異常(DegradeException)進行處理,不能針對業務異常進行處理。
特别地,若 blockHandler 和 fallback 都進行了配置,則被限流降級而抛出 BlockException 時隻會進入 blockHandler 處理邏輯。若未配置 blockHandler、fallback 和 defaultFallback,則被限流降級時會将 BlockException 直接抛出。
3.3 測試
啟動子工程web_mvc,啟動成功後打開浏覽器通路:http://localhost:8000/hello ,可以看到頁面正常顯示
Hello Web MVC
,多次重新整理後打開Sentinel Dashboard,在Sentinel控制台上已經可以看到我們的web-mvc應用了,如圖:
- 注意:請確定用戶端有通路量,Sentinel 會在用戶端首次調用的時候進行初始化,開始向控制台發送心跳包。
4. Spring WebFlux
Sentinel目前已經支援WebFlux,需要配合
spring-boot-starter-webflux
依賴觸發 sentinel-starter中WebFlux相關的自動化配置。具體接入方式如下:
4.1 建立子工程web_flux
代碼清單:Alibaba/sentinel-springcloud/web_flux/pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
spring-boot-starter-webflux
引入WebFlux的相關依賴,Sentinel的依賴已在父工程引入。
4.2 配置檔案application.yml如下:
代碼清單:Alibaba/sentinel-springcloud/web_flux/src/main/resources/application.yml
server:
port: 9000
spring:
application:
name: web-flux
cloud:
sentinel:
transport:
dashboard: 192.168.44.129:8080
port: 8720
4.3 測試接口HelloController.java
代碼清單:Alibaba/sentinel-springcloud/web_flux/src/main/java/com/springcloud/web_flux/controller/HelloController.java
@RestController
public class HelloController {
@GetMapping("/hello")
@SentinelResource("hello")
public Mono<String> mono() {
return Mono.just("Hello Web Flux")
.transform(new SentinelReactorTransformer<>("resourceName"));
}
}
4.4 測試
啟動子工程web_flux,打開浏覽器通路:http://localhost:9000/hello ,頁面正常顯示
Hello Web Flux
,多次重新整理頁面後打開Sentinel控制台,可以看到web_flux工程正常注冊,測試成功,如圖:
5. 示例代碼
Github-示例代碼
Gitee-示例代碼
掃描二維碼關注「極客挖掘機」公衆号!作者:極客挖掘機
定期發表作者的思考:技術、産品、營運、自我提升等。
本文版權歸作者極客挖掘機和部落格園共有,歡迎轉載,但未經作者同意必須保留此段聲明,且在文章頁面明顯位置給出原文連接配接,否則保留追究法律責任的權利。
如果您覺得作者的文章對您有幫助,就來作者個人小站逛逛吧:
極客挖掘機