Sentinel: 使用注解限流

Kross 發(fā)布于2019-08-19 11:34 / 611人閱讀

摘要：要使用注解來保護(hù)資源需要引入下面的依賴引入之后我們需要配置切面讓其生效，因?yàn)槭峭ㄟ^切面來實(shí)現(xiàn)的，我這邊以中使用進(jìn)行配置示列然后在需要限制的方法上加注解即可錯(cuò)誤發(fā)生在表示資源名，必填項(xiàng)處理的方法名，可選項(xiàng)。

在前面我們對Sentinel做了一個(gè)詳細(xì)的介紹，可以手動的通過Sentinel提供的SphU類來保護(hù)資源。這種做法不好的地方在于每個(gè)需要限制的地方都得寫代碼，從 0.1.1 版本開始，Sentinel 提供了 @SentinelResource 注解的方式，非常方便。

要使用注解來保護(hù)資源需要引入下面的Maven依賴：


    com.alibaba.csp
    sentinel-annotation-aspectj
    1.4.1

引入之后我們需要配置SentinelResourceAspect切面讓其生效，因?yàn)槭峭ㄟ^SentinelResourceAspect切面來實(shí)現(xiàn)的，我這邊以Spring Boot中使用進(jìn)行配置示列：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect;

@Configuration
public class AopConfiguration {

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

然后在需要限制的方法上加SentinelResource注解即可：

@SentinelResource(value = "get", blockHandler = "exceptionHandler")
@Override
public String get(String id) {
   return "http://cxytiandi.com";
}

public String exceptionHandler(String id, BlockException e) {
   e.printStackTrace();
   return "錯(cuò)誤發(fā)生在" + id;
}

SentinelResource：value

表示資源名，必填項(xiàng)

SentinelResource：blockHandler

處理 BlockException 的方法名，可選項(xiàng)。若未配置，則將 BlockException 直接拋出。

blockHandler 函數(shù)訪問范圍需要是 public

返回類型需要與原方法相匹配

參數(shù)類型需要和原方法相匹配并且最后加一個(gè)額外的參數(shù)，類型為 BlockException

blockHandler 函數(shù)默認(rèn)需要和原方法在同一個(gè)類中

如果你不想讓異常處理方法跟業(yè)務(wù)方法在同一個(gè)類中，可以使用 blockHandlerClass 為對應(yīng)的類的 Class 對象，注意對應(yīng)的函數(shù)必需為 static 函數(shù)，否則無法解析。

業(yè)務(wù)方法：

@SentinelResource(value = "get2", blockHandler = "handleException", blockHandlerClass = { ExceptionUtil.class })
@Override
public String get2() {
    return "http://cxytiandi.com";
}

異常處理類：

import com.alibaba.csp.sentinel.slots.block.BlockException;

public final class ExceptionUtil {

    public static String handleException(BlockException ex) {
        System.err.println("錯(cuò)誤發(fā)生: " + ex.getClass().getCanonicalName());
        return "error";
    }
    
}

如何測試？

我們可以在Spring Boot的啟動類中定義規(guī)則，然后快速訪問接口，就可以看出效果啦，或者用壓力測試工具ab等。

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        initFlowRules();
        SpringApplication.run(App.class, args);
    }
    
    private static void initFlowRules() {
        List rules = new ArrayList<>();
        
        FlowRule rule = new FlowRule();
        rule.setResource("get");
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setCount(1);
        rules.add(rule);
        
        rule = new FlowRule();
        rule.setResource("get2");
        rule.setGrade(RuleConstant.FLOW_GRADE_QPS);
        rule.setCount(1);
        rules.add(rule);
        
        FlowRuleManager.loadRules(rules);
    }
}

源碼分析

只需要配置了SentinelResourceAspect就可以使用注解，我們來簡單的看下SentinelResourceAspect的源碼

@Aspect
public class SentinelResourceAspect extends AbstractSentinelAspectSupport {

    @Pointcut("@annotation(com.alibaba.csp.sentinel.annotation.SentinelResource)")
    public void sentinelResourceAnnotationPointcut() {
    }

    @Around("sentinelResourceAnnotationPointcut()")
    public Object invokeResourceWithSentinel(ProceedingJoinPoint pjp) throws Throwable {
        // 獲取當(dāng)前訪問的方法
        Method originMethod = resolveMethod(pjp);
        // 獲取方法上的SentinelResource注解
        SentinelResource annotation = originMethod.getAnnotation(SentinelResource.class);
        if (annotation == null) {
            // Should not go through here.
            throw new IllegalStateException("Wrong state for SentinelResource annotation");
        }
        // 獲取資源名
        String resourceName = getResourceName(annotation.value(), originMethod);
        EntryType entryType = annotation.entryType();
        Entry entry = null;
        try {
            entry = SphU.entry(resourceName, entryType, 1, pjp.getArgs());
            Object result = pjp.proceed();
            return result;
        } catch (BlockException ex) {
            // 處理被限制的異常，回調(diào)事先配置的異常處理方法
            return handleBlockException(pjp, annotation, ex);
        } catch (Throwable ex) {
            Tracer.trace(ex);
            throw ex;
        } finally {
            if (entry != null) {
                entry.exit();
            }
        }
    }
}

上面是整個(gè)切面的代碼，對所有加了SentinelResource注解的方法進(jìn)去切入。細(xì)節(jié)代碼在AbstractSentinelAspectSupport中，大家自己去看看。

歡迎加入我的知識星球，一起交流技術(shù)，免費(fèi)學(xué)習(xí)猿天地的課程（http://cxytiandi.com/course） PS：目前星球中正在星主的帶領(lǐng)下組隊(duì)學(xué)習(xí)Sentinel，等你哦！