springCloud學習05之api網關服務zuul過濾器filter

  前面學習了zuul的反向代理、負載均衡、fallback回退。這張學習寫過濾器filter，作java web開發的對filter都不陌生，那就是客戶端（如瀏覽器）發起請求的時候，都先通過過濾器filter作一些相關的校驗或業務判斷（如登陸、權限等），zuul也一樣提供了過濾器功能。只要繼承ZuulFilter類便可。

   經過前文的介紹，咱們對於Zuul的第一印象一般是這樣的：它包含了對請求的路由和過濾兩個功能，其中路由功能負責將外部請求轉發到具體的微服務實例上，是實現外部訪問統一入口的基礎；而過濾器功能則負責對請求的處理過程進行干預，是實現請求校驗、服務聚合等功能的基礎。

然而實際上，路由功能在真正運行時，它的路由映射和請求轉發都是由幾個不一樣的過濾器完成的。其中，路由映射主要經過pre類型的過濾器完成，它將請求路徑與配置的路由規則進行匹配，以找到須要轉發的目標地址；而請求轉發的部分則是由route類型的過濾器來完成，對pre類型過濾器得到的路由地址進行轉發。

因此，過濾器能夠說是Zuul實現API網關功能最爲核心的部件，每個進入Zuul的HTTP請求都會通過一系列的過濾器處理鏈獲得請求響應並返回給客戶端。

   繼承ZuulFilter.java，須要實現一些方法

package com.fei.springcloud.filter;

import com.netflix.zuul.ZuulFilter;

public class TestFilter extends ZuulFilter{

@Override
public boolean shouldFilter() {
return false;
}

@Override
public Object run() {
return null;
}

@Override
public String filterType() {
return null;
}

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

}

它們各自的含義與功能總結以下：

filterType：該函數須要返回一個字符串來表明過濾器的類型，而這個類型就是在HTTP請求過程當中定義的各個階段。在Zuul中默認定義了四種不一樣生命週期的過濾器類型，具體以下：
pre：能夠在請求被路由以前調用。
routing：在路由請求時候被調用。
post：在routing和error過濾器以後被調用。
error：處理請求時發生錯誤時被調用。
filterOrder：經過int值來定義過濾器的執行順序，數值越小優先級越高。
shouldFilter：返回一個boolean類型來判斷該過濾器是否要執行。咱們能夠經過此方法來指定過濾器的有效範圍。
run：過濾器的具體邏輯。在該函數中，咱們能夠實現自定義的過濾邏輯，來肯定是否要攔截當前的請求，不對其進行後續的路由，或是在請求路由返回結果以後，對處理結果作一些加工等。

從上圖中，咱們能夠看到，當外部HTTP請求到達API網關服務的時候，首先它會進入第一個階段pre，在這裏它會被pre類型的過濾器進行處理，該類型的過濾器主要目的是在進行請求路由以前作一些前置加工，好比請求的校驗等。

在完成了pre類型的過濾器處理以後，請求進入第二個階段routing，也就是以前說的路由請求轉發階段，請求將會被routing類型過濾器處理，這裏的具體處理內容就是將外部請求轉發到具體服務實例上去的過程，當服務實例將請求結果都返回以後，routing階段完成，請求進入第三個階段post，此時請求將會被post類型的過濾器進行處理，這些過濾器在處理的時候不只能夠獲取到請求信息，還能獲取到服務實例的返回信息，因此在post類型的過濾器中，咱們能夠對處理結果進行一些加工或轉換等內容。

另外，還有一個特殊的階段error，該階段只有在上述三個階段中發生異常的時候纔會觸發，可是它的最後流向仍是post類型的過濾器，由於它須要經過post過濾器將最終結果返回給請求客戶端（實際實現上還有一些差異)

Zuul自帶的核心過濾器

  在spring-cloud-netflix-core-XXX.jar架包下

 

如上圖所示，在默認啓用的過濾器中包含了三種不一樣生命週期的過濾器，這些過濾器都很是重要，能夠幫助咱們理解Zuul對外部請求處理的過程，以及幫助咱們如何在此基礎上擴展過濾器去完成自身系統須要的功能。下面，咱們將逐個地對這些過濾器作一些詳細的介紹：

pre過濾器
ServletDetectionFilter：它的執行順序爲-3，是最早被執行的過濾器。該過濾器老是會被執行，主要用來檢測當前請求是經過Spring的DispatcherServlet處理運行，仍是經過ZuulServlet來處理運行的。

它的檢測結果會以布爾類型保存在當前請求上下文的isDispatcherServletRequest參數中，這樣在後續的過濾器中，咱們就能夠經過RequestUtils.isDispatcherServletRequest()和RequestUtils.isZuulServletRequest()方法判斷它以實現作不一樣的處理。

通常狀況下，發送到API網關的外部請求都會被Spring的DispatcherServlet處理，除了經過/zuul/路徑訪問的請求會繞過DispatcherServlet，被ZuulServlet處理，主要用來應對處理大文件上傳的狀況。另外，對於ZuulServlet的訪問路徑/zuul/，咱們能夠經過zuul.servletPath參數來進行修改。

Servlet30WrapperFilter：它的執行順序爲-2，是第二個執行的過濾器。目前的實現會對全部請求生效，主要爲了將原始的HttpServletRequest包裝成Servlet30RequestWrapper對象。
FormBodyWrapperFilter：它的執行順序爲-1，是第三個執行的過濾器。

該過濾器僅對兩種類請求生效，第一類是Content-Type爲application/x-www-form-urlencoded的請求，第二類是Content-Type爲multipart/form-data而且是由Spring的DispatcherServlet處理的請求（用到了ServletDetectionFilter的處理結果）。

而該過濾器的主要目的是將符合要求的請求體包裝成FormBodyRequestWrapper對象。
DebugFilter：它的執行順序爲1，是第四個執行的過濾器。

該過濾器會根據配置參數zuul.debug.request和請求中的debug參數來決定是否執行過濾器中的操做。而它的具體操做內容則是將當前的請求上下文中的debugRouting和debugRequest參數設置爲true。

因爲在同一個請求的不一樣生命週期中，均可以訪問到這兩個值，因此咱們在後續的各個過濾器中能夠利用這兩值來定義一些debug信息，這樣當線上環境出現問題的時候，能夠經過請求參數的方式來激活這些debug信息以幫助分析問題。

另外，對於請求參數中的debug參數，咱們也能夠經過zuul.debug.parameter來進行自定義。
PreDecorationFilter：它的執行順序爲5，是pre階段最後被執行的過濾器。該過濾器會判斷當前請求上下文中是否存在forward.to和serviceId參數，若是都不存在，那麼它就會執行具體過濾器的操做（若是有一個存在的話，說明當前請求已經被處理過了，由於這兩個信息就是根據當前請求的路由信息加載進來的）。

而它的具體操做內容就是爲當前請求作一些預處理，好比：進行路由規則的匹配、在請求上下文中設置該請求的基本信息以及將路由匹配結果等一些設置信息等，這些信息將是後續過濾器進行處理的重要依據，咱們能夠經過RequestContext.getCurrentContext()來訪問這些信息。

另外，咱們還能夠在該實現中找到一些對HTTP頭請求進行處理的邏輯，其中包含了一些耳熟能詳的頭域，好比：X-Forwarded-Host、X-Forwarded-Port。

另外，對於這些頭域的記錄是經過zuul.addProxyHeaders參數進行控制的，而這個參數默認值爲true，因此Zuul在請求跳轉時默認地會爲請求增長X-Forwarded-*頭域，包括：X-Forwarded-Host、X-Forwarded-Port、X-Forwarded-For、X-Forwarded-Prefix、X-Forwarded-Proto。

咱們也能夠經過設置zuul.addProxyHeaders=false關閉對這些頭域的添加動做。

route過濾器
RibbonRoutingFilter：它的執行順序爲10，是route階段第一個執行的過濾器。該過濾器只對請求上下文中存在serviceId參數的請求進行處理，即只對經過serviceId配置路由規則的請求生效。而該過濾器的執行邏輯就是面向服務路由的核心，它經過使用Ribbon和Hystrix來向服務實例發起請求，並將服務實例的請求結果返回。
SimpleHostRoutingFilter：它的執行順序爲100，是route階段第二個執行的過濾器。該過濾器只對請求上下文中存在routeHost參數的請求進行處理，即只對經過url配置路由規則的請求生效。而該過濾器的執行邏輯就是直接向routeHost參數的物理地址發起請求，從源碼中咱們能夠知道該請求是直接經過httpclient包實現的，而沒有使用Hystrix命令進行包裝，因此這類請求並無線程隔離和斷路器的保護。
SendForwardFilter：它的執行順序爲500，是route階段第三個執行的過濾器。該過濾器只對請求上下文中存在forward.to參數的請求進行處理，即用來處理路由規則中的forward本地跳轉配置。
post過濾器
SendErrorFilter：它的執行順序爲0，是post階段第一個執行的過濾器。該過濾器僅在請求上下文中包含error.status_code參數（由以前執行的過濾器設置的錯誤編碼）而且尚未被該過濾器處理過的時候執行。而該過濾器的具體邏輯就是利用請求上下文中的錯誤信息來組織成一個forward到API網關/error錯誤端點的請求來產生錯誤響應。
SendResponseFilter：它的執行順序爲1000，是post階段最後執行的過濾器。該過濾器會檢查請求上下文中是否包含請求響應相關的頭信息、響應數據流或是響應體，只有在包含它們其中一個的時候就會執行處理邏輯。而該過濾器的處理邏輯就是利用請求上下文的響應信息來組織須要發送回客戶端的響應內容。

 

代碼實戰，完整代碼在github上 

寫2個pre類型的filter,1個post類型的filter.若是在第一個pre過濾器驗證就失敗了，則後面的過濾器不須要執行了。

 

TestPre01Filter.java

package com.fei.springcloud.filter;

import javax.servlet.http.HttpServletRequest;

import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;

/**
* 第一個pre類型的filter,prefilter01=true才能經過
* @author Jfei
*
*/
public class TestPre01Filter extends ZuulFilter{

/**
* 是否應該執行該過濾器，若是是false，則不執行該filter
*/
@Override
public boolean shouldFilter() {
return true;
}

/**
* 過濾器類型
* 順序: pre ->routing -> post ,以上3個順序出現異常時均可以觸發error類型的filter
*/
@Override
public String filterType() {

return FilterConstants.PRE_TYPE;
}

/**
* 同filterType類型中，order值越大，優先級越低
*/
@Override
public int filterOrder() {

return 1;
}
/**
* 執行業務操做，可執行sql,nosql等業務
*/
@Override
public Object run() {

RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();

String prefilter01 = request.getParameter("prefilter01");
System.out.println("執行pre01Filter .....prefilter01=" + prefilter01 );

//若是用戶名和密碼都正確，則繼續執行下一個filter
if("true".equals(prefilter01) ){
ctx.setSendZuulResponse(true);//會進行路由，也就是會調用api服務提供者
ctx.setResponseStatusCode(200);
ctx.set("isOK",true);//能夠把一些值放到ctx中，便於後面的filter獲取使用
}else{
ctx.setSendZuulResponse(false);//不須要進行路由，也就是不會調用api服務提供者
ctx.setResponseStatusCode(401);
ctx.set("isOK",false);//能夠把一些值放到ctx中，便於後面的filter獲取使用
//返回內容給客戶端
ctx.setResponseBody("{\"result\":\"pre01Filter auth not correct!\"}");// 返回錯誤內容
}

return null;
}





}
這是第一個自定義的pre類型filter，說以shuldFilter()爲true，也就是必須執行
TestPre02Filter.java

package com.fei.springcloud.filter;

import javax.servlet.http.HttpServletRequest;

import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;

/**
* prefilter02 校驗 prefilter02=true才能經過
* @author Jfei
*
*/
public class TestPre02Filter extends ZuulFilter{

/**
* 是否應該執行該過濾器，若是是false，則不執行該filter
*/
@Override
public boolean shouldFilter() {
//上一個filter設置該值
return RequestContext.getCurrentContext().getBoolean("isOK");
}

/**
* 過濾器類型
* 順序: pre ->routing -> post ,以上3個順序出現異常時均可以觸發error類型的filter
*/
@Override
public String filterType() {

return FilterConstants.PRE_TYPE;
}

/**
* 同filterType類型中，order值越大，優先級越低
*/
@Override
public int filterOrder() {

return 2;
}

@Override
public Object run() {
RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();

String prefilter02 = request.getParameter("prefilter02");
System.out.println("執行pre02Filter .....prefilter02=" + prefilter02 );

//若是用戶名和密碼都正確，則繼續執行下一個filter
if("true".equals(prefilter02) ){
ctx.setSendZuulResponse(true);//會進行路由，也就是會調用api服務提供者
ctx.setResponseStatusCode(200);
ctx.set("isOK",true);//能夠把一些值放到ctx中，便於後面的filter獲取使用
}else{
ctx.setSendZuulResponse(false);//不須要進行路由，也就是不會調用api服務提供者
ctx.setResponseStatusCode(401);
ctx.set("isOK",false);//能夠把一些值放到ctx中，便於後面的filter獲取使用
//返回內容給客戶端
ctx.setResponseBody("{\"result\":\"pre02Filter auth not correct!\"}");// 返回錯誤內容
}


return null;
}

}

TestPostFilter.java
package com.fei.springcloud.filter;

import javax.servlet.http.HttpServletRequest;

import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
/**
*
* post類型的filter,post=true才能經過
*
*/
public class TestPostFilter extends ZuulFilter{

/**
* 是否應該執行該過濾器，若是是false，則不執行該filter
*/
@Override
public boolean shouldFilter() {
//上一個filter設置該值
return RequestContext.getCurrentContext().getBoolean("isOK");
}

/**
* 過濾器類型
* 順序: pre ->routing -> post ,以上3個順序出現異常時均可以觸發error類型的filter
*/
@Override
public String filterType() {

return FilterConstants.ROUTE_TYPE;
}

/**
* 同filterType類型中，order值越大，優先級越低
*/
@Override
public int filterOrder() {

return 1;
}

@Override
public Object run() {
RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();

String post = request.getParameter("post");
System.out.println("執行postFilter .....post=" + post );

//若是用戶名和密碼都正確，則繼續執行下一個filter
if("true".equals(post) ){
ctx.setSendZuulResponse(true);//會進行路由，也就是會調用api服務提供者
ctx.setResponseStatusCode(200);
ctx.set("isOK",true);//能夠把一些值放到ctx中，便於後面的filter獲取使用
}else{
ctx.setSendZuulResponse(false);//不須要進行路由，也就是不會調用api服務提供者
ctx.setResponseStatusCode(401);
ctx.set("isOK",false);//能夠把一些值放到ctx中，便於後面的filter獲取使用
//返回內容給客戶端
ctx.setResponseBody("{\"result\":\"post auth not correct!\"}");// 返回錯誤內容
}


return null;
}

}

啓動類，對filter進行註冊
package com.fei.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.cloud.client.SpringCloudApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import org.springframework.context.annotation.Bean;

import com.fei.springcloud.filter.TestPre02Filter;
import com.fei.springcloud.filter.TestPostFilter;
import com.fei.springcloud.filter.TestPre01Filter;

@EnableZuulProxy
@SpringCloudApplication
public class ZuulFilterApplication {

public static void main(String[] args) {

SpringApplication.run(ZuulFilterApplication.class, args);
}

@Bean
public TestPre01Filter testPre01Filter(){
return new TestPre01Filter();
}

@Bean
public TestPre02Filter testPre02Filter(){
return new TestPre02Filter();
}


@Bean
public TestPostFilter testPostFilter(){
return new TestPostFilter();
}

}

啓動eureka-server,eureka-api(前面學習過，也有完整代碼了）,而後啓動Zuul-filter,
瀏覽器請求 http://127.0.0.1:8888/user-api/user/find
http://127.0.0.1:8888/user-api/user/find?prefilter01=true

http://127.0.0.1:8888/user-api/user/find?prefilter01=true&prefilter02=true

對比頁面看到的內容和控制檯打印的日誌，會發現若是pre的校驗都通不過的時候，api微服務就沒打印了，說明沒調用api微服務，post filter也沒執行--------------------- 做者：夢_殤 來源：CSDN 原文：https://blog.csdn.net/dream_broken/article/details/77197585 版權聲明：本文爲博主原創文章，轉載請附上博文連接！