【SpringCloud】GateWay概述、路由配置、Predicate使用、FIlter使用

最新推荐文章于 2024-10-08 10:52:07 发布
最新推荐文章于 2024-10-08 10:52:07 发布
阅读量1k 收藏 1
点赞数
分类专栏： # SpringCloud Java 文章标签： spring cloud gateway java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/See_Star/article/details/121330188
版权

🔰 学习视频 🔰

尚硅谷SpringCloud框架开发教程(SpringCloudAlibaba微服务分布式架构丨Spring Cloud)

集数：65—73

🔰 学习格言 🔰

不在能知，乃在能行。

🔰 学习笔记 🔰

【Java】学习笔记汇总

🔰 项目地址 🔰

https://gitee.com/zqcliudaliuda/cloud2021

文章目录

一、概述

Cloud全家桶中有个很重要的组件就是网关，在1.x版本中都是采用的ZuuI网关；但在2.x版本中，zuul的升级一直跳票 ，SpringCloud最后自己研发了一个网关替代Zuul，那就是SpringCloud Gateway，一句话: gateway是原zuul1.x版的替代。

在这里插入图片描述

1.1 应用

反向代理、鉴权、流量控制、熔断、日志监控…

1.2 特性

  • 基于Spring Framework 5, Project Reactor和Spring Boot 2.0进行构建;
  • 动态路由:能够匹配任何请求属性;
  • 可以对路由指定Predicate (断言)和Filter(过滤器)
  • 集成Hystrix的断路器功能;
  • 集成Spring Cloud服务发现功能;
  • 易于编写的Predicate(断言)和Filter(过滤器) ;
  • 请求限流功能;
  • 支持路径重写。

1.3 三大核心概念

  • Route：路由，路由是构建网关的基本模块，它由ID，目标URI，一系列的断言和过滤器组成，如断言为true则匹配该路由。

  • Predicate：断言，参考Java8的java.util.function.Predicate，开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数)，如果请求与断言相匹配则进行路由。

  • Filter：过滤，指的是Spring框架中GatewayFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。

1.4 工作流程

web请求，通过一些匹配条件， 定位到真正的服务节点。并在这个转发过程的前后，进行些精细化控制。predicate就是我们的匹配条件；而filter，就可以理解为一个无所不能的拦截器。有了这两个元素，再加上目标uri，就可以实现一个具体的路由了。
在这里插入图片描述
客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping中找到与请求相匹配的路由，将其发送到Gateway Web Handler。

Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑,然后返回。

过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前( “pre” )或之后( “post” )执行业务逻辑。Filter在"pre" 类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等,在"post”类型的过滤器中可以做响应内容、响应头的修改，日志的输出，流量监控等有着非常重要的作用。

二、入门配置

2.1 新建Module工程

新建maven项目cloud-gateway-gateway9527

2.2 POM

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
        <groupId>com.zqc.springcloud</groupId>
        <artifactId>cloud-api-commons</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <scope>true</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
</dependencies>

2.3 application.xml

server:
  port: 9527

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      routes:
        - id: payment_routh        # 路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001  # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/**  # 断言，路径相匹配的进行路由

        - id: payment_routh2        # 路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001  # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/**  # 断言，路径相匹配的进行路由

eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

后面将介绍另一种配置方式。

2.4 主启动类

@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9527 {
    public static void main(String[] args) {
        SpringApplication.run(GateWayMain9527.class, args);
    }
}

2.5 测试

依次启动：7001、cloud-provider-payment8001、9527网关

在Eureka中可查看到：
在这里插入图片描述

添加网管前访问：http://localhost:8001/payment/get/1
添加网管后访问：http://localhost:9527/payment/get/1

{"code":200,"message":"查询成功, serverPort:8001","data":{"id":1,"serial":"xxxx"}}

在这里插入图片描述

三、路由配置

3.1 配置文件

application.yml

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      routes:
        - id: payment_routh        # 路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001  # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/**  # 断言，路径相匹配的进行路由

        - id: payment_routh2        # 路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001  # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/**  # 断言，路径相匹配的进行路由

3.2 RouteLocator

在9527中添加新的配置类。

@Configuration
public class GateWayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();

        routes.route("path_route_1",
                r -> r.path("/guonei")
                        .uri("http://new.baidu.com/guonei")).build();
        return routes.build();
    }
}

启动9527并访问：http://localhost:9527/guonei

四、通过服务名实现动态

默认情况下Gatway会根据注册中心注册的服务列表, 以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由的功能。

4.1 application.yml

修改9527的application.yml

添加动态路由，并将uri: http://localhost:8001修改为uri: lb://cloud-payment-service。

server:
  port: 9527

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true   # 开启从注册中心动态创建路由功能，利用微服务名进行路由
      routes:
        - id: payment_routh        # 路由的ID，没有固定规则但要求唯一，建议配合服务名
          # uri: http://localhost:8001  # 匹配后提供服务的路由地址
          uri: lb://cloud-payment-service
          predicates:
            - Path=/payment/get/**  # 断言，路径相匹配的进行路由

        - id: payment_routh2        # 路由的ID，没有固定规则但要求唯一，建议配合服务名
          # uri: http://localhost:8001  # 匹配后提供服务的路由地址
          uri: lb://cloud-payment-service
          predicates:
            - Path=/payment/lb/**  # 断言，路径相匹配的进行路由

eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

4.2 测试

依次启动：7001、cloud-provider-payment8001、8002、9527

访问：http://localhost:9527/payment/get/1

{"code":200,"message":"查询成功, serverPort:8002","data":{"id":1,"serial":"xxxx"}}

{"code":200,"message":"查询成功, serverPort:8001","data":{"id":1,"serial":"xxxx"}}

同样实现了负载均衡。

五、Predicate使用

在yml中配置的predicate是path
在这里插入图片描述
官方：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

详细说明都在官网的介绍里面。

5.1 After、Before、Between

表示在该时间后，路由才生效。（After、Before、Between同理）
在这里插入图片描述

如何获得时间戳：

ZonedDateTime zbj = ZonedDateTime.now(); // 默认时区
System.out.println(zbj);

// 2021-11-15T20:09:01.647+08:00[Asia/Shanghai]

5.2 Cookie

Cookie Route Predicate需要两个参数，一个是Cookie name，一个是正则表达式。

路由规则会通过获取对应的Cookie name值喝正则表达式去匹配，如果匹配上就回去执行路由，如果没匹配上不执行。

🔶 修改配置
在这里插入图片描述
🔶 测试

使用crul进行测试，打开命令行工具

命令：curl http://localhost:9527/payment/get/1

此时不带cookie访问，结果是404，查询失败。
在这里插入图片描述
命令：curl http://localhost:9527/payment/get/1 --cookie "username=zzyy"

此时带cookie访问，结果为200，查询成功。
在这里插入图片描述

5.3 Header

两个参数: 一个是属性名称和一个正则表达式，这个属性值和正则表达式匹配则执行。
在这里插入图片描述
访问：curl http://localhost:9527/payment/get/1 失败
访问：curl http://localhost:9527/payment/get/1 -H "X-Request-Id:123" 成功

六、Filter使用

路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用。Spring Cloud Gateway内置了多种路由过滤器，他们都由GatewayFilter的工厂 类来产生

Filter包含两种：GatewayFilter、GlobalFilter

🔶 自定义过滤器

一般使用自定义过滤器，不用官网提供的。

在cloud-gateway-gateway9527中添加类MyLogGateWayFilter，过滤用户。

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("-----------------com in MyLogGateWayFilter: " + new Date());
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        if (uname == null) {
            log.info("用户名为null，非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

在这里插入图片描述

注释掉路由断言的条件，重启9527，

访问：http://localhost:9527/payment/get/1?uname=z3 成功
访问：http://localhost:9527/payment/get/1 错误

望天边星宿
关注
专栏目录
Gateway概述
dency
12-04 683
1.描述 核心逻辑：路由转发+执行过滤器链 Spring Cloud Gateway 使用的Webflux中的reactor-netty响应式编程组件，底层使用了Netty通讯框架 2.官网： https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/ 3.功能概述 反向代理 鉴权 流量控制 熔断 日志控制 4.网关在哪里 5.三大核心理念 .
Spring Cloud Gateway之路由配置
静水深流
08-28 852
Spring Cloud Gateway提供了丰富且灵活的路由配置方式，可以通过谓词、过滤器、全局过滤器以及动态路由等功能满足各种复杂的路由需求。正确地配置和使用这些选项可以确保API网关在微服务架构中的高效、安全运行。
springcloud gateway 配置predicates 多个path；路由请求头新增参数
cn_yaojin
05-25 5947
【代码】springcloud gateway 配置predicates 多个path；路由请求头新增参数。
SpringCloud 2023 Gateway的Filter配置介绍、类型、内置过滤器、自定义全局和单一内置过滤器
最新发布
Bulut0907
10-08 1454
类似SpringMVC里面的的拦截器Interceptor，Servlet的过滤器。“pre”和“post”分别会在请求被执行前调用和被执行后调用，用来修改请求和响应信息。可以用来做请求鉴权、异常处理、记录接口调用时长需求：统计每个请求的耗时时长思路：不管是在每个接口中进行统计；还是通过AOP + 反射形成注解然后进行使用。都会对业务代码形成入侵，可以通过自定义全局过滤器来实现步骤1：新建类MyGlobalFilter并实现GlobalFilter,Ordered两个接口。
Spring cloud Gateway 配置详解
Java技术攻略的博客
03-06 3459
每一个Predicate的使用，你可以理解为：当满足这种条件后才会被转发，如果是多个，那就是都满足的情况下被转发。本章节讲解了Spring Cloud Gateway的相关谓词、断言基本使用方式，GateWay内部提供了很多种灵活的路由转发规则，在同一个路由内存在多个Predicate时，同时满足规则后请求才会被路由转发。
Java编码方式实现spring cloud gateway多filter配置、RedisRateLimiter配置
fizay的博客
08-10 1006
需求： 把yml中的route配置： /** * 使用java编码的方式，替换原先yml中路由2的配置： * #考虑到要采用ip白名单，将路由2改为java配置 - id: accessProvider #路由2：要想访问后台微服务，请求头中就必须要含有CMSOFT_TOKEN才能实现路由转发！！ uri: lb://provider predicates: - Path=/provider-service/**
Spring Cloud GateWay 路由转发规则介绍详解
08-26
开始使用 Spring Cloud Gateway 有两种方式进行配置：application.yml 配置文件方式和 @Bean 注解 RouteLocator 方法返回值。添加依赖项需要添加 Spring Cloud Gateway 相关依赖项，pom.xml 文件中需要添加相关依赖...
Spring Cloud Gateway自带Predicate使用 | Spring Cloud 14
gmHappy
03-08 3041
`Spring Cloud Gateway` 匹配路由作为 `Spring WebFluxHandlerMapping`基础设施的一部分。`Spring Cloud Gateway` 包含许多内置的`Predicate` 。所有这些`Predicate`都匹配 `HTTP` 请求的不同属性。您可以将多个`Predicate` 与`and`结合起来。
springcloud gateway动态路由
pliulijia的专栏
01-16 3010
springcloud gateway动态路由
【云原生&微服务＞SCG网关篇五】Spring Cloud Gateway自定义网关路由Predicate
m0_67392010的博客
07-29 426
云原生&微服务＞SCG网关篇一】为什么要有网关、生产环境如何选择网关云原生&微服务＞SCG网关篇二】生产上那些灰度发布方式【云原生&微服务＞SCG网关篇三】SpringCloudGateway是什么、详细使用案例云原生&微服务＞SCG网关篇四】SpringCloudGateway内置的11种PredicateFactory如何使用为什么要有网关？网关的作用是什么？网关的分类？网关的技术选型？使用网关时常用的灰度发布方式有哪些？SpringCloudGateway是什么？...
Spring Cloud Gateway概念与配置
swg321321的博客
07-27 2173
Spring Cloud Gateway,示例与说明，包含限速、恢复发布，请求重试、熔断、断路器、添加请求和响应 头、请求参数等信息。
spring cloud gateway之filter篇
09-06 410
https://blog.csdn.net/forezp/article/details/85057268 版权声明：本文为博主原创文章，遵循 CC 4.0 BY-S...
Spring cloud Gateway常用配置
fantoutou1的博客
08-06 3665
Spring cloud Gateway常用配置。包含路由Route、断言Predicate、过滤器Filter、等
Spring Cloud Gateway配置
weixin_48352162的博客
03-10 915
![](https://img-blog.csdnimg.cn/img_convert/6cc657529fb3920364d88e221ab8a562.png#align=left&display=inline&height=595&margin=[object Object]&originHeight=595&originWidth=443&size=0&status=done&style=none&width=443) 客户端发送
Spring Cloud GateWay 之 Predicate与Filter
记录，记录，记录
04-22 3024
一.请求过程 大致流程： 请求去访问GateWay Client 访问GateWay Handler Mappeing 寻找有没有与路径相匹配的路由 根据predicate来决定访问那个路由 再经过pre类型的过滤器，进行请求代理 再经过post类型过滤器 二.predicate predicate就像是一个条件，SpringCloud GateWay内置很多predicate，配置在配...
springcloudgateway动态路由_Spring Cloud Gateway 自定义 ReadBodyPredicateFactory 实现动态路由...
weixin_39986543的博客
11-30 489
在互网企业当中网关的重要性我就不再赘述了，相信大家都比较清楚。我们公司网关采用的是 Spring Cloud Gateway。并且是通过自定义 RouteLocator 来实现动态路由的。路由规则是请求参数里面的bizType，比如接收 JSON 格式体的请求对象并且业务方请求的是创建支付订单接口，下面就是业务方需要传递的参数：{ "bizType" : "createOrder", ...
SpringCloud Gateway GatewayFilter网关过滤器详解
qq_33240556的博客
06-18 625
如果内置过滤器不能满足需求，可以创建自定义过滤器。创建一个实现// 在这里添加自定义逻辑 return chain . filter(exchange);} }// 在这里添加自定义逻辑 return chain . filter(exchange);} }// 在这里添加自定义逻辑 return chain . filter(exchange);} }// 在这里添加自定义逻辑 return chain . filter(exchange);} }
Gateway的过滤器
m0_61830834的博客
04-26 1172
在SpringCloudGateway自定义过滤器，过滤器需要实现GatewayFilter和Ordered这两个接口我们以计算当前请求调用链时长为例，实现自定义GatewayFilter@Slf4j/*** @param exchange 服务网络交换器，存放着重要的请求-响应属性、请求实例和响应实例等等，类似于请求上下文对象* @param chain Gateway的filter调用链对象* @return*/@Override// 打印当前客户端请求的地址。
Gateway的配置讲解(包括maven,yml,filter)
qq_37805943的博客
03-04 871
<dependencies> <!--引入 spring-cloud-gateway 依赖 去除了web,act坐标, 防止gateway和web包冲突--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gatew
Spring Cloud Gateway路由详解：配置与工作流程
在使用Spring Cloud Gateway时，主要有两种配置方式：一是通过`application.yml`配置文件，另一种是通过`@Bean`注解的`RouteLocator`方法。本章节将以配置文件方式为主，讲解如何配置路由规则、添加依赖，以及如何在...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

望天边星宿

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值