Spring Cloud Alibaba（8）使用@SentinelResource注解实现限流带源码

83 阅读 0 评论 55 点赞

我是靠谱客的博主细心鸵鸟，最近开发中收集的这篇文章主要介绍Spring Cloud Alibaba（8）使用@SentinelResource注解实现限流带源码，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

源码

参考

背景

自定义资源点

实现限流控制

实现限流的异常处理

实现熔断降级

熔断的降级处理

更多注解属性说明

源码

https://gitee.com/acelee723/acelee-alibaba-sentinelresource

参考

http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-5/

背景

在之前的《Spring Cloud Alibaba（3）Sentinel接口限流整合入门带源码》一文中，我们仅依靠引入Spring Cloud Alibaba对Sentinel的整合封装spring-cloud-starter-alibaba-sentinel，就完成了对所有Spring MVC接口的限流控制。然而，在实际应用过程中，我们可能需要限流的层面不仅限于接口。可能对于某个方法的调用限流，对于某个外部资源的调用限流等都希望做到控制。那么，这个时候我们就不得不手工定义需要限流的资源点，并配置相关的限流策略等内容了。

今天这篇我们就来一起学习一下，如何使用@SentinelResource注解灵活的定义控制资源以及如何配置控制策略。

自定义资源点

1.新建一个spring boot项目acelee-alibaba-sentinelresource，pom.xml文件添加sentinel依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.aceleeyy</groupId>
    <artifactId>acelee-alibaba-sentinelresource</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>acelee-alibaba-sentinelresource</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
            <version>0.9.0.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.2</version>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2.在应用启动主类中增加注解支持的配置

package com.aceleeyy.aceleespringcloudalibaba;

import com.alibaba.csp.sentinel.annotation.aspectj.SentinelResourceAspect;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class AceleeSpringcloudAlibabaApplication {

    public static void main(String[] args) {
        SpringApplication.run(AceleeSpringcloudAlibabaApplication.class, args);
    }


    // 注解支持的配置Bean
    @Bean
    public SentinelResourceAspect sentinelResourceAspect() {
        return new SentinelResourceAspect();
    }

}

3.新建service和serviceImpl的包，对应增加接口类和实现类，添加一个doSomething()的方法

1）HelloService

package com.aceleeyy.aceleespringcloudalibaba.service;

/**
 * TODO
 *
 * @author Ace Lee
 * @date 2019/9/23 14:53
 * @version 1.0
 **/
public interface HelloService {

    void doSomething(String s);
}

2）HelloServiceImpl

在需要通过Sentinel来控制流量的地方使用@SentinelResource注解，比如下面以控制Service逻辑层的某个方法为例:

package com.aceleeyy.aceleespringcloudalibaba.service.impl;

import com.aceleeyy.aceleespringcloudalibaba.service.HelloService;
import com.alibaba.csp.sentinel.annotation.SentinelResource;
import org.springframework.stereotype.Service;

/**
 * TODO
 *
 * @author Ace Lee
 * @date 2019/9/23 14:54
 * @version 1.0
 **/
@Service
public class HelloSericeImpl implements HelloService {


    @SentinelResource(value = "doSomething")
    @Override
    public void doSomething(String s) {
        System.out.println("doSomething------------"+s);
    }
}

到这里一个需要被保护的方法就定义完成了。下面我们分别说说，定义了资源点之后，我们如何实现不同的保护策略，包括：限流、降级等。

如何实现限流与熔断降级

在定义了资源点之后，我们就可以通过Dashboard来设置限流和降级策略来对资源点进行保护了。同时，也可以通过@SentinelResource来指定出现限流和降级时候的异常处理策略。下面，就来一起分别看看限流和降级都是如何实现的。

实现限流控制

1.新建一个controller包，下面新建一个HelloController.java的类，加一个hello的http测试接口，里面调用HelloService的doSomething()方法

package com.aceleeyy.aceleespringcloudalibaba.controller;

import com.aceleeyy.aceleespringcloudalibaba.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@RestController
public class HelloController {

    @Autowired
    private HelloService helloService;

    @GetMapping("/hello")
    public String hello() {
        helloService.doSomething("hello"+new Date());
        return "aceleeyy.com";
    }

}

2.启动Sentinel-Dashboard，参考《Spring Cloud Alibaba（3）Sentinel接口限流整合入门带源码》

3.增加应用程序配置，启动应用

application.properties

spring.application.name=acelee-alibaba-sentinelresource
server.port=8001

# sentinel dashboard
spring.cloud.sentinel.transport.dashboard=localhost:8080

4.访问http://localhost:8001/hello，返回：aceleeyy.com，查看日志

5.这个时候查看sentinel dashboard，可以看到除了如之前入门实例中那样有/hello资源点之外，多了一个doSomething资源点。可以通过界面为这个资源点设置限流规则，比如将其QPS设置为2。由于/hello资源不设置限流规则，所以只要请求/hello接口，就可以直接模拟调用doSomething资源，来观察限流规则是否生效。

6.配置doSomething 的流控规则，配置如下图所示

7.快速调用/hello接口几次，只要QPS超过2，那么就会出现如下的错误返回，代表限流策略生效了

实现限流的异常处理

默认情况下，Sentinel对控制资源的限流处理是直接抛出异常，也就是上一节中贴出的日志内容。在没有合理的业务承接或者前端对接情况下可以这样，但是正常情况为了更好的用户业务，都会实现一些被限流之后的特殊处理，我们不希望展示一个生硬的报错。那么只需要基于上面的例子做一些加工，比如：

HelloServiceImpl

package com.aceleeyy.aceleespringcloudalibaba.service.impl;

import com.aceleeyy.aceleespringcloudalibaba.service.HelloService;
import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

/**
 * TODO
 *
 * @author Ace Lee
 * @date 2019/9/23 14:54
 * @version 1.0
 **/
@Slf4j
@Service
public class HelloSericeImpl implements HelloService {


    @SentinelResource(value = "doSomething", blockHandler = "exceptionHandler")
    @Override
    public void doSomething(String s) {
        System.out.println("doSomething------------"+s);
    }

    // 限流与阻塞处理
    public void exceptionHandler(String str, BlockException ex) {
        log.error( "blockHandler：" + str, ex);
    }
}

主要做了两件事：

通过@SentinelResource注解的blockHandler属性制定具体的处理函数
实现处理函数，该函数的传参必须与资源点的传参一样，并且最后加上BlockException异常参数；同时，返回类型也必须一样。

如果熟悉Hystrix的读者应该会发现，这样的设计与HystrixCommand中定义fallback很相似，还是很容易理解的。

完成上面的改动之后，重新启动应用，再快速访问接口（注意限流规则需要配置好），此时前端就不会返回异常信息了，后端会打印exceptionHandler中定义的日志输出。而在实际应用的时候，只要根据业务需要对限流请求做缓存或者前端提示等都可以基于此方法来实现。

实现熔断降级

@SentinelResource注解除了可以用来做限流控制之外，还能实现与Hystrix类似的熔断降级策略。下面就来具体看看如何使用吧。

1.还是以上面项目为例，在HelloService里添加doSomething2()的方法

HelloService

package com.aceleeyy.aceleespringcloudalibaba.service;

/**
 * TODO
 *
 * @author Ace Lee
 * @date 2019/9/23 14:53
 * @version 1.0
 **/
public interface HelloService {

    void doSomething(String s);

    void doSomething2(String s);
}

HelloServiceImpl

与限流控制一样，使用@SentinelResource注解标记资源点，比如：

package com.aceleeyy.aceleespringcloudalibaba.service.impl;

import com.aceleeyy.aceleespringcloudalibaba.service.HelloService;
import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

/**
 * TODO
 *
 * @author Ace Lee
 * @date 2019/9/23 14:54
 * @version 1.0
 **/
@Slf4j
@Service
public class HelloSericeImpl implements HelloService {


    @SentinelResource(value = "doSomething", blockHandler = "exceptionHandler")
    @Override
    public void doSomething(String s) {
        System.out.println("doSomething------------"+s);
    }

    @SentinelResource(value = "doSomething2")
    @Override
    public void doSomething2(String s) {
        log.info("doSomething2------------"+s);
        throw new RuntimeException("发生异常");
    }

    // 限流与阻塞处理
    public void exceptionHandler(String str, BlockException ex) {
        log.error( "blockHandler：" + str, ex);
    }
}

这里在实现类中创建了一个新的方法，并使用@SentinelResource将该资源命名为doSomething2。该方法会抛出异常，以配合后续制定基于异常比例的降级策略（类似Hystrix）。Sentinel相比Hystrix更丰富，还有基于响应时间和异常数的降级策略。

2.在HelloController里添加接口，调用doSomething2()方法

package com.aceleeyy.aceleespringcloudalibaba.controller;

import com.aceleeyy.aceleespringcloudalibaba.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@RestController
public class HelloController {

    @Autowired
    private HelloService helloService;

    @GetMapping("/hello")
    public String hello() {
        helloService.doSomething("hello"+new Date());
        return "aceleeyy.com";
    }

    @GetMapping("/hello2")
    public String hello2() {
        helloService.doSomething2("hello2"+new Date());
        return "aceleeyy.com";
    }

}

3.启动应用，调用/hello2接口，可以看到“发生异常”日志

4.查看Sentinel-Dashboard，可以看到簇点链路名为doSomeThing2的资源点。然后点击”降级“按钮，为该资源设置降级规则。这里使用异常比例策略，比例设置为0.5（即：50%的异常率），时间窗口设置为2（秒）。

5.验证熔断降级，根据上面的降级策略配置，当doSomeThing2方法的调用QPS >= 5，如果异常率超过50%，那么后续2秒内的调用将直接出发熔断降级，默认情况会直接抛出DegradeException异常，比如：

熔断的降级处理

在Sentinel中定义熔断的降级处理方法非常简单，与Hystrix非常相似。只需要使用@SentinelResource注解的fallback属性来指定具体的方法名即可。这里也需要注意传参与返回必须一致。比如：

HelloServiceImpl

package com.aceleeyy.aceleespringcloudalibaba.service.impl;

import com.aceleeyy.aceleespringcloudalibaba.service.HelloService;
import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

/**
 * TODO
 *
 * @author Ace Lee
 * @date 2019/9/23 14:54
 * @version 1.0
 **/
@Slf4j
@Service
public class HelloSericeImpl implements HelloService {


    @SentinelResource(value = "doSomething", blockHandler = "exceptionHandler")
    @Override
    public void doSomething(String s) {
        System.out.println("doSomething------------"+s);
    }

    
    @SentinelResource(value = "doSomething2", fallback = "fallbackHandler")
    @Override
    public void doSomething2(String s) {
        log.info("doSomething2------------"+s);
        throw new RuntimeException("发生异常");
    }

    // 限流与阻塞处理
    public void exceptionHandler(String str, BlockException ex) {
        log.error( "blockHandler：" + str, ex);
    }

    // 熔断与降级处理
    public void fallbackHandler(String str) {
        log.error("fallbackHandler：" + str);
    }
}

完成上面的改造之后，重启应用，并设置doSomeThing2资源的熔断降级策略（使用异常百分比），然后频繁的请求/hello2接口。在QPS>=5之后，由于这个接口一直在抛出异常，所以一定会满足熔断降级条件，这时候就会执行fallbackHandler方法，不断的打印如下日志：