1. 程式人生 > >spring cloud gateway之filter篇

spring cloud gateway之filter篇

轉載請標明出處:
https://www.fangzhipeng.com
本文出自方誌朋的部落格

在上一篇文章詳細的介紹了Gateway的Predict,Predict決定了請求由哪一個路由處理,在路由處理之前,需要經過“pre”型別的過濾器處理,處理返回響應之後,可以由“post”型別的過濾器處理。

filter的作用和生命週期

由filter工作流程點,可以知道filter有著非常重要的作用,在“pre”型別的過濾器可以做引數校驗、許可權校驗、流量監控、日誌輸出、協議轉換等,在“post”型別的過濾器中可以做響應內容、響應頭的修改,日誌的輸出,流量監控等。首先需要弄清一點為什麼需要閘道器這一層,這就不得不說下filter的作用了。

作用

當我們有很多個服務時,比如下圖中的user-service、goods-service、sales-service等服務,客戶端請求各個服務的Api時,每個服務都需要做相同的事情,比如鑑權、限流、日誌輸出等。

1.png

對於這樣重複的工作,有沒有辦法做的更好,答案是肯定的。在微服務的上一層加一個全域性的許可權控制、限流、日誌輸出的Api Gatewat服務,然後再將請求轉發到具體的業務服務層。這個Api Gateway服務就是起到一個服務邊界的作用,外接的請求訪問系統,必須先通過閘道器層。

2.png

生命週期

Spring Cloud Gateway同zuul類似,有“pre”和“post”兩種方式的filter。客戶端的請求先經過“pre”型別的filter,然後將請求轉發到具體的業務服務,比如上圖中的user-service,收到業務服務的響應之後,再經過“post”型別的filter處理,最後返回響應到客戶端。

3.png

與zuul不同的是,filter除了分為“pre”和“post”兩種方式的filter外,在Spring Cloud Gateway中,filter從作用範圍可分為另外兩種,一種是針對於單個路由的gateway filter,它在配置檔案中的寫法同predict類似;另外一種是針對於所有路由的global gateway filer。現在從作用範圍劃分的維度來講解這兩種filter。

gateway filter

過濾器允許以某種方式修改傳入的HTTP請求或傳出的HTTP響應。過濾器可以限定作用在某些特定請求路徑上。 Spring Cloud Gateway包含許多內建的GatewayFilter工廠。

GatewayFilter工廠同上一篇介紹的Predicate工廠類似,都是在配置檔案application.yml中配置,遵循了約定大於配置的思想,只需要在配置檔案配置GatewayFilter Factory的名稱,而不需要寫全部的類名,比如AddRequestHeaderGatewayFilterFactory只需要在配置檔案中寫AddRequestHeader,而不是全部類名。在配置檔案中配置的GatewayFilter Factory最終都會相應的過濾器工廠類處理。

Spring Cloud Gateway 內建的過濾器工廠一覽表如下:

1.png

現在挑幾個常見的過濾器工廠來講解,每一個過濾器工廠在官方文件都給出了詳細的使用案例,如果不清楚的還可以在org.springframework.cloud.gateway.filter.factory看每一個過濾器工廠的原始碼。

AddRequestHeader GatewayFilter Factory

建立工程,引入相關的依賴,包括spring boot 版本2.0.5,spring Cloud版本Finchley,gateway依賴如下:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

在工程的配置檔案中,加入以下的配置:

server:
  port: 8081
spring:
  profiles:
    active: add_request_header_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: http://httpbin.org:80/get
        filters:
        - AddRequestHeader=X-Request-Foo, Bar
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]
  profiles: add_request_header_route

在上述的配置中,工程的啟動埠為8081,配置檔案為add_request_header_route,在add_request_header_route配置中,配置了roter的id為add_request_header_route,路由地址為http://httpbin.org:80/get,該router有AfterPredictFactory,有一個filter為AddRequestHeaderGatewayFilterFactory(約定寫成AddRequestHeader),AddRequestHeader過濾器工廠會在請求頭加上一對請求頭,名稱為X-Request-Foo,值為Bar。為了驗證AddRequestHeaderGatewayFilterFactory是怎麼樣工作的,檢視它的原始碼,AddRequestHeaderGatewayFilterFactory的原始碼如下:


public class AddRequestHeaderGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {

    @Override
    public GatewayFilter apply(NameValueConfig config) {
        return (exchange, chain) -> {
            ServerHttpRequest request = exchange.getRequest().mutate()
                    .header(config.getName(), config.getValue())
                    .build();

            return chain.filter(exchange.mutate().request(request).build());
        };
    }

}

由上面的程式碼可知,根據舊的ServerHttpRequest建立新的 ServerHttpRequest ,在新的ServerHttpRequest加了一個請求頭,然後建立新的 ServerWebExchange ,提交過濾器鏈繼續過濾。

啟動工程,通過curl命令來模擬請求:


curl localhost:8081

最終顯示了從 http://httpbin.org:80/get得到了請求,響應如下:

{
  "args": {},
  "headers": {
    "Accept": "*/*",
    "Connection": "close",
    "Forwarded": "proto=http;host=\"localhost:8081\";for=\"0:0:0:0:0:0:0:1:56248\"",
    "Host": "httpbin.org",
    "User-Agent": "curl/7.58.0",
    "X-Forwarded-Host": "localhost:8081",
    "X-Request-Foo": "Bar"
  },
  "origin": "0:0:0:0:0:0:0:1, 210.22.21.66",
  "url": "http://localhost:8081/get"
}

可以上面的響應可知,確實在請求頭中加入了X-Request-Foo這樣的一個請求頭,在配置檔案中配置的AddRequestHeader過濾器工廠生效。

跟AddRequestHeader過濾器工廠類似的還有AddResponseHeader過濾器工廠,在此就不再重複。

RewritePath GatewayFilter Factory

在Nginx服務啟中有一個非常強大的功能就是重寫路徑,Spring Cloud Gateway預設也提供了這樣的功能,這個功能是Zuul沒有的。在配置檔案中加上以下的配置:


spring:
  profiles:
    active: rewritepath_route
---
spring:
  cloud:
    gateway:
      routes:
      - id: rewritepath_route
        uri: https://blog.csdn.net
        predicates:
        - Path=/foo/**
        filters:
        - RewritePath=/foo/(?<segment>.*), /$\{segment}
  profiles: rewritepath_route

上面的配置中,所有的/foo/**開始的路徑都會命中配置的router,並執行過濾器的邏輯,在本案例中配置了RewritePath過濾器工廠,此工廠將/foo/(?

自定義過濾器

Spring Cloud Gateway內建了19種強大的過濾器工廠,能夠滿足很多場景的需求,那麼能不能自定義自己的過濾器呢,當然是可以的。在spring Cloud Gateway中,過濾器需要實現GatewayFilter和Ordered2個介面。寫一個RequestTimeFilter,程式碼如下:


public class RequestTimeFilter implements GatewayFilter, Ordered {

    private static final Log log = LogFactory.getLog(GatewayFilter.class);
    private static final String REQUEST_TIME_BEGIN = "requestTimeBegin";

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        exchange.getAttributes().put(REQUEST_TIME_BEGIN, System.currentTimeMillis());
        return chain.filter(exchange).then(
                Mono.fromRunnable(() -> {
                    Long startTime = exchange.getAttribute(REQUEST_TIME_BEGIN);
                    if (startTime != null) {
                        log.info(exchange.getRequest().getURI().getRawPath() + ": " + (System.currentTimeMillis() - startTime) + "ms");
                    }
                })
        );

    }

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

在上面的程式碼中,Ordered中的int getOrder()方法是來給過濾器設定優先級別的,值越大則優先順序越低。還有有一個filterI(exchange,chain)方法,在該方法中,先記錄了請求的開始時間,並儲存在ServerWebExchange中,此處是一個“pre”型別的過濾器,然後再chain.filter的內部類中的run()方法中相當於"post"過濾器,在此處列印了請求所消耗的時間。然後將該過濾器註冊到router中,程式碼如下:

    @Bean
    public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {
        // @formatter:off
        return builder.routes()
                .route(r -> r.path("/customer/**")
                        .filters(f -> f.filter(new RequestTimeFilter())
                                .addResponseHeader("X-Response-Default-Foo", "Default-Bar"))
                        .uri("http://httpbin.org:80/get")
                        .order(0)
                        .id("customer_filter_router")
                )
                .build();
        // @formatter:on
    }

重啟程式,通過curl命令模擬請求:

 curl localhost:8081/customer/123

在程式的控制檯輸出一下的請求資訊的日誌:


2018-11-16 15:02:20.177  INFO 20488 --- [ctor-http-nio-3] o.s.cloud.gateway.filter.GatewayFilter   : /customer/123: 152ms

自定義過濾器工廠

在上面的自定義過濾器中,有沒有辦法自定義過濾器工廠類呢?這樣就可以在配置檔案中配置過濾器了。現在需要實現一個過濾器工廠,在列印時間的時候,可以設定引數來決定是否列印請引數。檢視GatewayFilterFactory的原始碼,可以發現GatewayFilterfactory的層級如下:

微信截圖_20181204175448.png

過濾器工廠的頂級介面是GatewayFilterFactory,我們可以直接繼承它的兩個抽象類來簡化開發AbstractGatewayFilterFactory和AbstractNameValueGatewayFilterFactory,這兩個抽象類的區別就是前者接收一個引數(像StripPrefix和我們建立的這種),後者接收兩個引數(像AddResponseHeader)。

過濾器工廠的頂級介面是GatewayFilterFactory,有2個兩個較接近具體實現的抽象類,分別為AbstractGatewayFilterFactory和AbstractNameValueGatewayFilterFactory,這2個類前者接收一個引數,比如它的實現類RedirectToGatewayFilterFactory;後者接收2個引數,比如它的實現類AddRequestHeaderGatewayFilterFactory類。現在需要將請求的日誌打印出來,需要使用一個引數,這時可以參照RedirectToGatewayFilterFactory的寫法。


public class RequestTimeGatewayFilterFactory extends AbstractGatewayFilterFactory<RequestTimeGatewayFilterFactory.Config> {


    private static final Log log = LogFactory.getLog(GatewayFilter.class);
    private static final String REQUEST_TIME_BEGIN = "requestTimeBegin";
    private static final String KEY = "withParams";

    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList(KEY);
    }

    public RequestTimeGatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            exchange.getAttributes().put(REQUEST_TIME_BEGIN, System.currentTimeMillis());
            return chain.filter(exchange).then(
                    Mono.fromRunnable(() -> {
                        Long startTime = exchange.getAttribute(REQUEST_TIME_BEGIN);
                        if (startTime != null) {
                            StringBuilder sb = new StringBuilder(exchange.getRequest().getURI().getRawPath())
                                    .append(": ")
                                    .append(System.currentTimeMillis() - startTime)
                                    .append("ms");
                            if (config.isWithParams()) {
                                sb.append(" params:").append(exchange.getRequest().getQueryParams());
                            }
                            log.info(sb.toString());
                        }
                    })
            );
        };
    }


    public static class Config {

        private boolean withParams;

        public boolean isWithParams() {
            return withParams;
        }

        public void setWithParams(boolean withParams) {
            this.withParams = withParams;
        }

    }
}

在上面的程式碼中 apply(Config config)方法內建立了一個GatewayFilter的匿名類,具體的實現邏輯跟之前一樣,只不過加了是否列印請求引數的邏輯,而這個邏輯的開關是config.isWithParams()。靜態內部類類Config就是為了接收那個boolean型別的引數服務的,裡邊的變數名可以隨意寫,但是要重寫List

需要注意的是,在類的構造器中一定要呼叫下父類的構造器把Config型別傳過去,否則會報ClassCastException

最後,需要在工程的啟動檔案Application類中,向Srping Ioc容器註冊RequestTimeGatewayFilterFactory類的Bean。


    @Bean
    public RequestTimeGatewayFilterFactory elapsedGatewayFilterFactory() {
        return new RequestTimeGatewayFilterFactory();
    }

然後可以在配置檔案中配置如下:

spring:
  profiles:
    active: elapse_route

---
spring:
  cloud:
    gateway:
      routes:
      - id: elapse_route
        uri: http://httpbin.org:80/get
        filters:
        - RequestTime=false
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]
  profiles: elapse_route

啟動工程,在瀏覽器上訪問localhost:8081?name=forezp,可以在控制檯上看到,日誌輸出了請求消耗的時間和請求引數。

global filter

Spring Cloud Gateway根據作用範圍劃分為GatewayFilter和GlobalFilter,二者區別如下:

  • GatewayFilter : 需要通過spring.cloud.routes.filters 配置在具體路由下,只作用在當前路由上或通過spring.cloud.default-filters配置在全域性,作用在所有路由上

  • GlobalFilter : 全域性過濾器,不需要在配置檔案中配置,作用在所有的路由上,最終通過GatewayFilterAdapter包裝成GatewayFilterChain可識別的過濾器,它為請求業務以及路由的URI轉換為真實業務服務的請求地址的核心過濾器,不需要配置,系統初始化時載入,並作用在每個路由上。

Spring Cloud Gateway框架內建的GlobalFilter如下:

上圖中每一個GlobalFilter都作用在每一個router上,能夠滿足大多數的需求。但是如果遇到業務上的定製,可能需要編寫滿足自己需求的GlobalFilter。在下面的案例中將講述如何編寫自己GlobalFilter,該GlobalFilter會校驗請求中是否包含了請求引數“token”,如何不包含請求引數“token”則不轉發路由,否則執行正常的邏輯。程式碼如下:


public class TokenFilter implements GlobalFilter, Ordered {

    Logger logger=LoggerFactory.getLogger( TokenFilter.class );
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String token = exchange.getRequest().getQueryParams().getFirst("token");
        if (token == null || token.isEmpty()) {
            logger.info( "token is empty..." );
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

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

在上面的TokenFilter需要實現GlobalFilter和Ordered介面,這和實現GatewayFilter很類似。然後根據ServerWebExchange獲取ServerHttpRequest,然後根據ServerHttpRequest中是否含有引數token,如果沒有則完成請求,終止轉發,否則執行正常的邏輯。

然後需要將TokenFilter在工程的啟動類中注入到Spring Ioc容器中,程式碼如下:


@Bean
public TokenFilter tokenFilter(){
        return new TokenFilter();
}

啟動工程,使用curl命令請求:

 curl localhost:8081/customer/123
 

可以看到請沒有被轉發,請求被終止,並在控制檯列印瞭如下日誌:

2018-11-16 15:30:13.543  INFO 19372 --- [ctor-http-nio-2] gateway.TokenFilter                      : token is empty...

上面的日誌顯示了請求進入了沒有傳“token”的邏輯。

總結

本篇文章講述了Spring Cloud Gateway中的過濾器,包括GatewayFilter和GlobalFilter。從官方文件的內建過濾器講起,然後講解自定義GatewayFilter、GatewayFilterFactory以及自定義的GlobalFilter。有很多內建的過濾器並沒有講述到,比如限流過濾器,這個我覺得是比較重要和大家關注的過濾器,將在之後的文章講述。

參考資料

https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.1.0.M1/single/spring-cloud-gateway.html

https://www.jianshu.com/p/eb3a67291050

https://blog.csdn.net/qq_36236890/article/details/80822051

https://windmt.com/2018/05/08/spring-cloud-14-spring-cloud-gateway-filter

原始碼下載

https://github.com/forezp/SpringCloudLearning/tree/master/sc-f-gateway-predicate


掃一掃,支援下作者吧

(轉載本站文章請註明作者和出處 方誌朋的部落格