Gateway-EW帮帮网

一、初识网关

1.网关介绍

在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢?如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。这样的话会产生很多问题，例如:

客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
认证复杂，每个微服务都有独立认证
存在跨域请求，在一定场景下处理相对复杂

为解决上面的问题所以引入了网关的概念:所谓的API网关，就是指系统的统一入口，提供内部服务的路由中转，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、路由转发等。

2.网关对比

Zuul 1.x

Netflix开源的网关，基于Servet框架构建，功能丰富，使用JAVA开发，易于二次开发问题:即一个线程处理-次连接请求，这种方式在内部延迟严重、设备故障较多情况下会引起存活的连接增多和线程增加的情况发生

Zuul 2.x

Zuul2 采用了Netty实现异步非阻塞编程模型，每个 CPU 核一个线程，处理所有的请求和响应，请求和响应的生命周期是通过事件和回调来处理的，这种方式减少了线程数量，因此开销较小。

GateWay

Spring公司为了替换Zuul而开发的网关服务，底层为Netty，将在下面具体介绍。

Nginx+lua

使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用，lua是一种脚本语言,可以来编写一些简单的逻辑,nginx支持lua脚本，问题在于:无法融入到微服务架构中.

Kong

基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。问题:只支持Http协议;二次开发，自由扩展困难;提供管理AP1，缺乏更易用的管控、配置方式。

3.Gateway介绍

Sprine Cloud Gateway 基于Sprine Boot 2.xSprine WebFlux和Proiect Reactor,它旨在为微服务架构提供一种简单有效的统一的 API路由管理方式。它的目标是替代Netfix Zuul，其不仅提供统一的路由方式，并且基于 filter 链的方式提供了网关基本的功能，例如:安全，监控和限流。

特点:

1.性能强劲:是Zuul的1.6倍

2.功能强大:内置了很多实用的功能，例如转发、监控、限流等

3.设计优雅，容易扩展

3.1基本概念:

路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息:

id:路由标识、区别于其他route
uri:路由指向的目的地uri，即客户端请求最终被转发到的微服务
order:用于多个route之间的排序，数值越小排序越靠前，匹配优先级越高
predicate:断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由
filter:过滤器用于修改请求和响应信息

3.2 执行流程:

1.Gateway Client向Gateway Server发送请求

2.请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文

3.然后网关的上下文会传递到DispatcherHandler，它负责将请求分发给RoutePredicateHandlerMapping

4.RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用

5.如果过断言成功，由FilteringWebHandler创建过滤器链并调用

6.请求会一次经过PreFilter--微服务-PostFilter的方法，最终返回响应

4.核心流程简单介绍

在开始Gateway的使用之前我们先简单的来提下Gateway的核心流程。

说明:

客户端向 Spring Cloud Gateway 发出请求。如果Gateway Handler Mapping确定请求与路由匹配，则将其发送到Gateway Web Handler 处理程序。此处理程序通过特定于请求的Fliter链运行请求。Fiter被虛线分隔的原因是Fliter可以在发送代理请求之前(pre)和之后(post)运行逻辑。执行所有pre过滤器逻辑。然后进行代理请求。发出代理请求后，将运行“post”过滤器逻辑。

过滤器的作用:

Filter在pre类型的过滤器可以做参数效验、权限效验、流量监控、日志输出、协议转换等
Filter在post类型的过滤器可以做响应内容、!响应头的修改、日志输出、流量监控等
这两种类型的过滤器有着非堂重要的作用

需要了解的几个核心概念

Route(路由)

路由是构建网关的基础模块，它由ID，目标URI，包括一些列的断言和过滤器组成，如果断言为true则匹配该路由

Predicate(断言)

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

Filter(过滤)

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

三个核心点连起来:

当用户发出请求到达GateWay，GateWay会通过一些匹配条件，定位到真正的服务节点，并在这个转发过程前后，进行一些及细化控制。其中Predicate就是我们匹配的条件，而Filter可以理解为一个拦截器，有了这两个点，再加上目标URI，就可以实现一个具体的路由了

二、快速入门

添加相关依赖

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

编写对应的配置文件

server:
  port: 9999
spring:
  application:
    name: gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848  # Nacos地址正确
    gateway:
      routes: #路由
        - id: nacos-consumer  #路由ID 没用固定要求，但是要保证唯一
          # 方案1：直接指定目标服务URL（需知道具体端口）
          uri: http://127.0.0.1:7777  # 假设consumer服务运行在8080

          # 方案2（推荐）：通过服务名动态路由（需确保服务已注册到Nacos）
#          uri: lb://nacos-consumer  # lb://表示负载均衡
          predicates:
            - Path=/nacos-consumer/** #断言 路径相匹配进行路由
#          filters:
#            - StripPrefix=1  # 去掉路径前缀/nacos-consumer

基于代码编写配置

@Configuration
public class GateWayConfig {

    @Bean
    public RouteLocator routeLocator(RouteLocatorBuilder routeLocatorBuilder) {
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        routes.route("nacos-provider",r->r.path("/nacos-consumer/**").uri("http://127.0.0.1:7777"));
        return  routes.build();
    }
}

gateway服务多节点模式转发开启负载均衡

server:
  port: 9999
spring:
  application:
    name: gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848  # Nacos地址正确
    gateway:
      discovery:
        locator:
          enabled: true #开启注册中心的路由
      routes:
        - id: nacos-consumer
#          # 方案1：直接指定目标服务URL（需知道具体端口）
          uri: http://127.0.0.1:7777/nacos-consumer # 假设consumer服务运行在8080

          # 方案2（推荐）：通过服务名动态路由（需确保服务已注册到Nacos）
#          uri: lb://nacos-consumer  # lb://表示负载均衡
          predicates:
            - Path=/nacos-consumer/**
#          filters:
#            - StripPrefix=1  # 去掉路径前缀/nacos-consumer

添加loadbalancer依赖

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

三、predicate 断言

每一个Predicate的使用，可以理解为:当足条件后才会进行转发，如果十多个，那就是满足所有条件才会转发。

1.断言的种类

1.Afer:匹配在指定日期时间之后发生的请求。

2.Before:匹配在指定日期之前发生的请求。

3.Between:需要指定两个日期参数，设定一个时间区间，匹配此时间区间内的请求。

4.Cookie:需要指定两个参数，分别为name和regexp(正则表达式)，也可以理解Key和Value，匹配具有给定名称且其值与正则表达式匹配的Cookie。

5.Header:需要两个参数header和regexp(正则表达式)，也可以理解为Key和Value，匹配请求携带信息。

6.Host:匹配当前请求是否来自于设置的主机。

7.Method:可以设置一个或多个参数，匹配HTTP请求，比如GET、POST

8.Path:匹配指定路径下的请求，可以是多个用逗号分隔

9.0uery;需要指定一个或者多个参数，一个必须参数和一个可选的正则表达式，匹配请求中是否包含第一个参数，如果有两个参数，则匹配请求中第一个参数的值是否符合正则表达式。

10.RemoteAddr:匹配指定IP或IP段，符合条件转发。

11.Weight:需要两个参数group和weight(int)，实现了路由权重功能，按照路由权重选择同一个分组中的路由

2.案例demo

2.1 After

After：匹配在指定时间之后发生的请求，可以对应提前上线业务

spring:
  application:
    name: gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848  # Nacos地址正确
    gateway:
      discovery:
        locator:
          enabled: true #开启注册中心的路由
      routes:
        - id: nacos-consumer
#          # 方案1：直接指定目标服务URL（需知道具体端口）
#          uri: http://127.0.0.1:7777/consumer # 假设consumer服务运行在8080

          # 方案2（推荐）：通过服务名动态路由（需确保服务已注册到Nacos）
          uri: lb://nacos-consumer  # lb://表示负载均衡
          predicates:  #断言
            - Path=/consumer/**
            - After=2025-05-20T17:42:47.789-07:00[Asia/Shanghai]
          filters:
            - StripPrefix=1  # 去掉路径前缀/consumer

Brfore:匹配在指定时间之前发生的请求，可以对应提前上线业务

spring:
  cloud:
    gateway:
      routes:
      - id: before_route
        uri: https://example.org
        predicates:
        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

Between: 什么时间到什么时间之间

spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: https://example.org
        predicates:
        - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

2.2 Cookie

需要指定两个参数，分别为name和regexp(正则表达式)，也可以理解Key和Value，匹配具有给定名称且其值与正则表达式匹配的Cookie。

简单理解就是路由规则会通过获取Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，如果匹配不上则不执行。

我们可以分为两种情况演示，Cookie匹配，Cookie不匹配

spring:
  application:
    name: gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848  # Nacos地址正确
    gateway:
      discovery:
        locator:
          enabled: true #开启注册中心的路由
      routes:
        - id: nacos-consumer
          uri: lb://nacos-consumer  # lb://表示负载均衡
          predicates:  #断言
            - Path=/consumer/**
            - Cookie=username,[a-z]+ #匹配Cooike的key和vuelue（正则表达式）

2.3 Header

需要两个参数header和regexp(正则表达式)，也可以理解为Key和Value，匹配请求携带信息。实际上就是请求头携带的信息，官网给出的案例是X-Request-ld。

spring:
  cloud:
    gateway:
      routes:
      - id: nacos-consumer
          uri: lb://nacos-consumer  # lb://表示负载均衡
        predicates:
        - Header=X-Request-Id, \d+ #表示数字

2.4 Host

匹配当前请求是否来自于设置的主机。

spring:
  cloud:
    gateway:
      routes:
      - id: nacos-consumer
          uri: lb://nacos-consumer  # lb://表示负载均衡
        predicates:
        - Host=**.code.com  #匹配上去的主机地址发来的请求

2.5 Method

可以设置一个或多个参数，匹配HTTP请求，比如GET、POST

          predicates:  #断言
            - Path=/consumer/**
            - Method=GET #匹配GET请求或者POST请求

2.6 Query

需要指定一个或者多个参数，一个必须参数和一个可选的正则表达式，匹配请求中是否包含第一个参数，如果有两个参数，则匹配请求中第一个参数的值是否符合正则表达式。

       predicates:  #断言
            - Path=/consumer/**
            - Query=id,.+ #匹配请求参数，这里如果需要匹配多个参数，可以写多个Query

2.7 Weight

需要两个参数group和weight(int)，实现了路由权重功能，按照路由权重选择同一个分组中的路由

spring:
  cloud:
    gateway:
      routes:
      - id: weight_high
        uri: https://weighthigh.org
        predicates:
        - Weight=group1, 8
      - id: weight_low
        uri: https://weightlow.org
        predicates:
        - Weight=group1, 2

该路由会将约 80% 的流量转发到weighthigh.o作，将约20%的流量转发到welghtlow.org

小结：

Predicate就是为了实现一组匹配规则，让请求过来找到对应的Route进行处理。

四、Filter

1.内置Filter

路由过滤器允许以某种方式修改传入的 HTTP 请求或传出的 HTTP 响应。路由过滤器的范围是特定的路由。Spring Cloud Gateway 包含许多内置的 GatewayFilter工厂。

Spring Cloud Gateway 中文文档

1.GateWay内置的Filter生命周期为两种:pre(业务逻辑之前)、post(业务逻辑之后)

2.GateWay本身自带的Filter分为两种:GateWayFilter(单一)、GlobalFilter(全局)

3.单一的有32种，全局的有9种

StripPrefix

该StripPrefix有一个参数，parts。该parts参数指示在将请求发送到下游之前要从请求中剥离的路径中的部分数。

spring:
  application:
    name: gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848  # Nacos地址正确
    gateway:
      discovery:
        locator:
          enabled: true #开启注册中心的路由
      routes:
        - id: nacos-consumer
          uri: lb://nacos-consumer  # lb://表示负载均衡
          predicates:  #断言
            - Path=/consumer/**
            - Method=post
          filters:
            - StripPrefix=1  # 去掉路径前缀/consumer

其实已经用了 StripPrefix 参数了。上面 Path 的配置。其实是当我们提交的请求

http://1ocalhost:9999/code/hello 会路由到 http://nacos-provider/code/hello 中。这里我们需要去掉 boge 这个信息。这时 stripPrefix 就能帮我们解决这个问题，去掉地址中的第一部分。得到的就是http://nacos-provider/hello 这个地址了

2.自定义过滤器

要实现GateWay自定义过滤器，那么我们需要实现两个接口

GlobalFilter
Ordered

首先我们新建一个类MyFiliter

@Component
public class MyFilter implements Ordered, GatewayFilter {
    /**
     * 针对特定请求触发后要执行的过滤逻辑
     * @param exchange
     * @param chain
     * @return
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //Pre处理
        String username = exchange.getRequest().getQueryParams().getFirst("username");
        if (username != null) {
            //如果没用传递改参数我们就拒绝该请求
            exchange.getResponse().setStatusCode(HttpStatus.NO_CONTENT);
            return exchange.getResponse().setComplete(); //设置响应完成 也就是在这个位置拦截了请求
        }
        Mono<Void> mono = chain.filter(exchange); //正常的就放过了
        //post处理
        return mono;
    }

    /**
     * 改过滤器在震哥哥过滤器链条中的加载顺序
     *  数字越小 优先级越高
     * @return
     */
    @Override
    public int getOrder() {
        return 0;
    }
}

Gateway