深入浅出 Gateway

悟空约 3753 字大约 13 分钟...

深入浅出 Gateway

1. 网关简介

大家都都知道在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端（pc androud ios 平板）要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。 axios.get(ip:port/url) axios.get(ip:port/url)

这样的架构，会存在着诸多的问题：

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

（跨域: 浏览器的 ajax 从一个地址访问另一个地址：

协议://ip:port 如果三则有一个不同，则会出现跨域问题。

http://192.168.10.11:8080open in new window ----->https://192.168.10.11:8080open in new window

http://127.0.0.1:8080--->http://localhost:8080open in new window 跨域

上面的这些问题可以借助 API网关来解决。

所谓的 API 网关，就是指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控（黑白名单）、路由转发等等。添加上 API 网关之后，系统的架构图变成了如下所示：

在业界比较流行的网关，有下面这些：

Ngnix+lua

使用 nginx 的反向代理和负载均衡可实现对 api 服务器的负载均衡及高可用

lua 是一种脚本语言, 可以来编写一些简单的逻辑, nginx 支持 lua 脚本

Kong

基于 Nginx+Lua 开发，性能高，稳定，有多个可用的插件 (限流、鉴权等等) 可以开箱即用。问题：

只支持 Http 协议；二次开发，自由扩展困难；提供管理 API，缺乏更易用的管控、配置方式。

Zuul 1.0（慢 servlet 2.0 ） zuul2.0 没出来。

Netflix 开源的网关，功能丰富，使用 JAVA 开发，易于二次开发问题：缺乏管控，无法动态配

置；依赖组件较多；处理 Http 请求依赖的是 Web 容器，性能不如 Nginx

Spring Cloud Gateway

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

注意：SpringCloud alibaba 技术栈中并没有提供自己的网关，我们可以采用 Spring Cloud Gateway 来做网关

2. Gateway 简介

Spring Cloud Gateway 是 Spring 公司基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代 Netflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。

优点：

性能强劲：是第一代网关 Zuul 的 1.6 倍
功能强大：内置了很多实用的功能，例如转发、监控、限流等
设计优雅，容易扩展

缺点：

其实现依赖 Netty 与 WebFlux，不是传统的 Servlet 编程模型，学习成本高
不能将其部署在 Tomcat、Jetty 等 Servlet 容器里，只能打成 jar 包执行 web.Jar
需要 Spring Boot 2.0 及以上的版本，才支持

3.Gateway 快速入门

3.1 创建一个 my-gateway 的工程并加入依赖

3.2 创建启动类

3.3 修改配置文件

server:
  port: 8000

spring:
  nacos:
    server-addr: localhost:8848
    application:
      name: my-gateway
  cloud:
    gateway:
      routes:
        - id: shop-product
          uri: lb://shop-product
          order: 0
          predicates:
            - Path=/product/**
#            - After=2020-12-31T23:59:59.789+08:00[Asia/Shanghai]
#            - Header=token, \d+
            #- Age=18,50
          filters:
#            - SetStatus=700
#            - StripPrefix=1

        - id: shop-order
          uri: lb://shop-order
          order: 0
          predicates:
             - Path=/order/**

3.4 测试

4. 增强版

现在在配置文件中写死了转发路径的地址, 前面我们已经分析过地址写死带来的问题, 接下来我们从注册中心获取此地址。

4.1 加入 nacos 依赖

4.2 在主启动类上加入服务发现的注解

4.3 修改 application.yml 的配置文件

5. 简写版

5.1 修改 application.yml 的配置文件

server:
port: 8000

spring:
cloud:
gateway:
discovery:
locator:
enabled: true
nacos:
server-addr: localhost:8848
application:
name: my-gateway

6. 基本概念

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

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

6.1 执行流程

执行流程大体如下：

\1. Gateway Client 向 Gateway Server 发送请求

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

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

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

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

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

6.2 断言

Predicate(断言, 谓词) 用于进行条件判断，只有断言都返回真，才会真正的执行路由。

断言就是说: 在什么条件下才能进行路由转发

6.3 内置路由断言工厂

SpringCloud Gateway 包括许多内置的断言工厂，所有这些断言都与 HTTP 请求的不同属性匹配体如下：

基于 Datetime 类型的断言工厂
此类型的断言根据时间做判断，主要有三个：

AfterRoutePredicateFactory：接收一个日期参数，判断请求日期是否晚于指定日期

BeforeRoutePredicateFactory：接收一个日期参数，判断请求日期是否早于指定日期

BetweenRoutePredicateFactory：接收两个日期参数，判断请求日期是否在指定时间段内

-After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]

基于远程地址的断言工厂 RemoteAddrRoutePredicateFactory：
接收一个 IP 地址段，判断请求主机地址是否在地址段中

-RemoteAddr=192.168.1.1/24

基于 Cookie 的断言工厂
CookieRoutePredicateFactory：接收两个参数，cookie 名字和一个正则表达式。判断请求

cookie 是否具有给定名称且值与正则表达式匹配。

-Cookie=chocolate, ch.

基于 Header 的断言工厂
HeaderRoutePredicateFactory：接收两个参数，标题名称和正则表达式。判断请求 Header 是否

具有给定名称且值与正则表达式匹配。 key value

-Header=X-Request-Id, \d+

基于 Host 的断言工厂
HostRoutePredicateFactory：接收一个参数，主机名模式。判断请求的 Host 是否满足匹配规则。

-Host=**.testhost.org

基于 Method 请求方法的断言工厂
MethodRoutePredicateFactory：接收一个参数，判断请求类型是否跟指定的类型匹配。

-Method=GET

基于 Path 请求路径的断言工厂
PathRoutePredicateFactory：接收一个参数，判断请求的 URI 部分是否满足路径规则。

-Path=/foo/{segment} 基于 Query 请求参数的断言工厂

QueryRoutePredicateFactory ：接收两个参数，请求 param 和正则表达式，判断请求参数是否具

有给定名称且值与正则表达式匹配。

-Query=baz, ba.

基于路由权重的断言工厂
WeightRoutePredicateFactory：接收一个 [组名, 权重], 然后对于同一个组内的路由按照权重转发

routes:

-id: weight_route1 uri: host1 predicates:

-Path=/product/**

-Weight=group3, 1

-id: weight_route2 uri: host2 predicates:

-Path=/product/**

-Weight= group3, 9

内置路由断言工厂的使用

7. 自定义路由断言工厂

7.1 在配置文件中, 添加一个 Age 的断言配置

7.2 自定义一个断言工厂, 实现断言方法

package com.yyh.gateway.predicates;

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.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.server.ServerWebExchange;

import javax.validation.constraints.NotNull;
import java.time.ZonedDateTime;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;

/**
 * @program: springcloud-parent
 * @description: 自定义断言
 * @author:
 * @create: 2021-07-08 16:06
 **/
@Component
public class AgeRoutePredicateFactory extends AbstractRoutePredicateFactory<AgeRoutePredicateFactory.Config> {
    public AgeRoutePredicateFactory() {
        super(AgeRoutePredicateFactory.Config.class);
    }

    public List<String> shortcutFieldOrder() {
        return Arrays.asList("minAge", "maxAge");
    }

    public Predicate<ServerWebExchange> apply(AgeRoutePredicateFactory.Config config) {
        return new GatewayPredicate() {
            public boolean test(ServerWebExchange serverWebExchange) {
                ServerHttpRequest request=serverWebExchange.getRequest();
                String age = request.getQueryParams().getFirst("age");
                if(StringUtils.isEmpty(age)){
                    return false;
                }else {
                    Integer a=Integer.parseInt(age);
                    if(a>= config.getMinAge()&&a<= config.getMaxAge()){
                        return true;
                    }else {
                        return false;
                    }
                }

            }
        };
    }

    @Validated
    public static class Config {
        @NotNull
        private Integer minAge;
        @NotNull
        private Integer maxAge;

        public Integer getMinAge() {
            return minAge;
        }

        public void setMinAge(Integer minAge) {
            this.minAge = minAge;
        }

        public Integer getMaxAge() {
            return maxAge;
        }

        public void setMaxAge(Integer maxAge) {
            this.maxAge = maxAge;
        }
    }
}

7.3 测试

8. 过滤器

1 作用: 过滤器就是在请求的传递过程中, 对请求和响应做一些手脚

2 生命周期: Pre Post

3 分类: 局部过滤器 (作用在某一个路由上) 全局过滤器 (作用全部路由上)

在 Gateway 中, Filter 的生命周期只有两个：“pre” 和 “post”。

PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的 HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

Gateway 的 Filter 从作用范围可分为两种: GatewayFilter 与 GlobalFilter。

GatewayFilter：应用到单个路由或者一个分组的路由上。
GlobalFilter：应用到所有的路由上。

8.1 内置局部过滤器

在 SpringCloud Gateway 中内置了很多不同类型的网关路由过滤器。

Spring Cloud Gateway 内置的过滤器工厂open in new window

这里简单将 Spring Cloud Gateway 内置的所有过滤器工厂整理成了一张表格。如下：

过滤器工厂	作用	参数
AddRequestHeader	为原始请求添加 Header	Header 的名称及值
AddRequestParameter	为原始请求添加请求参数	参数名称及值
AddResponseHeader	为原始响应添加 Header	Header 的名称及值
DedupeResponseHeader	剔除响应头中重复的值	需要去重的 Header 名称及去重策略
Hystrix	为路由引入 Hystrix 的断路器保护 HystrixCommand 的名称
FallbackHeaders	为 fallbackUri 的请求头中添加具体的异常信息	Header 的名称
PrefixPath	为原始请求路径添加前缀	前缀路径
PreserveHostHeader	为请求添加一个 preserveHostHeader=true 的属性，路由过滤器会检查该属性以决定是否要发送原始的 Host	无
RequestRateLimiter	用于对请求限流，限流算法为令牌桶	keyResolver、rateLimiter、statusCode、denyEmptyKey、emptyKeyStatus
RedirectTo	将原始请求重定向到指定的 URL	http 状态码及重定向的 url
RemoveHopByHopHeadersFilter	为原始请求删除 IETF 组织规定的一系列 Header	默认就会启用，可以通过配置指定仅删除哪些 Header
RemoveRequestHeader	为原始请求删除某个 Header	Header 名称
RemoveResponseHeader	为原始响应删除某个 Header	Header 名称
RewritePath	重写原始的请求路径	原始路径正则表达式以及重写后路径的正则表达式
RewriteResponseHeader	重写原始响应中的某个 Header	Header 名称，值的正则表达式，重写后的值
SaveSession	在转发请求之前，强制执行 WebSession::save 操作	无
secureHeaders	为原始响应添加一系列起安全作用的响应头	无，支持修改这些安全响应头的值
SetPath	修改原始的请求路径	修改后的路径
SetResponseHeader	修改原始响应中某个 Header 的值	Header 名称，修改后的值
SetStatus	修改原始响应的状态码	HTTP 状态码，可以是数字，也可以是字符串
StripPrefix	用于截断原始请求的路径	使用数字表示要截断的路径的数量
Retry	针对不同的响应进行重试	retries、statuses、methods、series
RequestSize	设置允许接收最大请求包的大小。如果请求包大小超过设置的值，则返回 413 Payload Too Large	请求包大小，单位为字节，默认值为 5M
ModifyRequestBody	在转发请求之前修改原始请求体内容	修改后的请求体内容
ModifyResponseBody	修改原始响应体的内容	修改后的响应体内容
Default	为所有路由添加过滤器	过滤器工厂名称及值

当客户端第一次请求服务时，服务端对用户进行信息认证（登录）
认证通过，将用户信息进行加密形成 token，返回给客户端 aaaa，作为登录凭证
以后每次请求，客户端都携带认证的 token
服务端对 token 进行解密，判断是否有效。

如上图，对于验证用户是否已经登录鉴权的过程可以在网关统一检验。

检验的标准就是请求中是否携带 token 凭证以及 token 的正确性

9.3 例子

下面的我们自定义一个 GlobalFilter，去校验所有请求的请求参数中是否包含 “token”，如何不包含请求参数“token” 则不转发路由，否则执行正常的逻辑

自定义全局过滤器要求：必须实现 GlobalFilter,Order 接口

package com.yyh.gateway.filter;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * @program: springcloud-parent
 * @description: 登录的全局过滤器
 * @author: 苑银辉
 * @create: 2021-07-08 16:51
 **/
@Component
public class LoginFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request= exchange.getRequest();
        String token = request.getHeaders().getFirst("token");
        if(!StringUtils.isEmpty(token)){
            if("admin".equals(token)){
                return chain.filter(exchange);
            }
        }
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        return exchange.getResponse().setComplete();
    }

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

测试

原文：https://blog.csdn.net/qq_43747175/article/details/118581655open in new window

昵称

邮箱

网址

按正序
按倒序
按热度

深入浅出 Gateway

深入浅出 Gateway

1. 网关简介

2. Gateway 简介

3.Gateway 快速入门

3.1 创建一个 my-gateway 的工程并加入依赖

3.2 创建启动类

3.3 修改配置文件

3.4 测试

4. 增强版

4.1 加入 nacos 依赖

4.2 在主启动类上加入服务发现的注解

4.3 修改 application.yml 的配置文件

5. 简写版

5.1 修改 application.yml 的配置文件

6. 基本概念

6.1 执行流程

6.2 断言

6.3 内置路由断言工厂

7. 自定义路由断言工厂

7.1 在配置文件中, 添加一个 Age 的断言配置

7.2 自定义一个断言工厂, 实现断言方法

7.3 测试

8. 过滤器

8.1 内置局部过滤器

8.2 内置局部过滤器的使用

8.3 测试

9. 全局过滤器

9.1 内置全局过滤器

9.2 自定义全局过滤器

9.3 例子

预览: