详解Springboot集成sentinel实现接口限流入门

我将为您详细讲解“详解SpringBoot集成Sentinel实现接口限流入门”的完整攻略。

1. 准备工作

在进行Sentinel配置之前，需要先准备好以下环境：

• SpringBoot 2.x或者以上版本
• Maven 3.x或者以上版本
• JDK 1.8或者以上版本

2. 添加依赖

在项目的pom.xml文件中，添加以下依赖：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-sentinel</artifactId>
    <version>2.1.0.RELEASE</version>
</dependency>

3. 配置Sentinel

在项目的application.properties 或 application.yml 文件中配置Sentinel：

spring.cloud.sentinel.namespace: sentinel

4. 定义接口限流规则

在代码中使用@SentinelResource注解来定义接口限流规则，例如：

@GetMapping("/hello")
@SentinelResource(value = "hello", blockHandler = "handleBlock")
public String hello() {
    return "Hello Sentinel";
}

public String handleBlock(BlockException ex) {
    return "流量控制了";
}

上述代码中，使用@SentinelResource注解定义了一个名为"hello"的Sentinel资源，并且指定了当资源被限流时，使用本地函数handleBlock来处理。

5. 使用Sentinel Dashboard来查看限流效果

Sentinel Dashboard是一个可以可视化监控Sentinel限流状态的控制台。您可以通过以下步骤来使用Sentinel Dashboard：

• 下载Sentinel Dashboard

wget https://github.com/alibaba/Sentinel/releases/download/1.8.0/sentinel-dashboard-1.8.0.jar

• 启动Sentinel Dashboard

java -jar sentinel-dashboard-1.8.0.jar

• 在浏览器中访问Sentinel Dashboard

http://localhost:8080/

• 在Sentinel Dashboard中查看限流效果

在Sentinel Dashboard的界面中，您可以查看到各个资源的请求情况、响应时间等信息。您也可以根据需要来配置流控规则。

示例一

下面是一个根据请求路径进行限流的示例，当同一IP在5秒内超过5个请求时，该IP将被限制：

@RestController
public class TestController {
    @GetMapping("/test")
    @SentinelResource(value = "test", blockHandler = "handleBlock")
    public String test(HttpServletRequest request) {
        String ip = request.getRemoteAddr();
        // 根据请求路径进行限流，如果同一IP 5秒内超过5次请求，将被限制
        FlowRule rule = new FlowRule("/test").setCount(5).setIntervalSec(5);
        List<FlowRule> rules = new ArrayList<>();
        rules.add(rule);
        FlowRuleManager.loadRules(rules);
        return "test";
    }

    // 当流控时，调用该方法
    public String handleBlock(HttpServletRequest request, BlockException ex) {
        return "流量控制了";
    }
}

在上述代码中，我们定义了一个/test的接口，当同一IP在5秒内进行超过5次请求时，将被限制。

示例二

下面是一个根据资源名称进行请求限流的示例，当某资源在1秒内处理请求超过10次时，该资源将被限制：

// 定义资源名称
@SentinelResource(value = "sayHello", blockHandler = "sayHelloLimit")
@GetMapping("/sayHello")
public String sayHello(@RequestParam String name) {
    return "hello " + name;
}

// 编写降级方法
public String sayHelloLimit(String name, BlockException e) {
    return "接口sayHello受限，请稍后重试";
}

// 添加Flow Rule
FlowRule flowRule = new FlowRule();
flowRule.setResource("sayHello");
flowRule.setCount(10);
flowRule.setGrade(RuleConstant.FLOW_GRADE_QPS);
flowRule.setControlBehavior(RuleConstant.CONTROL_BEHAVIOR_DEFAULT);
flowRule.setLimitApp("default");
FlowRuleManager.loadRules(Collections.singletonList(flowRule));

在上述代码中，我们定义了一个名称为"sayHello"的资源，并添加了CustomBlockHandler实现类。

我们还定义了一个FlowRule，并将其添加到Sentinel中，规定了当"sayHello"的接口在一秒内的请求处理数量超过10次时，该接口将被限制。

这两个示例是根据不同场景进行限流的，Sentinel提供了多种限流方式，使用时需要视情况选择适合自己的方式。