Sentinel之@SentinelResource注解的使用

目录

1 定义Sentinel资源点，指定异常处理方法

2 调用定义的方法（资源点）

3 编写Sentinel异常处理方法

4 编写业务异常处理方法

5 运行测试

6 总结

---

在定义了资源点之后，我们可以通过Dashboard控制台页面来设置限流和降级策略来对资源点进行保护。同时还能通过@SentinelResource注解来指定出现异常时的处理策略。

@SentinelResource用于定义资源，并提供可选的异常处理和fallback配置项。其主要参数如下：

下面示例@SentinelResource的使用：

1 定义Sentinel资源点，指定异常处理方法

package cn.jack.service.impl;

import com.alibaba.csp.sentinel.annotation.SentinelResource;
import org.springframework.stereotype.Service;

@Service
public class OrderServiceImpl3 {
    int i = 0;

    @SentinelResource(value = "demoResource1",
            blockHandlerClass = OrderServiceImpl3BlockHandler.class,
            blockHandler = "blockHandler",
            fallbackClass = OrderServiceImpl3Fallback.class,
            fallback = "fallback")
    public String demoResource1(String name) {
        i++;
        // 模拟业务异常
        if (i % 3 == 0) {
            throw new RuntimeException("模拟异常");
        }

        return "jack";
    }
}

2 调用定义的方法（资源点）

package cn.jack.controller;

import cn.jack.service.impl.OrderServiceImpl3;
import com.alibaba.csp.sentinel.annotation.SentinelResource;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class OrderController3 {

    @Autowired
    private OrderServiceImpl3 orderServiceImpl3;

    @RequestMapping("/order/message4")
    public String message4() {
        return this.orderServiceImpl3.demoResource1("xx");
    }
}

3 编写Sentinel异常处理方法

package cn.jack.service.impl;

import com.alibaba.csp.sentinel.slots.block.BlockException;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class OrderServiceImpl3BlockHandler {

    // 要求：
    // 1 当前方法的返回值和参数要跟原方法一致
    // 2 参数列表的最后，允许添加一个BlockException参数，用来接收原方法中发生的Sentinel异常
    // 3 需要用static修饰
    public static String  blockHandler(String name, BlockException e) {
        log.error("BlockException catch. actual exception type={}", e.getClass().getSimpleName());
        return "BlockException";
    }
}

4 编写业务异常处理方法

package cn.jack.service.impl;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class OrderServiceImpl3Fallback {

    // 要求：
    // 1 当前方法的返回值和参数要跟原方法一致
    // 2 参数列表的最后，允许添加一个Throwable参数，用来接收原方法中发生的异常
    // 3 需要用static修饰
    public static String fallback(String name, Throwable throwable) {
        log.error("业务异常。信息如下：{}", throwable.getMessage());
        return "Throwable";
    }
}

5 运行测试

第一步：为资源点demoResource1添加一条流控规则

第二步：频繁访问/order/message4接口，会发现进入限流异常处理逻辑

第三步：在不触发流控的情况下，每访问三次/order/message4接口，会进入业务异常处理逻辑

6 总结

@SentinelResource注解的blockHandler字段，指定发生Sentinel异常时的处理方法（即触发Sentinel五种类型规则时的处理逻辑）。fallback字段指定发生业务异常时的处理方法。当然，为了省事，可以不指定blockHandler，所有处理逻辑都放在fallback中。