默认情况下,Sentinel会将controller中的方法作为被保护资源,Sentinel中的资源用Entry来表示。
Sentinel中Entry可以理解为每次进入资源的一个凭证,如果调用SphO.entry()或者SphU.entry()能获取Entry对象,代表获取了凭证,没有被限流,否则抛出一个BlockException。
Entry是一个抽象的类,在Sentinel中真正创建的Entry是CtEntry。
Entry
- createTime:当前entry的创建时间,毫秒值,用来计算响应时间rt。
- curNode:当前Entry所关联的node,会在NodeSelectorSlot插槽中设置,主要是记录了当前Context下的统计信息。
- originNode:context的请求源节点,通常是服务的消费端,如果存在的话,在ClusterBuilderSlot的entry方法中设置
- resourceWrapper:当前Entry所关联的资源包装器
CtEntry
CtEntry 是 Entry的子类,主要保存了实体之间的关系、调用链、上下文信息。
- parent:entry的父entry,用于在同一个context上下文中,多次调用entry方法,保存entry之间的关系。
- child:entry的子entry,与parent相反
- chain:entry中的插槽链
- context:entry的上下文
Sentinel中的资源用Entry来表示。声明Entry的API示例:
// 资源名可使用任意有业务语义的字符串,比如方法名、接口名或其它可唯一标识的字符串。
try (Entry entry = SphU.entry("resourceName")) {
  // 被保护的业务逻辑
  // do something here...
} catch (BlockException ex) {
  // 资源访问阻止,被限流或被降级
  // 在此处进行相应的处理操作
}Sentinel 提供了 @SentinelResource 注解用于定义资源,并提供了 AspectJ 的扩展用于自动定义资源、处理 BlockException 等 。
@SentinelResource属性
| 参数 | 描述 | 
|---|---|
| value | 资源名称,必需项(不能为空) | 
| entryType | 资源调用方向,可选项(默认为 EntryType.OUT) | 
| resourceType | 资源的分类 | 
| blockHandler | 对应处理 BlockException的函数名称 | 
| blockHandlerClass | 处理类的 Class对象,函数必需为static函数 | 
| fallback | 用于在抛出异常的时候提供 fallback处理逻辑 | 
| defaultFallback | 用作默认的回退的方法 | 
| fallbackClass | 异常类的 Class对象,函数必需为static函数 | 
| exceptionsToTrace | 异常类跟踪列表(默认为Throwable.class) | 
| exceptionsToIgnore | 排除掉的异常类型 | 
@SentinelResource 用于定义资源,并提供可选的异常处理和 fallback 配置项。 @SentinelResource 注解包含以下属性:
value
entryType
blockHandler / blockHandlerClass: blockHandler
fallback / fallbackClass
- fallback 函数名称,可选项,用于在抛出异常的时候提供 fallback 处理逻辑。fallback 函数可以针对所有类型的异常(除了 exceptionsToIgnore里面排除掉的异常类型)进行处理。fallback 函数签名和位置要求:
defaultFallback 
默认的 fallback 函数名称,可选项,通常用于通用的 fallback 逻辑(即可以用于很多服务或方法)。默认 fallback 函数可以针对所有类型的异常(除了 exceptionsToIgnore 里面排除掉的异常类型)进行处理。若同时配置了 fallback 和 defaultFallback,则只有 fallback 会生效
exceptionsToIgnore 
用于指定哪些异常被排除掉,不会计入异常统计中,也不会进入 fallback 逻辑中,而是会原样抛出。
特别地,若 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");
    }
}









