Spring Cloud Alibaba：Sentinel實現熔斷與限流

Spring Cloud Alibaba 致力於提供微服務開發的一站式解決方案，Sentinel 作為其核心元件之一，具有熔斷與限流等一系列服務保護功能，本文將對其用法進行詳細介紹。

Sentinel簡介

隨著微服務的流行，服務和服務之間的穩定性變得越來越重要。Sentinel 以流量為切入點，從流量控制、熔斷降級、系統負載保護等多個維度保護服務的穩定性。

Sentinel具有如下特性:

豐富的應用場景：承接了阿里巴巴近 10 年的雙十一大促流量的核心場景，例如秒殺，可以實時熔斷下游不可用應用；
完備的實時監控：同時提供實時的監控功能。可以在控制檯中看到接入應用的單臺機器秒級資料，甚至 500 臺以下規模的叢集的彙總執行情況；
廣泛的開源生態：提供開箱即用的與其它開源框架/庫的整合模組，例如與 Spring Cloud、Dubbo、gRPC 的整合；
完善的 SPI 擴充套件點：提供簡單易用、完善的 SPI 擴充套件點。您可以通過實現擴充套件點，快速的定製邏輯。

安裝Sentinel控制檯

Sentinel控制檯是一個輕量級的控制檯應用，它可用於實時檢視單機資源監控及叢集資源彙總，並提供了一系列的規則管理功能，如流控規則、降級規則、熱點規則等。

我們先從官網下載Sentinel，這裡下載的是sentinel-dashboard-1.6.3.jar檔案，下載地址：https://github.com/alibaba/Sentinel/releases
下載完成後在命令列輸入如下命令執行Sentinel控制檯：

java -jar sentinel-dashboard-1.6.3.jar

Sentinel控制檯預設執行在8080埠上，登入賬號密碼均為 sentinel，通過如下地址可以進行訪問：http://localhost:8080

Sentinel控制檯可以檢視單臺機器的實時監控資料。

建立sentinel-service模組

這裡我們建立一個sentinel-service模組，用於演示Sentinel的熔斷與限流功能。

在pom.xml中新增相關依賴，這裡我們使用Nacos作為註冊中心，所以需要同時新增Nacos的依賴：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>

在application.yml中新增相關配置，主要是配置了Nacos和Sentinel控制檯的地址：

server:
  port: 8401
spring:
  application:
    name: sentinel-service
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #配置Nacos地址
    sentinel:
      transport:
        dashboard: localhost:8080 #配置sentinel dashboard地址
        port: 8719
service-url:
  user-service: http://nacos-user-service
management:
  endpoints:
    web:
      exposure:
        include: '*'

限流功能

Sentinel Starter 預設為所有的 HTTP 服務提供了限流埋點，我們也可以通過使用@SentinelResource來自定義一些限流行為。

建立RateLimitController類

用於測試熔斷和限流功能。

/**
 * 限流功能
 * Created by macro on 2019/11/7.
 */
@RestController
@RequestMapping("/rateLimit")
public class RateLimitController {

    /**
     * 按資源名稱限流，需要指定限流處理邏輯
     */
    @GetMapping("/byResource")
    @SentinelResource(value = "byResource",blockHandler = "handleException")
    public CommonResult byResource() {
        return new CommonResult("按資源名稱限流", 200);
    }

    /**
     * 按URL限流，有預設的限流處理邏輯
     */
    @GetMapping("/byUrl")
    @SentinelResource(value = "byUrl",blockHandler = "handleException")
    public CommonResult byUrl() {
        return new CommonResult("按url限流", 200);
    }

    public CommonResult handleException(BlockException exception){
        return new CommonResult(exception.getClass().getCanonicalName(),200);
    }

}

根據資源名稱限流

我們可以根據@SentinelResource註解中定義的value（資源名稱）來進行限流操作，但是需要指定限流處理邏輯。

流控規則可以在Sentinel控制檯進行配置，由於我們使用了Nacos註冊中心，我們先啟動Nacos和sentinel-service；
由於Sentinel採用的懶載入規則，需要我們先訪問下介面，Sentinel控制檯中才會有對應服務資訊，我們先訪問下該介面：http://localhost:8401/rateLimit/byResource
在Sentinel控制檯配置流控規則，根據@SentinelResource註解的value值：

快速訪問上面的介面，可以發現返回了自己定義的限流處理資訊：

根據URL限流

我們還可以通過訪問的URL來限流，會返回預設的限流處理資訊。

在Sentinel控制檯配置流控規則，使用訪問的URL：

多次訪問該介面，會返回預設的限流處理結果：http://localhost:8401/rateLimit/byUrl

自定義限流處理邏輯

我們可以自定義通用的限流處理邏輯，然後在@SentinelResource中指定。

建立CustomBlockHandler類用於自定義限流處理邏輯：

/**
 * Created by macro on 2019/11/7.
 */
public class CustomBlockHandler {

    public CommonResult handleException(BlockException exception){
        return new CommonResult("自定義限流資訊",200);
    }
}

在RateLimitController中使用自定義限流處理邏輯：

/**
 * 限流功能
 * Created by macro on 2019/11/7.
 */
@RestController
@RequestMapping("/rateLimit")
public class RateLimitController {

    /**
     * 自定義通用的限流處理邏輯
     */
    @GetMapping("/customBlockHandler")
    @SentinelResource(value = "customBlockHandler", blockHandler = "handleException",blockHandlerClass = CustomBlockHandler.class)
    public CommonResult blockHandler() {
        return new CommonResult("限流成功", 200);
    }

}

熔斷功能

Sentinel 支援對服務間呼叫進行保護，對故障應用進行熔斷操作，這裡我們使用RestTemplate來呼叫nacos-user-service服務所提供的介面來演示下該功能。

首先我們需要使用@SentinelRestTemplate來包裝下RestTemplate例項：

/**
 * Created by macro on 2019/8/29.
 */
@Configuration
public class RibbonConfig {

    @Bean
    @SentinelRestTemplate
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}

新增CircleBreakerController類，定義對nacos-user-service提供介面的呼叫：

/**
 * 熔斷功能
 * Created by macro on 2019/11/7.
 */
@RestController
@RequestMapping("/breaker")
public class CircleBreakerController {

    private Logger LOGGER = LoggerFactory.getLogger(CircleBreakerController.class);
    @Autowired
    private RestTemplate restTemplate;
    @Value("${service-url.user-service}")
    private String userServiceUrl;

    @RequestMapping("/fallback/{id}")
    @SentinelResource(value = "fallback",fallback = "handleFallback")
    public CommonResult fallback(@PathVariable Long id) {
        return restTemplate.getForObject(userServiceUrl + "/user/{1}", CommonResult.class, id);
    }

    @RequestMapping("/fallbackException/{id}")
    @SentinelResource(value = "fallbackException",fallback = "handleFallback2", exceptionsToIgnore = {NullPointerException.class})
    public CommonResult fallbackException(@PathVariable Long id) {
        if (id == 1) {
            throw new IndexOutOfBoundsException();
        } else if (id == 2) {
            throw new NullPointerException();
        }
        return restTemplate.getForObject(userServiceUrl + "/user/{1}", CommonResult.class, id);
    }

    public CommonResult handleFallback(Long id) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser,"服務降級返回",200);
    }

    public CommonResult handleFallback2(@PathVariable Long id, Throwable e) {
        LOGGER.error("handleFallback2 id:{},throwable class:{}", id, e.getClass());
        User defaultUser = new User(-2L, "defaultUser2", "123456");
        return new CommonResult<>(defaultUser,"服務降級返回",200);
    }
}

啟動nacos-user-service和sentinel-service服務：
由於我們並沒有在nacos-user-service中定義id為4的使用者，所有訪問如下介面會返回服務降級結果：http://localhost:8401/breaker/fallback/4

{
	"data": {
		"id": -1,
		"username": "defaultUser",
		"password": "123456"
	},
	"message": "服務降級返回",
	"code": 200
}

由於我們使用了exceptionsToIgnore引數忽略了NullPointerException，所以我們訪問介面報空指標時不會發生服務降級：http://localhost:8401/breaker/fallbackException/2

與Feign結合使用

Sentinel也適配了Feign元件，我們使用Feign來進行服務間呼叫時，也可以使用它來進行熔斷。

首先我們需要在pom.xml中新增Feign相關依賴：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

在application.yml中開啟Sentinel對Feign的支援：

feign:
  sentinel:
    enabled: true #開啟sentinel對feign的支援

在應用啟動類上新增@EnableFeignClients啟動Feign的功能；
建立一個UserService介面，用於定義對nacos-user-service服務的呼叫：

/**
 * Created by macro on 2019/9/5.
 */
@FeignClient(value = "nacos-user-service",fallback = UserFallbackService.class)
public interface UserService {
    @PostMapping("/user/create")
    CommonResult create(@RequestBody User user);

    @GetMapping("/user/{id}")
    CommonResult<User> getUser(@PathVariable Long id);

    @GetMapping("/user/getByUsername")
    CommonResult<User> getByUsername(@RequestParam String username);

    @PostMapping("/user/update")
    CommonResult update(@RequestBody User user);

    @PostMapping("/user/delete/{id}")
    CommonResult delete(@PathVariable Long id);
}

建立UserFallbackService類實現UserService介面，用於處理服務降級邏輯：

/**
 * Created by macro on 2019/9/5.
 */
@Component
public class UserFallbackService implements UserService {
    @Override
    public CommonResult create(User user) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser,"服務降級返回",200);
    }

    @Override
    public CommonResult<User> getUser(Long id) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser,"服務降級返回",200);
    }

    @Override
    public CommonResult<User> getByUsername(String username) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser,"服務降級返回",200);
    }

    @Override
    public CommonResult update(User user) {
        return new CommonResult("呼叫失敗，服務被降級",500);
    }

    @Override
    public CommonResult delete(Long id) {
        return new CommonResult("呼叫失敗，服務被降級",500);
    }
}

在UserFeignController中使用UserService通過Feign呼叫nacos-user-service服務中的介面：

/**
 * Created by macro on 2019/8/29.
 */
@RestController
@RequestMapping("/user")
public class UserFeignController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public CommonResult getUser(@PathVariable Long id) {
        return userService.getUser(id);
    }

    @GetMapping("/getByUsername")
    public CommonResult getByUsername(@RequestParam String username) {
        return userService.getByUsername(username);
    }

    @PostMapping("/create")
    public CommonResult create(@RequestBody User user) {
        return userService.create(user);
    }

    @PostMapping("/update")
    public CommonResult update(@RequestBody User user) {
        return userService.update(user);
    }

    @PostMapping("/delete/{id}")
    public CommonResult delete(@PathVariable Long id) {
        return userService.delete(id);
    }
}

呼叫如下介面會發生服務降級，返回服務降級處理資訊：http://localhost:8401/user/4

{
	"data": {
		"id": -1,
		"username": "defaultUser",
		"password": "123456"
	},
	"message": "服務降級返回",
	"code": 200
}

使用Nacos儲存規則

預設情況下，當我們在Sentinel控制檯中配置規則時，控制檯推送規則方式是通過API將規則推送至客戶端並直接更新到記憶體中。一旦我們重啟應用，規則將消失。下面我們介紹下如何將配置規則進行持久化，以儲存到Nacos為例。

原理示意圖

首先我們直接在配置中心建立規則，配置中心將規則推送到客戶端；
Sentinel控制檯也從配置中心去獲取配置資訊。

功能演示

先在pom.xml中新增相關依賴：

<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-datasource-nacos</artifactId>
</dependency>

修改application.yml配置檔案，新增Nacos資料來源配置：

spring:
  cloud:
    sentinel:
      datasource:
        ds1:
          nacos:
            server-addr: localhost:8848
            dataId: ${spring.application.name}-sentinel
            groupId: DEFAULT_GROUP
            data-type: json
            rule-type: flow

在Nacos中新增配置：

新增配置資訊如下：

[
    {
        "resource": "/rateLimit/byUrl",
        "limitApp": "default",
        "grade": 1,
        "count": 1,
        "strategy": 0,
        "controlBehavior": 0,
        "clusterMode": false
    }
]

相關引數解釋：
- resource：資源名稱；
- limitApp：來源應用；
- grade：閾值型別，0表示執行緒數，1表示QPS；
- count：單機閾值；
- strategy：流控模式，0表示直接，1表示關聯，2表示鏈路；
- controlBehavior：流控效果，0表示快速失敗，1表示Warm Up，2表示排隊等待；
- clusterMode：是否叢集。
發現Sentinel控制檯已經有了如下限流規則：

快速訪問測試介面，可以發現返回了限流處理資訊：

參考資料

Spring Cloud Alibaba 官方文件：https://github.com/alibaba/spring-cloud-alibaba/wiki

使用到的模組

springcloud-learning
├── nacos-user-service -- 註冊到nacos的提供User物件CRUD介面的服務
└── sentinel-service -- sentinel功能測試服務

專案原始碼地址

https://github.com/macrozheng/springcloud-learning