從零開始學習 Spring Cloud Gateway:打造可擴展的微服務網關
今日目標
- 掌握Gateway服務網關
在當今的微服務架構中,一個高性能、可擴展的網關是至關重要的。而Spring Cloud Gateway作為Spring Cloud生態系統的一部分,成為許多開發者選擇的首選網關解決方案。本文將為您提供一個簡單易懂的Spring Cloud Gateway入門指南,幫助您快速上手并開始構建強大的微服務網關。
一.Gateway服務網關介紹
Spring Cloud Gateway,它是一個基于Spring Framework 5、Project Reactor和Spring Boot 2的非阻塞(響應式編程和事件技術流)API網關,它旨在為微服務架構提供一種簡單有效的統一的 API 路由管理方式。相比傳統的Zuul網關,Spring Cloud Gateway具有更高的性能和更靈活的配置選項。
為什么需要網關
在微服務架構中,系統可能由多個服務組成。網關可以作為請求的入口,根據事先配置的路由規則將請求轉發到相應的服務實例。
網關的核心功能特性:
- 請求路由
- 權限控制
- 限流
簡單架構圖:
核心功能作用:權限控制:網關作為微服務入口,需要校驗用戶是是否有請求資格,如果沒有則進行攔截。
路由和負載均衡:一切請求都必須先經過gateway,但網關不處理業務,而是根據某種規則,把請求轉發到某個微服務,這個過程叫做路由。當然路由的目標服務有多個時,還需要做負載均衡。
限流:當請求流量過高時,在網關中按照下流的微服務能夠接受的速度來放行請求,避免服務壓力過大。
二.Gateway快速入門
接下來我們演示Gateway網關基本路由功能,步驟如下:
- 1.創建微服務gateway-cloud-server,引入網關依賴
- 2.編寫網關啟動類
- 3.編寫基礎配置和路由
- 4.啟動Gateway網關進行測試
【步驟一】:創建gateway-cloud-server服務,并引入依賴
在這里需要創建一個項目進行演示,和之前的項目區別不大,可是為了區分,我還是重新創建了新的項目day32-cloud-gateway,不具體演示如何創建項目,大家可以去github地址查看
在pom.xml中引入Gateway依賴
<dependencies>
<!--nacos服務發現依賴-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
</dependencies>
【步驟二】:編寫Gateway網關啟動類
package com.zbbmeta.gateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @author springboot葵花寶典
* @description: TODO
*/
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class,args);
}
}
【步驟三】:編寫基礎配置和路由
在resuorces目錄下創建application.yml文件,內容如下:
server:
port: 9999 # 網關端口
spring:
application:
name: gateway-service # 服務名稱
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
# 開啟nacos負載均衡策略
loadbalancer:
nacos:
enabled: true
gateway:
routes: # 網關路由配置
- id: user-service # 路由id,自定義,只要唯一即可
#uri: http://127.0.0.1:8088 # 路由的目標地址 http就是固定地址
uri: lb://user-service # 路由的目標地址 lb就是負載均衡,后面跟服務名稱
predicates: # 路由斷言,也就是判斷請求是否符合路由規則的條件
- Path=/user/** # 這個是按照路徑匹配,只要以/user/開頭就符合要求
我們將符合Path 規則的一切請求,都代理到 uri參數指定的地址。
本案例中,我們將 /user/**開頭的請求,代理到lb://user-service,lb是負載均衡,根據服務名拉取服務列表,實現負載均衡。
【步驟四】:啟動Gateway網關進行測試
重啟網關,訪問http://localhost:9999/user/1時,符合/user/**規則,請求轉發到uri:http://user-service/user/1,得到了結果:
Gateway網關路由配置圖
請求訪問流程如下:
網關搭建步驟:
1.創建項目,引入nacos服務發現和gateway依賴
2.配置application.yml,包括服務基本信息、nacos地址、路由
路由配置:
1.路由id:路由的唯一標示
2.路由目標(uri):路由的目標地址,http代表固定地址,lb代表根據服務名負載均衡
3.路由斷言(predicates):判斷路由的規則,
4.路由過濾器(filters):對請求或響應做處理
三.Gateway斷言工廠(PredicateFactory)
配置文件中寫的斷言規則只是字符串,這些字符串會被Predicate Factory讀取并處理,轉變為路由判斷的條件
例如Path=/user/**是按照路徑匹配,這個規則是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory類來
處理的,像這樣的斷言工廠在SpringCloudGateway還有十幾個:只需要掌握Path這種路由工程就可以了
可以訪問Gateway官網查看每一個的具體說明
名稱 | 說明 | 示例 |
After | 是某個時間點后的請求 | - After=2037-01-20T17:42:47.789-07:00[America/Denver] |
Before | 是某個時間點之前的請求 | - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] |
Between | 是某兩個時間點之前的請求 | - Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver] |
Cookie | 請求必須包含某些cookie | - Cookie=chocolate, ch.p |
Header | 請求必須包含某些header | - Header=X-Request-Id, \d+ |
Host | 請求必須是訪問某個host(域名) | - Host=.somehost.org,.anotherhost.org |
Method | 請求方式必須是指定方式 | - Method=GET,POST |
Path | 請求路徑必須符合指定規則 | - Path=/red/{segment},/blue/** |
Query | 請求參數必須包含指定參數 | - Query=name, Jack或者- Query=name |
RemoteAddr | 請求者的ip必須是指定范圍 | - RemoteAddr=192.168.1.1/24 |
Weight | 權重處理 |
標頭路由謂詞工廠實例:
spring:
cloud:
gateway:
routes:
- id: header_route
uri: https://example.org
predicates:
- Header=X-Request-Id, \d+
如果請求具有名為 X-Request-Id 其值與 \d+正則表達式匹配的標頭(即,它的值為一個或多個數字),則此路由匹配。
四.過濾器工廠( GatewayFilter Factory)
Spring提供了31種不同的路由過濾器工廠,具體每一種過濾器的使用方式,你也可以去其官網查看,這邊我們只介紹記住常用的過濾器
名稱 | 說明 |
AddRequestHeader | 給當前請求添加一個請求頭 |
RemoveRequestHeader | 移除請求中的一個請求頭 |
AddResponseHeader | 給響應結果中添加一個響應頭 |
RemoveResponseHeader | 從響應結果中移除有一個響應頭 |
RequestRateLimiter | 限制請求的流量 |
4.1. 請求頭過濾器(AddRequestHeader)
下面我們以AddRequestHeader 為例來講解。
需求:給所有進入user-service的請求添加一個請求頭:Learn=跟著 springboot葵花寶典一起學習開發!
【步驟一】:Gateway網關添加請求頭配置
只需要修改gateway服務的application.yml文件,添加路由過濾即可:
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
filters: # 過濾器
- AddRequestHeader=Learn, learn springboot! # 添加請求頭
注意:AddRequestHeader=Learn, learn springboot:
- 請求頭格式: key:value
- Learn:表示請求頭的key
- learn springboot:表示value 當前過濾器寫在user-service路由下,因此僅僅對訪問user-service的請求有效。
【步驟二】:修改user-service控制器獲取請求頭
@GetMapping("/{id}")
public User test(@PathVariable("id") Long id, HttpServletRequest httpRequest){
String learn = httpRequest.getHeader("Learn");
System.out.println("Learn = " + learn);
User user = userService.getById(id);
return user;
}
【步驟三】:測試
使用瀏覽器訪問http://localhost:9999/user/2,查看控制臺
圖片
思考:剛才我們展示的是user-service單個微服務的過濾器,如何可以寫一個過濾器對所有的路由都生效?
默認過濾器
spring:
gateway:
routes: # 網關路由配置
- id: user-service # 路由id,自定義,只要唯一即可
#uri: http://127.0.0.1:8088 # 路由的目標地址 http就是固定地址
uri: lb://user-service # 路由的目標地址 lb就是負載均衡,后面跟服務名稱
predicates: # 路由斷言,也就是判斷請求是否符合路由規則的條件
- Path=/user/** # 這個是按照路徑匹配,只要以/user/開頭就符合要求
default-filters: # 默認過濾項
- AddRequestHeader=Learn, learn springbot! # 添加請求頭
總結
1.過濾器的作用是什么?
對路由的請求或響應做加工處理,比如添加請求頭
配置在路由下的過濾器只對當前路由的請求生效
2.defaultFilters的作用是什么?
對所有路由都生效的過濾器
5.全局過濾器
學習的過濾器,網關提供了31種,但每一種過濾器的作用都是固定的。如果我們希望攔截請求,做自己的業務邏輯則沒辦法實現。那就需要全局過濾器。
5.1. 全局過濾器作用
全局過濾器的作用也是處理一切進入網關的請求和微服務響應,與GatewayFilter的作用一樣。區別在于GatewayFilter通過配置定義,處理邏輯是固定的;而GlobalFilter的邏輯需要自己寫代碼實現。
5.2.實現方式
定義方式是實現GlobalFilter接口。
public interface GlobalFilter {
/**
* 處理當前請求,有必要的話通過{@link GatewayFilterChain}將請求交給下一個過濾器處理
*
* @param exchange 請求上下文,里面可以獲取Request、Response等信息
* @param chain 用來把請求委托給下一個過濾器
* @return {@code Mono<Void>} 返回標示當前過濾器業務結束
*/
Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
在filter中編寫自定義邏輯,可以實現下列功能:
- 登錄狀態判斷
- 權限校驗
- 請求限流等
5.3 自定義全局過濾器
需求:定義全局過濾器,攔截請求,判斷請求頭中是否有滿足下面條件:
- 請求頭key是否有authorization,
- authorization參數值是否為admin
如果同時滿足則放行,否則攔截
實現:
package com.zbbmeta.gateway.filters;
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.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import reactor.netty.http.server.HttpServerRequest;
import java.util.List;
/**
* @author springboot葵花寶典
* @description: TODO
*/
@Component
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1.獲取請求頭
HttpHeaders headers = exchange.getRequest().getHeaders();
// 2.獲取請求頭key是authorization
List<String> auths = headers.get("authorization");
// 3.校驗
if(auths.contains("admin")){
// 放行
return chain.filter(exchange);
}
// 4.攔截
// 4.1.禁止訪問,設置狀態碼
exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
// 4.2.結束處理
return exchange.getResponse().setComplete();
}
}
測試
使用postman訪問http://localhost:9999/user/1,并在請求頭添加authorizatinotallow=admin
錯誤展示請求頭添加authorizatinotallow=admin1
5.4. 過濾器執行順序
請求進入網關會碰到三類過濾器:
- 當前路由的過濾器
- DefaultFilter
- GlobalFilter
請求路由后,會將當前路由過濾器和DefaultFilter、GlobalFilter,合并到一個過濾器鏈(集合)中,排序后依次執行每個過濾器:
排序的規則是什么呢?
- 每一個過濾器都必須指定一個int類型的order值,order值越小,優先級越高,執行順序越靠前。
- GlobalFilter通過實現Ordered接口,或者添加@Order注解來指定order值,由我們自己指定
- 路由過濾器和defaultFilter的order由Spring指定,默認是按照聲明順序從1遞增。
- 當過濾器的order值一樣時,會按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執行。
詳細內容,可以查看源碼:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加載defaultFilters,然后再加載某個route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法會加載全局過濾器,與前面的過濾器合并后根據order排序,組織過濾器鏈
總結
本文針對微服務中另一重要組件:網關 進行了實戰性演練,網關作為分布式架構中的重要中間件,不僅承擔著路由分發(重點關注Path規則配置),同時可根據自身負載均衡策略,對多個注冊服務實例進行均衡調用。我們借助GateWay實現的網關只是技術實現的方案之一,后續大家可能會接觸像:Zuul、Kong等,其實現細節或有差異,但整體目標是一致的。