Spring Cloud Alibaba 致力于提供微服务开发的一站式解决方案,Sentinel 作为其核心组件之一,具有熔断与限流等一系列服务保护功能,本文将对其用法进行详细介绍。
https://github.com/alibaba/Sentinel/wiki/%E4%B8%BB%E9%A1%B5
https://github.com/alibaba/spring-cloud-alibaba/wiki/Sentinel
随着微服务的流行,服务和服务之间的稳定性变得越来越重要。 Sentinel 以流量为切入点,从流量控制、熔断降级、系统负载保护等多个维度保护服务的稳定性。
Sentinel具有如下特性:
Sentinel控制台是一个轻量级的控制台应用,它可用于实时查看单机资源监控及集群资源汇总,并提供了一系列的规则管理功能,如流控规则、降级规则、热点规则等。
我们先从官网下载Sentinel,这里下载的是sentinel-dashboard-1.6.3.jar
文件,下载地址:Releases · alibaba/Sentinel · GitHub
下载完成后在命令行输入如下命令运行Sentinel控制台:
java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard.jar
其中
-Dserver.port=8080
用于指定 Sentinel 控制台端口为8080
。
https://github.com/alibaba/Sentinel/tree/master/sentinel-dashboard
使用如下命令将代码打包成一个 fat jar:
mvn clean package
使用如下命令启动编译后的控制台:
java -Dserver.port=8080 -Dcsp.sentinel.dashboard.server=localhost:8080 -Dproject.name=sentinel-dashboard \
-jar target/sentinel-dashboard.jar
-Dserver.port=8080
是 Spring Boot 的参数, 用于指定 Spring Boot 服务端启动端口为 8080
。其余几个是 Sentinel 客户端的参数。参数 | 作用 |
---|---|
Dcsp.sentinel.dashboard.server=localhost:8080 | 向 Sentinel 接入端指定控制台的地址 |
-Dproject.name=sentinel-dashboard | 向 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 分钟; |
注意:配置了后需要先访问一次,才能被检测到
这里我们创建一个sentinel-service模块,用于演示Sentinel的熔断与限流功能。
server:port: 8401
spring:application:name: sentinel-servicecloud: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来自定义一些限流行为。
用于测试熔断和限流功能。
@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(资源名称)来进行限流操作,但是需要指定限流处理逻辑。
https://github.com/alibaba/Sentinel/wiki/%E6%B3%A8%E8%A7%A3%E6%94%AF%E6%8C%81
@SentinelResource 注解
注意:注解方式埋点不支持 private 方法。
@SentinelResource
用于定义资源,并提供可选的异常处理和 fallback 配置项。@SentinelResource
注解包含以下属性:
value
:资源名称,必需项(不能为空)entryType
:entry 类型,可选项(默认为EntryType.OUT
)blockHandler
/blockHandlerClass
:blockHandler
对应处理BlockException
的函数名称,可选项。blockHandler 函数访问范围需要是public
,返回类型需要与原方法相匹配,参数类型需要和原方法相匹配并且最后加一个额外的参数,类型为BlockException
。blockHandler 函数默认需要和原方法在同一个类中。若希望使用其他类的函数,则可以指定blockHandlerClass
为对应的类的Class
对象,注意对应的函数必需为 static 函数,否则无法解析。fallback
/fallbackClass
: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
直接抛出(若方法本身未定义 throws BlockException 则会被 JVM 包装一层UndeclaredThrowableException
)。
流控规则可以在Sentinel控制台进行配置,由于我们使用了Nacos注册中心,我们先启动Nacos和sentinel-service;
由于Sentinel采用的懒加载规则,需要我们先访问下接口,Sentinel控制台中才会有对应服务信息,我们先访问下该接口:http://localhost:8401/rateLimit/byResource
在Sentinel控制台配置流控规则,根据@SentinelResource注解的value值:
我们还可以通过访问的URL来限流,会返回默认的限流处理信息。
我们可以自定义通用的限流处理逻辑,然后在@SentinelResource中指定。
public class CustomBlockHandler {public CommonResult handleException(BlockException exception){return new CommonResult("自定义限流信息",200);}
}
@RestController
@RequestMapping("/rateLimit")
public class RateLimitController {/*** 自定义通用的限流处理逻辑*/@GetMapping("/customBlockHandler")@SentinelResource(value = "customBlockHandler", blockHandler = "handleException",blockHandlerClass = CustomBlockHandler.class)public CommonResult blockHandler() {return new CommonResult("限流成功", 200);}}
Field | 说明 | 默认值 |
---|---|---|
resource | 资源名,资源名是限流规则的作用对象 | |
count | 限流阈值 | |
grade | 限流阈值类型,QPS 模式(1)或并发线程数模式(0) | QPS 模式 |
limitApp | 流控针对的调用来源 | default ,代表不区分调用来源 |
strategy | 调用关系限流策略:直接、链路、关联 | 根据资源本身(直接) |
controlBehavior | 流控效果(直接拒绝 / 排队等待 / 慢启动模式),不支持按调用关系限流 | 直接拒绝 |
clusterMode | 是否集群限流 | 否 |
Sentinel 支持对服务间调用进行保护,对故障应用进行熔断操作,这里我们使用RestTemplate来调用nacos-user-service服务所提供的接口来演示下该功能。
RestTemplate
的服务调用使用 Sentinel 进行保护,在构造 RestTemplate
bean的时候需要加上 @SentinelRestTemplate
注解。@Bean
@SentinelRestTemplate(blockHandler = "handleException", blockHandlerClass = ExceptionUtil.class)
public RestTemplate restTemplate() {return new RestTemplate();
}@SentinelRestTemplate 注解的属性支持限流(blockHandler, blockHandlerClass)和降级(fallback, fallbackClass)的处理。其中 blockHandler 或 fallback 属性对应的方法必须是对应 blockHandlerClass 或 fallbackClass 属性中的静态方法。该方法的参数跟返回值跟 org.springframework.http.client.ClientHttpRequestInterceptor#interceptor 方法一致,其中参数多出了一个 BlockException 参数用于获取 Sentinel 捕获的异常。比如上述 @SentinelRestTemplate 注解中 ExceptionUtil 的 handleException 属性对应的方法声明如下:public class ExceptionUtil {public static ClientHttpResponse handleException(HttpRequest request, byte[] body, ClientHttpRequestExecution execution, BlockException exception) {...}
}
--------------------------
Note
应用启动的时候会检查 @SentinelRestTemplate 注解对应的限流或降级方法是否存在,如不存在会抛出异常
@SentinelRestTemplate 注解的限流(blockHandler, blockHandlerClass)和降级(fallback, fallbackClass)属性不强制填写。当使用 RestTemplate 调用被 Sentinel 熔断后,会返回 RestTemplate request block by sentinel 信息,或者也可以编写对应的方法自行处理返回信息。这里提供了 SentinelClientHttpResponse 用于构造返回信息。Sentinel RestTemplate 限流的资源规则提供两种粒度:httpmethod:schema://host:port/path:协议、主机、端口和路径httpmethod:schema://host:port:协议、主机和端口Note
以 https://www.taobao.com/test 这个 url 并使用 GET 方法为例。对应的资源名有两种粒度,分别是 GET:https://www.taobao.com 以及 GET:https://www.taobao.com/test
@Configuration
public class RibbonConfig {@Bean@SentinelRestTemplatepublic RestTemplate restTemplate(){return new RestTemplate();}
}
/*** 熔断功能* Created by macro on 2019/11/7.*/
@RestController
@RequestMapping("/breaker")
public class CircleBreakerController {private Logger LOGGER &#61; LoggerFactory.getLogger(CircleBreakerController.class);&#64;Autowiredprivate RestTemplate restTemplate;&#64;Value("${service-url.user-service}")private String userServiceUrl;&#64;RequestMapping("/fallback/{id}")&#64;SentinelResource(value &#61; "fallback",fallback &#61; "handleFallback")public CommonResult fallback(&#64;PathVariable Long id) {return restTemplate.getForObject(userServiceUrl &#43; "/user/{1}", CommonResult.class, id);}&#64;RequestMapping("/fallbackException/{id}")&#64;SentinelResource(value &#61; "fallbackException",fallback &#61; "handleFallback2", exceptionsToIgnore &#61; {NullPointerException.class})public CommonResult fallbackException(&#64;PathVariable Long id) {if (id &#61;&#61; 1) {throw new IndexOutOfBoundsException();} else if (id &#61;&#61; 2) {throw new NullPointerException();}return restTemplate.getForObject(userServiceUrl &#43; "/user/{1}", CommonResult.class, id);}public CommonResult handleFallback(Long id) {User defaultUser &#61; new User(-1L, "defaultUser", "123456");return new CommonResult<>(defaultUser,"服务降级返回",200);}public CommonResult handleFallback2(&#64;PathVariable Long id, Throwable e) {LOGGER.error("handleFallback2 id:{},throwable class:{}", id, e.getClass());User defaultUser &#61; new User(-2L, "defaultUser2", "123456");return new CommonResult<>(defaultUser,"服务降级返回",200);}
}
启动nacos-user-service和sentinel-service服务&#xff1a;
由于我们并没有在nacos-user-service中定义id为4的用户&#xff0c;所有访问如下接口会返回服务降级结果&#xff1a;http://localhost:8401/breaker/fallback/4
Field | 说明 | 默认值 |
---|---|---|
resource | 资源名&#xff0c;即限流规则的作用对象 | |
count | 阈值 | |
grade | 熔断策略&#xff0c;支持秒级 RT/秒级异常比例/分钟级异常数 | 秒级平均 RT |
timeWindow | 降级的时间&#xff0c;单位为 s | |
rtSlowRequestAmount | RT 模式下 1 秒内连续多少个请求的平均 RT 超出阈值方可触发熔断&#xff08;1.7.0 引入&#xff09; | 5 |
minRequestAmount | 异常熔断的触发最小请求数&#xff0c;请求数小于该值时即使异常比率超出阈值也不会熔断&#xff08;1.7.0 引入&#xff09; | 5 |
推荐阅读&#xff1a;Feign整合Sentinel实现容错_陈家宝的博客-CSDN博客https://blog.csdn.net/qq_31155349/article/details/108543571
方案一&#xff1a;直接继承被容错的接口&#xff0c;并为每个方法实现容错方案
package cn.jack.fallback;import cn.jack.domain.Product;
import cn.jack.service.ProductService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;&#64;Component
&#64;Slf4j
public class ProductServiceFallback implements ProductService {&#64;Overridepublic Product findByPid(Long pid) {Product product &#61; new Product();product.setPid(-100);product.setPname("远程服务调用出现问题了。");return product;}
}
-------------------------------------
方案二&#xff1a;实现FallbackFactory接口(***) import cn.jack.domain.Product;
import cn.jack.service.ProductService;
import feign.hystrix.FallbackFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;&#64;Component
&#64;Slf4j
public class ProductServiceFallbackFactory implements FallbackFactory
}
Sentinel也适配了Feign组件&#xff0c;我们使用Feign来进行服务间调用时&#xff0c;也可以使用它来进行熔断。
feign:sentinel:enabled: true #打开sentinel对feign的支持
在应用启动类上添加&#64;EnableFeignClients启动Feign的功能&#xff1b;
创建一个UserService接口&#xff0c;用于定义对nacos-user-service服务的调用&#xff1a;
/*** Created by macro on 2019/9/5.*/
&#64;FeignClient(value &#61; "nacos-user-service",fallback &#61; UserFallbackService.class)
public interface UserService {&#64;PostMapping("/user/create")CommonResult create(&#64;RequestBody User user);&#64;GetMapping("/user/{id}")CommonResult
}
/*** Created by macro on 2019/9/5.*/
&#64;Component
public class UserFallbackService implements UserService {&#64;Overridepublic CommonResult create(User user) {User defaultUser &#61; new User(-1L, "defaultUser", "123456");return new CommonResult<>(defaultUser,"服务降级返回",200);}&#64;Overridepublic CommonResult
}
/*** Created by macro on 2019/8/29.*/
&#64;RestController
&#64;RequestMapping("/user")
public class UserFeignController {&#64;Autowiredprivate UserService userService;&#64;GetMapping("/{id}")public CommonResult getUser(&#64;PathVariable Long id) {return userService.getUser(id);}&#64;GetMapping("/getByUsername")public CommonResult getByUsername(&#64;RequestParam String username) {return userService.getByUsername(username);}&#64;PostMapping("/create")public CommonResult create(&#64;RequestBody User user) {return userService.create(user);}&#64;PostMapping("/update")public CommonResult update(&#64;RequestBody User user) {return userService.update(user);}&#64;PostMapping("/delete/{id}")public CommonResult delete(&#64;PathVariable Long id) {return userService.delete(id);}
}
{"data": {"id": -1,"username": "defaultUser","password": "123456"},"message": "服务降级返回","code": 200
}
默认情况下&#xff0c;当我们在Sentinel控制台中配置规则时&#xff0c;控制台推送规则方式是通过API将规则推送至客户端并直接更新到内存中。一旦我们重启应用&#xff0c;规则将消失。下面我们介绍下如何将配置规则进行持久化&#xff0c;以存储到Nacos为例。
首先我们直接在配置中心创建规则&#xff0c;配置中心将规则推送到客户端&#xff1b;
Sentinel控制台也从配置中心去获取配置信息。
spring:cloud:sentinel:datasource:ds1:nacos:server-addr: localhost:8848dataId: ${spring.application.name}-sentinelgroupId: DEFAULT_GROUPdata-type: jsonrule-type: flow
[{"resource": "/rateLimit/byUrl","limitApp": "default","grade": 1,"count": 1,"strategy": 0,"controlBehavior": 0,"clusterMode": false}
]相关参数解释&#xff1a;resource&#xff1a;资源名称&#xff1b;
limitApp&#xff1a;来源应用&#xff1b;
grade&#xff1a;阈值类型&#xff0c;0表示线程数&#xff0c;1表示QPS&#xff1b;
count&#xff1a;单机阈值&#xff1b;
strategy&#xff1a;流控模式&#xff0c;0表示直接&#xff0c;1表示关联&#xff0c;2表示链路&#xff1b;
controlBehavior&#xff1a;流控效果&#xff0c;0表示快速失败&#xff0c;1表示Warm Up&#xff0c;2表示排队等待&#xff1b;
clusterMode&#xff1a;是否集群。
动态数据源支持
SentinelProperties
内部提供了 TreeMap
类型的 datasource
属性用于配置数据源信息。
比如配置 4 个数据源&#xff1a;
spring.cloud.sentinel.datasource.ds1.file.file&#61;classpath: degraderule.json
spring.cloud.sentinel.datasource.ds1.file.rule-type&#61;flow#spring.cloud.sentinel.datasource.ds1.file.file&#61;classpath: flowrule.json
#spring.cloud.sentinel.datasource.ds1.file.data-type&#61;custom
#spring.cloud.sentinel.datasource.ds1.file.converter-class&#61;com.alibaba.cloud.examples.JsonFlowRuleListConverter
#spring.cloud.sentinel.datasource.ds1.file.rule-type&#61;flowspring.cloud.sentinel.datasource.ds2.nacos.server-addr&#61;localhost:8848
spring.cloud.sentinel.datasource.ds2.nacos.data-id&#61;sentinel
spring.cloud.sentinel.datasource.ds2.nacos.group-id&#61;DEFAULT_GROUP
spring.cloud.sentinel.datasource.ds2.nacos.data-type&#61;json
spring.cloud.sentinel.datasource.ds2.nacos.rule-type&#61;degradespring.cloud.sentinel.datasource.ds3.zk.path &#61; /Sentinel-Demo/SYSTEM-CODE-DEMO-FLOW
spring.cloud.sentinel.datasource.ds3.zk.server-addr &#61; localhost:2181
spring.cloud.sentinel.datasource.ds3.zk.rule-type&#61;authorityspring.cloud.sentinel.datasource.ds4.apollo.namespace-name &#61; application
spring.cloud.sentinel.datasource.ds4.apollo.flow-rules-key &#61; sentinel
spring.cloud.sentinel.datasource.ds4.apollo.default-flow-rule-value &#61; test
spring.cloud.sentinel.datasource.ds4.apollo.rule-type&#61;param-flow
d1, ds2, ds3, ds4 是
ReadableDataSource
的名字&#xff0c;可随意编写。后面的file
&#xff0c;zk
&#xff0c;nacos
,apollo
就是对应具体的数据源&#xff0c;它们后面的配置就是这些具体数据源各自的配置。注意数据源的依赖要单独引入&#xff08;比如sentinel-datasource-nacos
)。每种数据源都有两个共同的配置项&#xff1a;
data-type
、converter-class
以及rule-type
。
data-type
配置项表示Converter
类型&#xff0c;Spring Cloud Alibaba Sentinel 默认提供两种内置的值&#xff0c;分别是json
和xml
(不填默认是json)。 如果不想使用内置的json
或xml
这两种Converter
&#xff0c;可以填写custom
表示自定义Converter
&#xff0c;然后再配置converter-class
配置项&#xff0c;该配置项需要写类的全路径名(比如spring.cloud.sentinel.datasource.ds1.file.converter-class&#61;com.alibaba.cloud.examples.JsonFlowRuleListConverter
)。
rule-type
配置表示该数据源中的规则属于哪种类型的规则(flow
&#xff0c;degrade
&#xff0c;authority
&#xff0c;system
,param-flow
,gw-flow
,gw-api-group
)。默认情况下&#xff0c;xml 格式是不支持的。需要添加
jackson-dataformat-xml
依赖后才会自动生效。