【网关限流】

网关限流

网关是所有请求的公共入口,所以可以在网关进行限流,而且限流的方式也很多,我们本次采用前面学

过的Sentinel组件来实现网关的限流。Sentinel支持对SpringCloud Gateway、Zuul等主流网关进行限

流。

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

从1.6.0版本开始,Sentinel提供了SpringCloud Gateway的适配模块,可以提供两种资源维度的限流:

  • route维度:即在Spring配置文件中配置的路由条目,资源名为对应的routeId
  • 自定义API维度:用户可以利用Sentinel提供的API来自定义一些API分组

1 导入依赖

<dependency>
    <groupId>com.alibaba.csp</groupId>
    <artifactId>sentinel-spring-cloud-gateway-adapter</artifactId>
</dependency>

2 编写配置类

基于Sentinel 的Gateway限流是通过其提供的Filter来完成的,使用时只需注入对应的

SentinelGatewayFilter实例以及 SentinelGatewayBlockExceptionHandler 实例即可。

package com.xyf.config;

import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule;
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayRuleManager;
import com.alibaba.csp.sentinel.adapter.gateway.sc.SentinelGatewayFilter;
import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.BlockRequestHandler;
import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.GatewayCallbackManager;
import com.alibaba.csp.sentinel.adapter.gateway.sc.exception.SentinelGatewayBlockExceptionHandler;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.codec.ServerCodecConfigurer;
import org.springframework.web.reactive.function.BodyInserters;
import org.springframework.web.reactive.function.server.ServerResponse;
import org.springframework.web.reactive.result.view.ViewResolver;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import javax.annotation.PostConstruct;
import java.util.*;

@Configuration
public class GatewayConfiguration {
    private final List<ViewResolver> viewResolvers;private final
    ServerCodecConfigurer serverCodecConfigurer;
    public GatewayConfiguration(ObjectProvider<List<ViewResolver>>
                                        viewResolversProvider,
                                ServerCodecConfigurer serverCodecConfigurer) {
        this.viewResolvers =
                viewResolversProvider.getIfAvailable(Collections::emptyList);
        this.serverCodecConfigurer = serverCodecConfigurer;
    }
    // 初始化一个限流的过滤器
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public GlobalFilter sentinelGatewayFilter() {
        return new SentinelGatewayFilter();
    }
    // 配置初始化的限流参数
    @PostConstruct
    public void initGatewayRules() {
        Set<GatewayFlowRule> rules = new HashSet<>();
        rules.add(
                new GatewayFlowRule("product_route") //资源名称,对应路由id
                        .setCount(1) // 限流阈值
                        .setIntervalSec(1) // 统计时间窗口,单位是秒,默认是 1 秒
        );
        GatewayRuleManager.loadRules(rules);
    }
    // 配置限流的异常处理器
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public SentinelGatewayBlockExceptionHandler
    sentinelGatewayBlockExceptionHandler() {
        return new SentinelGatewayBlockExceptionHandler(viewResolvers,
                serverCodecConfigurer);
    }
    // 自定义限流异常页面
    @PostConstruct
    public void initBlockHandlers() {
        BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {
            public Mono<ServerResponse> handleRequest(ServerWebExchange
                                                              serverWebExchange, Throwable throwable) {
                Map map = new HashMap<>();
                map.put("code", 0);
                map.put("message", "接口被限流了");
                return
                        ServerResponse.status(HttpStatus.OK).contentType(MediaType.APPLICATION_JSON_UTF8
                        ).
                                body(BodyInserters.fromObject(map));
            }
        };
        GatewayCallbackManager.setBlockHandler(blockRequestHandler);
    }
}

3配置文件

server:
  port: 7000
spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: true   #让gateway可以发现nacos中的微服务
      routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
        - id: product_route # 当前路由的标识, 要求唯一
         # uri: http://localhost:8081 # 请求要转发到的地址
          uri: lb://service-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均
          order: 1 # 路由的优先级,数字越小级别越高
          predicates: # 断言(就是路由转发要满足的条件)
            - Path=/product-serv/** # 当请求路径满足Path指定的规则时,才进行路由转发
            #- Before=2022-11-28T00:00:00.000+08:00 #限制请求时间在2022-11-28之前
            #- Age=18,60  #18---60
          filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
            - StripPrefix=1 # 转发之前去掉1层路径
            - Log=true,false # 控制日志是否开启
        - id: order_route # 当前路由的标识, 要求唯一
            # uri: http://localhost:8081 # 请求要转发到的地址
          uri: lb://service-order # lb指的是从nacos中按照名称获取微服务,并遵循负载均
          order: 1 # 路由的优先级,数字越小级别越高
          predicates: # 断言(就是路由转发要满足的条件)
              - Path=/order-serv/** # 当请求路径满足Path指定的规则时,才进行路由转发
              #- Before=2022-11-28T00:00:00.000+08:00 #限制请求时间在2022-11-28之前
              #- Age=18,60  #18---60
          filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
              - StripPrefix=1 # 转发之前去掉1层路径
              - Log=true,false # 控制日志是否开启

4 测试

在一秒钟内多次访问http://localhost:7000/product-serv/product/4就可以看到限流启作用了。

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

### 配置 Sentinel 网关进行流量限制 #### 启用 Sentinel 对网关的支持 为了使 Sentinel 正确工作于 API Gateway 上,需确保引入了 `Sentinel API Gateway Adapter Common` 模块。该模块提供了必要的组件来支持网关级别的限流功能[^2]。 对于基于 Spring Cloud Alibaba 的项目,在 pom.xml 文件中加入依赖: ```xml <dependency> <groupId>com.alibaba.csp</groupId> <artifactId>sentinel-apache-httpclient-adapter</artifactId> </dependency> <!-- 如果使用的是 Spring Cloud Gateway --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId> </dependency> ``` #### 设置基础配置属性 在 application.yml 中添加如下配置以启用并调整基本行为: ```yaml spring: cloud: sentinel: filter: enabled: true # 开启过滤器,默认开启;如果看到URL资源,则应设为false gw-flow-rules: # 自定义网关流控规则的数据源路径(可选) source: classpath:/gateway-flow-rules.json ``` 注意当观察到 URL 资源而非预期的路由或API分组时,应当将 `filter.enabled` 设定为 `false` 来修正这一情况[^4]。 #### 创建自定义 API 分组 可以通过编码方式创建 ApiDefinition 实现更细粒度的控制。例如,假设希望把 `/api/v1/*` 下的所有请求视为同一个 API 分组来进行统一管理: ```java import com.alibaba.csp.sentinel.adapter.gateway.common.rule.ApiPredicateItem; import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayApiDefinitionManager; public void initCustomApis() { List<ApiPredicateItem> items = new ArrayList<>(); items.add(new SubPathMatchable().setPattern("/api/v1/**")); Set<String> apiNames = Collections.singleton("my_custom_api"); GatewayApiDefinitionManager.loadApiDefinitions(apiNames, items); } ``` 这段代码会注册一个新的名为 "my_custom_api" 的 API 分组,并将其映射至特定模式下的所有子路径上。 #### 定义网关限流规则 同样地,也可以编程化地设置 GatewayFlowRule 。这里给出一个简单的例子说明如何针对某个 Route 或者之前提到过的自定义 API 分组实施限流策略: ```java import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.BlockRequestHandler; import org.springframework.context.annotation.Bean; import java.util.Collections; @Bean public BlockRequestHandler blockRequestHandler(){ return (serverWebExchange, throwable) -> serverWebExchange.getResponse() .writeWith(Mono.just( ServerHttpResponse.writeAndFlushWith(Flux.just( Mono.just(ResponseEntity.ok("{\"code\": \"429\", \"msg\":\"Too Many Requests\"}")))) )); } // 添加限流规则... List<GatewayFlowRule> rules = Arrays.asList( new GatewayFlowRule("some_route_id_or_api_group_name") .setCount(10)//每秒允许的最大访问次数 .setIntervalSec(1)); GatewayFlowRuleManager.loadRules(rules); ``` 上述片段展示了怎样设定最大 QPS (Queries Per Second)为 10 的速率限制,并指定了受影响的目标对象——这可以是一个具体的 route ID 或者前面所建立的那个叫做 “my_custom_api”的 API 分组名[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值