Spring Cloud -- GateWay

1. 为什么需要网关

在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。这样的话会产生很多问题，例如：
客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
认证复杂，每个微服务都有独立认证
存在跨域请求，在一定场景下处理相对复杂

提供统一的入口和统一的出口

网关作为流量的入口，常用的功能：路由转发、权限校验、限流

2. 网关对比

• 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，缺乏更易用的管控、配置方式。

带有Nginx的性能要远远高于zuul和gateway，但是nginx不支持微服务，所以一般使用zuul和gateway。gateway的性能要高于zuul，所以我们来学习gateway

3. 官网地址

https://spring.io/projects/spring-cloud-gateway
https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/

4. 特点

1.性能强劲：是Zuul的1.6倍

2. 功能强大：内置了很多实用的功能，例如转发、监控、限流等

3. 设计优雅，容易扩展

不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。

gateway由webFlux+Netty+Reactor实现的响应式的API网关

gateway不能在传统的servlet容器中工作，也不能构建成war包

5. gateway工作流程图：

客户端向 Spring Cloud Gateway 发出请求。如果Gateway Handler Mapping确定请求与路由匹配，则将其发送到Gateway Web Handler 处理程序。此处理程序通过特定于请求的Fliter链运行请求。Fliter被虚线分隔的原因是Fliter可以在发送代理请求之前（pre）和之后（post）运行逻辑。执行所有pre过滤器逻辑。然后进行代理请求。发出代理请求后，将运行“post”过滤器逻辑。

6. 过滤器作用

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

• Filter在post类型的过滤器可以做响应内容、响应头的修改、日志输出、流量监控等

• 这两种类型的过滤器有着非常重要的作用

7. 核心概念

• Route（路由）

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

• Predicate（断言）

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

• Filter（过滤）

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

三个核心点连起来：

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

8. spring boot和spring cloud的对应关系

9. gateway项目搭建：

引入GateWay一定要删除spring-boot-starter-web依赖，否则会有冲突无法启动（gateway不能在传统的servlet容器中工作）

1. 父项目引入

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

2. 子项目

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

3. 配置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=/msb/** # 断言，路径相匹配进行路由

代码中也可以添加配置（不推荐）

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

10. 路由

1. 自动路由

gateway自带负载均衡

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

不配置具体的routes，自动路由时访问需要加serviceName

localhost:9999/ServiceID/xxx/

2. 手动负载均衡（更常用）

uri中加lb表示负载均衡

 routes: # 路由
    - id: nacos-provider #路由ID，没有固定要求，但是要保证唯一，建议配合服务名
      uri: lb://nacos-provider # 匹配提供服务的路由地址
      predicates: # 断言
        - Path=/msb/** 

routes中配置了以后，走routes中的配置，不走gateway.discovery.locator.enabled

11. 断言Predicate

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

断言种类

1. After：匹配在指定日期时间之后发生的请求。

2. Before：匹配在指定日期之前发生的请求。

3. Between：需要指定两个日期参数，设定一个时间区间，匹配此时间区间内的请求。

4. Cookie：需要指定两个参数，分别为name和regexp（正则表达式），也可以理解Key和Value，匹配具有给定名称且其值与正则表达式匹配的Cookie。

5. Header：需要两个参数header和regexp（正则表达式），也可以理解为Key和Value，匹配请求携带信息。

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

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

8. Path：匹配指定路径下的请求，可以是多个，用逗号分隔

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

10. RemoteAddr：匹配指定IP或IP段，符合条件转发。

11. Weight：需要两个参数group和weight（int），实现了路由权重功能，按照路由权重选择同一个分组中的路由

具体用法：

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

自定义Predicate

public class XXXRoutePredicateFactory extends AbstractRoutePredicateFactory<>{}

12. 过滤器Filter

路由过滤器允许以某种方式修改传入的 HTTP 请求或传出的 HTTP 响应。路由过滤器的范围是特定的路由。Spring Cloud Gateway 包含许多内置的 GatewayFilter 工厂。

过滤器分为内置过滤器和自定义过滤器

内置Filter

1. GateWay内置的Filter生命周期为两种：pre（业务逻辑之前）、post（业务逻辑之后）

2. GateWay本身自带的Filter分为两种： GateWayFilter（单一）、GlobalFilter（全局）

3. 单一的有32种，全局的有9种

4. 官方网址：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters

自定义Filter（全局）

需要实现两个接口：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;
    }
}

自定义Filter（局部）

public class XXXGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory{}