spring cloud-zuul的Filter使用詳解
在前面我們使用zuul搭建了網(wǎng)關(guān)http://m.fzitv.net/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)行下面的過濾動(dòng)作了，直接跳過后面的所有過濾器并返回結(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ù)據(jù)交換?Json?和?異步請求?Ajax詳解
Json（JavaScript Object Notation）是一種輕量級的數(shù)據(jù)交換格式，采用鍵值對的形式來表示數(shù)據(jù)，它廣泛應(yīng)用于Web開發(fā)中，特別適合于前后端數(shù)據(jù)傳輸和存儲，這篇文章主要介紹了Java數(shù)據(jù)交換Json和異步請求Ajax,需要的朋友可以參考下2023-09-09
MybatisPlus的LambdaQueryWrapper用法詳解
LambdaQueryWrapper<Tag>?是 MyBatis-Plus 框架中的一個(gè)功能強(qiáng)大的查詢構(gòu)造器,它用于構(gòu)建 SQL 查詢條件,具有一定的參考價(jià)值,感興趣的可以了解一下2024-10-10
Java搭建一個(gè)springboot3.4.1項(xiàng)目?JDK21的詳細(xì)過程
這篇文章詳細(xì)介紹了如何使用IntelliJ IDEA搭建一個(gè)基于Spring Boot 3.4.1的項(xiàng)目,并使用JDK 21和Maven 3.6.3,涵蓋了環(huán)境準(zhǔn)備、項(xiàng)目創(chuàng)建、依賴管理、Maven配置、以及解決常見問題的步驟,感興趣的朋友跟隨小編一起看看吧2025-01-01
這篇文章主要介紹了Hibernate持久化對象生命周期原理解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09
Java基礎(chǔ)之extends用法詳解及簡單實(shí)例
這篇文章主要介紹了 Java基礎(chǔ)之extends用法詳解及簡單實(shí)例的相關(guān)資料,需要的朋友可以參考下2017-02-02
這篇文章主要介紹了Java抽象類概念與用法,結(jié)合實(shí)例形式分析了java抽象類的概念、方法、特點(diǎn)及使用方法,需要的朋友可以參考下2018-02-02
這篇文章主要介紹了spring緩存cache的使用詳解，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-10-10
idea的spring boot項(xiàng)目實(shí)現(xiàn)更改端口號操作
這篇文章主要介紹了idea的spring boot項(xiàng)目實(shí)現(xiàn)更改端口號操作，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-09-09
springboot如何開啟和關(guān)閉kafka消費(fèi)
在Kafka消費(fèi)者中,通過關(guān)閉自動(dòng)消費(fèi)配置,使用自定義容器工廠,并在消費(fèi)監(jiān)聽器上設(shè)置id,可以手動(dòng)控制消費(fèi)的開啟和關(guān)閉,這是根據(jù)個(gè)人經(jīng)驗(yàn)總結(jié)的方法,旨在幫助其他開發(fā)者2024-12-12
Java實(shí)現(xiàn)獲取客戶端真實(shí)IP方法小結(jié)
本文給大家匯總介紹了2種使用java實(shí)現(xiàn)獲取客戶端真實(shí)IP的方法，主要用于獲取使用了代理訪問的來訪者的IP，有需要的小伙伴可以參考下。2016-03-03