Spring Cloud Gateway通過(guò)全局過(guò)濾器實(shí)現(xiàn)接口防刷

作者：Springboot實(shí)戰(zhàn)案例錦集 2023-07-24 08:00:56

通過(guò)某種機(jī)制實(shí)現(xiàn)對(duì)系統(tǒng)中的某些接口在規(guī)定的時(shí)間段內(nèi)只能讓某個(gè)具體的客戶端訪問(wèn)指定次數(shù)，超出次數(shù)，就不讓訪問(wèn)了。

環(huán)境：Spring Boot2.7.12 + Spring Cloud2021.0.7

1 概念

通過(guò)某種機(jī)制實(shí)現(xiàn)對(duì)系統(tǒng)中的某些接口在規(guī)定的時(shí)間段內(nèi)只能讓某個(gè)具體的客戶端訪問(wèn)指定次數(shù)，超出次數(shù)，就不讓訪問(wèn)了。等待指定的時(shí)間到期后又能繼續(xù)訪問(wèn)接口；這里需要注意的是是控制到每一個(gè)具體的接口上，所以必須確定兩個(gè)要素：

客戶端是誰(shuí)
訪問(wèn)的接口

2 實(shí)現(xiàn)原理

可以通過(guò)2種方式實(shí)現(xiàn)：

通過(guò)網(wǎng)關(guān)
可以控制到所有的服務(wù)
通過(guò)AOP
該方案只能針對(duì)具體的每一個(gè)服務(wù)，代碼重復(fù)，如果通過(guò)

本篇文章我們通過(guò)網(wǎng)關(guān)實(shí)現(xiàn)，那接下來(lái)就是考慮上該如何去記錄當(dāng)前客戶端訪問(wèn)的具體接口在指定的時(shí)間內(nèi)已經(jīng)訪問(wèn)了多少次了？通過(guò)兩種方式：

JVM層
該種實(shí)現(xiàn)方式，你需要自己實(shí)現(xiàn)時(shí)效性的檢查，實(shí)現(xiàn)麻煩
通過(guò)Redis
Redis本身就可以對(duì)Key設(shè)置時(shí)效性，所以非常的方便。本文通過(guò)Redis實(shí)現(xiàn)。

通過(guò) Redis 記錄訪問(wèn)請(qǐng)求的次數(shù)，每次訪問(wèn)都進(jìn)行遞減，如果次數(shù)小于0就返回錯(cuò)誤信息，當(dāng)?shù)搅酥付ǖ臅r(shí)效則Redis會(huì)對(duì)過(guò)期的key進(jìn)行自動(dòng)刪除。

3 代碼實(shí)現(xiàn)

Redis配置

spring:
  redis:
    host: localhost
    port: 6379
    password: 123123
    database: 8
    lettuce:
      pool:
        maxActive: 8
        maxIdle: 100
        minIdle: 10
        maxWait: -1

定義全局過(guò)濾器

@Component
public class BrushProofFilter implements GlobalFilter, Ordered {


  private final ReactiveStringRedisTemplate reactiveStringRedisTemplate ;
  
  public BrushProofFilter(ReactiveStringRedisTemplate reactiveStringRedisTemplate) {
    this.reactiveStringRedisTemplate = reactiveStringRedisTemplate ;
  }
  
  @Override
  public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
    // 獲取客戶端的請(qǐng)求ip
    InetAddress address = exchange.getRequest().getRemoteAddress().getAddress();
    // 獲取請(qǐng)求的URI
    String path = exchange.getRequest().getPath().toString() ;
    // 將其組合為Redis中的Key
    String key = ("ratelimiter:" + address + ":" + path) ;
    // 通過(guò)拋出異常的方式終止序列，然后通過(guò)自定義的WebExceptionHandler處理異常信息 
    return this.reactiveStringRedisTemplate.opsForValue()
        // 這里固定設(shè)置每30s，訪問(wèn)10次
        .setIfAbsent(key, "10", Duration.ofSeconds(30))
        .flatMap(exist -> {
          return this.reactiveStringRedisTemplate.opsForValue().decrement(key) ;
        })
        .doOnNext(num -> {
          if (num < 0) {
            throw new BrushProofException("你訪問(wèn)太快了") ;
          }
        })
        .then(chain.filter(exchange)) ;
  }


  @Override
  public int getOrder() {
    return -2 ;
  }


}

自定義異常

public class BrushProofException extends RuntimeException {


  private static final long serialVersionUID = 1L;
  
  public BrushProofException(String message) {
    super(message) ;
  }
  
}

自定義異常處理句柄

@Component
public class RatelimiterWebExceptionHandler implements WebExceptionHandler {


  @Override
  public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
    if (ex instanceof RatelimiterException re) {
      ServerHttpResponse response = exchange.getResponse() ;
      response.setStatusCode(HttpStatus.INTERNAL_SERVER_ERROR) ;
      response.getHeaders().add("Content-Type", "text/html;charset=utf8") ;
      // 直接輸出了，異常不進(jìn)行傳遞
      return response.writeWith(Mono.just(response.bufferFactory().wrap(("你訪問(wèn)太快了").getBytes()))) ;
    }
    // 如果是其它異常，則將異常繼續(xù)向下傳遞
    return Mono.error(ex) ;
  }


}

訪問(wèn)測(cè)試

圖片