时间戳

首页 > 技术文章 > SpringCloud入门 服务网关 Gateway

SpringCloud入门 服务网关 Gateway

naimao 2020-09-04 15:34 原文

服务网关

zuul路由网关，内部出问题，建议不再使用。zuul原始开发人员被挖走了，zuul2中开发人员出现分歧。。。

学习方式：image-20200827151840744

Gateway新一代网关，主要这个！

Gateway是什么？

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

官方文档https://docs.spring.io/spring-cloud-gateway/docs/2.2.4.RELEASE/reference/html/

image-20200827152713386

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

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

SpringCloud Gateway是Spring Cloud的一个全新项目，基于Spring 5.0+Spring Boot2.0和Project Reactor等技术开发的网关，它旨在为微服务架构提供—种简单有效的统一的API路由管理方式。

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

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

搜索 B站 韩顺平 netty·~~~~~

能干嘛？

image-20200827153136726

微服务结构中网关的位置

image-20200827153200150

2、Gateway非阻塞异步模型

我们为什么选择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 Boot2.0进行构建;
动态路由:能够匹配任何请求属性;
可以对路由指定Predicate(断言）和Filter(过滤器）﹔
集成Hystrix的断路器功能;
集成Spring Cloud 服务发现功能;
易于编写的Predicate(断言）和Filter(过滤器）;
请求限流功能;
支持路径重写。

3、SpringCloud Gateway与Zuul的区别

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

1、Zuul 1.x，是一个基于阻塞1O的API Gateway

2、Zuul 1.x基于Servlet2.5使用阻塞架构它不支持任何长连接(如WebSocket)Zuul的设计模式和Nginx较像，每次VО操作都是从工作线程中选择一个执行，请求线程被阻塞到工作线程完成，但是差别是Nginx用C++实现，Zuul用Java实现，而VM本身会有第
—次加载较慢的情况，使得Zuul的性能相对较差。

3、Zuul 2.x理念更先进，想基于Netty非阻塞和支持长连接，但SpringCloud目前还没有整合。Zul 2x的性能较Zuul 1.x有较大提升
。在性能方面，根据官方提供的基准测试，Spring Cloud Gateway的RPS(每秒请求数）是Zuul的1.6倍。

4、Spring Cloud Gateway建立在Spring Framework 5、Project Reactor和Spring Boot2之上，使用非阻塞API。

5、Spring Cloud Gateway还支持WebSocket，并且与Spring紧密集成拥有更好的开发体验

Zuul的模型

Springcloud中所集成的Zuul版本，采用的是Tomcat容器，使用的是传统的Servlet IO处理模型。
学过尚硅谷web中期课程都知道一个题目，Servlet的生命周期?servlet由servlet container进行生命周期管理.
container启动时构造servlet对象并调用servlet init(进行初始化;
container运行时接受请求，并为每个请求分配一个线程（一般从线程池中获取空闲线程）然后调用service).
container关闭时调用servlet destory0销毁servlet;

image-20200827154424697

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

Gateway模型

WebFlux是什么？

查看官网：https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html#spring-webflux

Spring框架中包含的原始Web框架Spring Web MVC是专门为Servlet API和Servlet容器而构建的。反应性堆栈Web框架Spring WebFlux在更高版本5.0中添加。它是完全非阻塞的，支持 Reactive Streams背压，并在Netty，Undertow和Servlet 3.1+容器等服务器上运行。
这两个Web框架均反映了其源模块的名称（spring-webmvc和 spring-webflux），并在Spring Framework中并存。每个模块都是可选的。应用程序可以使用一个模块或另一个模块，或者在某些情况下可以同时使用这两个模块，例如，带有react的Spring MVC控制器WebClient。

说明：

传统的Web框架，比如说: struts2，springmvc等都是基于Servlet API与Servlet容器基础之上运行的。
但是
在Servlet3.1之后有了异步非阻塞的支持。而WebFlux是一个典型非阻塞异步的框架，它的核心是基于Reactor的相关APl实现的。相对于传统的web框架来说，它可以运行在诸如Netty,Undertow及支持Servlet3.1的容器上。非阻塞式+函数式编程(Spring5必须让你使用java8)

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

3、Gateway工作流程

三大核心概念：

1、Route（路由）

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

2、Predicate（断言）

参考的是Java8的java.util.function.Predicate 。开发人员可以匹配Http请求中的所有内容（例如请求头或者请求参数），如果请求与断言匹配则进行路由。

3、Filter（过滤）

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

总体：

image-20200827155707456

web请求，通过一些匹配条件，定位到真正的服务节点，并在这个转发过程中的前后，进行一些精细化的控制。

predicate就是我们的匹配条件；而filter，就可以理解为一个无所不能的拦截器。有了这俩个元素，再加上目标uri，就可以实现一个具体的路由了。

工作流程

核心逻辑：路由转发和执行过滤链。

image-20200827160252950

客户端向Spring Cloud Gateway发出请求。如果网关处理程序映射确定请求与路由匹配，则将其发送到网关Web处理程序。该处理程序通过特定于请求的过滤器链运行请求。筛选器由虚线分隔的原因是，筛选器可以在发送代理请求之前和之后运行逻辑。所有“前置”过滤器逻辑均被执行。然后发出代理请求。发出代理请求后，将运行“后”过滤器逻辑。

客户端向Spring Cloud Gateway 发出请求。然后在Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到Gateway Web Handler。

Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。

过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”）或之后(“post”)执行业务逻辑。

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

4、Gateway搭建

新建模块cloud-gateway-gateway9527

引入pom

<properties>
    <spring.boot.version>2.2.9.RELEASE</spring.boot.version>
</properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
            <groupId>com.fage</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
    </dependencies>

注意 springboot 版本问题，要不然一直报错。。。。。先是netty后是webFlux。。

yml配置

server:
  port: 9527

spring:
  application:
    name: cloud-gateway-service
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
      routes:
        - id: payment_routh1  # 路由id，没有固定规则但要求唯一，建议配合服务名使用
          uri: http://localhost:8001 # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/** # 断言，路径相匹配的进行路由
        - id: payment_routh2  # 路由id，没有固定规则但要求唯一，建议配合服务名使用
          uri: http://localhost:8001 # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/loadBalanced/** # 断言，路径相匹配的进行路由

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

验证：

image-20200831201519624

5、gateway配置路由的方式

1、yml配置

如上所示

2、硬编码方式

package com.fage.springcloud.config;

import org.springframework.cloud.gateway.route.Route;
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 lin
 * @version 1.0
 * @date 2020/8/31 20:36
 * @Description TODO
 */
@Configuration
public class GatewayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeBuilder) {
        return routeBuilder.routes().route("1234", predicateSpec -> {
            return predicateSpec.path("/guonei")
                    .uri("http://news.baidu.com/guonei");
        }).build();
    }

}

配置动态路由

将制定ip修改为命名形式，使用网关实现负载均衡等。

image-20200903094914216

默认情况下Gateway会根据注册中心的服务列表，以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由的功能。

修改yml配置文件即可

  ## 开启从注册中心动态创建路由的功能，利用微服务进行路由
1、  discovery:
    locator:
      enabled: true
      
 2、  uri: lb://cloud-payment-service  #  使用命名的方式

spring:
  application:
    name: cloud-gateway-service
  cloud:
    gateway:
      ## 开启从注册中心动态创建路由的功能，利用微服务进行路由
      discovery:
        locator:
          enabled: true
      routes:
        - id: payment_routh1  # 路由id，没有固定规则但要求唯一，建议配合服务名使用
          #uri: http://localhost:8001 # 匹配后提供服务的路由地址
          uri: lb://cloud-payment-service  #  使用命名的方式
          predicates:
            - Path=/payment/get/** # 断言，路径相匹配的进行路由
        - id: payment_routh2  # 路由id，没有固定规则但要求唯一，建议配合服务名使用
          uri: http://localhost:8001 # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/loadBalanced/** # 断言，路径相匹配的进行路由

测试：

image-20200903100631385

image-20200903100951666

6、常用的Predicate断言

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

image-20200903101216459

Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。
Spring Cloud Gateway包括许多内置的Route Predicate工厂。所有这些Predicate都与HTTP请求的不同属性匹配。多个Route Predicate工厂可以进行组合。

Spring Cloud Gateway创建Route对象时，使用RoutePredicateFactory 创Predicate对象可以赋值给Route。Spring Cloud Gateway包含许多内置的Route Predicate Factories.

所有这些谓词都匹配HTTP请求的不同属性。多种谓词丁厂可以组合逻辑and。

如何获取到after的时间

ZonedDateTime.now() = 2020-09-03T10:41:08.988+08:00[Asia/Shanghai]

public class TestMain {

    public static void main(String[] args) {
        System.out.println("ZonedDateTime.now() = " + ZonedDateTime.now());
    }

}

时间要求：after、before、between

之后
-After=ZonedDateTime.now() = 2020-09-03T10:41:08.988+08:00[Asia/Shanghai]

之前
-Before=ZonedDateTime.now() = 2020-09-03T10:41:08.988+08:00[Asia/Shanghai]

俩者之间
-Between=ZonedDateTime.now() = 2020-09-03T10:41:08.988+08:00[Asia/Shanghai],ZonedDateTime.now() = 2021-09-03T10:41:08.988+08:00[Asia/Shanghai]

请求参数：cookie、header、host、method、query

cookie：需要俩个参数，一个是Cookie name，一个是正则表达式
路由规则则会通过获取对应的Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，反之则不执行
- Cookie=username,fagejiang

Header 请求头参数
#请求头要有X-request-id属性并且值为正整数。
- Header=X-request-id,\d+ 

Host 主机
- Host=**。fagejiang.com

Method 方法
- Method=GET

Query
#请求参数名有username并且值要是正数。
- Query=username,\d+ 

Path
#路径是否包含
- Path=/payment/get/**

终归是一个扛下了 所有：
 - Path=/payment/get/** # 断言，路径相匹配的进行路由
 
 - After=2020-09-03T10:41:08.988+08:00[Asia/Shanghai]
 
 - Before=2021-09-03T10:41:08.988+08:00[Asia/Shanghai]
 
 - Between=2020-09-03T10:41:08.988+08:00[Asia/Shanghai],2021-09-03T10:41:08.988+08:00[Asia/Shanghai]

- Cookie=username,fagejiang

- Header=X-request-id,\d+

- Host=**.fagejiang.com

- Method=GET

- Query=username,\d+

Windows下安装使用Curl及解决中文乱码问题

https://blog.csdn.net/leedee/article/details/82685636

注意使用 PowerShell（出错）和CMD（正常）窗口问题。

7、GateFilter过滤器

Spring Cloud Gateway内置了多种路由过滤器，他们都由GatewayFilter的工厂类产生。

路由过滤器可用于修改进入的Http请求和返回的Http响应，路由过滤器只能指定路由进行使用。

image-20200903113226273

全局过滤器

        - id: payment_routh2  # 路由id，没有固定规则但要求唯一，建议配合服务名使用
          uri: http://localhost:8001 # 匹配后提供服务的路由地址
          ### 增加过过滤条件
          predicates:
            - Path=/payment/loadBalanced # 断言，路径相匹配的进行路由
          filters:
            # 过滤器工厂会在匹配的请求头上加上一对请求头，名称为X-Request-id，值为整数数字
            - AddRequestHeader=X-Request-id, \d+

查看官网：https://docs.spring.io/spring-cloud-gateway/docs/2.2.5.RELEASE/reference/html/#gatewayfilter-factories

自定义过滤器

image-20200903113537739

@Component
@Slf4j
public class MyLogGatewayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("*********** come in MyLogGatewayFilter : " + DateUtil.now());
        boolean loadBalanced = exchange.getRequest().getPath().toString().contains("loadBalanced");
        String name = exchange.getRequest().getQueryParams().getFirst("name");
        if (loadBalanced && name == null) {
            log.info("*********** 用户名为null，非法用户，o(╥﹏╥)o");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return OrderedConstant.REQUEST_FILTER;
    }
}

调用http://localhost:9527/payment/loadBalanced?name=z3成功

调用http://localhost:9527/payment/loadBalanced失败

image-20200903144045385

2020-09-03 14:39:45.775 [reactor-http-nio-2] INFO  com.fage.springcloud.filters.MyLogGatewayFilter - *********** come in MyLogGatewayFilter : 2020-09-03 14:39:45
2020-09-03 14:40:39.121 [reactor-http-nio-2] INFO  com.fage.springcloud.filters.MyLogGatewayFilter - *********** come in MyLogGatewayFilter : 2020-09-03 14:40:39
2020-09-03 14:40:39.121 [reactor-http-nio-2] INFO  com.fage.springcloud.filters.MyLogGatewayFilter - *********** 用户名为null，非法用户，o(╥﹏╥)o

公众号：发哥讲

这是一个稍偏基础和偏技术的公众号，甚至其中包括一些可能阅读量很低的包含代码的技术文，不知道你是不是喜欢，期待你的关注。

代码分享

https://gitee.com/naimaohome

微信公众号 点击关于我，加入QQ群，即可获取到代码以及高级进阶视频和电子书！！

img

如果你觉得文章还不错，就请点击右上角选择发送给朋友或者转发到朋友圈~

● 扫码关注我们

据说看到好文章不推荐的人，服务器容易宕机！

本文版权归 发哥讲 和 博客园 共有，原创文章，未经允许不得转载，否则保留追究法律责任的权利。

推荐阅读