引言

全局過濾器無疑是作用于所有經(jīng)過網(wǎng)關(guān)轉(zhuǎn)發(fā)的請求的贮缕，對于設(shè)計者來說被設(shè)計成全局過濾器實現(xiàn)的功能組件也即是設(shè)計者認(rèn)為此功能是網(wǎng)關(guān)所必備的功能組件，這點非常重要的俺榆，對于引入spring-cloud-gateway做二次封裝的時候感昼，我們應(yīng)該秉承作者的設(shè)計思想，即如果需要增加一個全局過濾組件的時候應(yīng)該實現(xiàn)一個全局過濾器（即實現(xiàn)GlobalFilter接口）罐脊。

我們可以通過gateway內(nèi)嵌的endpoint來查看GlobalFilter列表（/actuator/gateway/globalfilters）：

GlobalFilters

從api結(jié)果可以看到一個全局過濾器列表定嗓，并且沒一個過濾器都有一個排序id蜕琴，gateway是通過同時實現(xiàn)Ordered接口來實現(xiàn)控制過濾器的過濾順序的，其中id越小其代表的優(yōu)先級越高宵溅。

預(yù)覽GlobalFilter凌简、Ordered

從GlobalFilter接口的聲明來看，其作用及其明確恃逻，就是定義了一個filter行為雏搂，用于攔截web請求和實現(xiàn)一些跨領(lǐng)域，與應(yīng)用無關(guān)的需求寇损，比如安全驗證凸郑、超時判斷和其他的一些功能性行為。

Ordered接口是spring框架的一個規(guī)范接口矛市，用于元素排序或者需要有序的對象實現(xiàn)該接口芙沥。

從endpoint api的結(jié)果中我們將org.springframework.cloud.gateway.filter.包下的全局過濾器羅列出來，org.iblog.enhance.gateway.filter.**包下的均是增強(qiáng)實現(xiàn)的攔截功能（本文對于自增實現(xiàn)只簡單提及尘盼，后續(xù)章節(jié)會詳細(xì)解釋）憨愉。

• org.iblog.enhance.gateway.filter.MarkRequestFilter@75c589f2: -2147483647,
• org.springframework.cloud.gateway.filter.AdaptCachedBodyGlobalFilter@7c8f803d: -2147482648,
• org.iblog.enhance.gateway.filter.logging.LoggingRequestBodyFilter@6db04a6: -1000,
• org.iblog.enhance.gateway.filter.convert.ConvertRequestBodyFilter@1bba9862: -900,
• org.iblog.enhance.gateway.filter.extract.ExtractRequestBodyFilter@565c887e: -800,
• org.iblog.enhance.gateway.filter.async.AsyncProcessingFilter@1317ac2c: -700,
• org.iblog.enhance.gateway.filter.convert.ConvertResponseBodyFilter@451a4187: -25,
• org.iblog.enhance.gateway.filter.logging.LoggingResponseBodyFilter@8f374de: -20,
• org.iblog.enhance.gateway.filter.extract.ExtractResponseBodyFilter@5c215642: -10,
• org.springframework.cloud.gateway.filter.NettyWriteResponseFilter@4e26c308: -1,
• org.springframework.cloud.gateway.filter.ForwardPathFilter@7c6ab057: 0,
• org.springframework.cloud.gateway.filter.GatewayMetricsFilter@1f7557fe: 0,
• org.iblog.enhance.gateway.filter.logging.LoggingResponseStatusFilter@426913c4: 1,
• org.springframework.cloud.gateway.filter.RouteToRequestUrlFilter@176e839e: 10000,
• org.springframework.cloud.gateway.filter.LoadBalancerClientFilter@363ba634: 10100,
• org.iblog.enhance.gateway.filter.logging.LoggingRealPathFilter@416c1b0: 10101
• org.springframework.cloud.gateway.filter.WebsocketRoutingFilter@7ce4498f: 2147483646,
• org.springframework.cloud.gateway.filter.ForwardRoutingFilter@4ac0d49: 2147483647,

展示官方的架構(gòu)設(shè)計圖，所有的filtter則按照圖中filter模塊進(jìn)行工作卿捎，處于handler-proxied模塊之間配紫，而且是一個雙向的工作關(guān)系：

MarkRequestFilter　|　優(yōu)先級：-2147483647

這是我個人實現(xiàn)的一個GlobalFilter，這是為自己在后續(xù)功能實現(xiàn)而準(zhǔn)備的一個過濾器午阵；為每一個request第一時間分配一個uniqueue_key躺孝，并且set到exchange的attributes屬性列表當(dāng)中。

MarkRequestFilter

AdaptCachedBodyGlobalFilter　|　優(yōu)先級：-2147482648

gateway內(nèi)置的一個GlobalFilter底桂，其作用是從exchange的attributes中或者cachedRequestBody屬性值作為request的body植袍，注意使用此功能首先必須預(yù)設(shè)cachedRequestBody屬性至attributes中，這個必須要手動設(shè)置籽懦，無法通過配置來設(shè)置的于个，可以在優(yōu)先級更高的filter中來設(shè)置cachedRequestBody；當(dāng)然也可以自己寫一個FilterFactory類來做成配置化暮顺；我個人覺得暫時這個過濾器作用場景還不太明確厅篓，可以不用太考慮。

AdaptCachedBodyGlobalFilter

LoggingRequestBodyFilter　| 優(yōu)先級： -1000

這個GlobalFilter是我自己實現(xiàn)的捶码，其功能是對于gateway透傳的每一個請求進(jìn)行日志跟蹤并且記錄至持久化層羽氮，這里會將request的基礎(chǔ)信息logging下來，初始化一個日志實體存儲惫恼。

ConvertRequestBodyFilter　|　優(yōu)先級： -900

屬于enhance-gateway自己的實現(xiàn)档押，這個功能在還是比較常見的，尤其是面向B端客戶需求的時候，會有接口對接時報文轉(zhuǎn)換的需求令宿，在這個filter中就是實現(xiàn)了這種應(yīng)用無感知的轉(zhuǎn)換叼耙。

ExtractRequestBodyFilter　|　優(yōu)先級：-800

屬于enhance-gateway自己的實現(xiàn)，這個功能與ConvertRequestBodyFilter類似掀淘，只不過這里不是報文轉(zhuǎn)換旬蟋，而是實現(xiàn)從報文中抽取一些關(guān)鍵詞油昂，這個filter從某個角度上其實可以考慮與ConvertRequestBodyFilter合并成一個filter實現(xiàn)革娄，這個取決于需求的復(fù)雜性。

AsyncProcessingFilter　|　優(yōu)先級：-700

屬于enhance-gateway自己的實現(xiàn)冕碟，這里是一種針對性的需求拦惋，接受調(diào)用方一個請求，而調(diào)用方對于處理結(jié)果的處理進(jìn)度沒有時間敏感或者任務(wù)處理時常過長的情況安寺，采用即時反饋而異步作處理的方式來處理厕妖。

ConvertResponseBodyFilter　|　優(yōu)先級：-25

屬于enhance-gateway自己的實現(xiàn)，與ConvertRequestBodyFilter對稱挑庶，對于response的body做輸出報文轉(zhuǎn)換的需求言秸，這個視具體應(yīng)用場景來定，算是一種比較常見的開發(fā)場景迎捺。

LoggingResponseBodyFilter　|　優(yōu)先級：-20

屬于enhance-gateway自己的實現(xiàn)举畸，與LoggingRequestBodyFilter對稱，將response的body記錄進(jìn)日志需求中凳枝。

ExtractResponseBodyFilter　|　優(yōu)先級：-10

屬于enhance-gateway自己的實現(xiàn)抄沮，與ExtractRequestBodyFilter對稱，將response的body中的關(guān)鍵詞記錄進(jìn)日志需求中岖瑰。

NettyWriteResponseFilter　|　優(yōu)先級：-1

將Netty代理調(diào)用的response數(shù)據(jù)流寫入ServerHttpResponse的body中叛买，此外這個是一個先調(diào)用后發(fā)生的行為動作，流式編程的典型范例蹋订，也是驗證了之前所說的filter的鏈?zhǔn)秸{(diào)用是一個對稱的模型率挣，對于優(yōu)先級越高的行為定義其真實發(fā)生其實越晚，NettyWriteResponseFilter將結(jié)果數(shù)據(jù)流寫入ServerHttpResponse中發(fā)生在NettyRouting獲取到遠(yuǎn)程調(diào)用的結(jié)果數(shù)據(jù)流之后露戒，當(dāng)NettyRouting拿到結(jié)果數(shù)據(jù)流之后會將其寫入當(dāng)前請求exchange的attributes中椒功，寫入發(fā)生在return語句。建議調(diào)試階段可以將log level設(shè)置為trace玫锋，這樣可以清楚地觀察請求的行為發(fā)生軌跡蛾茉。

NettyWriteResponseFilter

ForwardPathFilter　|　優(yōu)先級：0

這是一個條件過濾器，只有當(dāng)請求的header scheme為forward的時候才會發(fā)生撩鹿，否則會忽略沒有任何作用谦炬，當(dāng)有轉(zhuǎn)發(fā)需求的時候會將request的請求path修改，從而修改了請求的目的地址。

ForwardPathFilter

GatewayMetricsFilter　|　優(yōu)先級：０

metrics實現(xiàn)键思，對于每個請求記錄其發(fā)生時間戳础爬，包括開始和結(jié)束時間以及請求狀態(tài)，gateway集成了micrometer框架來實現(xiàn)的吼鳞，個人覺得這個metrics實現(xiàn)并不是非常完美看蚜，micrometer實現(xiàn)其實依賴了dropwizard-metrics，dropwizard-metrics與微服務(wù)框架dropwizard之間可以無縫集成赔桌，效果非常好供炎，監(jiān)控數(shù)據(jù)是非常全面的，而micrometer實現(xiàn)比較精簡疾党，感興趣的讀者可以學(xué)習(xí)一下dropwizard的使用音诫，輕量級容易上手開發(fā)。

GatewayMetricsFilter

LoggingResponseStatusFilter　|　優(yōu)先級：１

屬于enhance-gateway自己的實現(xiàn)雪位，與GatewayMetricsFilter記錄請求結(jié)果狀態(tài)一致竭钝，不過我是基于依賴做的二次開發(fā)，無法復(fù)用已有的邏輯部分雹洗；這里有個需要注意的地方香罐，就是其優(yōu)先級必須發(fā)生在NettyWriteResponseFilter之后，也就是要大于-1才能獲取到status时肿，否則取到的會是null庇茫。

RouteToRequestUrlFilter　|　優(yōu)先級：10000

RouteToRequestUrlFilter是必須的全局過濾器，這個會在你通過注冊中心配置一個下游服務(wù)的時候起作用嗜侮，請求進(jìn)來的時候path的前綴是gateway的服務(wù)地址（ip+port或者是域名）港令，但是對于真實的請求調(diào)用，必須將其uri映射至服務(wù)id上锈颗；比如將path的192.168.20.134:10080映射至服務(wù)lb://{serviceId}顷霹；而對于絕對路徑配置的服務(wù)exchange的GATEWAY_ROUTE_ATTR屬性將會是null，直接過濾到下一個過濾器击吱，而不會發(fā)生path的真實映射淋淀。

RouteToRequestUrlFilter

LoadBalancerClientFilter　|　優(yōu)先級：10100

LoadBalancerClientFilter負(fù)責(zé)服務(wù)真實ip的映射，主要針對對個服務(wù)節(jié)點的情況進(jìn)行負(fù)載均衡覆醇，默認(rèn)采用的netflix-ribbon作為負(fù)載均衡器朵纷，首先如果scheme不是服務(wù)節(jié)點映射的話直接過濾，獲取服務(wù)節(jié)點永脓，69行的choose函數(shù)是真實負(fù)載均衡發(fā)生的函數(shù)袍辞，獲取一個本次選出的服務(wù)server instance（如果是單節(jié)點則無負(fù)載計算），然后將服務(wù)的真實ip+port替換掉path中的lb://{serviceId}前綴常摧。

LoadBalancerClientFilter

LoggingRealPathFilter　|　優(yōu)先級：10101

屬于enhance-gateway自己的實現(xiàn)搅吁，發(fā)生在LoadBalancerClientFilter之后便可以獲取當(dāng)前請求的真實path威创。

WebsocketRoutingFilter　|　優(yōu)先級：2147483646

WebsocketRoutingFilter過濾器實現(xiàn)了gateway對于websocket的支持，內(nèi)部通過websocketClient實現(xiàn)將一個http請求協(xié)議換轉(zhuǎn)成websocket谎懦，實現(xiàn)調(diào)用方無感知的請求websocket的服務(wù)肚豺，只需要將schme設(shè)置成ws或者wss這么簡單。

WebsocketRoutingFilter

ForwardRoutingFilter　|　優(yōu)先級：2147483647

ForwardRoutingFilter是一個結(jié)束操作界拦，經(jīng)過filter chain的鏈?zhǔn)秸{(diào)用吸申，最終將exchange交還給web handler做http請求處理。

ForwardRoutingFilter

總結(jié)

源碼當(dāng)中還有兩個GlobalFilter享甸，分別是WebClientHttpRoutingFilter截碴、WebClientWriteResponseFilter，/actuator/gateway/globalfilters結(jié)果當(dāng)中不包含它們原因是沒有在GatewayAutoConfiguration依賴注入枪萄，作者還沒啟用隐岛。

整個filter的調(diào)用通過Ordered接口捆綁成一個鏈?zhǔn)浇Y(jié)構(gòu)，并且通過reactor流式編程將代碼精簡瓷翻，這是一個非常優(yōu)秀的思想，如果在自己的服務(wù)當(dāng)中采用此編碼模型的話割坠，會使得代碼清晰很多齐帚，感興趣的讀者可以參考學(xué)習(xí)reactor-core。

本文主要分析了gateway的GlobalFilter的源碼實現(xiàn)彼哼，對于enhance-gateway實現(xiàn)的GlobalFilter只是提及对妄，這個是一種前后對應(yīng)的設(shè)計思想，并不是很完美敢朱，計劃在后續(xù)通過一篇獨立的文章探討自己的思想剪菱，并進(jìn)行優(yōu)化。

注：enhance-gateway參考地址