SpringCloud Gateway路由組件詳解
簡介
Gateway是SpringCloud Alibaba中的路由組件(前身是Zuul),作為瀏覽器端請求的統(tǒng)一入口。當(dāng)項(xiàng)目采用微服務(wù)模式時(shí),若包含了路由模塊,瀏覽器端的請求都不會(huì)直接請求含有業(yè)務(wù)邏輯的各個(gè)業(yè)務(wù)模塊,而是請求這個(gè)路由模塊,然后再由它來轉(zhuǎn)發(fā)到各個(gè)業(yè)務(wù)模塊去。
核心概念
Gateway中的三個(gè)核心概念:路由、斷言(Predicate)、過濾器。
路由:由唯一id、目的url、斷言和過濾組成
斷言:即路由規(guī)則,用來判斷哪些請求符合規(guī)則,符合的請求進(jìn)行轉(zhuǎn)發(fā)
過濾器:分為GatewayFilter和GlobalFilter,前者作用于單一路由,后者作用于所有路由。過濾器可以對請求或者返回進(jìn)行處理,如增加請求頭、刪除請求頭
配置文件如下:
spring:
cloud:
gateway:
# 網(wǎng)關(guān)路由配置
routes:
# 路由id,自定義,只要唯一即可
- id: user-service
# uri: http://127.0.0.1:8081 # 路由的目標(biāo)地址 http就是固定地址
# 路由的目標(biāo)地址 lb就是負(fù)載均衡,后面跟服務(wù)名稱,要和nacos的注冊中心結(jié)合
uri: lb://userservice
# 斷言
predicates:
# 這個(gè)是按照路徑匹配,只要以/user/開頭就符合要求
- Path=/user/**
# 過濾器
filters:
# 添加請求頭
- AddRequestHeader=sign, xn2001.com is eternal
上面寫到了根據(jù)路徑匹配的斷言,Gateway提供了十幾種內(nèi)置的斷言:
名稱 | 說明 | 示例 |
---|---|---|
After | 是某個(gè)時(shí)間點(diǎn)之后的請求 | - After=2022-08-26T18:34:10.475+08:00[Asia/Shanghai] |
Before | 是某個(gè)時(shí)間點(diǎn)之前的請求 | - Before=2022-11-26T18:34:10.475+08:00[Asia/Shanghai] |
Between | 是某兩個(gè)時(shí)間點(diǎn)之前的請求 | - Between=2022-10-26T18:35:15.093+08:00[Asia/Shanghai], 2022-11-26T18:35:15.093+08:00[Asia/Shanghai] |
Cookie | 請求必須包含某些cookie | - Cookie=chocolate, ch.p |
Header | 請求必須包含某些header | - Header=sign, internal |
Host | 請求必須是訪問某個(gè)host(域名) | - Host=**.somehost.org, **.anotherhost.org |
Method | 請求方式必須是指定方式 | - Method=GET,POST |
Path | 請求路徑必須符合指定規(guī)則 | - Path=/blue/** |
Query | 請求參數(shù)必須包含指定參數(shù) | - Query=name, Jack或- Query=name |
RemoteAddr | 請求者的ip必須是指定范圍 | - RemoteAddr=192.168.1.1/24 |
Weight | 權(quán)重處理 |
配置中的AddRequestHeader就是其中一種Gateway Filter,還有其余的內(nèi)置的:
名稱 | 說明 |
---|---|
AddRequestHeader | 給當(dāng)前請求添加一個(gè)請求頭 |
RemoveRequestHeader | 移除請求中的一個(gè)請求頭 |
AddResponseHeader | 給響應(yīng)結(jié)果中添加一個(gè)響應(yīng)頭 |
RemoveResponseHeader | 從響應(yīng)結(jié)果中移除一個(gè)響應(yīng)頭 |
RequestRateLimiter | 限制請求的流量 |
全局過濾器,后面的示例給出具體用法
具體示例
這里新建2個(gè)模塊,路由模塊和用戶模塊
用戶模塊,引入依賴spring-boot-starter-web、spring-cloud-starter-alibaba-nacos-discovery,bootstrap.yml配置端口號(hào)、nacos注冊中心的地址,并提供接口:
import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestHeader; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; @Controller @RequestMapping("/user") public class UserController { @ResponseBody @RequestMapping("/sayHello") public String sayHello(@RequestHeader(value = "sign", required = false) String sign) { return "這是好吃的:" + sign; } }
路由模塊,引入依賴:
<dependencies> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-config </artifactId> <version>2.2.0.RELEASE</version> </dependency> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery </artifactId> <version>2.2.0.RELEASE</version> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> <version>2.2.0.RELEASE</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> </dependencies>
bootstrap.yml的配置:
server:
port: 8086
servlet:
context-path: /gatewayspring:
application:
name: gateway
profiles:
active: dev
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848
file-extension: yml
discovery:
server-addr: 127.0.0.1:8848
2個(gè)模塊都啟動(dòng)后,nacos的服務(wù)列表顯示:
nacos中新建名為gateway-dev.yml的配置,內(nèi)容為:
spring:
cloud:
gateway:
discovery:
locator:
# 通過服務(wù)名稱轉(zhuǎn)發(fā),默認(rèn)false
enabled: true
# 服務(wù)名稱不用大寫
lower-case-service-id: true
# routes:
# - id: user-service
# uri: lb://supplier
# predicates:
# - Path=/provider/**
# filters:
# - AddRequestHeader=sign, big JavaCoder
此時(shí),請求路徑:http://localhost:8086/supplier/provider/user/sayHello
注:supplier是服務(wù)名稱,provider是模塊訪問路徑(server.servlet.context-path)
但這種配置不是很推薦
把spring.cloud.gateway.discovery及子配置注釋掉,把spring.cloud.gateway.routes及子配置取消注釋,重啟路由模塊,這時(shí)訪問路徑:
http://localhost:8086/provider/user/sayHello。
注:這是訪問的路徑,經(jīng)過gateway處理后,實(shí)際訪問的是lb://supplier/provider/user/sayHello(見RouteToRequestUrlFilter的filter方法);provider是模塊訪問路徑(server.servlet.context-path),如果用戶模塊沒有設(shè)置的話,filters下添加- StripPrefix=1,這時(shí)訪問路徑不變,實(shí)際的訪問路徑是lb://supplier/user/sayHello。
GlobalFilter
處理一切進(jìn)入網(wǎng)關(guān)的請求和響應(yīng),并且也是可以編寫代碼自定義邏輯;在執(zhí)行順序上,GatewayFilter先執(zhí)行,GlobalFilter后執(zhí)行。
import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.http.server.reactive.ServerHttpResponse; import org.springframework.stereotype.Component; import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono; import java.util.List; @Component public class AuthorizeFilter implements GlobalFilter { @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { ServerHttpRequest request = exchange.getRequest(); HttpHeaders headers = request.getHeaders(); List<String> sign = headers.get("sign"); if(sign.size() < 1) { ServerHttpResponse response = exchange.getResponse(); response.setStatusCode(HttpStatus.BAD_REQUEST); //被攔截,請求不到對應(yīng)模塊了 return exchange.getResponse().setComplete(); } headers = HttpHeaders.writableHttpHeaders(headers); headers.set("sign1", "bigAAA"); //放行 return chain.filter(exchange); } }
到此這篇關(guān)于SpringCloud Gateway路由組件詳解的文章就介紹到這了,更多相關(guān)SpringCloud Gateway內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring boot項(xiàng)目使用thymeleaf模板過程詳解
這篇文章主要介紹了Spring boot項(xiàng)目使用thymeleaf模板過程詳解,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07SpringBoot中實(shí)現(xiàn)訂單30分鐘自動(dòng)取消的項(xiàng)目實(shí)踐
現(xiàn)在電子商務(wù)平臺(tái)上訂單創(chuàng)建成功,等待支付,一般會(huì)給30分鐘的時(shí)間,本文主要介紹了SpringBoot中實(shí)現(xiàn)訂單30分鐘自動(dòng)取消的項(xiàng)目實(shí)踐,具有一定的參考價(jià)值,感興趣的可以了解一下2023-10-10Java并發(fā)編程中的CyclicBarrier線程屏障詳解
這篇文章主要介紹了Java并發(fā)編程中的CyclicBarrier線程屏障詳解,2023-12-12Java中靜態(tài)代碼塊、構(gòu)造代碼塊、構(gòu)造函數(shù)和普通代碼塊的區(qū)別
在Java中,靜態(tài)代碼塊、構(gòu)造代碼塊、構(gòu)造函數(shù)、普通代碼塊的執(zhí)行順序是一個(gè)筆試的考點(diǎn),通過這篇文章希望大家能徹底了解它們之間的執(zhí)行順序,需要的朋友可以參考下2023-05-05詳解context root修改無效web修改項(xiàng)目路徑(eclipse)
這篇文章主要介紹了詳解context root修改無效web修改項(xiàng)目路徑(eclipse)的相關(guān)資料,需要的朋友可以參考下2017-04-04Mybatis查詢返回Map<String,Object>類型實(shí)例詳解
這篇文章主要給大家介紹了關(guān)于Mybatis查詢返回Map<String,Object>類型的相關(guān)資料,平時(shí)沒太注意怎么用,今天又遇到了總結(jié)記錄一下,方便以后處理此類問題,需要的朋友可以參考下2022-07-07