前言

過(guò)濾器是Zuul的核心組件，這篇文章我們來(lái)詳細(xì)討論Zuul的過(guò)濾器。下面話不多說(shuō)，來(lái)看看詳細(xì)的介紹吧。

過(guò)濾器類型與請(qǐng)求生命周期

Zuul大部分功能都是通過(guò)過(guò)濾器來(lái)實(shí)現(xiàn)的。Zuul中定義了四種標(biāo)準(zhǔn)過(guò)濾器類型，這些過(guò)濾器類型對(duì)應(yīng)于請(qǐng)求的典型生命周期。

(1) PRE：這種過(guò)濾器在請(qǐng)求被路由之前調(diào)用。我們可利用這種過(guò)濾器實(shí)現(xiàn)身份驗(yàn)證、在集群中選擇請(qǐng)求的微服務(wù)、記錄調(diào)試信息等。

(2) ROUTING：這種過(guò)濾器將請(qǐng)求路由到微服務(wù)。這種過(guò)濾器用于構(gòu)建發(fā)送給微服務(wù)的請(qǐng)求，并使用Apache HttpClient或Netfilx Ribbon請(qǐng)求微服務(wù)。

(3) POST：這種過(guò)濾器在路由到微服務(wù)以后執(zhí)行。這種過(guò)濾器可用來(lái)為響應(yīng)添加標(biāo)準(zhǔn)的HTTP Header、收集統(tǒng)計(jì)信息和指標(biāo)、將響應(yīng)從微服務(wù)發(fā)送給客戶端等。

(4) ERROR：在其他階段發(fā)生錯(cuò)誤時(shí)執(zhí)行該過(guò)濾器。

除了默認(rèn)的過(guò)濾器類型，Zuul還允許我們創(chuàng)建自定義的過(guò)濾器類型。例如，我們可以定制一種STATIC類型的過(guò)濾器，直接在Zuul中生成響應(yīng)，而不將請(qǐng)求轉(zhuǎn)發(fā)到后端的微服務(wù)。

Zuul請(qǐng)求的生命周期如圖8-5所示，該圖詳細(xì)描述了各種類型的過(guò)濾器的執(zhí)行順序。

Zuul請(qǐng)求的生命周期

編寫(xiě)Zuul過(guò)濾器

理解過(guò)濾器類型和請(qǐng)求生命周期后，我們來(lái)編寫(xiě)一個(gè)Zuul過(guò)濾器。編寫(xiě)Zuul的過(guò)濾器非常簡(jiǎn)單，我們只需繼承抽象類ZuulFilter，然后實(shí)現(xiàn)幾個(gè)抽象方法就可以了。

那么現(xiàn)在，我們來(lái)編寫(xiě)一個(gè)簡(jiǎn)單的Zuul過(guò)濾器，讓該過(guò)濾器打印請(qǐng)求日志。

(1) 復(fù)制項(xiàng)目microservice-gateway-zuul，將ArtifactId修改為microservice-gateway-zuul-filter。

(2) 編寫(xiě)自定義Zuul過(guò)濾器

public class PreRequestLogFilter extends ZuulFilter {
 private static final Logger LOGGER = LoggerFactory.getLogger(PreRequestLogFilter.class);
 @Override
 public String filterType() {
 return "pre";
 }
 @Override
 public int filterOrder() {
 return 1;
 }
 @Override
 public boolean shouldFilter() {
 return true;
 }
 @Override
 public Object run() {
 RequestContext ctx = RequestContext.getCurrentContext();
 HttpServletRequest request = ctx.getRequest();
 PreRequestLogFilter.LOGGER.info(String.format("send %s request to %s", request.getMethod(), request.getRequestURL().toString()));
 return null;
 }
}

由代碼可知，自定義的Zuul Filter需實(shí)現(xiàn)以下幾個(gè)方法：

1. filterType：返回過(guò)濾器的類型。有pre、route、post、error等幾種取值，分別對(duì)應(yīng)上文的幾種過(guò)濾器。詳細(xì)可以參考com.netflix.zuul.ZuulFilter.filterType() 中的注釋。
2. filterOrder：返回一個(gè)int值來(lái)指定過(guò)濾器的執(zhí)行順序，不同的過(guò)濾器允許返回相同的數(shù)字。
3. shouldFilter：返回一個(gè)boolean值來(lái)判斷該過(guò)濾器是否要執(zhí)行，true表示執(zhí)行，false表示不執(zhí)行。
4. run：過(guò)濾器的具體邏輯。本例中，我們讓它打印了請(qǐng)求的HTTP方法以及請(qǐng)求的地址。

(2) 修改啟動(dòng)類，為啟動(dòng)類添加以下內(nèi)容：

@Bean
public PreRequestLogFilter preRequestLogFilter() {
 return new PreRequestLogFilter();
}

測(cè)試

(1) 啟動(dòng)microservice-discovery-eureka。

(2) 啟動(dòng)microservice-provider-user。

(3) 啟動(dòng)microservice-gateway-zuul-filter。

(4) 訪問(wèn)http://localhost:8040/microservice-provider-user/1 ，可獲得類似如下的日志。

[nio-8040-exec-6] c.i.c.s.filters.pre.PreRequestLogFilter : send GET request to http://localhost:8040//microservice-provider-user/1

說(shuō)明我們編寫(xiě)的自定義Zuul過(guò)濾器被執(zhí)行了。

禁用Zuul過(guò)濾器

Spring Cloud默認(rèn)為Zuul編寫(xiě)并啟用了一些過(guò)濾器，例如DebugFilter、FormBodyWrapperFilter、PreDecorationFilter等。這些過(guò)濾器都存放在spring-cloud-netflix-core這個(gè)Jar包的org.springframework.cloud.netflix.zuul.filters包中。

一些場(chǎng)景下，我們想要禁用掉部分過(guò)濾器，此時(shí)該怎么辦呢？

答案非常簡(jiǎn)單，只需設(shè)置zuul.<SimpleClassName>.<filterType>.disable=true ，即可禁用SimpleClassName所對(duì)應(yīng)的過(guò)濾器。以過(guò)濾器org.springframework.cloud.netflix.zuul.filters.post.SendResponseFilter為例，只需設(shè)置zuul.SendResponseFilter.post.disable=true ，即可禁用該過(guò)濾器。

同理，如果想要禁用《編寫(xiě)Zuul過(guò)濾器》一節(jié)編寫(xiě)的過(guò)濾器，只需設(shè)置zuul.PreRequestLogFilter.pre.disable=true 即可。

TPS

(1) 相關(guān)代碼com.netflix.zuul.ZuulFilter.disablePropertyName() 、com.netflix.zuul.ZuulFilter.isFilterDisabled() 、com.netflix.zuul.ZuulFilter.runFilter() 。

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來(lái)一定的幫助，如果有疑問(wèn)大家可以留言交流。

最新評(píng)論