全站資源開放下載,感謝廣大網友的支持
鏈接失效請移步職業司平臺
非盈利平臺

非盈利平臺

只為分享一些優質內容

Java幫幫-微信公眾號

Java幫幫-微信公眾號

將分享做到極致

微信小程序

微信小程序

更方便的閱讀

職業司微信公眾號

職業司微信公眾號

實時動態通知

安卓APP

安卓APP

我們從此不分開

程序員生活志-公眾號

程序員生活志-公眾號

程序員生活學習圈,互聯網八卦黑料

支付寶贊助-Java幫幫社區
微信贊助-Java幫幫社區

深入理解Zuul之源碼解析

40
發表時間:2018-09-05 13:23

Zuul 架構圖

zuul.png

在zuul中, 整個請求的過程是這樣的,首先將請求給zuulservlet處理,zuulservlet中有一個zuulRunner對象,該對象中初始化了RequestContext:作為存儲整個請求的一些數據,并被所有的zuulfilter共享。zuulRunner中還有 FilterProcessor,FilterProcessor作為執行所有的zuulfilter的管理器。FilterProcessor從filterloader 中獲取zuulfilter,而zuulfilter是被filterFileManager所加載,并支持groovy熱加載,采用了輪詢的方式熱加載。有了這些filter之后,zuulservelet首先執行的Pre類型的過濾器,再執行route類型的過濾器,最后執行的是post 類型的過濾器,如果在執行這些過濾器有錯誤的時候則會執行error類型的過濾器。執行完這些過濾器,最終將請求的結果返回給客戶端。

zuul工作原理源碼分析

在之前已經講過,如何使用zuul,其中不可缺少的一個步驟就是在程序的啟動類加上@EnableZuulProxy,該EnableZuulProxy類代碼如下:

其中,引用了ZuulProxyConfiguration,跟蹤ZuulProxyConfiguration,該類注入了DiscoveryClient、RibbonCommandFactoryConfiguration用作負載均衡相關的。注入了一些列的filters,比如PreDecorationFilter、RibbonRoutingFilter、SimpleHostRoutingFilter,代碼如如下:

它的父類ZuulConfiguration ,引用了一些相關的配置。在缺失zuulServlet bean的情況下注入了ZuulServlet,該類是zuul的核心類。

同時也注入了其他的過濾器,比如ServletDetectionFilter、DebugFilter、Servlet30WrapperFilter,這些過濾器都是pre類型的。

它也注入了post類型的,比如 SendResponseFilter,error類型,比如 SendErrorFilter,route類型比如SendForwardFilter,代碼如下:

初始化ZuulFilterInitializer類,將所有的filter 向FilterRegistry注冊。

而FilterRegistry管理了一個ConcurrentHashMap,用作存儲過濾器的,并有一些基本的CURD過濾器的方法,代碼如下:

FilterLoader類持有FilterRegistry,FilterFileManager類持有FilterLoader,所以最終是由FilterFileManager注入 filterFilterRegistry的ConcurrentHashMap的。FilterFileManager到開啟了輪詢機制,定時的去加載過濾器,代碼如下:

Zuulservlet作為類似于Spring MVC中的DispatchServlet,起到了前端控制器的作用,所有的請求都由它接管。它的核心代碼如下:

跟蹤init(),可以發現這個方法為每個請求生成了RequestContext,RequestContext繼承了ConcurrentHashMap

而FilterProcessor類為調用filters的類,比如調用pre類型所有的過濾器:

跟蹤runFilters()方法,可以發現,它最終調用了FilterLoader的getFiltersByType(sType)方法來獲取同一類的過濾器,然后用for循環遍歷所有的ZuulFilter,執行了 processZuulFilter()方法,跟蹤該方法可以發現最終是執行了ZuulFilter的方法,最終返回了該方法返回的Object對象。

route、post類型的過濾器的執行過程和pre執行過程類似。

Zuul默認過濾器

默認的核心過濾器一覽表

Zuul默認注入的過濾器,它們的執行順序在FilterConstants類,我們可以先定位在這個類,然后再看這個類的過濾器的執行順序以及相關的注釋,可以很輕松定位到相關的過濾器,也可以直接打開
spring-cloud-netflix-core.jar的 zuul.filters包,可以看到一些列的filter,現在我以表格的形式,列出默認注入的filter.

過濾器的order值越小,就越先執行,并且在執行過濾器的過程中,它們共享了一個RequestContext對象,該對象的生命周期貫穿于請求,可以看出優先執行了pre類型的過濾器,并將執行后的結果放在RequestContext中,供后續的filter使用,比如在執行PreDecorationFilter的時候,決定使用哪一個route,它的結果的是放在RequestContext對象中,后續會執行所有的route的過濾器,如果不滿足條件就不執行該過濾器的run方法。最終達到了就執行一個route過濾器的run()方法。

而error類型的過濾器,是在程序發生異常的時候執行的。

post類型的過濾,在默認的情況下,只注入了SendResponseFilter,該類型的過濾器是將最終的請求結果以流的形式輸出給客戶單。

現在來看SimpleHostRoutingFilter是如何工作?

進入到SimpleHostRoutingFilter類的方法的run()方法,核心代碼如下:

查閱這個類的全部代碼可知,該類創建了一個HttpClient作為請求類,并重構了url,請求到了具體的服務,得到的一個CloseableHttpResponse對象,并將CloseableHttpResponse對象的保存到RequestContext對象中。并調用了ProxyRequestHelper的setResponse方法,將請求狀態碼,流等信息保存在RequestContext對象中。

現在來看SendResponseFilter是如何工作?

這個過濾器的order為1000,在默認且正常的情況下,是最后一個執行的過濾器,該過濾器是最終將得到的數據返回給客戶端的請求。

在它的run()方法里,有兩個方法:addResponseHeaders()和writeResponse(),即添加響應頭和寫入響應數據流。

其中writeResponse()方法是通過從RequestContext中獲取ResponseBody獲或者ResponseDataStream來寫入到HttpServletResponse中的,但是在默認的情況下ResponseBody為null,而ResponseDataStream在route類型過濾器中已經設置進去了。具體代碼如下:

如何在zuul上做日志處理

由于zuul作為api網關,所有的請求都經過這里,所以在網關上,可以做請求相關的日志處理。
我的需求是這樣的,需要記錄請求的 url,ip地址,參數,請求發生的時間,整個請求的耗時,請求的響應狀態,甚至請求響應的結果等。
很顯然,需要實現這樣的一個功能,需要寫一個ZuulFliter,它應該是在請求發送給客戶端之前做處理,并且在route過濾器路由之后,在默認的情況下,這個過濾器的order應該為500-1000之間。那么如何獲取這些我需要的日志信息呢?找RequestContext,在請求的生命周期里這個對象里,存儲了整個請求的所有信息。

現在編碼,在代碼的注釋中,做了詳細的說明,代碼如下:

現在讀者也許有疑問,如何得到的statrtTime,即請求開始的時間,其實這需要另外一個過濾器,在網絡請求route之前(大部分耗時都在route這一步),在過濾器中,在RequestContext存儲一個時間即可,另寫一個過濾器,代碼如下:

可能還有這樣的需求,我需要將響應結果,也要存儲在log中,在之前已經分析了,在route結束后,將從具體服務獲取的響應流存儲在RequestContext中,在SendResponseFilter過濾器寫入在HttpServletResponse中,最終返回給客戶端。那么我只需要在SendResponseFilter寫入響應流之前把響應流寫入到 log日志中即可,那么會引發另外一個問題,因為響應流寫入到 log后,RequestContext就沒有響應流了,在SendResponseFilter就沒有流輸入到HttpServletResponse中,導致客戶端沒有任何的返回數據,那么解決的辦法是這樣的:

從RequestContext獲取到流之后,首先將流 copy一份,將流轉化下字符串,存在日志中,再set到RequestContext中,
這樣SendResponseFilter就可以將響應返回給客戶端。這樣的做法有點影響性能,如果不是字符流,可能需要做更多的處理工作。


Java幫幫學習群生態

Java幫幫學習群生態

總有一款能幫到你

Java學習群

Java學習群

與大牛一起交流

大數據學習群

大數據學習群

在數據中成長

九點編程學習群

九點編程學習群

深夜九點學編程

python學習群

python學習群

人工智能,爬蟲

測試學習群

測試學習群

感受測試的魅力

Java幫幫生態承諾

Java幫幫生態承諾

一直堅守,不負重望

初心
勤儉
誠信
正義
分享
友鏈交換:加幫主QQ2524138991 留言即可 24小時內答復  
業司
教育資訊
會員登錄
獲取驗證碼
登錄
登錄
我的資料
留言
回到頂部