快速学习-sentinel注解支持

12、注解支持

从0.1.1 版本开始，Sentinel 提供了@SentinelResource 注解用于定义资源，并提供了AspectJ 的扩展用于自动定义资源、处理BlockException 等。使用Sentinel Annotation AspectJ Extension 的时候需要引入以下依赖：

<dependency>
	<groupId>com.alibaba.csp</groupId>
	<artifactId>sentinel-annotation-aspectj</artifactId>
	<version>x.y.z</version>
</dependency>

12.1@SentinelResource 注解

@SentinelResource 用于定义资源，并提供可选的异常处理和fallback 配置项。@SentinelResource 注解包含以下属性：

• value: 资源名称，必需项（不能为空）
• entryType: 入口类型，可选项（默认为EntryType.OUT）
• blockHandler / blockHandlerClass: blockHandler 对应处理BlockException 的函数名称，可选项。若未配置，则将BlockException 直接抛出。blockHandler 函数访问范围需要是public，返回类型需要与原方法相匹配，参数类型需要和原方法相匹配并且最后加一个额外的参数，类型为BlockException。blockHandler 函数默认需要和原方法在同一个类中。若希望使用其他类的函数，则可以指定blockHandlerClass 为对应的类的Class 对象，注意对应的函数必需为static函数，否则无法解析。
• fallback: fallback 函数名称，可选项，仅针对降级功能生效（DegradeException）。fallback 函数的访问范围需要是public，参数类型和返回类型都需要与原方法相匹配，并且需要和原方法在同一个类中。若blockHandler 和fallback 都进行了配置，则遇到降级的时候首先选择fallback 函数进行处理。

示例：

    public class TestService {
        // 对应的`handleException` 函数需要位于`ExceptionUtil` 类中，并且必须为static 函数.
        @SentinelResource(value = "test", blockHandler = "handleException",
                blockHandlerClass = {ExceptionUtil.class})
        public void test() {
            System.out.println("Test");
        }
        // 原函数
        @SentinelResource(value = "hello", blockHandler = "exceptionHandler",
                fallback = "helloFallback")
        public String hello(long s) {
            return String.format("Hello at %d", s);
        }
        // Fallback 函数，函数签名与原函数一致.
        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;
        }
    }

12.2 配置

12.2.1AspectJ

若您的应用直接使用了AspectJ，那么您需要在aop.xml 文件中引入对应的Aspect：

<aspects>
	<aspect name="com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect"/>
</aspects>

12.2.2Spring AOP

若您的应用使用了Spring AOP，您需要通过配置的方式将SentinelResourceAspect 注册为一个Spring Bean：

@Configuration
public class SentinelAspectConfiguration {
    @Bean
    public SentinelResourceAspect sentinelResourceAspect() {
        return new SentinelResourceAspect();
    }
}

我们提供了Spring AOP 的示例，可以参见sentinel-demo-annotation-spring-aop。
注：对于Spring Boot 1.x 版本，请在application.properites 中添加spring.aop.proxy-target-class=true。Sentinel 0.2.0 将修复此问题。