SpringCloud Alibaba实战和源码（4）GateWay网关

渔阳节度使

已于 2024-03-30 00:17:54 修改

阅读量139

点赞数

于 2023-07-08 15:13:46 首次发布

本文链接：https://blog.csdn.net/Forbidden_City/article/details/131611991

版权

springcloud 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

网关介绍

在微服架构中，一个系统会被拆分成多个微服务。如果没有网关的存在，只能在客户端记录每个微服的地址，然后分别去调用。这样会产生很多问题，例如：

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

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

Zuul 1.x
Netflix开源的网关，基于Servlet框架构建，功能丰富，使用JAVA开发，易于二次开发问题：即一个线程处理一次连接请求，这种方式在内部延迟严重、设备故障较多情况下会引起存活的连接增多和线程增加的情况发生。
Zuul 2.x
Zuul2 采用了Netty实现异步非阻塞编程模型，每个 CPU 核一个线程，处理所有的请求和响应，请求和响应的生命周期是通过事件和回调来处理的，这种方式减少了线程数量，因此开销较小。
GateWay
Spring公司为了替换Zuul而开发的网关服务，底层为Netty，将在下面具体介绍。
Nginx+lua
使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用，lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本，问题在于：无法融入到微服务架构中
Kong
基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。问题：只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。

GateWay
Spring Cloud GateWay基于Spring Boot 2.x 、Spring WebFlux和Project Reactor ，它旨在为微服架构提供一种简单有效的API路由管理的方式。目标是替代NetFlix Zuul，不仅提供统一的路由方式，并且基于Filter链的方式提供了网关基本的功能，例如：安全，监控和限流。

特点:
1.性能强劲：是Zuul的1.6倍
2.功能强大：内置了很多实用的功能，例如转发、监控、限流等
3.设计优雅，容易扩展

基本概念：
路由（Router）是gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面几个信息：
id：路由标识、区别于其他route
uri：路由指向的目的地uri，及客户端请求最终被转发到的微服
order：用于多个route之间的排序，数值越小排序越靠前，匹配优先级越高
predicate：断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由
filter：过滤器用于修改请求和响应信息

执行流程:
1.GateWay Client向Gateway Server发送请求
2.请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文
3.然后网关的上下文会被传递到DispatcherHandler，它负责将请求分发给RoutePredicateHandlerMapping
4.RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用
5.如果过断言成功，由FilteringWebHandler创建过滤器链并调用
6.请求会一次经过PreFilter-微服-PostFilter的方法，最终返回响应

总结：
SpringCloud GateWay使用的是Webflux中的reactor-netty响应式编程组件，底层使用了Netty通讯框架。

GateWay工作流程+GateWay搭建

核心流程
在这里插入图片描述
核心概念：
客户端向Spring Cloud GateWay发出请求后。如果GateWa Handler Mapping确定请求与路径匹配，则将其发送到Gateway Web Handler 处理程序。此处理程序通过特定于请求的Filter链运行请求。Fliter被虚线分隔的原因是Fliter可以在发送代理请求之前（pre）和之后（post）运行逻辑。执行所有pre过滤器逻辑。然后进行代理请求。发出代理请求后，将运行“post”过滤器逻辑。
过滤器作用：

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

核心点

Route（路由）
路由是构建网关的基础模块，由ID，目标URI，包括一些列的断言和过滤器组成，如果断言为true则匹配该路由
Predicate（断言）
参考的是jdk8的java.util.function.Predicate，开发人员看匹配Http请求中的所有内容（例如请求头或请求参数），请求与断言匹配则进行路由
Filter（过滤）
指的是Spring框架中GateWayFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。

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

总结
GateWay核心的流程就是：路由转发+执行过滤器链

GateWay搭建
在这里插入图片描述
因为GateWay输入SpringCloud的，所以我们要导入对应依赖，一定要注意版本关系：

版本对应地址：https://spring.io/projects/spring-cloud

老师这里使用的是SpringBoot2.2.6的版本所以配合的是SpringCloud的Hoxton.SR5版本

注意：引入GateWay一定要删除spring-boot-starter-web依赖，否则会有冲突无法启动

父级项目引入

<!--spring cloud Hoxton.SR5-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-dependencies</artifactId>
    <version>${spring-cloud-gateway-varsion}</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

子级项目，因为GateWay也需要注册进Nacos，所以也需要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-gateway</artifactId>
</dependency>

YML文件

server:
  port: 9999
spring:
  application:
    name: cloud-gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: true #开启注册中心路由功能
      routes:  # 路由
        - id: nacos-provider #路由ID，没有固定要求，但是要保证唯一，建议配合服务名
          uri: http://localhost:9001/nacos-provider # 匹配提供服务的路由地址(可以不加服务名)
          predicates: # 断言
            - Path=/gate/** # 断言，路径相匹配进行路由

9001的DemoController

@RestController
@RequestMapping("/gate")//路由路径
public class DemoController {
    @Value("${server.port}")
    private String serverPort;
    @GetMapping(value = "/get")
    public String getServerPort(){
        return "库存-1："+serverPort;
    }
}

在这里插入图片描述

配置路由的两种方式

实际上GateWay还提供了另外一种配置方式，也就是通过@Bean注入一个RouteLocator

@Configuration
public class GateWayConfig {
    /*
    配置了一个id为path_msb1的路由规则
    当访问地址http://localhost:9999/msb/**
    就会转发到http://localhost:9001/nacos-provider/msb/任何地址
     */

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        // 构建多个路由routes
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        // 具体路由地址
        routes.route("path_gate",r -> r.path("/gate/**").uri("http://localhost:9001/nacos-provider")).build();
        // 返回所有路由规则
        return routes.build();
    }
}

GateWay实现负载均衡

自动负载均衡

gateway.discovery.locator.enabled: true #开启自动路由功能

GateWay还提供了和Zuul类似的自动路由规则，具体配置如下：

discovery.locator.enabled: true #这个配置默认为false，但是如果为true，就是开启了通过serviceId转发到具体的服务实例。“localhost:端口号/ServiceID/**”
在配置好这些以后，我们可以直接通过服务名称来进行访问Nacos中注册的服务和对应的接口
这个位置我们为了测试可以启动2个微服务9001、9002
GateWay在开启了自动路由以后，还自带负载均衡

server:
  port: 9999
spring:
  application:
    name: cloud-gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: true #是否与服务发现组件进行结合，通过serviceId转发到具体的服务实例。默认为false，设为true便开启通过服务中心的自动根据 serviceId 创建路由的功能。

@RestController
public class DemoController {

    @Value("${server.port}")
    private String serverPort;

    @GetMapping(value = "/get")
    public String getServerPort(){
        return "Hello Nacos Discovery9001"+serverPort;
    }

    @GetMapping(value = "custom")
    public String customTest(){
        return "测试网关配置类~~custom";
    }
}

在这里插入图片描述

手动负载均衡

server:
  port: 9999
spring:
  application:
    name: cloud-gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: true #开启自动路由功能(此时可以关闭)
      routes:  # 路由
        - id: nacos-provider  #路由ID，没有固定要求，但是要保证唯一，建议配合服务名
          uri: lb://nacos-provider    # 匹配提供服务的路由地址
          predicates: #断言
            - Path=/** # 断言，路径相匹配进行路由

        - id: cloudalibaba-sentinel-service  #路由ID，没有固定要求，但是要保证唯一，建议配合服务名
          uri: lb://cloudalibaba-sentinel-service   #http://127.0.0.1:9001  #匹配提供服务的路由地址
          predicates: #断言
            - Path=/** # 断言，路径相匹配进行路由

在这里插入图片描述

GateWay断言Predicate

当满足条件后才会进行转发，如果十多个，那就是满足所有条件才会转发

断言种类

After：匹配在指定日期时间之后发生的请求。
Before：匹配在指定日期之前发生的请求。
Between：需要指定两个日期参数，设定一个时间区间，匹配此时间区间内的请求。
Cookie：需要指定两个参数，分别为name和regexp（正则表达式），也可以理解Key和Value，匹配具有给定名称且其值与正则表达式匹配的Cookie。
Header：需要两个参数header和regexp（正则表达式），也可以理解为Key和Value，匹配请求携带信息。
Host：匹配当前请求是否来自于设置的主机。
Method：可以设置一个或多个参数，匹配HTTP请求，比如GET、POST
Path：匹配指定路径下的请求，可以是多个用逗号分隔
Query：需要指定一个或者多个参数，一个必须参数和一个可选的正则表达式，匹配请求中是否包含第一个参数，如果有两个参数，则匹配请求中第一个参数的值是否符合正则表达式。
RemoteAddr：匹配指定IP或IP段，符合条件转发。

After

server:
  port: 9999
spring:
  application:
    name: cloud-gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: false # 是否与服务发现进行组合，通过ServiceID转发到具体的服务实例，默认为false，
                        # 设置为true便开启通过服务注册中心来自动根据SeviceID创建路由功能。
      routes:
        - id: nacos-provider # 路由ID，唯一不可重复，最好配合服务名
          uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
          predicates: # 断言
            - Path=/gate/** # 匹配对应地址
            - After=2023-07-10T15:07:33.767+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过，当前没有为题以后，故意改为1个小时以后

测试类，获取当前时间

	public static void main(String[] args) {
        ZonedDateTime zbj = ZonedDateTime.now();//默认时区
        System.out.println(zbj);
    }

在这里插入图片描述
剩下的关于日期时间的设置Before、Between道理都是一样的，只不过是限定不同的日期时间区间

- Between=2023-07-09T15:07:33.767+08:00[Asia/Shanghai],2023-08-09T15:07:33.767+08:00[Asia/Shanghai]

Cookie
需要指定两个参数，分别为name和regexp（正则表达式），可以理解Key和Value，匹配具有给定名称且其值与正则表达式匹配的Cookie。就是说路由规则会通过获取Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，如果匹配不上则不执行。

server:
  port: 9999
spring:
  application:
    name: cloud-gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: false # 是否与服务发现进行组合，通过ServiceID转发到具体的服务实例，默认为false，
                        # 设置为true便开启通过服务注册中心来自动根据SeviceID创建路由功能。
      routes:
        - id: nacos-provider # 路由ID，唯一不可重复，最好配合服务名
          uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
          predicates: # 断言
            - Path=/gate/** # 匹配对应地址
            - Cookie=username,[a-z]+ # 匹配Cookie的key和value（正则表达式）

Header
需要两个参数header和regexp（正则表达式），也可以理解为Key和Value，匹配请求携带信息。
实际上就是请求头携带的信息

            - Header=X-Request-Id,\d+ #表示数字

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

- Host=**.yuyang.com #匹配当前的主机地址发出的请求

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

- Method=GET,POST # 匹配GET请求或者POST请求

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

 - Query=id,.+ # 匹配请求参数，这里如果需要匹配多个参数，可以写多个Query

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

GateWay的Filter

内置Filter

GateWay内置的Filter生命周期为两种：pre（业务逻辑之前）、post（业务逻辑之后）
GateWay本身自带的Filter分为两种： GateWayFilter（单一）、GlobalFilter（全局）
单一的有32种，全局的有9种
官方网址：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters
StripPrefix
该StripPrefix有一个参数，parts。该parts参数指示在将请求发送到下游之前要从请求中剥离的路径中的部分数。
例子：

server:
  port: 9001
  servlet:
    context-path: /nacos-provider

gateway网关配置

server:
  port: 9999
spring:
  application:
    name: cloud-gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: false # 是否与服务发现进行组合，通过ServiceID转发到具体的服务实例，默认为false，
                        # 设置为true便开启通过服务注册中心来自动根据SeviceID创建路由功能。
      routes:
        - id: nacos-provider # 路由ID，唯一不可重复，最好配合服务名
          uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
          predicates: # 断言
            - Path=/gate/** # 匹配对应地址

在这里插入图片描述
解决方法，在转发的时候去地址中最前面的/gate，所以就需要使用FIlter：StripPrefix

server:
  port: 9999
spring:
  application:
    name: cloud-gateway-service
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      discovery:
        locator:
          enabled: false # 是否与服务发现进行组合，通过ServiceID转发到具体的服务实例，默认为false，
                        # 设置为true便开启通过服务注册中心来自动根据SeviceID创建路由功能。
      routes:
        - id: nacos-provider # 路由ID，唯一不可重复，最好配合服务名
          uri: lb://nacos-provider # 匹配提供服务的路由地址 lb://代表开启负载均衡
          predicates: # 断言
            - Path=/gate/** # 匹配对应地址
          filters:
            - StripPrefix=1 # 去掉地址中的第一部分

在这里插入图片描述
自定义Filter
要实现GateWay自定义过滤器，需要实现两个接口

GlobalFilter
Ordered

@Component
@Slf4j
public class MyFilter implements Ordered, GlobalFilter {
    /**
     * @param exchange 可以拿到对应的request和response
     * @param chain 过滤器链
     * @return 是否放行
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String username = exchange.getRequest().getQueryParams().getFirst("username");
        log.info("*************MyFilter:"+new Date());
        if(username == null){
            log.info("**********用户名为null，非法用户，请求被拒绝！");
            //如果username为空，返回状态码为406，不可接受的请求
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        //放行
        return chain.filter(exchange);
    }

    /**
     * 加载过滤器的顺序
     * @return 整数数字越小优先级越高
     */
    @Override
    public int getOrder() {
        return 0;
    }
}

传入正确参数：
在这里插入图片描述
未传入正确参数：

渔阳节度使

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
SpringCloud Alibaba实战和源码（4）GateWay网关

目标是替代NetFlix Zuul，不仅提供统一的路由方式，并且基于Filter链的方式提供了网关基本的功能，例如：安全，监控和限流。为解决上面的问题所以引入了网关的概念：所谓的API网关，就是指系统的统一入口，提供内部服务的路由中转，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、路由转发等。predicate：断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由。uri：路由指向的目的地uri，及客户端请求最终被转发到的微服。
复制链接

扫一扫