SpringCloud组件——Gateway

一.网关

1.问题提出

我们通过Eureka,Nacos解决了服务注册,服务发现的问题,使用SpringCloud LoadBalance解决了负载均衡的问题,使用OpenFeign解决了远程调用的问题。

但是当前所有微服务的接口都是直接对外暴露的,可以直接通过外部访问。为了保证对外服务的安全性, 服务端实现的微服务接口通常都带有⼀定的权限校验机制。

由于使用了微服务,原本⼀个应用的多个模块拆分成了多个应用,我们不得不实现多次校验逻辑。当这套逻辑需要修改时,我们需要修改多个应用,比较麻烦。

这个时候就可以使用网关Gateway了。

2.API网关

API网关也是⼀个服务,通常是后端服务的唯一入口。它的定义类似设计模式中的Facade模式。它就类似整个微服务架构的门面,所有的外部客户端访问,都需要经过它来进行调度和过滤。

网关的核心功能:

1)权限控制:作为入口,可对用户进行权限校验,对校验失败的用户进行拦截;

2)动态路由:⼀切请求先经过网关,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务;

3)负载均衡:当路由的目标服务有多个时,需要做负载均衡;

4)限流:请求流量过高时,按照网关中配置微服务能够接受的流量进行放行。

二.SpringCloudGateway

由于API网关是一个服务,所以我们要先创建一个项目(服务)。

1.引入网关依赖

XML 复制代码
<!--网关-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--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-loadbalancer</artifactId>
</dependency>

2.编写启动类

java 复制代码
@SpringBootApplication
public class GatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class,args);
    }
}

3.添加Gateway的路由配置

创建application.yml文件,添加配置:

bash 复制代码
server:
  port: 10030
spring:
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      metrics:
        enabled: true
      routes:
        - id: order-service   
          uri: lb://order-service/ 
          predicates:   
            - Path=/order/**,/feign/**
        - id: product-service
          uri: lb://product-service/
          predicates:
            - Path=/product/**

字段说明:

1)id:自定义路由ID,保持唯一,不能重复;

2)uri:目标服务地址,支持普通URI及 lb:// 应用注册服务名称。lb标识负载均衡,使用 lb:// 方式标识从注册中心获取服务地址;

3)predicates:路由条件,根据匹配结果决定是否执行该请求路由,上述代码中,我们把符合Path规则的一切请求,都代理到uri参数指定的地址。

三.Route Predicate Factories

Route Predicate Factories,在Spring Cloud Gateway中,Predicate提供了路由规则的匹配机制。

这里举几个例子给大家看。

|---------|---------------------------------------------|
| After | 匹配指定日期之后的请求 |
| Before | 匹配指定日期之前的请求 |
| Between | 匹配两个指定时间之间的请求 datetime2 的参数必须在 datetime1 之后 |

具体写一下After的例子:

可以先通过下面的代码获取时间:

java 复制代码
System.out.println(ZonedDateTime.now());

在配置网关的配置文件中添加:

bash 复制代码
predicates:
    - Path=/product/**
    - After=2025-04-28T15:40:18.609323500+08:00[Asia/Shanghai]

详细内容大家可以去Spring官网查看:Route Predicate Factories :: Spring Cloud Gateway

四.Gateway Filter Factories

1.简介

Predicate决定了请求由哪⼀个路由处理,如果在请求处理前后需要加⼀些逻辑,这就是Filter(过滤器)的作用范围了。

Filter分为两种类型:

1)Pre类型过滤器:路由处理之前执行(请求转发到后端服务之前执行),在Pre类型过滤器中可以做鉴权,限流等.;

2)Post类型过滤器::求执行完成后,将结果返回给客户端之前执行。

Spring Cloud Gateway中内置了很多Filter,用于拦截和链式处理web请求。

Spring Cloud Gateway从作用范围上,也看把Filter可分为两类:

1)GatewayFilter:应用到单个路由或者⼀个分组的路由上;

2)GlobalFilter:应用到所有的路由上,也就是对所有的请求生效。

2.GatewayFilter

GatewayFilter也是将配置信息放在配置文件中,Spring Cloud Gateway提供了不少Filter,具体大家可以去官网看:AddRequestHeader GatewayFilter Factory :: Spring Cloud Gateway

左面的那些就是Filter,下面我举一个例子:AddRequestParameter

bash 复制代码
spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
            - AddRequestParameter=userName,Kobayashi

使用这个Filter可以为所有请求添加一个参数userName。

在Spring Cloud Gateway提供的所有Filter中,有一个特殊的Filter:Default Filters,默认过滤器。

默认过滤器可以对全部路由生效:

bash 复制代码
spring:
  cloud:
    gateway:
      default-filters:
      - AddResponseHeader=X-Response-Default-Red, Default-Blue
      - PrefixPath=/httpbin

其实从代码中也可以看出,default-filters是与routes同级的,这也能说明默认过滤器不仅仅是对某一些路由生效,而是对所有路由生效。

3.GlobalFilter

GlobalFilter是Spring Cloud Gateway中的全局过滤器。

1)添加过滤器

XML 复制代码
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

2)添加配置

bash 复制代码
spring:
    cloud:
        gateway:
            metrics:
                enabled: true
management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: always
    shutdown:
      enabled: true

4.过滤器执行顺序

请求路由后,网关会把当前项目中的GatewayFilter和GlobalFilter合并到⼀个过滤器链(集合)中,并进行排序,依次执行过滤器。

每⼀个过滤器都必须指定⼀个int类型的order值,默认值为0,表示该过滤的优先级。order值越小,优先级越高,执行顺序越靠前。

1)Filter通过实现Order接口或者添加@Order注解来指定order值。

2)SpringCloudGateway提供的Filter由Spring指定。用户也可以自定义Filter,由用户指定。

3)当过滤器的order值⼀样时,会按照defaultFilter>GatewayFilter>GlobalFilter的顺序执行。

相关推荐
陈如水11 小时前
Spring AI Alibaba 在多 Agent 场景下的实践
java·人工智能·spring
行百里er12 小时前
【Spring Insight 技术分享】如何给 AI 接口调用做滑动窗口限流
spring boot·后端·spring cloud
Resean022315 小时前
Spring 源码分析(六)循环依赖与三级缓存
java·spring·缓存
行百里er1 天前
【Spring Insight 技术分享】跨服务调用链路是怎么串起来的?
后端·spring·开源
Forget the Dream1 天前
Spring AI 2.0 系列(三):ChatClient 与 ChatModel:Spring AI 2.0 的两层职责
java·人工智能·spring·springai
皮皮林5512 天前
为什么越来越多人用 Spring AI ?
spring
Resean02232 天前
Spring 源码分析(七)AOP 原理(上):代理的创建
java·后端·spring
Tangq一定可以的2 天前
Spring AI Advisor 详解 - 给大模型调用加上“切面“,日志/过滤/记忆一键搞定
java·后端·spring
杨凯凡2 天前
Spring Framework 7 原生重试与并发限制实战:@Retryable、@ConcurrencyLimit 能替代 Resilience4j 吗?
数据库·spring·sqlserver
代码不停3 天前
Spring 原理
java·spring