在前兩篇文章：服務(wù)網(wǎng)關(guān)（基礎(chǔ)）、服務(wù)網(wǎng)關(guān)（路由配置）中，我們了解了Spring Cloud Zuul作為網(wǎng)關(guān)所具備的最基本功能：路由。本文我們將具體介紹一下Spring Cloud Zuul的另一項(xiàng)核心功能：過濾器。

過濾器的作用

通過上面所述的兩篇我們，我們已經(jīng)能夠?qū)崿F(xiàn)請(qǐng)求的路由功能，所以我們的微服務(wù)應(yīng)用提供的接口就可以通過統(tǒng)一的API網(wǎng)關(guān)入口被客戶端訪問到了。但是，每個(gè)客戶端用戶請(qǐng)求微服務(wù)應(yīng)用提供的接口時(shí)，它們的訪問權(quán)限往往都需要有一定的限制，系統(tǒng)并不會(huì)將所有的微服務(wù)接口都對(duì)它們開放。然而，目前的服務(wù)路由并沒有限制權(quán)限這樣的功能，所有請(qǐng)求都會(huì)被毫無保留地轉(zhuǎn)發(fā)到具體的應(yīng)用并返回結(jié)果，為了實(shí)現(xiàn)對(duì)客戶端請(qǐng)求的安全校驗(yàn)和權(quán)限控制，最簡(jiǎn)單和粗暴的方法就是為每個(gè)微服務(wù)應(yīng)用都實(shí)現(xiàn)一套用于校驗(yàn)簽名和鑒別權(quán)限的過濾器或攔截器。不過，這樣的做法并不可取，它會(huì)增加日后的系統(tǒng)維護(hù)難度，因?yàn)橥粋€(gè)系統(tǒng)中的各種校驗(yàn)邏輯很多情況下都是大致相同或類似的，這樣的實(shí)現(xiàn)方式會(huì)使得相似的校驗(yàn)邏輯代碼被分散到了各個(gè)微服務(wù)中去，冗余代碼的出現(xiàn)是我們不希望看到的。所以，比較好的做法是將這些校驗(yàn)邏輯剝離出去，構(gòu)建出一個(gè)獨(dú)立的鑒權(quán)服務(wù)。在完成了剝離之后，有不少開發(fā)者會(huì)直接在微服務(wù)應(yīng)用中通過調(diào)用鑒權(quán)服務(wù)來實(shí)現(xiàn)校驗(yàn)，但是這樣的做法僅僅只是解決了鑒權(quán)邏輯的分離，并沒有在本質(zhì)上將這部分不屬于業(yè)余的邏輯拆分出原有的微服務(wù)應(yīng)用，冗余的攔截器或過濾器依然會(huì)存在。

對(duì)于這樣的問題，更好的做法是通過前置的網(wǎng)關(guān)服務(wù)來完成這些非業(yè)務(wù)性質(zhì)的校驗(yàn)。由于網(wǎng)關(guān)服務(wù)的加入，外部客戶端訪問我們的系統(tǒng)已經(jīng)有了統(tǒng)一入口，既然這些校驗(yàn)與具體業(yè)務(wù)無關(guān)，那何不在請(qǐng)求到達(dá)的時(shí)候就完成校驗(yàn)和過濾，而不是轉(zhuǎn)發(fā)后再過濾而導(dǎo)致更長的請(qǐng)求延遲。同時(shí)，通過在網(wǎng)關(guān)中完成校驗(yàn)和過濾，微服務(wù)應(yīng)用端就可以去除各種復(fù)雜的過濾器和攔截器了，這使得微服務(wù)應(yīng)用的接口開發(fā)和測(cè)試復(fù)雜度也得到了相應(yīng)的降低。

為了在API網(wǎng)關(guān)中實(shí)現(xiàn)對(duì)客戶端請(qǐng)求的校驗(yàn)，我們將需要使用到Spring Cloud Zuul的另外一個(gè)核心功能：過濾器。

Zuul允許開發(fā)者在API網(wǎng)關(guān)上通過定義過濾器來實(shí)現(xiàn)對(duì)請(qǐng)求的攔截與過濾，實(shí)現(xiàn)的方法非常簡(jiǎn)單，我們只需要繼承ZuulFilter抽象類并實(shí)現(xiàn)它定義的四個(gè)抽象函數(shù)就可以完成對(duì)請(qǐng)求的攔截和過濾了。

過濾器的實(shí)現(xiàn)

比如下面的代碼，我們定義了一個(gè)簡(jiǎn)單的Zuul過濾器，它實(shí)現(xiàn)了在請(qǐng)求被路由之前檢查HttpServletRequest中是否有accessToken參數(shù)，若有就進(jìn)行路由，若沒有就拒絕訪問，返回401 Unauthorized錯(cuò)誤。

public class AccessFilter extends ZuulFilter { private static Logger log = LoggerFactory.getLogger(AccessFilter.class); @Override public String filterType() { return "pre"; } @Override public int filterOrder() { return 0; } @Override public boolean shouldFilter() { return true; } @Override public Object run() { RequestContext ctx = RequestContext.getCurrentContext(); HttpServletRequest request = ctx.getRequest(); log.info("send {} request to {}", request.getMethod(), request.getRequestURL().toString()); Object accessToken = request.getParameter("accessToken"); if(accessToken == null) { log.warn("access token is empty"); ctx.setSendZuulResponse(false); ctx.setResponseStatusCode(401); return null; } log.info("access token ok"); return null; } }

在上面實(shí)現(xiàn)的過濾器代碼中，我們通過繼承ZuulFilter抽象類并重寫了下面的四個(gè)方法來實(shí)現(xiàn)自定義的過濾器。這四個(gè)方法分別定義了：

• filterType：過濾器的類型，它決定過濾器在請(qǐng)求的哪個(gè)生命周期中執(zhí)行。這里定義為pre，代表會(huì)在請(qǐng)求被路由之前執(zhí)行。
• filterOrder：過濾器的執(zhí)行順序。當(dāng)請(qǐng)求在一個(gè)階段中存在多個(gè)過濾器時(shí)，需要根據(jù)該方法返回的值來依次執(zhí)行。
• shouldFilter：判斷該過濾器是否需要被執(zhí)行。這里我們直接返回了true，因此該過濾器對(duì)所有請(qǐng)求都會(huì)生效。實(shí)際運(yùn)用中我們可以利用該函數(shù)來指定過濾器的有效范圍。
• run：過濾器的具體邏輯。這里我們通過ctx.setSendZuulResponse(false)令zuul過濾該請(qǐng)求，不對(duì)其進(jìn)行路由，然后通過ctx.setResponseStatusCode(401)設(shè)置了其返回的錯(cuò)誤碼，當(dāng)然我們也可以進(jìn)一步優(yōu)化我們的返回，比如，通過ctx.setResponseBody(body)對(duì)返回body內(nèi)容進(jìn)行編輯等。

在實(shí)現(xiàn)了自定義過濾器之后，它并不會(huì)直接生效，我們還需要為其創(chuàng)建具體的Bean才能啟動(dòng)該過濾器，比如，在應(yīng)用主類中增加如下內(nèi)容：

@EnableZuulProxy @SpringCloudApplication public class Application { public static void main(String[] args) { new SpringApplicationBuilder(Application.class).web(true).run(args); } @Bean public AccessFilter accessFilter() { return new AccessFilter(); } }

在對(duì)api-gateway服務(wù)完成了上面的改造之后，我們可以重新啟動(dòng)它，并發(fā)起下面的請(qǐng)求，對(duì)上面定義的過濾器做一個(gè)驗(yàn)證：

• http://localhost:1101/api-a/hello：返回401錯(cuò)誤
• http://localhost:1101/api-a/hello&accessToken=token：正確路由到hello-service的/hello接口，并返回Hello World

到這里，對(duì)于Spring Cloud Zuul過濾器的基本功能就以介紹完畢。讀者可以根據(jù)自己的需要在服務(wù)網(wǎng)關(guān)上定義一些與業(yè)務(wù)無關(guān)的通用邏輯實(shí)現(xiàn)對(duì)請(qǐng)求的過濾和攔截，比如：簽名校驗(yàn)、權(quán)限校驗(yàn)、請(qǐng)求限流等功能。

進(jìn)階閱讀

為了更好的理解和擴(kuò)展Spring Cloud Zuul，我們可以閱讀下面這些文章，有助于深入的了解其內(nèi)部運(yùn)行機(jī)制，以指導(dǎo)我們合理的編寫過濾器邏輯：

• Spring Cloud源碼分析（四）Zuul：核心過濾器
• Spring Cloud實(shí)戰(zhàn)小貼士：Zuul處理Cookie和重定向
• Spring Cloud實(shí)戰(zhàn)小貼士：Zuul統(tǒng)一異常處理（一）
• Spring Cloud實(shí)戰(zhàn)小貼士：Zuul統(tǒng)一異常處理（二）
• Spring Cloud實(shí)戰(zhàn)小貼士：Zuul統(tǒng)一異常處理（三）【Dalston版】

---

總結(jié)

以上是生活随笔為你收集整理的Spring Cloud构建微服务架构：服务网关（过滤器）【Dalston版】的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。