快捷導(dǎo)航

spring cloud gateway 全局過(guò)濾器的實(shí)現(xiàn)

更新時(shí)間：2019年03月06日 10:35:56 作者：猿天地

全局過(guò)濾器作用于所有的路由，不需要單獨(dú)配置，我們可以用它來(lái)實(shí)現(xiàn)很多統(tǒng)一化處理的業(yè)務(wù)需求，這篇文章主要介紹了spring cloud gateway 全局過(guò)濾器的實(shí)現(xiàn)，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

全局過(guò)濾器作用于所有的路由，不需要單獨(dú)配置，我們可以用它來(lái)實(shí)現(xiàn)很多統(tǒng)一化處理的業(yè)務(wù)需求，比如權(quán)限認(rèn)證，IP訪問(wèn)限制等等。

接口定義類：org.springframework.cloud.gateway.filter.GlobalFilter

public interface GlobalFilter {
  Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

gateway自帶的GlobalFilter實(shí)現(xiàn)類有很多，如下圖：

有轉(zhuǎn)發(fā)，路由，負(fù)載等相關(guān)的GlobalFilter，感興趣的可以自己去看下源碼，了解下。

我們自己如何定義GlobalFilter來(lái)實(shí)現(xiàn)我們自己的業(yè)務(wù)邏輯？

給出一個(gè)官方文檔上的案例：

@Configuration
public class ExampleConfiguration {
  private Logger log = LoggerFactory.getLogger(ExampleConfiguration.class);

  @Bean
  @Order(-1)
  public GlobalFilter a() {
    return (exchange, chain) -> {
      log.info("first pre filter");
      return chain.filter(exchange).then(Mono.fromRunnable(() -> {
        log.info("third post filter");
      }));
    };
  }

  @Bean
  @Order(0)
  public GlobalFilter b() {
    return (exchange, chain) -> {
      log.info("second pre filter");
      return chain.filter(exchange).then(Mono.fromRunnable(() -> {
        log.info("second post filter");
      }));
    };
  }

  @Bean
  @Order(1)
  public GlobalFilter c() {
    return (exchange, chain) -> {
      log.info("third pre filter");
      return chain.filter(exchange).then(Mono.fromRunnable(() -> {
        log.info("first post filter");
      }));
    };
  }
}

上面定義了3個(gè)GlobalFilter，通過(guò)@Order來(lái)指定執(zhí)行的順序，數(shù)字越小，優(yōu)先級(jí)越高。下面就是輸出的日志，從日志就可以看出執(zhí)行的順序：

2018-10-14 12:08:52.406 INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration : first pre filter
2018-10-14 12:08:52.406 INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration : second pre filter
2018-10-14 12:08:52.407 INFO 55062 --- [ioEventLoop-4-1] c.c.gateway.config.ExampleConfiguration : third pre filter
2018-10-14 12:08:52.437 INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration : first post filter
2018-10-14 12:08:52.438 INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration : second post filter
2018-10-14 12:08:52.438 INFO 55062 --- [ctor-http-nio-7] c.c.gateway.config.ExampleConfiguration : third post filter

當(dāng)GlobalFilter的邏輯比較多時(shí)，我還是推薦大家單獨(dú)寫(xiě)一個(gè)GlobalFilter來(lái)處理，比如我們要實(shí)現(xiàn)對(duì)IP的訪問(wèn)限制，不在IP白名單中就不讓調(diào)用的需求。

單獨(dú)定義只需要實(shí)現(xiàn)GlobalFilter, Ordered這兩個(gè)接口就可以了。

@Component
public class IPCheckFilter implements GlobalFilter, Ordered {

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

  @Override
  public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
    HttpHeaders headers = exchange.getRequest().getHeaders();
    // 此處寫(xiě)死了，演示用，實(shí)際中需要采取配置的方式
    if (getIp(headers).equals("127.0.0.1")) {
      ServerHttpResponse response = exchange.getResponse();
      ResponseData data = new ResponseData();
      data.setCode(401);
      data.setMessage("非法請(qǐng)求");
      byte[] datas = JsonUtils.toJson(data).getBytes(StandardCharsets.UTF_8);
      DataBuffer buffer = response.bufferFactory().wrap(datas);
      response.setStatusCode(HttpStatus.UNAUTHORIZED);
      response.getHeaders().add("Content-Type", "application/json;charset=UTF-8");
      return response.writeWith(Mono.just(buffer));
    }
    return chain.filter(exchange);
  }

  // 這邊從請(qǐng)求頭中獲取用戶的實(shí)際IP,根據(jù)Nginx轉(zhuǎn)發(fā)的請(qǐng)求頭獲取
  private String getIp(HttpHeaders headers) {
    return "127.0.0.1";
  }

}

過(guò)濾的使用沒(méi)什么好講的，都比較簡(jiǎn)單，作用卻很大，可以處理很多需求，上面講的IP認(rèn)證攔截只是冰山一角，更多的功能需要我們自己基于過(guò)濾器去實(shí)現(xiàn)。

比如我想做a/b測(cè)試，那么就得在路由轉(zhuǎn)發(fā)層面做文章，前面我們有貼一個(gè)圖片，圖片中有很多默認(rèn)的全局過(guò)濾器，其中有一個(gè)LoadBalancerClientFilter是負(fù)責(zé)選擇路由服務(wù)的負(fù)載過(guò)濾器，里面會(huì)通過(guò)loadBalancer去選擇轉(zhuǎn)發(fā)的服務(wù)，然后傳遞到下面的路由NettyRoutingFilter過(guò)濾器去執(zhí)行，那么我們就可以基于這個(gè)機(jī)制來(lái)實(shí)現(xiàn)。

Filter中往下一個(gè)Filter中傳遞數(shù)據(jù)實(shí)用下面的方式：

exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, requestUrl);

獲取方直接獲取：

URI requestUrl = exchange.getRequiredAttribute(GATEWAY_REQUEST_URL_ATTR);

如果我想改變路由的話，就可以這樣做：

@Component
public class DebugFilter implements GlobalFilter, Ordered {

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

  @Override
  public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
    try {
      exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, new URI("http://192.168.31.245:8081/house/hello2"));
    } catch (URISyntaxException e) {
      e.printStackTrace();
    }
    return chain.filter(exchange);
  }

}

LoadBalancerClientFilter的order是10100，我們這邊比它大1，這樣就能在它執(zhí)行完之后來(lái)替換要路由的地址了。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: