目錄
1.為什么需要網(wǎng)關(guān)
2.gateway快速入門
1)創(chuàng)建gateway服務(wù),引入依賴
2)編寫啟動類
3)編寫基礎(chǔ)配置和路由規(guī)則
4)重啟測試
5)網(wǎng)關(guān)路由的流程圖
3.斷言工廠
4.過濾器工廠
4.1.路由過濾器的種類
4.2.請求頭過濾器
4.3.默認(rèn)過濾器
4.4.總結(jié)
5.全局過濾器
5.1.全局過濾器作用
5.2.自定義全局過濾器
5.3.過濾器執(zhí)行順序
6.跨域問題
6.1.什么是跨域問題
6.2.模擬跨域問題
6.3.解決跨域問題
Spring Cloud Gateway 是 Spring Cloud 的一個全新項目,該項目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等響應(yīng)式編程和事件流技術(shù)開發(fā)的網(wǎng)關(guān),它旨在為微服務(wù)架構(gòu)提供一種簡單有效的統(tǒng)一的 API 路由管理方式。
1.為什么需要網(wǎng)關(guān)
Gateway網(wǎng)關(guān)是我們服務(wù)的守門神,所有微服務(wù)的統(tǒng)一入口。
網(wǎng)關(guān)的核心功能特性:
-
請求路由
-
權(quán)限控制
-
限流
架構(gòu)圖:
權(quán)限控制:網(wǎng)關(guān)作為微服務(wù)入口,需要校驗用戶是是否有請求資格,如果沒有則進行攔截。
路由和負(fù)載均衡:一切請求都必須先經(jīng)過gateway,但網(wǎng)關(guān)不處理業(yè)務(wù),而是根據(jù)某種規(guī)則,把請求轉(zhuǎn)發(fā)到某個微服務(wù),這個過程叫做路由。當(dāng)然路由的目標(biāo)服務(wù)有多個時,還需要做負(fù)載均衡。
限流:當(dāng)請求流量過高時,在網(wǎng)關(guān)中按照下流的微服務(wù)能夠接受的速度來放行請求,避免服務(wù)壓力過大。
在SpringCloud中網(wǎng)關(guān)的實現(xiàn)包括兩種:
-
gateway
-
zuul
Zuul是基于Servlet的實現(xiàn),屬于阻塞式編程。而SpringCloudGateway則是基于Spring5中提供的WebFlux,屬于響應(yīng)式編程的實現(xiàn),具備更好的性能。
2.gateway快速入門
下面,我們就演示下網(wǎng)關(guān)的基本路由功能?;静襟E如下:
-
創(chuàng)建SpringBoot工程gateway,引入網(wǎng)關(guān)依賴
-
編寫啟動類
-
編寫基礎(chǔ)配置和路由規(guī)則
-
啟動網(wǎng)關(guān)服務(wù)進行測試
1)創(chuàng)建gateway服務(wù),引入依賴
創(chuàng)建服務(wù):
引入依賴:
<!--網(wǎng)關(guān)-->
<dependency>
? ?<groupId>org.springframework.cloud</groupId>
? ?<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服務(wù)發(fā)現(xiàn)依賴-->
<dependency>
? ?<groupId>com.alibaba.cloud</groupId>
? ?<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
2)編寫啟動類
package cn.itcast.gateway;
?
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
?
@SpringBootApplication
public class GatewayApplication {
?
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
3)編寫基礎(chǔ)配置和路由規(guī)則
創(chuàng)建application.yml文件,內(nèi)容如下:
server:
port: 10010 # 網(wǎng)關(guān)端口
spring:
application:
? name: gateway # 服務(wù)名稱
cloud:
? nacos:
? ? server-addr: localhost:8848 # nacos地址
? gateway:
? ? routes: # 網(wǎng)關(guān)路由配置
? ? ? - id: user-service # 路由id,自定義,只要唯一即可
? ? ? ? ?# uri: http://127.0.0.1:8081 # 路由的目標(biāo)地址 http就是固定地址
? ? ? ? uri: lb://userservice # 路由的目標(biāo)地址 lb就是負(fù)載均衡,后面跟服務(wù)名稱
? ? ? ? predicates: # 路由斷言,也就是判斷請求是否符合路由規(guī)則的條件
? ? ? ? ? - Path=/user/** # 這個是按照路徑匹配,只要以/user/開頭就符合要求
我們將符合Path
規(guī)則的一切請求,都代理到 uri
參數(shù)指定的地址。
本例中,我們將 /user/**
開頭的請求,代理到lb://userservice
,lb是負(fù)載均衡,根據(jù)服務(wù)名拉取服務(wù)列表,實現(xiàn)負(fù)載均衡。
4)重啟測試
重啟網(wǎng)關(guān),訪問http://localhost:10010/user/1時,符合/user/**
規(guī)則,請求轉(zhuǎn)發(fā)到uri:http://userservice/user/1,得到了結(jié)果:
5)網(wǎng)關(guān)路由的流程圖
整個訪問的流程如下:
總結(jié):
網(wǎng)關(guān)搭建步驟:
-
創(chuàng)建項目,引入nacos服務(wù)發(fā)現(xiàn)和gateway依賴
-
配置application.yml,包括服務(wù)基本信息、nacos地址、路由
路由配置包括:
-
路由id:路由的唯一標(biāo)示
-
路由目標(biāo)(uri):路由的目標(biāo)地址,http代表固定地址,lb代表根據(jù)服務(wù)名負(fù)載均衡
-
路由斷言(predicates):判斷路由的規(guī)則,
-
路由過濾器(filters):對請求或響應(yīng)做處理
接下來,就重點來學(xué)習(xí)路由斷言和路由過濾器的詳細知識
3.斷言工廠
我們在配置文件中寫的斷言規(guī)則只是字符串,這些字符串會被Predicate Factory讀取并處理,轉(zhuǎn)變?yōu)槁酚膳袛嗟臈l件
例如Path=/user/**是按照路徑匹配,這個規(guī)則是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory
類來
處理的,像這樣的斷言工廠在SpringCloudGateway還有十幾個:
名稱 | 說明 | 示例 |
---|---|---|
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 | 請求路徑必須符合指定規(guī)則 | - Path=/red/{segment},/blue/** |
Query | 請求參數(shù)必須包含指定參數(shù) | - Query=name, Jack或者- Query=name |
RemoteAddr | 請求者的ip必須是指定范圍 | - RemoteAddr=192.168.1.1/24 |
Weight | 權(quán)重處理 |
我們只需要掌握Path這種路由工程就可以了。
4.過濾器工廠
GatewayFilter是網(wǎng)關(guān)中提供的一種過濾器,可以對進入網(wǎng)關(guān)的請求和微服務(wù)返回的響應(yīng)做處理:
4.1.路由過濾器的種類
Spring提供了31種不同的路由過濾器工廠。例如:
名稱 | 說明 |
---|---|
AddRequestHeader | 給當(dāng)前請求添加一個請求頭 |
RemoveRequestHeader | 移除請求中的一個請求頭 |
AddResponseHeader | 給響應(yīng)結(jié)果中添加一個響應(yīng)頭 |
RemoveResponseHeader | 從響應(yīng)結(jié)果中移除有一個響應(yīng)頭 |
RequestRateLimiter | 限制請求的流量 |
4.2.請求頭過濾器
下面我們以AddRequestHeader 為例來講解。
需求:給所有進入userservice的請求添加一個請求頭:Truth=itcast is freaking awesome!
只需要修改gateway服務(wù)的application.yml文件,添加路由過濾即可:
spring:
cloud:
? gateway:
? ? routes:
? ? - id: user-service
? ? ? uri: lb://userservice
? ? ? predicates:
? ? ? - Path=/user/**
? ? ? filters: # 過濾器
? ? ? - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加請求頭
當(dāng)前過濾器寫在userservice路由下,因此僅僅對訪問userservice的請求有效。
4.3.默認(rèn)過濾器
如果要對所有的路由都生效,則可以將過濾器工廠寫到default下。格式如下:
spring:
cloud:
? gateway:
? ? routes:
? ? - id: user-service
? ? ? uri: lb://userservice
? ? ? predicates:
? ? ? - Path=/user/**
? ? default-filters: # 默認(rèn)過濾項
? ? - AddRequestHeader=Truth, Itcast is freaking awesome!
4.4.總結(jié)
過濾器的作用是什么?
① 對路由的請求或響應(yīng)做加工處理,比如添加請求頭
② 配置在路由下的過濾器只對當(dāng)前路由的請求生效
defaultFilters的作用是什么?
① 對所有路由都生效的過濾器
5.全局過濾器
上一節(jié)學(xué)習(xí)的過濾器,網(wǎng)關(guān)提供了31種,但每一種過濾器的作用都是固定的。如果我們希望攔截請求,做自己的業(yè)務(wù)邏輯則沒辦法實現(xiàn)。
5.1.全局過濾器作用
全局過濾器的作用也是處理一切進入網(wǎng)關(guān)的請求和微服務(wù)響應(yīng),與GatewayFilter的作用一樣。區(qū)別在于GatewayFilter通過配置定義,處理邏輯是固定的;而GlobalFilter的邏輯需要自己寫代碼實現(xiàn)。
定義方式是實現(xiàn)GlobalFilter接口。
public interface GlobalFilter {
? ?/**
? ? * 處理當(dāng)前請求,有必要的話通過{@link GatewayFilterChain}將請求交給下一個過濾器處理
? ? *
? ? * @param exchange 請求上下文,里面可以獲取Request、Response等信息
? ? * @param chain 用來把請求委托給下一個過濾器
? ? * @return {@code Mono<Void>} 返回標(biāo)示當(dāng)前過濾器業(yè)務(wù)結(jié)束
? ? */
? ?Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
在filter中編寫自定義邏輯,可以實現(xiàn)下列功能:
-
登錄狀態(tài)判斷
-
權(quán)限校驗
-
請求限流等
5.2.自定義全局過濾器
需求:定義全局過濾器,攔截請求,判斷請求的參數(shù)是否滿足下面條件:
-
參數(shù)中是否有authorization,
-
authorization參數(shù)值是否為admin
如果同時滿足則放行,否則攔截
實現(xiàn):
在gateway中定義一個過濾器:
package cn.itcast.gateway.filters;
?
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
?
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
? ?@Override
? ?public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
? ? ? ?// 1.獲取請求參數(shù)
? ? ? ?MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
? ? ? ?// 2.獲取authorization參數(shù)
? ? ? ?String auth = params.getFirst("authorization");
? ? ? ?// 3.校驗
? ? ? ?if ("admin".equals(auth)) {
? ? ? ? ? ?// 放行
? ? ? ? ? ?return chain.filter(exchange);
? ? ? }
? ? ? ?// 4.攔截
? ? ? ?// 4.1.禁止訪問,設(shè)置狀態(tài)碼
? ? ? ?exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
? ? ? ?// 4.2.結(jié)束處理
? ? ? ?return exchange.getResponse().setComplete();
? }
}
5.3.過濾器執(zhí)行順序
請求進入網(wǎng)關(guān)會碰到三類過濾器:當(dāng)前路由的過濾器、DefaultFilter、GlobalFilter
請求路由后,會將當(dāng)前路由過濾器和DefaultFilter、GlobalFilter,合并到一個過濾器鏈(集合)中,排序后依次執(zhí)行每個過濾器:
排序的規(guī)則是什么呢?
-
每一個過濾器都必須指定一個int類型的order值,order值越小,優(yōu)先級越高,執(zhí)行順序越靠前。
-
GlobalFilter通過實現(xiàn)Ordered接口,或者添加@Order注解來指定order值,由我們自己指定
-
路由過濾器和defaultFilter的order由Spring指定,默認(rèn)是按照聲明順序從1遞增。
-
當(dāng)過濾器的order值一樣時,會按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執(zhí)行。
詳細內(nèi)容,可以查看源碼:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()
方法是先加載defaultFilters,然后再加載某個route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()
方法會加載全局過濾器,與前面的過濾器合并后根據(jù)order排序,組織過濾器鏈
6.跨域問題
6.1.什么是跨域問題
跨域:域名不一致就是跨域,主要包括:
-
域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
-
域名相同,端口不同:localhost:8080和localhost8081
跨域問題:瀏覽器禁止請求的發(fā)起者與服務(wù)端發(fā)生跨域ajax請求,請求被瀏覽器攔截的問題
解決方案:CORS,這個以前應(yīng)該學(xué)習(xí)過,這里不再贅述了。不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html
6.2.模擬跨域問題
找到課前資料的頁面文件:
放入tomcat或者nginx這樣的web服務(wù)器中,啟動并訪問。
可以在瀏覽器控制臺看到下面的錯誤:
從localhost:8090訪問localhost:10010,端口不同,顯然是跨域的請求。文章來源:http://www.zghlxwxcb.cn/news/detail-492137.html
6.3.解決跨域問題
在gateway服務(wù)的application.yml文件中,添加下面的配置:文章來源地址http://www.zghlxwxcb.cn/news/detail-492137.html
spring:
cloud:
? gateway:
? ? ?# 。。。
? ? globalcors: # 全局的跨域處理
? ? ? add-to-simple-url-handler-mapping: true # 解決options請求被攔截問題
? ? ? corsConfigurations:
? ? ? ? '[/**]':
? ? ? ? ? allowedOrigins: # 允許哪些網(wǎng)站的跨域請求
? ? ? ? ? ? - "http://localhost:8090"
? ? ? ? ? allowedMethods: # 允許的跨域ajax的請求方式
? ? ? ? ? ? - "GET"
? ? ? ? ? ? - "POST"
? ? ? ? ? ? - "DELETE"
? ? ? ? ? ? - "PUT"
? ? ? ? ? ? - "OPTIONS"
? ? ? ? ? allowedHeaders: "*" # 允許在請求中攜帶的頭信息
? ? ? ? ? allowCredentials: true # 是否允許攜帶cookie
? ? ? ? ? maxAge: 360000 # 這次跨域檢測的有效期
到了這里,關(guān)于Gateway服務(wù)網(wǎng)關(guān)使用教程的文章就介紹完了。如果您還想了解更多內(nèi)容,請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!