springcloud gateway限流使用

首先看pom的內容

<?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 https://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.8.RELEASE</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.eem</groupId>
   <artifactId>getway</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>getway</name>
   <description>Demo project for Spring Boot</description>

   <properties>
      <java.version>1.8</java.version>
      <spring-cloud.version>Greenwich.SR3</spring-cloud.version>
   </properties>

   <dependencies>
      <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-gateway</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
      </dependency>
      <!--監控組件-->
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-actuator</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-webflux</artifactId>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-data-redis</artifactId>
      </dependency>
      <dependency>
         <groupId>com.github.vladimir-bukhtoyarov</groupId>
         <artifactId>bucket4j-core</artifactId>
         <version>4.0.0</version>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
      </dependency>
      <dependency>
         <groupId>redis.clients</groupId>
         <artifactId>jedis</artifactId>
      </dependency>
   </dependencies>
   <dependencyManagement>
      <dependencies>
         <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring-cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
         </dependency>
      </dependencies>
   </dependencyManagement>
   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>
</project>
這裏的springboot的版本是2.1.8 
springcloud的版本是 Greenwich.SR3

第一種實現方式如下: 需要用redis,根據自己情況安裝即可

啓動類和以前的一樣沒有啥就不寫了.

配置類如下:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class RemoteKeyResolver {

    @Bean(name="remoteAddrKeyResolver")
    public RemoteAddrKeyResolver remoteAddrKeyResolver() {
        return new RemoteAddrKeyResolver();
    }

}

引用類如下

import org.springframework.cloud.gateway.filter.ratelimit.KeyResolver;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;


public class RemoteAddrKeyResolver implements  KeyResolver{
    public static final String BEAN_NAME = "remoteAddrKeyResolver";

    @Override
    public Mono<String> resolve(ServerWebExchange exchange) {
        System.out.println("hello");
        Mono<String> just = Mono.just(exchange.getRequest().getRemoteAddress().getAddress().getHostAddress());
        return just;
    }

}

配置文件如下:

server:
  port: 9701
eureka:
  client:
        registerWithEureka: true
        fetchRegistry: true
        serviceUrl:
           defaultZone: http://localhost:9601/eureka/
spring:
  redis:
      host: localhost
      port: 6379
      database: 0
      lettuce:
        pool:
          #連接池最大連接數（使用負值表示沒有限制）
           max-active: 300
                  #連接池最大阻塞等待時間（使用負值表示沒有限制）
           max-wait: -1s
                  #連接池中的最大空閒連接
           max-idle: 100
                  #連接池中的最小空閒連接
           min-idle: 20
  application:
    name: getway
  cloud:
    gateway:
      routes:
        - id: getway
          #uri: lb://hello  # 這個也可以  lb://爲固定寫法，表示開啓負載均衡；hello即服務在註冊的名字
          uri: http://localhost:9606
          predicates:
            - Path=/hello/**
          filters:
              - StripPrefix=1  # 這個必須要有,否則就是不能顯示
              - name: RequestRateLimiter
                args:
                    # 令牌桶每秒填充平均速率,即行等價於允許用戶每秒處理多少個請求平均數
                    redis-rate-limiter.replenishRate: 1
                    # 令牌桶的容量，允許在一秒鐘內完成的最大請求數
                    redis-rate-limiter.burstCapacity: 6
                    # 用於限流的鍵的解析器的 Bean 對象的名字。它使用 SpEL 表達式根據#{@beanName}從 Spring 容器中獲取 Bean 對象。
                    key-resolver: "#{@remoteAddrKeyResolver}"

然後在別的項目,比如服務註冊,服務提供就不寫了,然後在瀏覽器輸入http://localhost:9701/hello/get1就可以顯示正確內容.

第二種實現方式如下,這裏使用配置類實現,配置類如下

import io.github.bucket4j.Bandwidth;
import io.github.bucket4j.Bucket;
import io.github.bucket4j.Bucket4j;
import io.github.bucket4j.Refill;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.time.Duration;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

public class LimitFilter implements GatewayFilter, Ordered {
    private final Logger logger = LoggerFactory.getLogger(LimitFilter.class);

    int capacity;
    int refillTokens;
    Duration refillDuration;

    public LimitFilter(int capacity, int refillTokens, Duration refillDuration) {
        this.capacity = capacity;
        this.refillTokens = refillTokens;
        this.refillDuration = refillDuration;
    }

    private static final Map<String,Bucket> CACHE = new ConcurrentHashMap<>();
    private Bucket createNewBucket() {
        Refill refill = Refill.of(refillTokens,refillDuration);
        Bandwidth limit = Bandwidth.classic(capacity,refill);
        return Bucket4j.builder().addLimit(limit).build();
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String ip = exchange.getRequest().getRemoteAddress().getAddress().getHostAddress();
        Bucket bucket = CACHE.computeIfAbsent(ip,k -> createNewBucket());
        logger.info("IP: " + ip + "，TokenBucket Available Tokens: " + bucket.getAvailableTokens());
        if (bucket.tryConsume(1)) {
            return chain.filter(exchange);
        } else {
            exchange.getResponse().setStatusCode(HttpStatus.TOO_MANY_REQUESTS);
            return exchange.getResponse().setComplete();
        }
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

啓動類:

import com.eem.getway.config.LimitFilter;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.context.annotation.Bean;

import java.time.Duration;

@SpringBootApplication
@EnableEurekaClient
public class GetwayApplication {

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

@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
   return builder.routes()
         //增加一個path匹配，以"/gateway/hello/"開頭的請求都在此路由
         .route(r -> r.path("/hello/**")
               //表示將路徑中的第一級參數刪除，用剩下的路徑與provider的路徑做拼接，
               //這裏就是"lb://provider/hello/"，能匹配到provider的HelloController的路徑
               .filters(f -> f.stripPrefix(1)
                     //.filter(new LimitFilter(10,1, Duration.ofSeconds(1))) //限流設置
                     //在請求的header中添加一個key&value
                     .addRequestHeader("extendtag", "geteway-" + System.currentTimeMillis()))
               //指定匹配服務provider，lb是load balance的意思
               .uri("lb://hello")
         ).build();
}

}

配置文件如下:

server:
  port: 9701
eureka:
  client:
        registerWithEureka: true
        fetchRegistry: true
        serviceUrl:
           defaultZone: http://localhost:9601/eureka/,http://localhost:9602/eureka/
spring:
  redis:
      host: localhost
      port: 6379
      database: 0
      lettuce:
        pool:
          #連接池最大連接數（使用負值表示沒有限制）
           max-active: 300
                  #連接池最大阻塞等待時間（使用負值表示沒有限制）
           max-wait: -1s
                  #連接池中的最大空閒連接
           max-idle: 100
                  #連接池中的最小空閒連接
           min-idle: 20
  application:
    name: getway

也可以實現限流功能.

稍後,我講會把所有代碼上傳.