-
返回值类型必须与原函数返回值类型一致;
-
方法参数列表需要和原函数一致,或者可以额外多一个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.8.0 版本开始,defaultFallback 支持在类级别进行配置。
注:1.6.0 之前的版本,fallback 函数只针对降级异常(DegradeException)进行处理,不能针对业务异常进行处理。
特别地,若 blockHandler和fallback都进行了配置,则被限流降级而抛出 BlockException 时只会进入 blockHandler 处理逻辑。若未配置 blockHandler、fallback 和 defaultFallback,则被限流降级时会将 BlockException 直接抛出(若方法本身未定义 throws BlockException 则会被 JVM 包装一层 UndeclaredThrowableException)。
示例:
public class TestService {
// 原函数
@SentinelResource(value = “hello”, blockHandler = “exceptionHandler”, fallback = “helloFallback”)
public String hello(long s) {
return String.format(“Hello at %d”, s);
}
// Fallback 函数,函数签名与原函数一致或加一个 Throwable 类型的参数.
public String helloFallback(long s) {
return String.format(“Halooooo %d”, s);
}
// Block 异常处理函数,参数最后多一个 BlockException,其余与原函数一致.
public String exceptionHandler(long s, BlockException ex) {
// Do some log here.
ex.printStackTrace();
return "Oops, error occurred at " + s;
}
// 这里单独演示 blockHandlerClass 的配置.
// 对应的 handleException
函数需要位于 ExceptionUtil
类中,并且必须为 public static 函数.
@SentinelResource(value = “test”, blockHandler = “handleException”, blockHandlerClass = {ExceptionUtil.class})
public void test() {
System.out.println(“Test”);
}
}
复制代码
4.springboot整合
如果要在您的项目中引入 Sentinel,使用 group ID 为 com.alibaba.cloud 和 artifact ID 为 spring-cloud-starter-alibaba-sentinel 的 starter。
1.修改pom.xml
com.alibaba.cloud
spring-cloud-starter-alibaba-sentinel
复制代码
2.修改application.yml
spring:
cloud:
sentinel:
transport:
port: 8719 #如果是多个服务 端口不能相同
dashboard: ip:8080
复制代码
spring.cloud.sentinel.transport.port是本地启的端口,与dashboard进行数据交互。官方文档是这样写的:这里的 spring.cloud.sentinel.transport.port 端口配置会在应用对应的机器上启动一个 Http Server,该 Server 会与 Sentinel 控制台做交互。比如 Sentinel 控制台添加了一个限流规则,会把规则数据 push 给这个 Http Server 接收,Http Server 再将规则注册到 Sentinel 中。
注意transport:port: 8719 这个端口不能多次占用,比如果一个项目制定的为8719 那么同服务器的任何项目都不能在使用8719了
3.验证
访问ip:8080账号/密码,出现以下页面即可。
注意:当访问一次接口之后 才能在左面出现服务选项!!
3.Feign 支持
==========
Sentinel 适配了 Feign 组件。如果想使用,除了引入 spring-cloud-starter-alibaba-sentinel 的依赖外还需要 2 个步骤:
-
配置文件打开 Sentinel 对 Feign 的支持:feign.sentinel.enabled=true
-
加入 spring-cloud-starter-openfeign 依赖使 Sentinel starter 中的自动化配置类生效:
如果不开启,将不能实现熔断,会直接抛出异常!
1.修改yml文件
feign:
sentinel:
enabled: true
复制代码
2.示例
这是一个 FeignClient 的简单使用示例:
@FeignClient(name = “service-provider”, fallback = EchoServiceFallback.class, configuration = FeignConfiguration.class)
public interface EchoService {
@RequestMapping(value = “/echo/{str}”, method = RequestMethod.GET)
String echo(@PathVariable(“str”) String str);
}
class FeignConfiguration {
@Bean
public EchoServiceFallback echoServiceFallback() {
return new EchoServiceFallback();
}
}