springcloud中如何實現(xiàn)服務(wù)網(wǎng)關(guān)過濾器

這篇文章將為大家詳細講解有關(guān)springcloud中如何實現(xiàn)服務(wù)網(wǎng)關(guān)過濾器，小編覺得挺實用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。

過濾器作用

我們的微服務(wù)應(yīng)用提供的接口就可以通過統(tǒng)一的API網(wǎng)關(guān)入口被客戶端訪問到了。但是，每個客戶端用戶請求微服務(wù)應(yīng)用提供的接口時，它們的訪問權(quán)限往往都需要有一定的限制，系統(tǒng)并不會將所有的微服務(wù)接口都對它們開放。然而，目前的服務(wù)路由并沒有限制權(quán)限這樣的功能，所有請求都會被毫無保留地轉(zhuǎn)發(fā)到具體的應(yīng)用并返回結(jié)果，為了實現(xiàn)對客戶端請求的安全校驗和權(quán)限控制，最簡單和粗暴的方法就是為每個微服務(wù)應(yīng)用都實現(xiàn)一套用于校驗簽名和鑒別權(quán)限的過濾器或攔截器。

不過，這樣的做法并不可取，它會增加日后的系統(tǒng)維護難度，因為同一個系統(tǒng)中的各種校驗邏輯很多情況下都是大致相同或類似的，這樣的實現(xiàn)方式會使得相似的校驗邏輯代碼被分散到了各個微服務(wù)中去，冗余代碼的出現(xiàn)是我們不希望看到的。所以，比較好的做法是將這些校驗邏輯剝離出去，構(gòu)建出一個獨立的鑒權(quán)服務(wù)。在完成了剝離之后，有不少開發(fā)者會直接在微服務(wù)應(yīng)用中通過調(diào)用鑒權(quán)服務(wù)來實現(xiàn)校驗，但是這樣的做法僅僅只是解決了鑒權(quán)邏輯的分離，并沒有在本質(zhì)上將這部分不屬于業(yè)余的邏輯拆分出原有的微服務(wù)應(yīng)用，冗余的攔截器或過濾器依然會存在。

對于這樣的問題，更好的做法是通過前置的網(wǎng)關(guān)服務(wù)來完成這些非業(yè)務(wù)性質(zhì)的校驗。由于網(wǎng)關(guān)服務(wù)的加入，外部客戶端訪問我們的系統(tǒng)已經(jīng)有了統(tǒng)一入口，既然這些校驗與具體業(yè)務(wù)無關(guān)，那何不在請求到達的時候就完成校驗和過濾，而不是轉(zhuǎn)發(fā)后再過濾而導致更長的請求延遲。同時，通過在網(wǎng)關(guān)中完成校驗和過濾，微服務(wù)應(yīng)用端就可以去除各種復雜的過濾器和攔截器了，這使得微服務(wù)應(yīng)用的接口開發(fā)和測試復雜度也得到了相應(yīng)的降低。

為了在API網(wǎng)關(guān)中實現(xiàn)對客戶端請求的校驗，我們將需要使用到Spring Cloud Zuul的另外一個核心功能：過濾器。

Zuul允許開發(fā)者在API網(wǎng)關(guān)上通過定義過濾器來實現(xiàn)對請求的攔截與過濾，實現(xiàn)的方法非常簡單，我們只需要繼承ZuulFilter抽象類并實現(xiàn)它定義的四個抽象函數(shù)就可以完成對請求的攔截和過濾了。

過濾器的實現(xiàn)

比如下面的代碼，我們定義了一個簡單的Zuul過濾器，它實現(xiàn)了在請求被路由之前檢查HttpServletRequest中是否有accessToken參數(shù)，若有就進行路由，若沒有就拒絕訪問，返回401 Unauthorized錯誤。

public class AccessFilter extends ZuulFilter {
private static Logger log = LoggerFactory.getLogger(AccessFilter.class);
@Override
public String filterType() {
return "pre";
}
@Override
public int filterOrder() {
return 0;
}
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() {
RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();
log.info("send {} request to {}", request.getMethod(), request.getRequestURL().toString());
Object accessToken = request.getParameter("accessToken");
if(accessToken == null) {
log.warn("access token is empty");
ctx.setSendZuulResponse(false);
ctx.setResponseStatusCode(401);
return null;
}
log.info("access token ok");
return null;
}
}

在上面實現(xiàn)的過濾器代碼中，我們通過繼承ZuulFilter抽象類并重寫了下面的四個方法來實現(xiàn)自定義的過濾器。這四個方法分別定義了：

• filterType：過濾器的類型，它決定過濾器在請求的哪個生命周期中執(zhí)行。這里定義為pre，代表會在請求被路由之前執(zhí)行。

• filterOrder：過濾器的執(zhí)行順序。當請求在一個階段中存在多個過濾器時，需要根據(jù)該方法返回的值來依次執(zhí)行。

• shouldFilter：判斷該過濾器是否需要被執(zhí)行。這里我們直接返回了true，因此該過濾器對所有請求都會生效。實際運用中我們可以利用該函數(shù)來指定過濾器的有效范圍。

• run：過濾器的具體邏輯。這里我們通過ctx.setSendZuulResponse(false)令zuul過濾該請求，不對其進行路由，然后通過ctx.setResponseStatusCode(401)設(shè)置了其返回的錯誤碼，當然我們也可以進一步優(yōu)化我們的返回，比如，通過ctx.setResponseBody(body)對返回body內(nèi)容進行編輯等。

在實現(xiàn)了自定義過濾器之后，它并不會直接生效，我們還需要為其創(chuàng)建具體的Bean才能啟動該過濾器，比如，在應(yīng)用主類中增加如下內(nèi)容：

@EnableZuulProxy
@SpringCloudApplication
public class Application {
public static void main(String[] args) {
new SpringApplicationBuilder(Application.class).web(true).run(args);
}
@Bean
public AccessFilter accessFilter() {
return new AccessFilter();
}
}

關(guān)于“springcloud中如何實現(xiàn)服務(wù)網(wǎng)關(guān)過濾器”這篇文章就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，使各位可以學到更多知識，如果覺得文章不錯，請把它分享出去讓更多的人看到。