Spring GateWay-阿里云开发者社区

概述简介

能干什么

反向代理

鉴权

流量控制

熔断

日志监控

Spring Cloud Gateway 与Zuul的区别

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

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

2、Zuul 1.x基于Servlet 2.使用阻塞架构它不支持任何长连接(如WebSocket)Zuul的设计模式利

INginx较像，每次Ⅳ/O操作都是从

工作线程中选择一个执行，请求线程被阻塞到工作线程完成，但是差别是Nginx用C+＋实现，Zuu

Java实现，而JVM本身会有第

-次加载较慢的情况，使得Zuul 的性能相对较差。

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

4、Spring Cloud Gateway建立在Spring Framework5、Project Reactor和Spring Boot 2之上，使用非阻塞API。

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

上述模式的缺点:

servlet是一个简单的网络IO模型，当请求进入servlet container时，servlet container就会为其绑定一个线程，在并发不高的场景下这种模型是适用的。但是一旦高并发(此比如抽风用jemeter压)，线程数量就会上涨，而线程资源代价是昂贵的（上线文切换，内存消耗大)严重影响请求的处理时间。在一些简单业务场景下，不希望为每个request分配一个线程，只需要1个或几个线程就能应对极大并发的请求，这种业务场景下servlet模型没有优势

所以Zul 1.X是基于servlet之上的一个阻塞式处理模型，即spring实现了处理所有request请求的一个servlet (DispatcherServlet)并由该servlet阻塞式处理.所以SpringCloud zuul无法摆脱servlet模型的弊端

传统的Web框架，比如说: struts2，springmvc等都是基于Servlet APl与Servlet容器基础之上运行的。

但是

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

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

二,三大核心概念

Router(路由)

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

predicate(断言)

参考的是java8的java.util.function.Predicate

开发人员可以匹配Http请求中的所有内容(例如请求头或者参数),如果请求头与断言相匹配则进行路由

filter(过滤)

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

总体

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

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

三,工作流程

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

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

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

核心逻辑

路由转发+执行过滤链

四,入门配置

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

server:  
  port: 9527  
spring:  
  application:  
    name: cloud-gateway  
eureka:  
  instance:  
    hostname: cloud-gateway-service  
  client:  
    service-url:  
      register-with-eureka: true  
      fetch-register: true  
      defaultZone: http://eureka7001.com:7001/eureka

package com.atguigu.springcloud;  
  
import org.springframework.boot.SpringApplication;  
import org.springframework.boot.autoconfigure.SpringBootApplication;  
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;  
  
@SpringBootApplication  
@EnableEurekaClient  
public class GateWayMain9527 {  
    public static void main(String[] args) {  
        SpringApplication.run(GateWayMain9527.class,args);  
    }  
}

9527网关如何做路由映射

yml新增网关配置

server:
  port: 9527
spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      routes:
        - id: payment_route # 路由的id,没有规定规则但要求唯一,建议配合服务名
          #匹配后提供服务的路由地址
          uri: http://localhost:8001
          predicates:
            - Path=/payment/get/** # 断言，路径相匹配的进行路由
        - id: payment_route2
          uri: http://localhost:8001
          predicates:
            - Path=/payment/lb/** #断言,路径相匹配的进行路由
eureka:
  instance:
    hostname: cloud-gateway-service
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/

这两个要删掉

<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>

成功

网关配置两种方式

在配置文件中配置
在配置文件yml中配置
在配置类中配置
代码中注入RouteLocator的Bean

@Configuration
public class GatewayConfig {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        routes.route("path_route_angenin",  //id
                r -> r.path("/guonei")  //访问 http://localhost:9527/guonei
                        .uri("http://news.baidu.com/guonei"));  //就会转发到 http://news.baidu.com/guonei
        routes.route("path_route_angenin2",  //id
                r -> r.path("/guoji")  //访问 http://localhost:9527/guoji
                        .uri("http://news.baidu.com/guoji"));  //就会转发到 http://news.baidu.com/guonji
        return routes.build();
    }
//    @Bean
//    public RouteLocator customRouteLocator2(RouteLocatorBuilder routeLocatorBuilder){
//        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
//
//        routes.route("path_route_angenin2",  //id
//                r -> r.path("/guoji")  //访问 http://localhost:9527/guoji
//                        .uri("http://news.baidu.com/guoji"));  //就会转发到 http://news.baidu.com/guonji
//
//        return routes.build();
//    }
}

出现的问题

地址写死
8001这种服务提供者不可能只有一台机器

五,根据服务名实现负载均衡

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

server:  
  port: 9527  
  
spring:  
  application:  
    name: cloud-gateway  
  cloud:  
    gateway:  
      discovery:  
        locator:  
          enabled: true  # 开清从注册中心动态创建路由的功能,利用微服务名进行路由
      routes:  
        - id: payment_route # 路由的id,没有规定规则但要求唯一,建议配合服务名  
          #匹配后提供服务的路由地址  
#          uri: http://localhost:8001  
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址  
          predicates:  
            - Path=/payment/get/** # 断言，路径相匹配的进行路由  
  
        - id: payment_route2  
#          uri: http://localhost:8001  
          uri: lb://cloud-payment-service #匹配后提供服务的路由地址  
          predicates:  
            - Path=/payment/lb/** #断言,路径相匹配的进行路由  
  
  
eureka:  
  instance:  
    hostname: cloud-gateway-service  
  client:  
    fetch-registry: true  
    register-with-eureka: true  
    service-url:  
      defaultZone: http://eureka7001.com:7001/eureka/

Spring Cloud Netflix Ribbon会在定义lb前缀的目标URI上实现负载平衡(官方文档翻译)

六, Predicate的使用

Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。

Spring Cloud Gateway包括许多内置的Route Predicate工厂。所有这些Predicate都与HTTP请求的不同属性匹配。多个RoutePredicate工厂可以进行组合

Spring Cloud Gateway创建Route对象时，使用RoutePredicateFactory创建Predicate对象

Predicate 对象可以赋值给

Route。Spring Cloud Gateway包含许多内置的Route Predicate Factories。

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

After Route Predicate

获取当前时区的时间
ZoneDateTime.now()

predicates:
- Path=/payment/1b/**
#断言，路径相匹配的进行路由
- After=2020-02-21T15:51:37.485+08:0o[Asia/shanghai]

Cookie Route Predicate

不带cookie访问
带cookie访问

Cookie Route Predicate需要两个参数，一个是Cookie name ,一个是正则表达式。

路由规则会通过获取对应的Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上则不执行

Header Route Predicate Factory

spring:
  cloud :
    gateway :
      routes:
      - id: header_route
        uri: https : //example.org
        predicates:
        - HeaderX-Request-Id，ld+

两个参数:一个是属性名称和一个正则表达式，这个属性值和正则表达式匹配则执行。

路径匹配

例如

Path=/*/product/**断言

作用: 这个断言基于请求的路径来决定是否将请求路由到对应的服务。只有当请求的路径匹配指定的模式（在这个例子中是/*/product/**），请求才会被路由到配置中指定的服务。这种模式允许在请求的路径中有很大的灵活性，能够匹配包含/product/的任何路径。
适用场景: 当你想要根据请求的URL路径将不同的请求分发到不同的后端服务时，这种方式非常有用。比如，所有关于产品信息的请求都可以路由到处理产品信息的微服务。

host匹配

Host=item.gmall.com断言

作用: 这个断言基于请求的主机名（即域名）来决定是否将请求路由到对应的服务。只有当请求的主机名完全匹配item.gmall.com时，请求才会被路由到配置中指定的服务。这种方式侧重于基于请求的“来源”或者说是“访问的域名”来进行路由。
适用场景: 当你的网关服务多个域名，并且你希望根据不同的域名将请求分发到不同的服务时，这种方式非常有用。比如，所有来自item.gmall.com的请求都被路由到处理特定商品信息的服务。

七,filter

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

而filter，就可以理解为一个无所不能的拦截器。有了这两个元素，再加上目标uri，就可以实现一个具体的路由了

概述

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

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

生命周期,only Two

pre
post

种类,Only Two

GateWayFilter
GlobalFilter

常用的GateWayFilter

GatewayFilter（31种）

Global Filter（10种）

这里以AddRequestParameter为代表。

自定义过滤器

两个主要接口介绍

implements GlobalFilter,Ordered

能干啥

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

配置

@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("**************come in MyLogGateWayFilter：" + new Date());
        //获取request中的uname参数
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        if(uname == null){
            log.info("*******用户名为null，非法用户！！");
            //设置响应，不被接受
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        //返回chain.filter(exchange)，放行
        return chain.filter(exchange);
    }
    @Override
    public int getOrder() {
        //返回值是过滤器的优先级，越小优先级越高（最小-2147483648，最大2147483648）
        return 0;
    }
}

启动7001，8001，8002，9527

http://localhost:9527/payment/lb?uname=111

http://localhost:9527/payment/lb?xxx=111

Spring GateWay