spring cloud alibaba-Geteway詳解

spring cloud alibaba-Gateway詳解

Gateway介紹

在 Spring Cloud Alibaba 生態系統中，Gateway 是一個非常重要的組件，用于構建微服務架構中的網關服務。它基于 Spring Cloud Gateway 進行擴展和優化，提供了更強大的功能和更好的性能。

Gateway功能

統一入口
? 微服務架構中，多個服務通常部署在不同的地址和端口上。網關作為統一的入口，將所有服務的請求集中管理，客戶端只需要與網關交互，而不需要直接與各個微服務通信。
? 這樣可以簡化客戶端的邏輯，同時提高系統的安全性。
請求路由
? 根據請求的特征（如路徑、方法、參數等）將請求轉發到對應的后端服務。
? 路由規則可以動態配置，方便調整服務的訪問路徑。
負載均衡
? 當后端服務有多個實例時，網關可以根據一定的策略（如輪詢、隨機、權重等）將請求分發到不同的實例，提高系統的可用性和性能。
流量控制
? 限制請求的流量，防止后端服務被過多的請求壓垮。
? 常見的流量控制算法包括令牌桶算法、滑動窗口算法等。
身份認證
? 對請求進行身份驗證，確保只有合法的用戶才能訪問后端服務。
? 常見的身份驗證方式包括基于令牌（如 JWT）、基于用戶名和密碼等。
協議轉換
? 將一種協議的請求轉換為另一種協議的請求，例如將 HTTP 請求轉換為 gRPC 請求。
? 這樣可以實現不同協議之間的通信，提高系統的靈活性。
系統監控
? 監控網關的運行狀態，包括請求量、響應時間、錯誤率等指標。
? 通過監控可以及時發現系統的問題，提高系統的可靠性。
安全防護
? 防止惡意攻擊，如 SQL 注入、XSS 攻擊、CSRF 攻擊等。
? 通過安全策略（如防火墻規則、WAF 等）保護系統免受攻擊。

創建網關

創建一個新項目

導入依賴

        <dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>${spring-cloud.version}</version><type>pom</type><scope>import</scope></dependency><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-alibaba-dependencies</artifactId><version>${spring-cloud-alibaba.version}</version><type>pom</type><scope>import</scope></dependency><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></dependencies>

編寫啟動類

package com.nie.gateway;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;@EnableDiscoveryClient
@SpringBootApplication
public class GatewayApplicationMain {public static void main(String[] args) {SpringApplication.run(GatewayApplicationMain.class,args);}
}

配置application.yml文件

spring:application:name: gatewaycloud:nacos:server-addr: 127.0.0.1:8848profiles:include: route
server:port: 80

配置路由規則 application-route.yml

spring:cloud:gateway:routes:- id: order-routeuri: lb://service-orderpredicates:- Path=/api/order/**- id: product-routeuri: lb://service-productpredicates:- Path=/api/product/**

@RequestMapping("/api/order/")
@RestController
public class OrderController {@GetMapping("/readDb")public String readDb(){return "readDb";}}

測試:說明是能訪問到的
在這里插入圖片描述

進入Nacos

斷言

斷言工廠

名稱	參數（個數/類型）	作用
After	1/datetime	在指定時間之后
Before	1/datetime	在指定時間之前
Between	2/datetime	在指定時間區間內
Cookie	2/string, regexp	包含cookie名且必須匹配指定值
Header	2/string, regexp	包含請求頭且必須匹配指定值
Host	N/string	請求host必須是指定枚舉值
Method	N/string	請求方式必須是指定枚舉值
Path	2/List, bool	請求路徑滿足規則，是否匹配最后的/
Query	2/string, regexp	包含指定請求參數
RemoteAddr	1/List	請求來源于指定網絡域(CIDR寫法)
Weight	2/string, int	按指定權重負載均衡
XForwarded	1/List	從X-Forwarded-For請求頭中解析請求來源，并判斷是否來源于指定網絡域

例如:
predicates的意思就是斷言
Cookie:路由斷言工廠(名)
mycookie,mycookievalue:參數

spring:cloud:gateway:routes:- id: after_routeuri: https://example.orgpredicates:- Cookie=mycookie,mycookievalue

假如我們要轉發到百度我們在加上一些斷言規則

spring:cloud:gateway:routes:- id: bing-routeuri: https://cn.bing.com/predicates:- name: Pathargs:pattern: /search- name: Queryargs:param: qregexp: haha

這時候我們訪問時必須為/serrch 必須帶上參數參數名為q 值必須為haha我們才能成功轉發
在這里插入圖片描述

如果值不等于haha 或者參數名不為q 那么會出現404找不到頁面錯誤
在這里插入圖片描述

自定義斷言工廠

package com.nie.gateway.predicate;import jakarta.validation.constraints.NotEmpty;
import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.cloud.gateway.handler.predicate.GatewayPredicate;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.server.ServerWebExchange;import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;/*** 自定義的VIP路由斷言工廠類，用于根據請求參數判斷是否匹配VIP路由。* 繼承自AbstractRoutePredicateFactory，實現了自定義路由斷言邏輯。*/
@Component
public class VipRoutePredicateFactory extends AbstractRoutePredicateFactory<VipRoutePredicateFactory.Config> {/*** 構造函數，指定配置類為Config。*/public VipRoutePredicateFactory() {super(Config.class);}/*** 實現apply方法，根據Config中的配置生成路由斷言邏輯。** @param config 配置對象，包含請求參數名和期望值* @return 返回一個Predicate<ServerWebExchange>，用于判斷請求是否匹配VIP路由*/@Overridepublic Predicate<ServerWebExchange> apply(Config config) {return new GatewayPredicate() {/*** 判斷請求是否匹配VIP路由的邏輯。** @param serverWebExchange 當前的請求上下文* @return 如果請求參數中存在指定參數且值匹配，則返回true，否則返回false*/@Overridepublic boolean test(ServerWebExchange serverWebExchange) {ServerHttpRequest request = serverWebExchange.getRequest();// 獲取請求參數中指定參數的第一個值String first = request.getQueryParams().getFirst(config.param);// 判斷參數值是否存在且是否等于配置的期望值if (StringUtils.hasText(first) && first.equals(config.value)) {return true;}return false;}};}/*** 定義配置類的字段順序，用于在配置文件中指定參數時的順序。** @return 返回字段順序列表*/@Overridepublic List<String> shortcutFieldOrder() {return Arrays.asList("param", "value");}/*** 配置類，用于存儲路由斷言的配置信息。*/@Validatedpublic static class Config {/*** 請求參數名，用于從請求中獲取參數值。*/@NotEmptyprivate String param;/*** 請求參數期望值，用于判斷請求參數值是否匹配。*/@NotEmptyprivate String value;/*** 獲取請求參數名。** @return 返回請求參數名*/public String getParam() {return param;}/*** 設置請求參數名。** @param param 請求參數名*/public void setParam(String param) {this.param = param;}/*** 獲取請求參數期望值。** @return 返回請求參數期望值*/public String getValue() {return value;}/*** 設置請求參數期望值。** @param value 請求參數期望值*/public void setValue(String value) {this.value = value;}}
}

spring:cloud:gateway:routes:- id: bing-routeuri: https://cn.bing.com/predicates:- name: Pathargs:pattern: /search- name: Queryargs:param: qregexp: haha- name: Vipargs:param: uservalue: xiaonie

在這里插入圖片描述

我出現的錯誤

我在這里犯了一個大錯誤

java.lang.IllegalArgumentException: Unable to find RoutePredicateFactory with name VipRoutePredicateFactory

我檢查了好幾遍代碼都沒問題最后我發現我在這里把這個包放在了外面去了所以他沒有掃描到這個包希望打架也注意一下

過濾器

路徑重寫

如果加上了路徑重寫那么微服務前面就不需要加上/api/模塊名

spring:cloud:gateway:routes:- id: bing-routeuri: https://cn.bing.com/predicates:- name: Pathargs:pattern: /search- name: Queryargs:param: qregexp: haha- name: Vipargs:param: uservalue: xiaonie- id: order-routeuri: lb://service-orderpredicates:- Path=/api/order/**filters:- RewritePath=/api/order/(?<segment>.*), /$\{segment}order: 1- id: product-routeuri: lb://service-productpredicates:- Path=/api/product/**filters:- RewritePath=/api/product/(?<segment>.*), /$\{segment}order: 2

package com.nie.order.controller;import com.alibaba.csp.sentinel.annotation.SentinelResource;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import com.nie.order.bean.Order;
import com.nie.order.properties.OrderProperties;
import com.nie.order.service.OrderService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;@RestController
public class OrderController {@Autowiredprivate OrderService orderService;@Autowiredprivate OrderProperties orderProperties;@GetMapping("/readDb")public String readDb(){return "readDb";}@GetMapping("/seckill")@SentinelResource(value = "seckill-order", fallback = "seckillFallback")public Order seckill(@RequestParam("userId") Long userId,@RequestParam("productId") Long productId){Order order = orderService.createOrder(productId, userId);order.setId(Long.MAX_VALUE);return order;}public Order seckillFallback(Long userId, Long productId, Throwable exception){System.out.println("已經開始限制了");Order order = new Order();order.setId(productId);order.setUserId(userId);order.setAddress("異常信息：" + exception.getClass());return order;}@GetMapping("/config")public String config(){return "order.timeout = " + orderProperties.getTimeout()+ ", order.auto-confirm = " + orderProperties.getAutoConfirm()+"order.db="+orderProperties.getDb();}@GetMapping("/create")public Order createOrder(@RequestParam("userId") Long userId,@RequestParam("productId") Long productId){Order order = orderService.createOrder(productId,userId);return order;}
}

這樣也就能訪問避免后期因為規劃不周到需要大量改前綴
在這里插入圖片描述

          filters:- RewritePath=/api/product/(?<segment>.*), /$\{segment}- AddResponseHeader=X-Response-Abcd, 123

如果我們加上AddResponseHeader=X-Response-Abcd, 123
那么在我們每次請求中他都會帶上響應頭值為123
在這里插入圖片描述

默認過濾器

      default-filters:- AddResponseHeader=X-Response-Abcd, 123

用上面的例子的話我們就在每次請求中都帶入了請求頭值為123
就不用在每個微服務上面都加了

在這里插入圖片描述

全局Filters

package com.nie.gateway.filter;import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
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;@Slf4j
@Component
public class RtGlobalFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {ServerHttpRequest request = exchange.getRequest();ServerHttpResponse response = exchange.getResponse();String uri = request.getURI().toString();long start = System.currentTimeMillis();log.info("請求【{}】開始: 時間: {}", uri, start);//=============以上是前置邏輯================Mono<Void> filter = chain.filter(exchange).doFinally((result)->{//=============以下是后置邏輯================long end = System.currentTimeMillis();log.info("請求【{}】結束: 時間: {}, 耗時: {}ms",uri,end,end-start);}); //放行  10sreturn filter;}@Overridepublic int getOrder() {return 0;}
}

在這里插入圖片描述

自定義過濾器

          filters:- RewritePath=/api/order/(?<segment>.*), /$\{segment}- OnceTooken=X-Response-Token, uuid

package com.nie.gateway.filter;import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.factory.AbstractNameValueGatewayFilterFactory;
import org.springframework.http.HttpHeaders;
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.UUID;@Component
public class OnceTokenGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {@Overridepublic GatewayFilter apply(NameValueConfig config) {return new GatewayFilter() {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {//每次響應之前，添加一個一次性令牌，支持 uuid, jwt等各種格式return chain.filter(exchange).then(Mono.fromRunnable(() -> {ServerHttpResponse response = exchange.getResponse();HttpHeaders headers = response.getHeaders();String value = config.getValue();if ("uuid".equalsIgnoreCase(value)) {value = UUID.randomUUID().toString();}if ("jwt".equalsIgnoreCase(value)) {value = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiIjoiMjQ4OTY3Nzg5IiwibmFtZSI6IkpvaG4gRG9lIiLCJleHAiOjE2NTM5MDk3OTksImlhdCI6MTY1MzkwOTc5OCwiZXhwIjoxNjUzOTA5NzkwLCJpc3MiOiJhdXRoIjoiLCJuYW1lIjoiYXV0aG9ycyIsImV4cCI6MTY1MzkwOTc5OCwianRpIjoiMjAyMyIsInR5cCI6IkpXVCJ9LCJpYXQiOjE2NTM5MDk3OTksImV4cCI6MTY1MzkwOTc5OCwiaXNzIjoiaHR0cHM6Ly9hdXRoLmF1dGhvcnMubmV0L3VzZXIiIsImF1dGhvcml0eSI6eyJpZGVudGl0eSI6eyJjbGllbnRzIjp7InVzZXJAZXhhbXBsZS5jb20iOnsiYWV0Ijp7InVzZXJAZXhhbXBsZS5jb20iOnsiZXhhbXBsZSI6eyJ1c2VyQGV4YW1wbGUiOnsiZXhhbXBsZSI6eyJ1c2VyQGV4YW1wbGUiOnsiZXhhbXBsZSI6eyJ1c2VyQGV4YW1wbGUiOnsiZXhhbXBsZSI6eyJ1c2VyQGV4YW1wbGUiOnsiZXhhbXBsZSI6eyJ1c2VyQGV4YW1wbGUiOnsiZXhhbXBsZSI6eyJ1c2VyGVyIjp7fSwicmV4cCI6eyJyIjoiLCJLCJsYW1vdW50aWVub3JhbCIsImZSI6eyJ1c2VyIjp7fX19LCJ30=\n";}headers.add(config.getName(), value);}));}};}}

在這里插入圖片描述

全局跨域

這樣配置application.yml之后
允許所有請求跨域 allowed-origin-patterns: ‘’
允許全部請求來源允許所有的頭 allowed-headers: '’
允許所有的請求方式 allowed-methods: ‘*’

spring:cloud:gateway:globalcors:cors-configurations:'[/**]':allowed-origin-patterns: '*'allowed-headers: '*'allowed-methods: '*'

在這里插入圖片描述