淺談Spring Cloud中的API網(wǎng)關(guān)服務(wù)Zuul
到目前為止,我們Spring Cloud中的內(nèi)容已經(jīng)介紹了很多了,Ribbon、Hystrix、Feign這些知識(shí)點(diǎn)大家都耳熟能詳了,我們?cè)谇拔囊蔡岬竭^(guò)微服務(wù)就是把一個(gè)大的項(xiàng)目拆分成很多小的獨(dú)立模塊,然后通過(guò)服務(wù)治理讓這些獨(dú)立的模塊配合工作等。那么大家來(lái)想這樣兩個(gè)問(wèn)題:1.如果我的微服務(wù)中有很多個(gè)獨(dú)立服務(wù)都要對(duì)外提供服務(wù),那么對(duì)于開(kāi)發(fā)人員或者運(yùn)維人員來(lái)說(shuō),他要如何去管理這些接口?特別是當(dāng)項(xiàng)目非常大非常龐雜的情況下要如何管理?2.權(quán)限管理也是一個(gè)老生常談的問(wèn)題,在微服務(wù)中,一個(gè)獨(dú)立的系統(tǒng)被拆分成很多個(gè)獨(dú)立的模塊,為了確保安全,我難道需要在每一個(gè)模塊上都添加上相同的鑒權(quán)代碼來(lái)確保系統(tǒng)不被非法訪問(wèn)?如果是這樣的話,那么工作量就太大了,而且維護(hù)也非常不方便。
為了解決上面提到的問(wèn)題,我們引入了API網(wǎng)關(guān)的概念,API網(wǎng)關(guān)是一個(gè)更為智能的應(yīng)用服務(wù)器,它有點(diǎn)類(lèi)似于我們微服務(wù)架構(gòu)系統(tǒng)的門(mén)面,所有的外部訪問(wèn)都要先經(jīng)過(guò)API網(wǎng)關(guān),然后API網(wǎng)關(guān)來(lái)實(shí)現(xiàn)請(qǐng)求路由、負(fù)載均衡、權(quán)限驗(yàn)證等功能。Spring Cloud中提供的Spring Cloud Zuul實(shí)現(xiàn)了API網(wǎng)關(guān)的功能,本文我們就先來(lái)看看Spring Cloud Zuul的一個(gè)基本使用。
構(gòu)建網(wǎng)關(guān)
網(wǎng)關(guān)的構(gòu)建我們通過(guò)下面三個(gè)步驟來(lái)實(shí)現(xiàn)。
1.創(chuàng)建Spring Boot工程并添加依賴
首先我們創(chuàng)建一個(gè)普通的Spring Boot工程名為api-gateway,然后添加相關(guān)依賴,這里我們主要添加兩個(gè)依賴spring-cloud-starter-zuul和spring-cloud-starter-eureka,spring-cloud-starter-zuul依賴中則包含了ribbon、hystrix、actuator等,如下:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.7.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<spring-cloud.version>Dalston.SR3</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zuul</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
2.添加注解
然后在入口類(lèi)上添加@EnableZuulProxy注解表示開(kāi)啟Zuul的API網(wǎng)關(guān)服務(wù)功能,如下:
@SpringBootApplication
@EnableZuulProxy
public class ApiGatewayApplication {
public static void main(String[] args) {
SpringApplication.run(ApiGatewayApplication.class, args);
}
}
3.配置路由規(guī)則
application.properties文件中的配置可以分為兩部分,一部分是Zuul應(yīng)用的基礎(chǔ)信息,還有一部分則是路由規(guī)則,如下:
# 基礎(chǔ)信息配置 spring.application.name=api-gateway server.port=2006 # 路由規(guī)則配置 zuul.routes.api-a.path=/api-a/** zuul.routes.api-a.serviceId=feign-consumer # API網(wǎng)關(guān)也將作為一個(gè)服務(wù)注冊(cè)到eureka-server上 eureka.client.service-url.defaultZone=http://localhost:1111/eureka/
我們?cè)谶@里配置了路由規(guī)則所有符合/api-a/**的請(qǐng)求都將被轉(zhuǎn)發(fā)到feign-consumer服務(wù)上,至于feign-consumer服務(wù)的地址到底是什么則由eureka-server去分析,我們這里只需要寫(xiě)上服務(wù)名即可。以上面的配置為例,如果我請(qǐng)求 http://localhost:2006/api-a/hello1 接口則相當(dāng)于請(qǐng)求 http://localhost:2005/hello1 (我這里feign-consumer的地址為 http://localhost:2005 ),我們?cè)诼酚梢?guī)則中配置的api-a是路由的名字,可以任意定義,但是一組path和serviceId映射關(guān)系的路由名要相同。
OK,做好這些之后,我們依次啟動(dòng)我們的eureka-server、provider和feign-consumer,然后訪問(wèn)如下地址 http://localhost:2006/api-a/hello1 ,訪問(wèn)結(jié)果如下:
看到這個(gè)效果說(shuō)明我們的API網(wǎng)關(guān)服務(wù)已經(jīng)構(gòu)建成功了,我們發(fā)送的符合路由規(guī)則的請(qǐng)求自動(dòng)被轉(zhuǎn)發(fā)到相應(yīng)的服務(wù)上去處理了。
請(qǐng)求過(guò)濾
構(gòu)建好了網(wǎng)關(guān),接下來(lái)我們就來(lái)看看如何利用網(wǎng)關(guān)來(lái)實(shí)現(xiàn)一個(gè)簡(jiǎn)單的權(quán)限驗(yàn)證。這里就涉及到了Spring Cloud Zuul中的另外一個(gè)核心功能:請(qǐng)求過(guò)濾。請(qǐng)求過(guò)濾有點(diǎn)類(lèi)似于Java中Filter過(guò)濾器,先將所有的請(qǐng)求攔截下來(lái),然后根據(jù)現(xiàn)場(chǎng)情況做出不同的處理,這里我們就來(lái)看看Zuul中的過(guò)濾器要如何使用。很簡(jiǎn)單,兩個(gè)步驟:
1.定義過(guò)濾器
首先我們定義一個(gè)過(guò)濾器繼承自ZuulFilter,如下:
public class PermisFilter extends ZuulFilter {
@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();
String login = request.getParameter("login");
if (login == null) {
ctx.setSendZuulResponse(false);
ctx.setResponseStatusCode(401);
ctx.addZuulResponseHeader("content-type","text/html;charset=utf-8");
ctx.setResponseBody("非法訪問(wèn)");
}
return null;
}
}
關(guān)于這個(gè)類(lèi)我說(shuō)如下幾點(diǎn):
1.filterType方法的返回值為過(guò)濾器的類(lèi)型,過(guò)濾器的類(lèi)型決定了過(guò)濾器在哪個(gè)生命周期執(zhí)行,pre表示在路由之前執(zhí)行過(guò)濾器,其他可選值還有post、error、route和static,當(dāng)然也可以自定義。
2.filterOrder方法表示過(guò)濾器的執(zhí)行順序,當(dāng)過(guò)濾器很多時(shí),這個(gè)方法會(huì)有意義。
3.shouldFilter方法用來(lái)判斷過(guò)濾器是否執(zhí)行,true表示執(zhí)行,false表示不執(zhí)行,在實(shí)際開(kāi)發(fā)中,我們可以根據(jù)當(dāng)前請(qǐng)求地址來(lái)決定要不要對(duì)該地址進(jìn)行過(guò)濾,這里我直接返回true。
4.run方法則表示過(guò)濾的具體邏輯,假設(shè)請(qǐng)求地址中攜帶了login參數(shù)的話,則認(rèn)為是合法請(qǐng)求,否則就是非法請(qǐng)求,如果是非法請(qǐng)求的話,首先設(shè)置ctx.setSendZuulResponse(false);表示不對(duì)該請(qǐng)求進(jìn)行路由,然后設(shè)置響應(yīng)碼和響應(yīng)值。這個(gè)run方法的返回值在當(dāng)前版本(Dalston.SR3)中暫時(shí)沒(méi)有任何意義,可以返回任意值。
2.配置過(guò)濾器Bean
然后在入口類(lèi)中配置相關(guān)的Bean即可,如下:
@Bean
PermisFilter permisFilter() {
return new PermisFilter();
}
此時(shí),如果我們?cè)L問(wèn) http://localhost:2006/api-a/hello1 ,結(jié)果如下:
如果給請(qǐng)求地址加上login參數(shù),則結(jié)果如下:
總結(jié)
到這里小伙伴們應(yīng)該已經(jīng)見(jiàn)識(shí)到Spring Cloud Zuul的強(qiáng)大之處了吧,API網(wǎng)關(guān)作為系統(tǒng)的的統(tǒng)一入口,將微服務(wù)中的內(nèi)部細(xì)節(jié)都屏蔽掉了,而且能夠自動(dòng)的維護(hù)服務(wù)實(shí)例,實(shí)現(xiàn)負(fù)載均衡的路由轉(zhuǎn)發(fā),同時(shí),它提供的過(guò)濾器為所有的微服務(wù)提供統(tǒng)一的權(quán)限校驗(yàn)機(jī)制,使得服務(wù)自身只需要關(guān)注業(yè)務(wù)邏輯即可。
Zuul的入門(mén)知識(shí)我們就先介紹到這里,小伙伴們有問(wèn)題歡迎留言討論。以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- Springcloud GateWay網(wǎng)關(guān)配置過(guò)程圖解
- 詳解spring cloud構(gòu)建微服務(wù)架構(gòu)的網(wǎng)關(guān)(API GateWay)
- SpringCloud-Gateway網(wǎng)關(guān)的使用實(shí)例教程
- spring cloud 使用Zuul 實(shí)現(xiàn)API網(wǎng)關(guān)服務(wù)問(wèn)題
- 詳解Spring Cloud Zuul 服務(wù)網(wǎng)關(guān)
- SpringCloud實(shí)戰(zhàn)之Zuul網(wǎng)關(guān)服務(wù)
- springcloud gateway網(wǎng)關(guān)服務(wù)啟動(dòng)報(bào)錯(cuò)的解決
- SpringCloud的Gateway網(wǎng)關(guān)詳解
- SpringCLoud搭建Zuul網(wǎng)關(guān)集群過(guò)程解析
- Spring Cloud 2026 網(wǎng)關(guān)模式實(shí)現(xiàn)示例
相關(guān)文章
SpringBoot feign動(dòng)態(tài)設(shè)置數(shù)據(jù)源(https請(qǐng)求)
這篇文章主要介紹了SpringBoot如何在運(yùn)行時(shí)feign動(dòng)態(tài)添加數(shù)據(jù)源,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2021-08-08
一文帶你掌握J(rèn)ava判斷字符串是否為數(shù)字的5種實(shí)現(xiàn)方法
這篇文章主要為大家詳細(xì)介紹了Java判斷字符串是否為數(shù)字的5種實(shí)現(xiàn)方法,文中的示例代碼講解詳細(xì),具有一定的借鑒價(jià)值,大家可以根據(jù)需要進(jìn)行選擇2026-03-03
System 類(lèi) 和 Runtime 類(lèi)的常用用法介紹
這篇文章主要介紹了System 類(lèi) 和 Runtime 類(lèi)的常用用法,有需要的朋友可以參考一下2014-01-01
利用Jackson解析JSON的詳細(xì)實(shí)現(xiàn)教程
JSON對(duì)于開(kāi)發(fā)者并不陌生,如今的WEB服務(wù)等都是以JSON作為數(shù)據(jù)交換的格式。學(xué)習(xí)JSON格式的操作工具對(duì)開(kāi)發(fā)者來(lái)說(shuō)是必不可少的。本文將介紹如何使用Jackson開(kāi)源工具庫(kù)對(duì)JSON進(jìn)行常見(jiàn)操作,需要的可以參考一下2022-07-07
Java多線程+鎖機(jī)制實(shí)現(xiàn)簡(jiǎn)單模擬搶票的項(xiàng)目實(shí)踐
鎖是一種同步機(jī)制,用于控制對(duì)共享資源的訪問(wèn),在線程獲取到鎖對(duì)象后,可以執(zhí)行搶票操作,本文主要介紹了Java多線程+鎖機(jī)制實(shí)現(xiàn)簡(jiǎn)單模擬搶票的項(xiàng)目實(shí)踐,具有一定的參考價(jià)值,感興趣的可以了解一下2024-02-02
Spring-全面詳解(學(xué)習(xí)總結(jié))
這篇文章主要介紹了詳解Spring框架入門(mén),小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧,希望能給你帶來(lái)幫助2021-07-07

