09 gateway

---

1 简介

cloud全家桶中有个很重要的组件就是网关，在1.x版本中都是采用zuul网关，但是在2.新版本中，zuul一直跳票，springcloud最后自己研发了一个网关代替zuul那就是springcloud gateway，一句话，gateway就是zuul1.x版本的替代

提供一种简单有效的方式对API进行路由，以及提供一些强大的过滤器功能，例如：熔断、限流、重试等

gateway可以提供反向代理、鉴权、流量控制、熔断、日志监控。。。

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

springCloud gateway 的目标是提供统一的路由方式且基于Filter链的方式提供了网关基本的功能，例如安全，监控，限流

1.1 特点

SpringCloud Gateway具有如下特性

• 基于Spring Framework5、Project Reactor、SpringBoot2.0进行构建
• 动态路由：能够匹配任何请求属性
• 可以对路由指定Predicate（断言）和Filter（过滤器）
• 集成Hystrix的断路器功能
• 集成SpringCloud服务发现功能
• 易于编写的Predicate（断言）和Filter（过滤器）
• 请求限流功能
• 支持路径重写

SpringCloud Gateway 和 zuul的区别

在spring Cloud Finchley版本之前，SpringCloud推荐的网关是Zuul

1. zuul 1.x 是一个基于阻塞IO的API gateway
2. zuul 1.x 基于Servlet2.5使用阻塞架构，他不支持任何长连接（比如WebSocket），Zuul的设计模式和nginx比较像，每次IO操作都是从工作线程中选择一个执行，请求线程被阻塞到工作线程完成，但是差别是nginx是C++实现的，Zuul是JAVA实现的，而jvm本身会有第一次加载比较慢的情况，是的Zuul的性能比较差。
3. Zuul 2.x 理念更先进，想基于Netty非阻塞和支持长连接，但是SpringCloud还没整合，相比较与1.x 在性能方面有较大的提升。
4. 在性能方面，根据官方提供的基准测试，SpringCloud gateway的RPS（每秒请求数）是Zuul的1.6倍
5. SpringCloud gateway基于Spring Framework5、Project Reactor、SpringBoot2.0进行构建，非阻塞API
6. SpringCloud gateway 还支持WebSocket。

1.2 三大核心概念

1. Route（路由）
   路由是构建网关的基本模块，它由ID，目标URI，一系列的断言和过滤器组成，如果断言为true则匹配该路由
2. Predicate（断言）
   参考java8的java.util.function.Predicate，开发人员可以匹配HTTP请求中的所有内容（例如请求头或者请求参数），如果请求与断言相匹配则进行路由
3. Filter（过滤器）
   指的是spring框架中GatewayFilter的实例，使用过滤器，可以在请求北路有前或者之后对请求进行修改

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

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

1.3 gateway工作流程

​客户端向SpringCloud Gateway发出请求，然后再Gateway Handler Mapping中找到与请求相匹配的路由，将其发送到Gateway Web Handler，handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回

​ 过滤器之间用须先分开是因为过滤器可能会在发送代理请求之前（“Pre”）或者之后（“Post”）执行业务逻辑

​ Filter在“Pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等

​ Filter在"Post"类型的过滤器可以做相应内容、响应头的修改、日志的输出、流量监控等有着非常重要的作用

​ 核心逻辑：路由转发+执行过滤器链

2 入门配置

2.1 网关服务搭建

1. 新建一个网关模块：cloud-gateway
2. 导入依赖

<dependencies>
   <!--gateway依赖-->
   <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-gateway</artifactId>
   </dependency>
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
   </dependency>
   <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
   </dependency>
   <dependency>
       <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
   </dependency>
   <dependency>
       <groupId>study.wyy</groupId>
       <artifactId>cloud-api-common</artifactId>
       <version>${project.version}</version>
   </dependency>
</dependencies>

3. 配置文件

server:
  port: 9587

spring:
  application:
    name: cloud-gateway

eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:7001/eureka/

4. 启动类

package study.wyy.cloud.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

/**
 * @author by wyaoyao
 * @Description
 * @Date 2020/12/22 7:14 下午
 */
@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {

    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class, args);
    }
}

5. 启动，发现报错

Spring MVC found on classpath, which is incompatible with Spring Cloud Gateway at this time. Please remove spring-boot-starter-web dependency.

Spring MVC在类路径中找到，目前与Spring Cloud Gateway不兼容。 请删除spring-boot-starter-web依赖项。

6. 移除spring-boot-starter-web依赖项，重新启动成功。

2.2 网关路由配置

之前的支付服务的两个接口：

如何通过网关的配置，不再直接访问支付，而是通过网关路由到这两个地址？
增加如下配置

spring:
  cloud:
    gateway:
      # 这里可以配置多个
      routes:
        - id: payment_routh # 路由ID，没有规定的规则，但要求全局唯一
          uri: http://localhost:8001
          predicates:
            # 也可以配置多个
            - Path=/payment/**

完整的配置：

server:
  port: 9587

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      # 这里可以配置多个
      routes:
        - id: payment_routh # 路由ID，没有规定的规则，但要求全局唯一
          uri: http://localhost:8001
          predicates: # #断言，路径相匹配就进行路由
            # 也可以配置多个
            - Path=/payment/**


eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:7001/eureka/

3 Predicate（断言）

gateway中内置了很多断言：

刚刚的案例演示的就是Path断言

predicates:
- After: 2020-02-15T15:51:23.484+08:00[Asia/Shanghai]	#就是实际在这个之后的才放行
- Between: 2020-02-15T15:51:23.484+08:00[Asia/Shanghai],2020-06-15T15:51:23.484+08:00[Asia/Shanghai]
- Cookie=username,zzyy		#Cookie Route Predicate需要2个参数，一个是Cookie name，一个是正则表达式，路由规则会通过获取对应的Cookie name值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上就不执行
	#curl http://localhost:9527/payment/get/31 --cookie "username=zzyy"
- Header=X-Request-Id, \d+		#带请求头参数
- Host: www.atguigu.com
- Method: GET,PUT,POST # 请求方式得是GET,PUT,POST
- Query: username		 # 请求参数里面得有username

可以去官网查看具体的用法案例

4 Filter

4.1 如何配置GateWayFilter

spring:
  cloud:
    routes:
      filters:
      - AddRequestParamaeter-X -Request_Id,1024 #过滤器工厂会在匹配的请求头加上一对请求头，名称为X-Request-Id值为1024

4.2 自定义全局过滤器GlobalFilter

两个主要接口介绍 implements Global Filter，Ordered

@Component
@slf4j
public class MyLogGatewatFilter implements GlobalFilter,Ordered{
    @Override
    public Mono<void> filter(ServerWebExchange exchange,GatewayFilterChain chain){
        log.info("#*****come in MylogGatewayFilter");
        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);
    }
    @Override
    public int getOrder(){
    	return 0;	#过滤器加载顺序， 从小到大
    }
}