SpringCloud Alibaba 入坑(六)@SentinelResource注解

目录


前言

上一篇 SpringCloud Alibaba 入坑(五)Sentinel高级流控规则

本章我们来学习Sentinel的一个重要注解:@SentinelResource


@SentinelResource

Sentinel提供了@SentinelResource来处理限流、熔断降级
注解的配置基于AOP实现,需要添加Aspect配置

@Configuration
public class SentinelAspectConfiguration {

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

@SentinelResource的源码

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface SentinelResource {
    String value() default "";

    EntryType entryType() default EntryType.OUT;

    String blockHandler() default "";

    Class<?>[] blockHandlerClass() default {};

    String fallback() default "";

    Class<? extends Throwable>[] exceptionsToTrace() default {Throwable.class};
}

@SentinelResource的属性

  • value 资源名称
  • entryType entry类型,有IN、OUT两种
  • blockHandler 限流处理方法
  • blockHandlerClass 限流处理类
  • fallback 熔断降级处理方法
  • fallbackClass 熔断降级处理类
  • exceptionsToTrace 异常跟踪列表

限流处理

SpringCloud Alibaba 入坑(六)@SentinelResource注解
前面出现限流情况后,都会出现一样的错误信息,那么我们是否能定义一个自己的限流处理方法呢?

@Slf4j
@RestController
@RequestMapping("provider")
public class GoodsController {

    @GetMapping("goods")
    @SentinelResource(value = "goods",blockHandler = "findGoodsExceptionHandler")
    public String findGoods(){
        log.info("正常返回商品");
        return "正常返回商品";
    }

    public String findGoodsExceptionHandler(BlockException ex){
        log.error("出现限流",ex);
        return "出现限流";
    }

blockHandler属性指定限流处理的方法名,默认情况下该方法必须定义在当前类中,而且参数和返回值和原方法一致,可以多定义一个BlockException参数代表限流异常。

如果不希望处理方法和原方法耦合在一起,可以单独定义处理类,处理方法必须是静态的。

@Slf4j
public class MyBlockHandler {

    public static String findGoodsExceptionHandler(BlockException ex){
        log.error("出现限流",ex);
        return "出现限流";
    }
}

然后@SentinelResource加上属性

blockHandlerClass = MyBlockHandler.class

配置限流规则
SpringCloud Alibaba 入坑(六)@SentinelResource注解
出现限流后,调用的是自定义方法
SpringCloud Alibaba 入坑(六)@SentinelResource注解

处理降级

通过fallback属性指定降级方法,降级方法必须在同一个类中,返回值和参数和原方法一致

@Slf4j
@RestController
@RequestMapping("provider")
public class GoodsController {

    @GetMapping("goods")
    @SentinelResource(value = "goods",fallback = "findGoodsFallback")
    public String findGoods(){
        if(new Random().nextInt(2) == 0){
            throw new RuntimeException("Error");
        }
        log.info("正常返回商品");
        return "正常返回商品";
    }


    public String findGoodsFallback(){
        log.info("出现异常熔断");
        return "出现异常熔断";
    }
}

添加一个降级规则,选择异常数,异常数、熔断时长、请求数都设置为1
SpringCloud Alibaba 入坑(六)@SentinelResource注解
原方法有1/2的机会抛出异常,抛出异常后,调用了降级方法
SpringCloud Alibaba 入坑(六)@SentinelResource注解

总结

@SentinelResource注解可以用来自定义限流和降级的处理方法,fallback属性用于设置降级方法,blockHandler属性用于设置限流方法,限流方法还可以通过配置blockHandlerClass 单独定义到一个类中。

本文就到这,如果看完了,给你点个赞!

上一篇:java 二维数组和对象数组


下一篇:Spring Cloud Alibaba:@SentinelResource注解的使用