spring cloud-zuul的Filter使用詳解
在前面我們使用zuul搭建了網(wǎng)關(guān)http://chabaoo.cn/article/133235.htm
關(guān)于網(wǎng)關(guān)的作用，這里就不再次贅述了，我們今天的重點(diǎn)是zuul的Filter。通過Filter，我們可以實(shí)現(xiàn)安全控制，比如，只有請求參數(shù)中有用戶名和密碼的客戶端才能訪問服務(wù)端的資源。那么如何來實(shí)現(xiàn)Filter了？
要想實(shí)現(xiàn)Filter，需要以下幾個(gè)步驟：
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");// 獲取請求的參數(shù)
if(null != username && username.equals("chhliu")) {// 如果請求的參數(shù)不為空，且值為chhliu時(shí)，則通過
ctx.setSendZuulResponse(true);// 對該請求進(jìn)行路由
ctx.setResponseStatusCode(200);
ctx.set("isSuccess", true);// 設(shè)值，讓下一個(gè)Filter看到上一個(gè)Filter的狀態(tài)
return null;
}else{
ctx.setSendZuulResponse(false);// 過濾該請求，不對其進(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)先級為0，數(shù)字越大，優(yōu)先級越低
}
@Override
public String filterType() {
return "pre";// 前置過濾器
}
}
通過繼承ZuulFilter然后覆寫上面的4個(gè)方法，就可以實(shí)現(xiàn)一個(gè)簡單的過濾器，下面就相關(guān)注意點(diǎn)進(jìn)行說明
filterType：返回一個(gè)字符串代表過濾器的類型，在zuul中定義了四種不同生命周期的過濾器類型，具體如下：
- pre：可以在請求被路由之前調(diào)用
- route：在路由請求時(shí)候被調(diào)用
- post：在route和error過濾器之后被調(diào)用
- error：處理請求時(shí)發(fā)生錯(cuò)誤時(shí)被調(diào)用
Zuul的主要請求生命周期包括“pre”，“route”和“post”等階段。對于每個(gè)請求，都會運(yùn)行具有這些類型的所有過濾器。
filterOrder：通過int值來定義過濾器的執(zhí)行順序
shouldFilter：返回一個(gè)boolean類型來判斷該過濾器是否要執(zhí)行，所以通過此函數(shù)可實(shí)現(xiàn)過濾器的開關(guān)。在上例中，我們直接返回true，所以該過濾器總是生效
run：過濾器的具體邏輯。需要注意，這里我們通過ctx.setSendZuulResponse(false)令zuul過濾該請求，不對其進(jìn)行路由，然后通過ctx.setResponseStatusCode(401)設(shè)置了其返回的錯(cuò)誤碼
過濾器間的協(xié)調(diào)
過濾器沒有直接的方式來訪問對方。 它們可以使用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)行下面的過濾動作了，直接跳過后面的所有過濾器并返回結(jié)果
}
@Override
public int filterOrder() {
return 1; // 優(yōu)先級設(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";// 在請求被處理之后，會進(jìn)入該過濾器
}
}
2、在主類中，先開啟前面的兩個(gè)過濾器
@Bean
public AccessUserNameFilter accessUserNameFilter() {
return new AccessUserNameFilter();
}
@Bean
public AccessPasswordFilter accessPasswordFilter(){
return new AccessPasswordFilter();
}
3、輸入請求，驗(yàn)證
(1)請求為：http://localhost:8768/h2service/user/1?username=chhliu
測試結(jié)果為：{"result":"password is not correct!"}
控制臺打印結(jié)果
GET AccessUserNameFilter request to http://localhost:8768/h2service/user/1
GET AccessPasswordFilter request to http://localhost:8768/h2service/user/1
通過了AccessUserNameFilter過濾器，在驗(yàn)證AccessPasswordFilter過濾器的時(shí)候失敗了
后臺無sql打印，說明請求沒有被路由
(2)請求為：http://localhost:8768/h2service/user/1?password=123456
測試結(jié)果為：{"result":"username is not correct!"}
控制臺打印結(jié)果：
GET AccessUserNameFilter request to http://localhost:8768/h2service/user/1
說明到了AccessUserNameFilter過濾器，但是沒有到AccessPasswordFilter過濾器，因?yàn)锳ccessUserNameFilter過濾器的優(yōu)先級高一些，會先執(zhí)行，在執(zhí)行的時(shí)候，發(fā)現(xiàn)過濾條件不符合，于是跳過了后面所有的過濾器，并返回結(jié)果
后臺無sql打印，說明請求沒有被路由
(3)請求為：http://localhost:8768/h2service/user/1?password=123456&username=chhliu
測試結(jié)果為：
{
"id": 1,
"username": "user1",
"name": "張三",
"age": 20,
"balance": 100.00
}
控制臺打印的結(jié)果：
GET AccessUserNameFilter request to http://localhost:8768/h2service/user/1
GET AccessPasswordFilter request to http://localhost:8768/h2service/user/1
說明是先執(zhí)行了AccessUserNameFilter然后才執(zhí)行AccessPasswordFilter這也和我們前面說的order的值越小，優(yōu)先級越高是吻合的。
同時(shí)被請求的服務(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=?
說明請求被路由了。
4、開啟post過濾器，再跑一次
測試結(jié)果：發(fā)現(xiàn)post過濾器是最后執(zhí)行的，盡管它的優(yōu)先級為0
關(guān)于zuul的Filter的生命周期，見下圖
注：上圖有個(gè)小錯(cuò)誤，routing應(yīng)該是route
5、拓展
zuul還提供了一類特殊的過濾器，分別為：StaticResponseFilter和SurgicalDebugFilter
StaticResponseFilter：StaticResponseFilter允許從Zuul本身生成響應(yīng)，而不是將請求轉(zhuǎn)發(fā)到源。
SurgicalDebugFilter：SurgicalDebugFilter允許將特定請求路由到分隔的調(diào)試集群或主機(jī)。
以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
解決Java編譯時(shí)錯(cuò)誤:A JNI error has occurred,ple
這篇文章主要介紹了解決Java編譯時(shí)錯(cuò)誤:A JNI error has occurred,please check your installation and try again,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-02-02
95%的Java程序員人都用不好Synchronized詳解
這篇文章主要為大家介紹了95%的Java程序員人都用不好Synchronized詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-03-03
這篇文章主要介紹了spring中actuator監(jiān)視器配置詳解,actuator主要是完成微服務(wù)的監(jiān)控,完成監(jiān)控治理,可以查看微服務(wù)間的數(shù)據(jù)處理和調(diào)用,當(dāng)它們之間出現(xiàn)了異常,就可以快速定位到出現(xiàn)問題的地方,需要的朋友可以參考下2023-09-09
java實(shí)現(xiàn)簡單登錄界面的實(shí)戰(zhàn)過程
學(xué)習(xí)JAVA的過程當(dāng)中,登陸界面是多數(shù)人第一個(gè)實(shí)現(xiàn)的小程序,下面這篇文章主要給大家介紹了關(guān)于利用java實(shí)現(xiàn)簡單登錄界面的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-05-05
Java如何利用Socket進(jìn)行數(shù)據(jù)讀寫
這篇文章主要介紹了Java如何利用Socket進(jìn)行數(shù)據(jù)讀寫，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-10-10
下面小編就為大家?guī)硪黄獪\析Java內(nèi)存模型與垃圾回收。小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧，祝大家游戲愉快哦2016-05-05
如何使用IDEA從SVN服務(wù)端檢出項(xiàng)目
這篇文章主要介紹了如何使用IDEA從SVN服務(wù)端檢出項(xiàng)目問題,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-12-12
Mybatis自定義TypeHandler解決特殊類型轉(zhuǎn)換問題詳解
這篇文章主要介紹了Mybatis自定義TypeHandler解決特殊類型轉(zhuǎn)換問題詳解，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-11-11
本篇文章是對Sqlite多線程入庫的問題進(jìn)行了詳細(xì)的分析介紹，需要的朋友參考下2013-05-05
Java 實(shí)現(xiàn)一個(gè)漢諾塔實(shí)戰(zhàn)練習(xí)
漢諾塔是源于印度一個(gè)古老傳說的益智玩具。大梵天創(chuàng)造世界時(shí)做了三根石柱，在一根柱子上從下往上按大小順序摞著64片黃金圓盤。大梵天命令婆羅門把圓盤從下面開始按大小順序重新擺放在另一根柱子上。并且規(guī)定，在小圓盤上不能放大圓盤，三根柱子之間一次只能移動一個(gè)圓盤2021-10-10