javascript
Spring Cloud(七) GateWay 服务化和过滤器
前文回顧:
Spring Cloud(一)Eureka Server-單體及集群搭建
Spring Cloud(二) 配置Eureka Client
Spring Cloud(三) 熔斷器Hystrix
Spring Cloud(四) API網(wǎng)關(guān)Zuul
Spring Cloud(五) Zuul Filter
Spring Cloud(六) 服務(wù)網(wǎng)關(guān)GateWay 入門
注冊中心
上篇主要講解了網(wǎng)關(guān)代理單個服務(wù)的使用語法,在實際的工作中,服務(wù)的相互調(diào)用都是依賴于服務(wù)中心提供的入口來使用,服務(wù)中心往往注冊了很多服務(wù),如果每個服務(wù)都需要單獨配置的話,這將是一份很枯燥的工作。Spring Cloud Gateway 提供了一種默認轉(zhuǎn)發(fā)的能力,只要將 Spring Cloud Gateway 注冊到服務(wù)中心,Spring Cloud Gateway 默認就會代理服務(wù)中心的所有服務(wù),下面用代碼演示。
服務(wù)網(wǎng)關(guān)注冊到注冊中心
復(fù)制上一節(jié)的示例項目,添加 eureka 的客戶端依賴包。
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency>修改 application.yml 配置文件內(nèi)容如下
server:port: 8888 spring:application:name: cloud-gateway-eurekacloud:gateway:discovery:locator:enabled: true eureka:client:service-url:defaultZone: http://localhost:8000/eureka/ logging:level:org.springframework.cloud.gateway: debug配置說明:
-
spring.cloud.gateway.discovery.locator.enabled:是否與服務(wù)注冊于發(fā)現(xiàn)組件進行結(jié)合,通過 serviceId 轉(zhuǎn)發(fā)到具體的服務(wù)實例。默認為 false,設(shè)為 true 便開啟通過服務(wù)中心的自動根據(jù) serviceId 創(chuàng)建路由的功能。
-
eureka.client.service-url.defaultZone指定注冊中心的地址,以便使用服務(wù)發(fā)現(xiàn)功能
-
logging.level.org.springframework.cloud.gateway 調(diào)整相 gateway 包的 log 級別,以便排查問題
修改完成后啟動 cloud-gateway-eureka 項目,訪問注冊中心地址 http://localhost:8000/ 即可看到名為 CLOUD-GATEWAY-EUREKA的服務(wù)。
測試
將 Spring Cloud Gateway 注冊到服務(wù)中心之后,網(wǎng)關(guān)會自動代理所有的在注冊中心的服務(wù),訪問這些服務(wù)的語法為:
http://網(wǎng)關(guān)地址:端口/服務(wù)中心注冊 serviceId/具體的url比如我們的 spring-cloud-producer 項目有一個 /hello 的服務(wù),訪問此服務(wù)的時候會返回:hello world。
比如訪問地址:http://localhost:9000/hello,頁面返回:hello world!
按照上面的語法我們通過網(wǎng)關(guān)來訪問,瀏覽器輸入:http://localhost:8888/SPRING-CLOUD-PRODUCER/hello 同樣返回:hello world!證明服務(wù)網(wǎng)關(guān)轉(zhuǎn)發(fā)成功。
我們將項目 spring-cloud-producer 復(fù)制一份為 spring-cloud-producer-1,將/hello服務(wù)的返回值修改為 hello world smile !,修改端口號為 9001 ,修完完成后重啟,這時候訪問注冊中心后臺會發(fā)現(xiàn)有兩個名為 SPRING-CLOUD-PRODUCER的服務(wù)。
在瀏覽器多次訪問地址:http://localhost:8888/SPRING-CLOUD-PRODUCER/hello,頁面交替返回以下信息:
hello world! hello world smile!說明后端服務(wù)自動進行了均衡負載。
基于 Filter(過濾器) 實現(xiàn)的高級功能
Spring Cloud Gateway 的 Filter 的生命周期不像 Zuul 的那么豐富,它只有兩個:“pre” 和 “post”。
-
PRE: 這種過濾器在請求被路由之前調(diào)用。我們可利用這種過濾器實現(xiàn)身份驗證、在集群中選擇請求的微服務(wù)、記錄調(diào)試信息等。
-
POST:這種過濾器在路由到微服務(wù)以后執(zhí)行。這種過濾器可用來為響應(yīng)添加標準的 HTTP Header、收集統(tǒng)計信息和指標、將響應(yīng)從微服務(wù)發(fā)送給客戶端等。
Spring Cloud Gateway 的 Filter 分為兩種:GatewayFilter 與 GlobalFilter。GlobalFilter 會應(yīng)用到所有的路由上,而 GatewayFilter 將應(yīng)用到單個路由或者一個分組的路由上。
Spring Cloud Gateway 內(nèi)置了9種 GlobalFilter,比如 Netty Routing Filter、LoadBalancerClient Filter、Websocket Routing Filter 等,根據(jù)名字即可猜測出這些 Filter 的作者,具體大家可以參考官網(wǎng)內(nèi)容:Global Filters
利用 GatewayFilter 可以修改請求的 Http 的請求或者響應(yīng),或者根據(jù)請求或者響應(yīng)做一些特殊的限制。 更多時候我們會利用 GatewayFilter 做一些具體的路由配置,下面我們做一些簡單的介紹。
快速上手 Filter 使用
我們以 AddRequestParameter GatewayFilter 來演示一下,如何在項目中使用 GatewayFilter,AddRequestParameter GatewayFilter 可以在請求中添加指定參數(shù)。
application.yml配置示例
spring:cloud:gateway:routes:- id: add_request_parameter_routeuri: http://example.orgfilters:- AddRequestParameter=foo, bar這樣就會給匹配的每個請求添加上foo=bar的參數(shù)和值。
我們將以上配置融入到 cloud-gateway-eureka 項目中,完整的 application.yml 文件配置信息如下:
server:port: 8888 spring:application:name: cloud-gateway-eurekacloud:gateway:discovery:locator:enabled: trueroutes:- id: add_request_parameter_routeuri: http://localhost:9000filters:- AddRequestParameter=foo, barpredicates:- Method=GET eureka:client:service-url:defaultZone: http://localhost:8000/eureka/ logging:level:org.springframework.cloud.gateway: debug這里的 routes 手動指定了服務(wù)的轉(zhuǎn)發(fā)地址,設(shè)置所有的 GET 方法都會自動添加foo=bar,http://localhost:9000 是 spring-cloud-producer 項目,我們在此項目中添加一個 foo() 方法,用來接收轉(zhuǎn)發(fā)中添加的參數(shù) foo。
@RequestMapping("/foo") public String foo(String foo) {return "hello "+foo+"!"; }修改完成后重啟 cloud-gateway-eureka、spring-cloud-producer 項目。訪問地址http://localhost:9000/foo頁面返回:hello null!,說明并沒有接受到參數(shù) foo;通過網(wǎng)關(guān)來調(diào)用此服務(wù),瀏覽器訪問地址http://localhost:8888/foo頁面返回:hello bar!,說明成功接收到參數(shù) foo 參數(shù)的值 bar ,證明網(wǎng)關(guān)在轉(zhuǎn)發(fā)的過程中已經(jīng)通過 filter 添加了設(shè)置的參數(shù)和值。
服務(wù)化路由轉(zhuǎn)發(fā)
上面我們使用 uri 指定了一個服務(wù)轉(zhuǎn)發(fā)地址,單個服務(wù)這樣使用問題不大,但是我們在注冊中心往往會使用多個服務(wù)來共同支撐整個服務(wù)的使用,這個時候我們就期望可以將 Filter 作用到每個應(yīng)用的實例上,spring cloud gateway 提供了這樣的功能,只需要簡單配置即可。
為了測試兩個服務(wù)提供者是否都被調(diào)用,我們在 spring-cloud-producer-1 項目中也同樣添加 foo() 方法。
@RequestMapping("/foo") public String foo(String foo) {return "hello "+foo+"!!"; }為了和 spring-cloud-producer 中 foo() 方法有所區(qū)別,這里使用了兩個感嘆號。同時將 cloud-gateway-eureka 項目配置文件中的 uri 內(nèi)容修改如下:
#格式為:lb://應(yīng)用注冊服務(wù)名 uri: lb://spring-cloud-producer修改完之后,重新啟動項目 cloud-gateway-eureka、spring-cloud-producer-1,瀏覽器訪問地址:http://localhost:8888/foo頁面交替出現(xiàn):
hello bar! hello bar!!證明請求依據(jù)均勻轉(zhuǎn)發(fā)到后端服務(wù),并且后端服務(wù)均接收到了 filter 增加的參數(shù) foo 值。
這里其實默認使用了全局過濾器 LoadBalancerClient ,當路由配置中 uri 所用的協(xié)議為 lb 時(以uri: lb://spring-cloud-producer為例),gateway 將使用 LoadBalancerClient 把 spring-cloud-producer 通過 eureka 解析為實際的主機和端口,并進行負載均衡。
總結(jié)
以上是生活随笔為你收集整理的Spring Cloud(七) GateWay 服务化和过滤器的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Spring Cloud(六) 服务网关
- 下一篇: Spring Boot集成Elastic