【SpringCloud12】Gateway服务网关

阿里云国内75折回扣微信号：monov8

阿里云国际，腾讯云国际，低至75折。AWS 93折免费开户实名账号代冲值优惠多多微信号：monov8 飞机：@monov6

1.概述简介

1.1官网

1.2是什么

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

Gateway是在Spring生态系统之上构建的API网关服务基于Spring 5Spring Boot 2和 Project Reactor等技术。Gateway旨在提供一种简单而有效的方式来对API进行路由以及提供一些强大的过滤器功能例如熔断、限流、重试等

概述

在这里插入图片描述
SpringCloud Gateway 是 Spring Cloud 的一个全新项目基于 Spring 5.0+Spring Boot 2.0 和 Project Reactor 等技术开发的网关它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

SpringCloud Gateway 作为 Spring Cloud 生态系统中的网关目标是替代 Zuul在Spring Cloud 2.0以上版本中没有对新版本的Zuul 2.0以上最新高性能版本进行集成仍然还是使用的Zuul 1.x非Reactor模式的老版本。而为了提升网关的性能SpringCloud Gateway是基于WebFlux框架实现的而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。

Spring Cloud Gateway的目标提供统一的路由方式且基于 Filter 链的方式提供了网关基本的功能例如安全监控/指标和限流。

概括 SpringCloud Gateway 使用的Webflux中的reactor-netty响应式编程组件底层使用了Netty通讯框架。

源码架构

1.3作用

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

1.4微服务架构中网关在哪里

1.5有Zuul为什么还会有Gateway

1.5.1 为什么选择Gateway

1.neflix不太靠谱zuul2.0一直跳票迟迟不发布。

一方面因为Zuul1.0已经进入了维护阶段而且Gateway是SpringCloud团队研发的是亲儿子产品值得信赖。而且很多功能Zuul都没有用起来也非常的简单便捷。
Gateway是基于异步非阻塞模型上进行开发的性能方面不需要担心。虽然Netflix早就发布了最新的 Zuul 2.x但 Spring Cloud 貌似没有整合计划。而且Netflix相关组件都宣布进入维护期不知前景如何
多方面综合考虑Gateway是很理想的网关选择。

2.SpringCloud Gateway的特性

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

3.SpringCloud Gateway与Zuul的区别

在SpringCloud Finchley 正式版之前Spring Cloud 推荐的网关是 Netflix 提供的Zuul

Zuul 1.x是一个基于阻塞 I/ O 的 API Gateway
Zuul 1.x 基于Servlet 2. 5使用阻塞架构它不支持任何长连接(如 WebSocket) Zuul 的设计模式和Nginx较像每次 I/ O 操作都是从工作线程中选择一个执行请求线程被阻塞到工作线程完成但是差别是Nginx 用C++ 实现Zuul 用 Java 实现而 JVM 本身会有第一次加载较慢的情况使得Zuul 的性能相对较差。
Zuul 2.x理念更先进想基于Netty非阻塞和支持长连接但SpringCloud目前还没有整合。 Zuul 2.x的性能较 Zuul 1.x 有较大提升。在性能方面根据官方提供的基准测试 Spring Cloud Gateway 的 RPS每秒请求数是Zuul 的 1. 6 倍。
Spring Cloud Gateway 建立在 Spring Framework 5、 Project Reactor 和 Spring Boot 2 之上使用非阻塞 API。
Spring Cloud Gateway 还支持 WebSocket 并且与Spring紧密集成拥有更好的开发体验

1.5.2 Zuul1.x模型

Springcloud中所集成的Zuul版本采用的是Tomcat容器使用的是传统的Servlet IO处理模型

学过尚硅谷web中期课程都知道一个题目Servlet的生命周期

回答 servlet由servlet container进行生命周期管理container启动时构造servlet对象并调用servlet init()进行初始化container运行时接受请求并为每个请求分配一个线程一般从线程池中获取空闲线程然后调用service()
container关闭时调用servlet destory()销毁servlet

在这里插入图片描述
上述模式的缺点

servlet是一个简单的网络IO模型当请求进入servlet container时servlet container就会为其绑定一个线程在并发不高的场景下这种模型是适用的。但是一旦高并发(比如抽风用jemeter压)线程数量就会上涨而线程资源代价是昂贵的上线文切换内存消耗大严重影响请求的处理时间。在一些简单业务场景下不希望为每个request分配一个线程只需要1个或几个线程就能应对极大并发的请求这种业务场景下servlet模型没有优势。
所以Zuul 1.X是基于servlet之上的一个阻塞式处理模型即spring实现了处理所有request请求的一个servletDispatcherServlet并由该servlet阻塞式处理处理。所以Springcloud Zuul无法摆脱servlet模型的弊端

1.5.3 Gateway模型

问题 WebFlux是什么
官网
说明传统的Web框架比如说struts2springmvc等都是基于Servlet API与Servlet容器基础之上运行的。

但是在Servlet3.1之后有了异步非阻塞的支持。而WebFlux是一个典型非阻塞异步的框架它的核心是基于Reactor的相关API实现的。相对于传统的web框架来说它可以运行在诸如NettyUndertow及支持Servlet3.1的容器上。非阻塞式+函数式编程Spring5必须让你使用java8

Spring WebFlux 是 Spring 5.0 引入的新的响应式框架区别于 Spring MVC它不需要依赖Servlet API它是完全异步非阻塞的并且基于 Reactor 来实现响应式流规范。
在这里插入图片描述

2.三大核心概念

2.1Route路由

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

2.2 Predicate断言

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

2.3 Filter过滤

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

2.4 总体

在这里插入图片描述

web请求通过一些匹配条件定位到真正的服务节点。并在这个转发过程的前后进行一些精细化控制。
predicate就是我们的匹配条件而filter就可以理解为一个无所不能的拦截器。有了这两个元素再加上目标uri就可以实现一个具体的路由了

3.Gateway工作流程

3.1官网总结

在这里插入图片描述

客户端向 Spring Cloud Gateway 发出请求。然后在 Gateway Handler Mapping 中找到与请求相匹配的路由将其发送到 Gateway Web Handler。
Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑然后返回。
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前“pre”或之后“post”执行业务逻辑。
Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等。
在“post”类型的过滤器中可以做响应内容、响应头的修改日志的输出流量监控等有着非常重要的作用

3.2核心逻辑

路由转发+执行过滤器链

4.入门配置

4.1新建cloud-gateway-gateway9527

4.2POM

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.atguigu.springcloud</groupId>
        <artifactId>cloud2022</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>cloud-gateway-gateway9527</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!--gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--eureka-client-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- 引入自己定义的api通用包可以使用Payment支付Entity -->
        <dependency>
            <groupId>com.atguigu.springcloud</groupId>
            <artifactId>cloud-api-common</artifactId>
            <version>${project.version}</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>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    
</project>

注意getway不需要下述两个pom依赖否则会报错
错误信息 Parameter 0 of method modifyResponseBodyGatewayFilterFactory in org.springframework.cloud.gateway.config.GatewayAutoConfiguration required a bean of type 'org.springframework.http.codec.ServerCodecConfigurer' that could not be found.

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

4.3YML

server:
  port: 9527

spring:
  application:
    name: cloud-gateway

eureka:
  instance:
    hostname: cloud-gateway-service
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

4.4业务类

无需配置网关无需业务类

4.5主启动类

package com.atguigu.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

/**
 * 简要描述
 *
 * @Author: ASuLe
 * @Date: ${DATE} ${TIME}
 * @Version: 1.0
 * @Description: 文件作用详细描述....
 */
@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9527 {
    public static void main(String[] args) {
        SpringApplication.run(GateWayMain9527.class,args);
    }
}

4.7 9527网关如何做路由映射

cloud-provider-payment8001查看controller的访问地址
- get
- lb
我们不想暴露8001端口希望在8001外面套一层9527

4.8YML新增网关配置

YML新增配置

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

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

在这里插入图片描述
更新后的YML文件

server:
  port: 9527

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

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

eureka:
  instance:
    hostname: cloud-gateway-service
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

注意routes是复数可以为某个controller里面的所有rest接口都可以做路由

4.9测试

4.9.1 启动7001

4.9.2 启动8001

cloud-provider-payment8001微服务

4.9.3 启动9527网关

在这里插入图片描述

4.9.4 访问说明

添加网关前访问http://localhost:8001/payment/get/1
在这里插入图片描述

添加网关后访问http://localhost:9527/payment/get/1
在这里插入图片描述
测试lb方法
添加网关前访问http://localhost:8001/payment/lb

添加网关后访问http://localhost:9527/payment/get/1

在这里插入图片描述

4.10 YML配置说明

Gate网关路由配置有两种方式

4.10.1在配置文件yml中配置上述方法

4.10.2 代码中注入RouteLocation的Bean

官网案例懵逼
github网址https://github.com/

通过9527网关访问到外网的百度新闻网址
编码配置类config实现不在yml配置了

package com.atguigu.springcloud.config;

import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 简要描述
 *
 * @Author: ASuLe
 * @Date: 2023/1/15 16:14
 * @Version: 1.0
 * @Description: 文件作用详细描述....
 */
@Configuration
public class GateConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        RouteLocatorBuilder.Builder routes = builder.routes();

        //相当于访问localhost:9527/github会映射到https://github.com/网址
        routes.route("path_route_atguigu",
                r -> r.path("/github")
                        .uri("https://github.com/")).build();

        return routes.build();
    }

}

在这里插入图片描述

5.通过微服务名实现动态路由

问题1 之前的IP是写死的
问题2 服务提供者不可能只有一台机器所以要实现负载均衡

在这里插入图片描述
默认情况下Gateway会根据注册中心注册的服务列表以注册中心上微服务名为路径创建动态路由进行转发从而实现动态路由的功能

5.1 启动

一个eureka7001 + 两个服务提供者8001/8002

5.2 POM

加入POM,这里之前就已经加过了

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

5.3 YML

需要注意的是uri的协议为lb表示启用Gateway的负载均衡功能
将网关中配置中的uri替换成匹配后提供服务的路由地址
uri: lb://serviceName是Spring Cloud Gateway在微服务中自动为我们创建的负载均衡uri
在这里插入图片描述

并开启从注册中心动态创建路由的功能

gateway:
      discovery:
        locator:
          enabled: true #开启从注册中心动态创建路由的功能利用微服务名进行路由

在这里插入图片描述

5.4 测试

测试网址 http://localhost:9527/payment/lb
会看到8001/8002端口切换

第一次测试
在这里插入图片描述
第二次测试

6.Predicate的使用

6.1 是什么

启动gatway9527后台日志会出现
在这里插入图片描述

6.2 上述图中的RoutePredicateFactories是什么

首先看官网
在这里插入图片描述

Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。
Spring Cloud Gateway包括许多内置的Route Predicate工厂所有这些Predicate都与HTTP请求的不同属性匹配多个Route Predicate工厂可以进行组合
Spring Cloud Gateway 创建 Route 对象时使用 RoutePredicateFactory 创建 Predicate 对象Predicate 对象可以赋值给 Route。 Spring Cloud Gateway 包含许多内置的Route Predicate Factories。
所有这些谓词都匹配HTTP请求的不同属性。多种谓词工厂可以组合并通过逻辑and。

6.3 常用的Route Predicate

在这里插入图片描述

6.3.1 After Route Predicate

在这里插入图片描述

问题如何获得此格式的时间

创建一个测试类和配置类

import java.time.ZonedDateTime;

/**
 * 简要描述
 *
 * @Author: ASuLe
 * @Date: 2023/1/15 17:02
 * @Version: 1.0
 * @Description: 文件作用详细描述....
 */
public class T2 {
    public static void main(String[] args) {
        ZonedDateTime zbj = ZonedDateTime.now();
        System.out.println(zbj);
    }
}

在这里插入图片描述
运行结果

2023-01-15T17:04:35.870+08:00[Asia/Shanghai]

在这里插入图片描述
使用上述时间测试结果没问题

将上述时间增加一个小时

此时的意思是时间要在设置的时间之后并且地址匹配才能正常访问此时访问应该报错

在这里插入图片描述

使用场景 比如说做一个系统一次次的系统迭代上线了要求什么时候才启动

6.3.2 Before Route Predicate

在这里插入图片描述

6.3.3 Between Route Predicate

在这里插入图片描述

6.3.4 Cookie Route Predicate

在这里插入图片描述

Cookie Route Predicate需要两个参数一个是 Cookie name一个是正则表达式
路由规则会通过获取对应的 Cookie name 值和正则表达式去匹配如果匹配上就会执行路由如果没有匹配上则不执行

测试工具

在这里插入图片描述

YML
在这里插入图片描述

不带cookies访问
cmd中执行命令 curl http://localhost:9527/payment/lb相当于只发了get请求没有带cookie
在这里插入图片描述

带cookies访问curl http://localhost:9527/payment/lb --cookie "username=asule"
在这里插入图片描述

6.3.5 Header Route Predicate

在这里插入图片描述
两个参数一个是属性名称和一个正则表达式这个属性值和正则表达式匹配则执行

在cmd中访问curl http://localhost:9527/payment/lb -H "X-Request-Id:123"

正数返回正确curl http://localhost:9527/payment/lb -H "X-Request-Id:123"
在这里插入图片描述

负数返回失败curl http://localhost:9527/payment/lb -H "X-Request-Id:-1"
在这里插入图片描述

6.3.6 Host Route Predicate

在这里插入图片描述

Host Route Predicate 接收一组参数一组匹配的域名列表这个模板是一个 ant 分隔的模板用.号作为分隔符
它通过参数中的主机地址作为匹配规则

在这里插入图片描述

在cmd中访问 curl http://localhost:9527/payment/lb -H "Host: www.atguigu.com"

带有Host测试成功 curl http://localhost:9527/payment/lb -H "Host: www.atguigu.com"
在这里插入图片描述

不带有Host测试失败 curl http://localhost:9527/payment/lb
在这里插入图片描述

6.3.7 Method Route Predicate

在这里插入图片描述

在cmd中访问 curl http://localhost:9527/payment/lb

Get请求测试成功 curl http://localhost:9527/payment/lb
在这里插入图片描述

POST请求测试失败 curl -X POST http://localhost:9527/payment/lb
在这里插入图片描述

6.3.8 Path Route Predicate

在这里插入图片描述

6.3.9 Query Route Predicate

在这里插入图片描述

在cmd中访问 curl http://localhost:9527/payment/lb?username=1

有username且值为正数测试成功 curl http://localhost:9527/payment/lb?username=1
在这里插入图片描述

有username且值为负数测试失败 curl http://localhost:9527/payment/lb?username=-1
在这里插入图片描述

没有username测试失败 curl http://localhost:9527/payment/lb
在这里插入图片描述

6.3.10 小总结

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

7.Filter的使用

7.1 是什么

在这里插入图片描述

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

7.2 Spring Cloud Gateway的Filter

7.2.1 两个生命周期

pre
post

7.2.2 种类

GatewayFilter
照着官网尝试有31种之多
GlobalFilter

7.3常用的Gateway Filter

添加AddRequestParameter配置

在这里插入图片描述

7.4 自定义过滤器

7.4.1 两个主要接口介绍

implements GlobalFilter,Ordered

7.4.2 作用

全局日志记录
统一网关鉴权
…

7.4.3案例代码

package com.atguigu.springcloud.filter;

import lombok.extern.slf4j.Slf4j;
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.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.Date;

/**
 * 简要描述
 *
 * @Author: ASuLe
 * @Date: 2023/1/15 18:14
 * @Version: 1.0
 * @Description: 文件作用详细描述....
 */
@Component
@Slf4j
public class MyLogGatewayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("****************come 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);
    }

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