SpringCloud Gateway 详解与配置

作者：小黄鸭技术

2022 年 9 月 23 日
山东
本文字数：5426 字
阅读完需：约 18 分钟

简介

用来构建 API 网关。Spring Cloud Gateway 旨在提供一种简单而有效的方式来路由到 API，并为它们提供横切关注点，例如：安全性、监控/指标和弹性。

特点

动态路由：能够匹配任何请求属性的路由
谓词和过滤器特定于路由
熔断器集成
易于编写谓词和过滤器
集成 SpringCloud 的服务发现功能
请求速率限制
路径重写

从 0 到 1 构建 Gateway

手动构建

1.点击SpringGateway初始化会显示如下页面，点击 GENRATE 下载配置好的压缩包。

2.解压缩下载好的 Gateway 项目压缩包，用你喜欢的 IDE 打开，项目结构如下：

基本配置

Route 组成

Route 是网关的基本组成单元，它是由 ID，目标 URI 和一组 predicates 和一组 filters 组成，如果一组断言结果为真，则匹配路由，目标 URI 会被访问。

注意：
多个 Predicate 之间是逻辑 and 的关系。
多个 Predicate 是从定义的顺序从上到下依次执行,也可以指定 order 属性的值。

配置方式

Gateway 提供了两种不同的方式来配置路由，一种是通过 yml 文件来配置，另一种是通过 New Bean 来配置。

uri 解析
http 前缀
路由匹配完成后跳转到此地址
lb 前缀
lb 代表负载均衡，service-name 代表服务注册中心该服务注册的服务名

yml 文件配置

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:          #路由的ID 唯一即可        - id: USER-CENTER          #路由的地址          uri:  http://localhost:8888/         #uri:  lb://service-name           predicates:            - Path=/user/**

复制代码

New Bean 配置

package com.example.gateway.config;
import org.springframework.cloud.gateway.route.RouteLocator;import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;
/** * @author Yellow Duck 🦆 * @date 2022-04-27 15:21 */@Configurationpublic class GatewayConfig {
    @Bean    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {        return builder.routes()                //配置路由                .route("USER-CENTER", r -> r.path("/user")                        .uri("http://localhost:8888"))                .build();    }}

复制代码

使用效果：

启动服务后，可以通过终端或者 Postman 等工具调用 http://localhost:8889/user
会发现请求被路由转发到http://localhost:8888/user

Route Predicate Factory

1.After

作用：请求在指定时间之后才匹配

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:                - After=2022-04-27T16:35:04.030+08:00[Asia/Shanghai]

复制代码

2.Before

作用：请求在指定时间之前才匹配

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:                - Before=2022-04-27T16:35:04.030+08:00[Asia/Shanghai]

复制代码

3.Between

作用：请求在指定时间区间之内才匹配，

🦆：第一个时间需要小于第二个时间。

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - Between=2022-04-22T16:00:00.020+08:00[Asia/Shanghai],2022-04-22T16:30:00.020+08:00[Asia/Shanghai]

复制代码

4.Cookie

作用：请求携带指定 Cookie 才匹配🦆：只有当请求 Cookie 中带有 name=yellowDuck 才可以匹配到此路由

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - Cookie=name,yellowDuck

复制代码

5.Header

作用：请求携带指定 Header 才匹配

🦆：只有当请求 Header 种中带有 X-User-Id:001 才可以匹配到此路由，其中\d+为校验数字正则表达式，可以根据需要自己定制。

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - Header=X-User-Id,\d+

复制代码

6.Host

作用：请求携带指定 Host 才匹配

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - Host=**.yellowDuck.com

复制代码

7.Method

作用：请求指定 Mehtod 请求方式才匹配

🦆：只有 GET,POST,DELETE 请求才可以访问

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - Method=GET,POST,DELETE

复制代码

8.Path

作用：请求路径匹配

🦆：只有包含配置的路径才可以匹配也可以支持/duck/{color}参数形式

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - Path=/duck/**

复制代码

9.Query

作用：请求参数包含才匹配

🦆：请求中必须有 duck 这个参数才可以访问

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - Query=duck

复制代码

10.RemoteAddr

作用：请求的 IP/IP 段一致才可以访问

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - RemoteAddr=127.0.0.1/24

复制代码

11.Weight

作用：根据权重的分配路由到相应的请求

🦆：group 分组，wight 权重，是一个 int 值，下面代表有 90%的请求会分配到http://localhost:8888/有 10%请求会分配到http://localhost:8887

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          predicates:            - Weight=group1,9        - id: DUCK-CENTER #路由的ID          uri: http://localhost:8887/ #匹配后路由地址          predicates:            - Weight=group2,1

复制代码

Route Filters

过滤器 Filter 将会对请求和响应进行修改处理，路由过滤器只能指定路由进行使用。

1.AddRequestParameter

作用：对请求添加参数

🦆：如下对 GET 请求添加 duck=yellow 相当于 ?duck=yellow

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          filters:            - AddRequestParameter=duck,yellow          predicates:            - Method=GET

复制代码

2.StripPrefix GatewayFilter

作用：对指定数量的路径进行删除过滤

🦆：比如 http://localhost:8888/yellow/big/duck 过滤前两个路径后会变成 http://localhost:8888/duck

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          filters:            - Path=/duck/**          predicates:            - StripPrefix=2

复制代码

3.PrefixPath GatewayFilter

作用：对指定的路径进行增加

🦆：比如 http://localhost:8888/duck 过滤增加路径后会变成 http://localhost:8888/yellow/duck

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          filters:            - Method=POST          predicates:            - PrefixPath=/yellow

复制代码

4.Hystrix GatewayFilter

1.首先需要添加 Hystrix 依赖，Hystrix 提供了熔断和降级。

<dependency>    <groupId>org.springframework.cloud</groupId>    <artifactId>spring-cloud-starter-netflix-hystrix</artifactId></dependency>

复制代码

2.编写服务降级的处理类

package com.gostop.cloud.gateway.config;
import com.gostop.cloud.gateway.handle.HystrixFallbackHandler;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.http.MediaType;import org.springframework.web.reactive.function.server.RequestPredicates;import org.springframework.web.reactive.function.server.RouterFunction;import org.springframework.web.reactive.function.server.RouterFunctions;
/** * * @date 2022-04-28 15:02 * @author YellowDuck */@Configurationpublic class GatewayFallbackConfiguration {
    @Autowired    private HystrixFallbackHandler hystrixFallbackHandler;
    @Bean    public RouterFunction routerFunction() {        return RouterFunctions.route(                RequestPredicates.GET("/defaultfallback")                        .and(RequestPredicates.accept(MediaType.TEXT_PLAIN)), hystrixFallbackHandler);    }}

复制代码

package com.gostop.cloud.gateway.handle;
import lombok.extern.slf4j.Slf4j;import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;import org.springframework.http.HttpStatus;import org.springframework.http.MediaType;import org.springframework.stereotype.Component;import org.springframework.web.reactive.function.BodyInserters;import org.springframework.web.reactive.function.server.HandlerFunction;import org.springframework.web.reactive.function.server.ServerRequest;import org.springframework.web.reactive.function.server.ServerResponse;import reactor.core.publisher.Mono;

/** * 覆盖异常处理 * @date 2022-04-28 15:03 * @author Yellow Duck */@Slf4j@Componentpublic class HystrixFallbackHandler implements HandlerFunction<ServerResponse> {
    @Override    public Mono<ServerResponse> handle(ServerRequest serverRequest) {        serverRequest.attribute(ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR)                .ifPresent(originalUrls -> log.error("=====网关执行请求:{}失败,服务降级处理=====", originalUrls));
        return ServerResponse                .status(HttpStatus.INTERNAL_SERVER_ERROR)                .contentType(MediaType.APPLICATION_JSON_UTF8)                .body(BodyInserters.fromValue("网络繁忙！"));    }}

复制代码

作用：提供了熔断和降级功能

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          filters:            - name: Hystrix              args:                name: fallback                fallbackUri: forward:/defaultfallback          predicates:            - Method=GET

复制代码

5.RequestRateLimiter GatewayFilter

引入 Redis 限流

<dependency>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-data-redis-reactive</artifactId></dependency>

复制代码

作用：用于限流

#GateWay项目端口号server:  port: 8889spring:  cloud:    gateway:      routes:        - id: USER-CENTER #路由的ID          uri:  http://localhost:8888/ #匹配后路由地址          filters:            - name: RequestRateLimiter              args:                #每秒允许处理的请求数量                redis-rate-limiter.replenishRate: 10                 #每秒最大处理的请求数量                redis-rate-limiter.burstCapacity: 20                 redis-rate-limiter.requestedTokens: 1          predicates:            - Method=GET,POST

复制代码

发布于: 刚刚阅读数: 4

原文链接:【http://xie.infoq.cn/article/c6e7c67142a864c8534410614】。文章转载请联系作者。

小黄鸭技术

关注

还未添加个人签名 2020.02.06 加入

还未添加个人简介

发布

暂无评论

创作场景

SpringCloud Gateway 详解与配置

简介

特点

从 0 到 1 构建 Gateway

手动构建

基本配置

Route 组成

配置方式

yml 文件配置

New Bean 配置

Route Predicate Factory

1.After

2.Before

3.Between

4.Cookie

5.Header

6.Host

7.Method

8.Path

9.Query

10.RemoteAddr

11.Weight

Route Filters

1.AddRequestParameter

2.StripPrefix GatewayFilter

3.PrefixPath GatewayFilter

4.Hystrix GatewayFilter

5.RequestRateLimiter GatewayFilter

小黄鸭技术

评论