• Spring Cloud Gateway 使用 Redis 限流使用教程

    从本文开始，笔者将总结 spring cloud 相关内容的教程

    版本选择

    为了适应 java8，笔者选择了下面的版本，后续会出 java17的以SpringBoot3.0.X为主的教程

    SpringBoot 版本 2.6.5

    SpringCloud 版本 2021.0.1

    SpringCloudAlibaba 版本 2021.0.1.0

    SpringCloudAlibaba github 版本说明截图

    SpringCloud 官网：https://spring.io/projects/spring-cloud

    Spring Cloud Alibaba 官网：https://sca.aliyun.com/zh-cn/

    目录

    1、环境准备

    2、项目创建

    3、测试限流

    4、改进限流返回

    5、项目代码

    1、环境准备

    本文讲解Spring Cloud Gateway 使用 Redis 限流，注册中心使用 Nacos

    Macos 官网：https://nacos.io/zh-cn/index.html

    Nacos 安装这里不做过多介绍，不了解的朋友可以参考

    Nacos 单机安装：https://blog.csdn.net/wsjzzcbq/article/details/123916233

    Nacos 集群安装：https://blog.csdn.net/wsjzzcbq/article/details/123956116

    笔者使用 docker 开启 nacos 和 redis

    Spring Cloud Alibaba  2021.0.1.0 版本对应的nacos版本是 1.4.2

    笔者使用的 Naocs 版本是 2.0.0-bugfix，redis 版本是 7.0.6

    2、项目创建

    新建 maven 聚合项目 cloud-learn

    最外层父工程 cloud-learn 的 pom.xml

    1. "1.0" encoding="UTF-8"?>
    2. <project xmlns="http://maven.apache.org/POM/4.0.0"
    3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    5.     <modelVersion>4.0.0modelVersion>
    6.  
    7.     <groupId>com.wsjzzcbqgroupId>
    8.     <artifactId>cloud-learnartifactId>
    9.     <version>1.0-SNAPSHOTversion>
    10.     <modules>
    11.         <module>gateway-learnmodule>
    12.         <module>consumer-learnmodule>
    13.     modules>
    14.     <packaging>pompackaging>
    15.  
    16.     <repositories>
    17.         <repository>
    18.             <id>naxus-aliyunid>
    19.             <name>naxus-aliyunname>
    20.             <url>https://maven.aliyun.com/repository/publicurl>
    21.             <releases>
    22.                 <enabled>trueenabled>
    23.             releases>
    24.             <snapshots>
    25.                 <enabled>falseenabled>
    26.             snapshots>
    27.         repository>
    28.     repositories>
    29.  
    30.     <parent>
    31.         <groupId>org.springframework.bootgroupId>
    32.         <artifactId>spring-boot-starter-parentartifactId>
    33.         <version>2.6.5version>
    34.         <relativePath/>
    35.     parent>
    36.  
    37.     <properties>
    38.         <spring-cloud.version>2021.0.1spring-cloud.version>
    39.         <spring-cloud-alibaba.version>2021.0.1.0spring-cloud-alibaba.version>
    40.         <alibaba-nacos-discovery.veriosn>2021.1alibaba-nacos-discovery.veriosn>
    41.         <alibaba-nacos-config.version>2021.1alibaba-nacos-config.version>
    42.         <spring-cloud-starter-bootstrap.version>3.1.1spring-cloud-starter-bootstrap.version>
    43.     properties>
    44.  
    45.     <dependencyManagement>
    46.         <dependencies>
    47.             <dependency>
    48.                 <groupId>org.springframework.cloudgroupId>
    49.                 <artifactId>spring-cloud-dependenciesartifactId>
    50.                 <version>${spring-cloud.version}version>
    51.                 <type>pomtype>
    52.                 <scope>importscope>
    53.             dependency>
    54.  
    55.             <dependency>
    56.                 <groupId>com.alibaba.cloudgroupId>
    57.                 <artifactId>spring-cloud-alibaba-dependenciesartifactId>
    58.                 <version>${spring-cloud-alibaba.version}version>
    59.                 <type>pomtype>
    60.                 <scope>importscope>
    61.             dependency>
    62.  
    63.             <dependency>
    64.                 <groupId>com.alibaba.cloudgroupId>
    65.                 <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
    66.                 <version>${alibaba-nacos-discovery.veriosn}version>
    67.             dependency>
    68.  
    69.             <dependency>
    70.                 <groupId>com.alibaba.cloudgroupId>
    71.                 <artifactId>spring-cloud-starter-alibaba-nacos-configartifactId>
    72.                 <version>${alibaba-nacos-config.version}version>
    73.             dependency>
    74.  
    75.             
    76.             <dependency>
    77.                 <groupId>org.springframework.cloudgroupId>
    78.                 <artifactId>spring-cloud-starter-bootstrapartifactId>
    79.                 <version>${spring-cloud-starter-bootstrap.version}version>
    80.             dependency>
    81.  
    82.             <dependency>
    83.                 <groupId>com.alibaba.fastjson2groupId>
    84.                 <artifactId>fastjson2artifactId>
    85.                 <version>2.0.40version>
    86.             dependency>
    87.         dependencies>
    88.     dependencyManagement>
    89.  
    90.     <dependencies>
    91.         <dependency>
    92.             <groupId>org.projectlombokgroupId>
    93.             <artifactId>lombokartifactId>
    94.         dependency>
    95.     dependencies>
    96.  
    97.  
    98. project>

    然后创建2个子工程 consumer-learn 和 gateway-learn

    gateway-learn 中配置路由转发到 consumer-learn

    consumer-learn 工程 pom.xml

    1. "1.0" encoding="UTF-8"?>
    2. <project xmlns="http://maven.apache.org/POM/4.0.0"
    3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    5.     <parent>
    6.         <artifactId>cloud-learnartifactId>
    7.         <groupId>com.wsjzzcbqgroupId>
    8.         <version>1.0-SNAPSHOTversion>
    9.     parent>
    10.     <modelVersion>4.0.0modelVersion>
    11.  
    12.     <artifactId>consumer-learnartifactId>
    13.  
    14.     <dependencies>
    15.         <dependency>
    16.             <groupId>org.springframework.bootgroupId>
    17.             <artifactId>spring-boot-starter-webartifactId>
    18.         dependency>
    19.         <dependency>
    20.             <groupId>com.alibaba.cloudgroupId>
    21.             <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
    22.         dependency>
    23.         <dependency>
    24.             <groupId>org.springframework.cloudgroupId>
    25.             <artifactId>spring-cloud-starter-openfeignartifactId>
    26.         dependency>
    27.  
    28.         
    29.         <dependency>
    30.             <groupId>org.springframework.cloudgroupId>
    31.             <artifactId>spring-cloud-starter-loadbalancerartifactId>
    32.         dependency>
    33.  
    34.     dependencies>
    35.  
    36.     <build>
    37.         <plugins>
    38.             <plugin>
    39.                 <groupId>org.springframework.bootgroupId>
    40.                 <artifactId>spring-boot-maven-pluginartifactId>
    41.             plugin>
    42.         plugins>
    43.     build>
    44. project>

    consumer-learn 工程 启动类

    1. package com.wsjzzcbq;
    2.  
    3. import org.springframework.boot.SpringApplication;
    4. import org.springframework.boot.autoconfigure.SpringBootApplication;
    5. import org.springframework.cloud.openfeign.EnableFeignClients;
    6.  
    7. /**
    8.  * ConsumerApplication
    9.  *
    10.  * @author wsjz
    11.  * @date 2023/09/17
    12.  */
    13. @EnableFeignClients
    14. @SpringBootApplication
    15. public class ConsumerApplication {
    16.  
    17.     public static void main(String[] args) {
    18.         SpringApplication.run(ConsumerApplication.class, args);
    19.     }
    20. }

    consumer-learn 工程 配置文件

    1. spring.application.name=consumer-learn
    2. server.port=8081
    3. spring.cloud.nacos.discovery.username=nacos
    4. spring.cloud.nacos.discovery.password=nacos
    5. spring.cloud.nacos.discovery.server-addr=192.168.31.152:8848
    6. spring.cloud.nacos.discovery.namespace=public
    7. logging.level.com.alibaba.cloudlearnconsumer.feign.ProducerService=DEBUG

    consumer-learn 工程 controller

    1. package com.wsjzzcbq.controller;
    2.  
    3. import org.springframework.web.bind.annotation.RequestMapping;
    4. import org.springframework.web.bind.annotation.RestController;
    5.  
    6. /**
    7.  * ConsumerController
    8.  *
    9.  * @author wsjz
    10.  * @date 2023/09/17
    11.  */
    12. @RestController
    13. public class ConsumerController {
    14.  
    15.     @RequestMapping("/name")
    16.     public String user() {
    17.         return "宝剑锋从磨砺出，梅花香自苦寒来";
    18.     }
    19. }

    gateway-learn

    gateway-learn 工程 pom.xml

    1. "1.0" encoding="UTF-8"?>
    2. <project xmlns="http://maven.apache.org/POM/4.0.0"
    3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    5.     <parent>
    6.         <artifactId>cloud-learnartifactId>
    7.         <groupId>com.wsjzzcbqgroupId>
    8.         <version>1.0-SNAPSHOTversion>
    9.     parent>
    10.     <modelVersion>4.0.0modelVersion>
    11.  
    12.     <artifactId>gateway-learnartifactId>
    13.  
    14.     <dependencies>
    15.         <dependency>
    16.             <groupId>org.springframework.cloudgroupId>
    17.             <artifactId>spring-cloud-starter-gatewayartifactId>
    18.         dependency>
    19.  
    20.         <dependency>
    21.             <groupId>com.alibaba.cloudgroupId>
    22.             <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
    23.         dependency>
    24.  
    25.         
    26.         <dependency>
    27.             <groupId>org.springframework.cloudgroupId>
    28.             <artifactId>spring-cloud-starter-loadbalancerartifactId>
    29.         dependency>
    30.  
    31.         
    32.         
    33.         <dependency>
    34.             <groupId>org.springframework.bootgroupId>
    35.             <artifactId>spring-boot-starter-data-redis-reactiveartifactId>
    36.         dependency>
    37.  
    38.         <dependency>
    39.             <groupId>com.alibaba.fastjson2groupId>
    40.             <artifactId>fastjson2artifactId>
    41.         dependency>
    42.     dependencies>
    43.  
    44.     <build>
    45.         <plugins>
    46.             <plugin>
    47.                 <groupId>org.springframework.bootgroupId>
    48.                 <artifactId>spring-boot-maven-pluginartifactId>
    49.             plugin>
    50.         plugins>
    51.     build>
    52.  
    53. project>

    gateway-learn 工程 启动类

    1. package com.wsjzzcbq;
    2.  
    3. import org.springframework.boot.SpringApplication;
    4. import org.springframework.boot.autoconfigure.SpringBootApplication;
    5.  
    6. /**
    7.  * GatewayApplication
    8.  *
    9.  * @author wsjz
    10.  * @date 2023/09/17
    11.  */
    12. @SpringBootApplication
    13. public class GatewayApplication {
    14.  
    15.     public static void main(String[] args) {
    16.         SpringApplication.run(GatewayApplication.class, args);
    17.     }
    18. }

    限流需要实现 KeyResolver 接口的 resolve 方法

    在 resolve 方法中返回限流的维度，如请求路径、ip地址、请求参数等

    笔者这里限流维度是请求路径

    1. package com.wsjzzcbq.limit;
    2.  
    3. import org.springframework.cloud.gateway.filter.ratelimit.KeyResolver;
    4. import org.springframework.stereotype.Component;
    5. import org.springframework.web.server.ServerWebExchange;
    6. import reactor.core.publisher.Mono;
    7.  
    8. /**
    9.  * ApiKeyResolver
    10.  *
    11.  * @author wsjz
    12.  * @date 2023/09/17
    13.  */
    14. @Component
    15. public class ApiKeyResolver implements KeyResolver {
    16.     @Override
    17.     public Mono resolve(ServerWebExchange exchange) {
    18.         System.out.println("API限流: " + exchange.getRequest().getPath().value());
    19.         return Mono.just(exchange.getRequest().getPath().value());
    20.     }
    21. }

    gateway-learn 工程 配置文件

    1. server:
    2.   port: 9000
    3. spring:
    4.   application:
    5.     name: gateway-learn
    6.  
    7.   redis:
    8.     host: 192.168.31.152
    9.     password: 123456
    10.     timeout: 5000
    11.     database: 0
    12.   cloud:
    13.     nacos:
    14.       discovery:
    15.         server-addr: http://192.168.31.152:8848
    16.     gateway:
    17.       routes:
    18.         - id: consumer-learn
    19.           uri:  lb://consumer-learn
    20.           predicates:
    21.             - Path=/cloudlearn/consumer/**
    22.           filters:
    23.             - name: RequestRateLimiter
    24.               args:
    25.                 key-resolver: "#{@apiKeyResolver}"
    26.                 redis-rate-limiter.replenishRate: 1 #生成令牌速率：个/秒
    27.                 redis-rate-limiter.burstCapacity: 2 #令牌桶容量
    28.                 redis-rate-limiter.requestedTokens: 1 #每次消费的Token数量，默认是 1
    29.             - StripPrefix=2
    30.  
    31.  
    32.

    配置说明：

    RequestRateLimiter 是 gateway 提供的限流过滤器

    #{@apiKeyResolver} 是笔者实现的 ApiKeyResolver

    redis-rate-limiter.replenishRate 生成令牌的速率每秒几个

    redis-rate-limiter.burstCapacity 令牌桶容量

    redis-rate-limiter.requestedTokens 每次消费的令牌数量

    当请求到网关以 /cloudlearn/consumer/  为开头前缀时，会路由到 consumer-learn 服务上

    创建完成的项目结构

    3、测试限流

    分别启动 consumer-learn 和 gateway-learn

    登录 Nacos 控制台查看

    启动成功后，可在Naocs 控制台查看注册服务信息

    浏览器访问测试限流：http://localhost:9000/cloudlearn/consumer/name

    运行效果

    可以看到当1秒钟内请求超过2次时会被限流

    4、改进限流返回

    上面代码实现了限流，但限流触发后返回的是429，不利于前端处理，这里我们可以在默认的限流过滤器基础上进行改进，自定义限流时的返回

    新建 NewRequestRateLimiterGatewayFilterFactory 类

    继承默认的 RequestRateLimiterGatewayFilterFactory

    1. package com.wsjzzcbq.filter;
    2.  
    3. import com.alibaba.fastjson2.JSONObject;
    4. import org.springframework.cloud.gateway.filter.GatewayFilter;
    5. import org.springframework.cloud.gateway.filter.factory.RequestRateLimiterGatewayFilterFactory;
    6. import org.springframework.cloud.gateway.filter.ratelimit.KeyResolver;
    7. import org.springframework.cloud.gateway.filter.ratelimit.RateLimiter;
    8. import org.springframework.cloud.gateway.route.Route;
    9. import org.springframework.cloud.gateway.support.HttpStatusHolder;
    10. import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
    11. import org.springframework.core.io.buffer.DataBuffer;
    12. import org.springframework.http.HttpStatus;
    13. import org.springframework.http.server.reactive.ServerHttpResponse;
    14. import org.springframework.stereotype.Component;
    15. import reactor.core.publisher.Mono;
    16.  
    17. import java.nio.charset.StandardCharsets;
    18. import java.util.Iterator;
    19. import java.util.Map;
    20.  
    21. /**
    22.  * NewRequestRateLimiterGatewayFilterFactory
    23.  *
    24.  * @author wsjz
    25.  * @date 2023/09/17
    26.  */
    27. @Component
    28. public class NewRequestRateLimiterGatewayFilterFactory extends RequestRateLimiterGatewayFilterFactory {
    29.  
    30.     private final RateLimiter defaultRateLimiter;
    31.  
    32.     private final KeyResolver defaultKeyResolver;
    33.  
    34.     private boolean denyEmptyKey = true;
    35.  
    36.     private String emptyKeyStatusCode = HttpStatus.FORBIDDEN.name();
    37.  
    38.     public NewRequestRateLimiterGatewayFilterFactory(RateLimiter defaultRateLimiter, KeyResolver defaultKeyResolver) {
    39.         super(defaultRateLimiter, defaultKeyResolver);
    40.         this.defaultRateLimiter = defaultRateLimiter;
    41.         this.defaultKeyResolver = defaultKeyResolver;
    42.     }
    43.  
    44.     @Override
    45.     public GatewayFilter apply(Config config) {
    46.         System.out.println("过滤限流");
    47.         KeyResolver resolver = (KeyResolver)this.getOrDefault(config.getKeyResolver(), this.defaultKeyResolver);
    48.         RateLimiter limiter = (RateLimiter)this.getOrDefault(config.getRateLimiter(), this.defaultRateLimiter);
    49.         boolean denyEmpty = (Boolean)this.getOrDefault(config.getDenyEmptyKey(), this.denyEmptyKey);
    50.         HttpStatusHolder emptyKeyStatus = HttpStatusHolder.parse((String)this.getOrDefault(config.getEmptyKeyStatus(), this.emptyKeyStatusCode));
    51.         return (exchange, chain) -> {
    52.             return resolver.resolve(exchange).defaultIfEmpty("____EMPTY_KEY__").flatMap((key) -> {
    53.                 if ("____EMPTY_KEY__".equals(key)) {
    54.                     if (denyEmpty) {
    55.                         ServerWebExchangeUtils.setResponseStatus(exchange, emptyKeyStatus);
    56.                         return exchange.getResponse().setComplete();
    57.                     } else {
    58.                         return chain.filter(exchange);
    59.                     }
    60.                 } else {
    61.                     String routeId = config.getRouteId();
    62.                     if (routeId == null) {
    63.                         Route route = (Route)exchange.getAttribute(ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR);
    64.                         routeId = route.getId();
    65.                     }
    66.  
    67.                     return limiter.isAllowed(routeId, key).flatMap((response) -> {
    68.                         Iterator var4 = response.getHeaders().entrySet().iterator();
    69.  
    70.                         while(var4.hasNext()) {
    71.                             Map.Entry header = (Map.Entry)var4.next();
    72.                             exchange.getResponse().getHeaders().add((String)header.getKey(), (String)header.getValue());
    73.                         }
    74.  
    75.                         if (response.isAllowed()) {
    76.                             return chain.filter(exchange);
    77.                         } else {
    78.                             ServerHttpResponse httpResponse = exchange.getResponse();
    79.                             httpResponse.getHeaders().set("Content-Type", "application/json");
    80.                             JSONObject json = new JSONObject();
    81.                             json.put("code", 0);
    82.                             json.put("msg", "当前请求人数较多，请稍后再访问");
    83.                             DataBuffer dataBuffer = httpResponse.bufferFactory().wrap(json.toJSONString().getBytes(StandardCharsets.UTF_8));
    84.                             return httpResponse.writeWith(Mono.just(dataBuffer));
    85.                         }
    86.                     });
    87.                 }
    88.             });
    89.         };
    90.     }
    91.  
    92.     private  T getOrDefault(T configValue, T defaultValue) {
    93.         return configValue != null ? configValue : defaultValue;
    94.     }
    95. }
      96.  

      修改配置文件
       

      配置我们自定义的限流过滤器
       

      1. server:
      2.   port: 9000
      3. spring:
      4.   application:
      5.     name: gateway-learn
      6.  
      7.   redis:
      8.     host: 192.168.31.152
      9.     password: 123456
      10.     timeout: 5000
      11.     database: 0
      12.   cloud:
      13.     nacos:
      14.       discovery:
      15.         server-addr: http://192.168.31.152:8848
      16.     gateway:
      17.       routes:
      18.         - id: consumer-learn
      19.           uri:  lb://consumer-learn
      20.           predicates:
      21.             - Path=/cloudlearn/consumer/**
      22.           filters:
      23.             - name: NewRequestRateLimiter
      24.               args:
      25.                 key-resolver: "#{@apiKeyResolver}"
      26.                 redis-rate-limiter.replenishRate: 1 #生成令牌速率：个/秒
      27.                 redis-rate-limiter.burstCapacity: 2 #令牌桶容量
      28.                 redis-rate-limiter.requestedTokens: 1 #每次消费的Token数量
      29.             - StripPrefix=2
      30.  
      31.  
      32.  
       

      重新启动 gateway-learn
       

      请求测试
       

       

       

      5、项目代码
       

      码云地址：https://gitee.com/wsjzzcbq/csdn-blog/tree/master/cloud-learn
       

       

      至此完
      
                
                    
                

                
    96. 

                    相关阅读:
      
                    
加密算法 — — 对token进行非对称加密【RSA】                            
      
使用传统方式遍历集合过滤元素和使用流遍历集合过滤元素的区别                            
      
刷题笔记17——KMP                            
      
【回归预测-LSTM预测】基于灰狼算法优化LSTM实现数据回归预测附Matlab代码                            
      
近半年内连获5家“巨头”投资，这家智能驾驶“黑马”受资本追捧                            
      
GPT-4并非世界模型，LeCun双手赞同！ACL力证LLM无法模拟真实世界                            
      
月报总结｜Moonbeam 8月份大事一览                            
      
1003 Emergency                            
      
springboot+vue+elementUI 广场舞团高校舞蹈社团管理系统-#毕业设计                            
      
软件测试流程分享                            
      
                          
                
      97. 
                
    97. 
                    原文地址：https://blog.csdn.net/wsjzzcbq/article/details/133244158
                
      98.