Filter怎么在spring cloud-zuul中使用

這篇文章將為大家詳細(xì)講解有關(guān)Filter怎么在spring cloud-zuul中使用，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個(gè)參考，希望大家閱讀完這篇文章后對(duì)相關(guān)知識(shí)有一定的了解。

1、繼承ZuulFilter類，為了驗(yàn)證Filter的特性，我們這里創(chuàng)建3個(gè)Filter

根據(jù)用戶名來過濾

package com.chhliu.springcloud.zuul;  
import javax.servlet.http.HttpServletRequest;  
import com.netflix.zuul.ZuulFilter; 
import com.netflix.zuul.context.RequestContext; 
public class AccessUserNameFilter extends ZuulFilter { 
  @Override 
  public Object run() { 
    RequestContext ctx = RequestContext.getCurrentContext(); 
    HttpServletRequest request = ctx.getRequest(); 
 
    System.out.println(String.format("%s AccessUserNameFilter request to %s", request.getMethod(), request.getRequestURL().toString())); 
 
    String username = request.getParameter("username");// 獲取請(qǐng)求的參數(shù) 
    if(null != username && username.equals("chhliu")) {// 如果請(qǐng)求的參數(shù)不為空，且值為chhliu時(shí)，則通過 
      ctx.setSendZuulResponse(true);// 對(duì)該請(qǐng)求進(jìn)行路由 
      ctx.setResponseStatusCode(200); 
      ctx.set("isSuccess", true);// 設(shè)值，讓下一個(gè)Filter看到上一個(gè)Filter的狀態(tài) 
      return null; 
    }else{ 
      ctx.setSendZuulResponse(false);// 過濾該請(qǐng)求，不對(duì)其進(jìn)行路由 
      ctx.setResponseStatusCode(401);// 返回錯(cuò)誤碼 
      ctx.setResponseBody("{\"result\":\"username is not correct!\"}");// 返回錯(cuò)誤內(nèi)容 
      ctx.set("isSuccess", false); 
      return null; 
    } 
  } 
 
  @Override 
  public boolean shouldFilter() { 
    return true;// 是否執(zhí)行該過濾器，此處為true，說明需要過濾 
  } 
 
  @Override 
  public int filterOrder() { 
    return 0;// 優(yōu)先級(jí)為0，數(shù)字越大，優(yōu)先級(jí)越低 
  } 
 
  @Override 
  public String filterType() { 
    return "pre";// 前置過濾器 
  } 
}

通過繼承ZuulFilter然后覆寫上面的4個(gè)方法，就可以實(shí)現(xiàn)一個(gè)簡(jiǎn)單的過濾器，下面就相關(guān)注意點(diǎn)進(jìn)行說明
filterType：返回一個(gè)字符串代表過濾器的類型，在zuul中定義了四種不同生命周期的過濾器類型，具體如下：

1. pre：可以在請(qǐng)求被路由之前調(diào)用

2. route：在路由請(qǐng)求時(shí)候被調(diào)用

3. post：在route和error過濾器之后被調(diào)用

4. error：處理請(qǐng)求時(shí)發(fā)生錯(cuò)誤時(shí)被調(diào)用

Zuul的主要請(qǐng)求生命周期包括“pre”，“route”和“post”等階段。對(duì)于每個(gè)請(qǐng)求，都會(huì)運(yùn)行具有這些類型的所有過濾器。

filterOrder：通過int值來定義過濾器的執(zhí)行順序

shouldFilter：返回一個(gè)boolean類型來判斷該過濾器是否要執(zhí)行，所以通過此函數(shù)可實(shí)現(xiàn)過濾器的開關(guān)。在上例中，我們直接返回true，所以該過濾器總是生效

run：過濾器的具體邏輯。需要注意，這里我們通過ctx.setSendZuulResponse(false)令zuul過濾該請(qǐng)求，不對(duì)其進(jìn)行路由，然后通過ctx.setResponseStatusCode(401)設(shè)置了其返回的錯(cuò)誤碼

過濾器間的協(xié)調(diào)

過濾器沒有直接的方式來訪問對(duì)方。 它們可以使用RequestContext共享狀態(tài)，這是一個(gè)類似Map的結(jié)構(gòu)，具有一些顯式訪問器方法用于被認(rèn)為是Zuul的原語，內(nèi)部是使用ThreadLocal實(shí)現(xiàn)的，有興趣的同學(xué)可以看下源碼。

再建一個(gè)過濾器，根據(jù)密碼來過濾：

package com.chhliu.springcloud.zuul;  
import javax.servlet.http.HttpServletRequest; 
import com.netflix.zuul.ZuulFilter; 
import com.netflix.zuul.context.RequestContext;  
public class AccessPasswordFilter extends ZuulFilter {  
  @Override 
  public Object run() { 
    RequestContext ctx = RequestContext.getCurrentContext(); 
    HttpServletRequest request = ctx.getRequest(); 
 
    System.out.println(String.format("%s AccessPasswordFilter request to %s", request.getMethod(), request.getRequestURL().toString())); 
 
    String username = request.getParameter("password"); 
    if(null != username && username.equals("123456")) { 
      ctx.setSendZuulResponse(true); 
      ctx.setResponseStatusCode(200); 
      ctx.set("isSuccess", true); 
      return null; 
    }else{ 
      ctx.setSendZuulResponse(false); 
      ctx.setResponseStatusCode(401); 
      ctx.setResponseBody("{\"result\":\"password is not correct!\"}"); 
      ctx.set("isSuccess", false); 
      return null; 
    } 
  } 
 
  @Override 
  public boolean shouldFilter() { 
    RequestContext ctx = RequestContext.getCurrentContext(); 
    return (boolean) ctx.get("isSuccess");// 如果前一個(gè)過濾器的結(jié)果為true，則說明上一個(gè)過濾器成功了，需要進(jìn)入當(dāng)前的過濾，如果前一個(gè)過濾器的結(jié)果為false，則說明上一個(gè)過濾器沒有成功，則無需進(jìn)行下面的過濾動(dòng)作了，直接跳過后面的所有過濾器并返回結(jié)果 
  } 
 
  @Override 
  public int filterOrder() { 
    return 1; // 優(yōu)先級(jí)設(shè)置為1 
  } 
 
  @Override 
  public String filterType() { 
    return "pre"; 
  } 
}

最后建一個(gè)post過濾器

package com.chhliu.springcloud.zuul;  
import javax.servlet.http.HttpServletRequest;  
import com.netflix.zuul.ZuulFilter; 
import com.netflix.zuul.context.RequestContext;  
public class AccessTokenFilter extends ZuulFilter { 
  @Override 
  public Object run() { 
    RequestContext ctx = RequestContext.getCurrentContext(); 
    HttpServletRequest request = ctx.getRequest(); 
 
    System.out.println(String.format("%s AccessTokenFilter request to %s", request.getMethod(), 
        request.getRequestURL().toString())); 
     
    ctx.setSendZuulResponse(true); 
    ctx.setResponseStatusCode(200); 
    ctx.setResponseBody("{\"name\":\"chhliu\"}");// 輸出最終結(jié)果 
    return null; 
  } 
 
  @Override 
  public boolean shouldFilter() { 
    return true; 
  } 
 
  @Override 
  public int filterOrder() { 
    return 0; 
  } 
 
  @Override 
  public String filterType() { 
    return "post";// 在請(qǐng)求被處理之后，會(huì)進(jìn)入該過濾器 
  } 
}

2、在主類中，先開啟前面的兩個(gè)過濾器

@Bean 
  public AccessUserNameFilter accessUserNameFilter() { 
    return new AccessUserNameFilter(); 
  } 
   
  @Bean 
  public AccessPasswordFilter accessPasswordFilter(){ 
    return new AccessPasswordFilter(); 
  }

3、輸入請(qǐng)求，驗(yàn)證

(1)請(qǐng)求為：http://localhost:8768/h3service/user/1?username=chhliu

測(cè)試結(jié)果為：{"result":"password is not correct!"}

控制臺(tái)打印結(jié)果

GET AccessUserNameFilter request to http://localhost:8768/h3service/user/1 
GET AccessPasswordFilter request to http://localhost:8768/h3service/user/1 

通過了AccessUserNameFilter過濾器，在驗(yàn)證AccessPasswordFilter過濾器的時(shí)候失敗了

后臺(tái)無sql打印，說明請(qǐng)求沒有被路由

(2)請(qǐng)求為：http://localhost:8768/h3service/user/1?password=123456

測(cè)試結(jié)果為：{"result":"username is not correct!"}

控制臺(tái)打印結(jié)果：
GET AccessUserNameFilter request to http://localhost:8768/h3service/user/1 

說明到了AccessUserNameFilter過濾器，但是沒有到AccessPasswordFilter過濾器，因?yàn)锳ccessUserNameFilter過濾器的優(yōu)先級(jí)高一些，會(huì)先執(zhí)行，在執(zhí)行的時(shí)候，發(fā)現(xiàn)過濾條件不符合，于是跳過了后面所有的過濾器，并返回結(jié)果
后臺(tái)無sql打印，說明請(qǐng)求沒有被路由

(3)請(qǐng)求為：http://localhost:8768/h3service/user/1?password=123456&username=chhliu

測(cè)試結(jié)果為：

{ 
 
    "id": 1, 
    "username": "user1", 
    "name": "張三", 
    "age": 20, 
    "balance": 100.00 
 
} 

控制臺(tái)打印的結(jié)果：

GET AccessUserNameFilter request to http://localhost:8768/h3service/user/1 
GET AccessPasswordFilter request to http://localhost:8768/h3service/user/1 

說明是先執(zhí)行了AccessUserNameFilter然后才執(zhí)行AccessPasswordFilter這也和我們前面說的order的值越小，優(yōu)先級(jí)越高是吻合的。

同時(shí)被請(qǐng)求的服務(wù)有sql輸出：

Hibernate: select user0_.id as id1_0_0_, user0_.age as age2_0_0_, user0_.balance as balance3_0_0_, user0_.name as name4_0_0_, user0_.username as username5_0_0_ from user user0_ where user0_.id=? 

說明請(qǐng)求被路由了。

4、開啟post過濾器，再跑一次

測(cè)試結(jié)果：發(fā)現(xiàn)post過濾器是最后執(zhí)行的，盡管它的優(yōu)先級(jí)為0

關(guān)于zuul的Filter的生命周期，見下圖

注：上圖有個(gè)小錯(cuò)誤，routing應(yīng)該是route

5、拓展

zuul還提供了一類特殊的過濾器，分別為：StaticResponseFilter和SurgicalDebugFilter

StaticResponseFilter：StaticResponseFilter允許從Zuul本身生成響應(yīng)，而不是將請(qǐng)求轉(zhuǎn)發(fā)到源。

SurgicalDebugFilter：SurgicalDebugFilter允許將特定請(qǐng)求路由到分隔的調(diào)試集群或主機(jī)。

關(guān)于Filter怎么在spring cloud-zuul中使用就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺得文章不錯(cuò)，可以把它分享出去讓更多的人看到。