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