Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

@[toc]

1. 为什么需要网关

网关功能：

• 身份认证和权限校验
• 服务路由、负载均衡
• 请求限流

2. 网关的技术实现

• 在SpringCloud中网关的实现包括两种：
  1、gateway
  2、zuul
• Zuul是基于Servlet的实现，属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

3. 小结：

网关的作用：
1、对用户请求做身份认证、权限校验
2、将用户请求路由到微服务，并实现负载均衡
3、对用户请求做限流

• 权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

• 路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

• 限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。

4. 搭建网关服务

搭建网关服务步骤：

1. 创建新的 module，引入Spring Cloud Gateway 的依赖 和 Nacos 的服务发现依赖

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

<!--nacos服务发现依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

2. 编写基础配置和路由规则及nacos地址

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: 47.107.53.146:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

• 将符合Path 规则的一切请求，都代理到 uri参数指定的地址
• 本例中，将 /user/**开头的请求，代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。
• 网关路由的流程图，整个访问的流程如下：
  

4. 重启测试：
   重启网关，访问http://localhost:10010/user/1时，符合/user/**规则，请求转发到uri：http://userservice/user/1，得到了结果：
   

• 访问 http://localhost:10010/order/101 ，符合 /order/** 规则，请求转发到 uri:http://orderservice/order/101，得到结果：
  

5. 小结

1、创建项目，引入nacos服务发现和gateway依赖
2、配置application.yml，包括服务基本信息、nacos地址、路由

• 路由配置包括：

1、路由id：路由的唯一标示
2、路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
3、路由断言（predicates）：判断路由的规则，
4、路由过滤器（filters）：对请求或响应做处理

6. 路由断言工厂 Route Predicate Factory

网关路由可以配置的内容包括：

• 路由id：路由唯一标示
• uri：路由目的地，支持lb和http两种
• predicates：路由断言，判断请求是否符合要求，符合则转发到路由目的地
• filters：路由过滤器，处理请求或响应

• 在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件
• 例如Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的
• 像这样的断言工厂在SpringCloudGateway还有十几个

Spring提供了11种基本的Predicate工厂：

• 如：把 orderservice 设定在 2023 年之后的请求，明显是不符合要求的，报 404 错误
  
  

• 可以根据需求来对断言 Predicate 进行相关设置，官网文档：
  https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

7. 小结

• PredicateFactory的作用是什么？
  读取用户定义的断言条件，对请求做出判断
• Path=/user/**是什么含义？
  路径是以/user开头的就认为是符合的

8. 路由过滤器 GatewayFilter

• GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：
  

• Spring提供了31种不同的路由过滤器工厂。例如：

• 官网：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

9. 请求头过滤器

下面以AddRequestHeader 为例来讲解：

• 给所有进入userservice的请求添加一个请求头：Truth=Just Do It!
• 实现方式：在gateway中修改application.yml文件，给userservice的路由添加过滤器：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=Truth, Just Do It! # 添加请求头

• 在 userservice 下的 UserController 下添加打印的请求头信息
  

• 重启 userservice，访问后可以看到：
  

• 当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效

10. 默认过滤器

• 如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=Truth, Just Do It! 

11. 小结

• 过滤器的作用是什么？

① 对路由的请求或响应做加工处理，比如添加请求头

② 配置在路由下的过滤器只对当前路由的请求生效

• defaultFilters的作用是什么？

① 对所有路由都生效的过滤器

12. 全局过滤器 GlobalFilter

• 全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。
• 区别在于GatewayFilter通过配置定义，处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。
• 定义方式是实现GlobalFilter接口。

public interface GlobalFilter {
    /**
     *  处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文，里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

• 定义全局过滤器，拦截并判断用户身份
  需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：
  参数中是否有authorization，
  authorization参数值是否为admin
  如果同时满足则放行，否则拦截

• 自定义类，实现GlobalFilter接口，添加@Order注解，在gateway中定义一个过滤器：

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter  {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1. 获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> params = request.getQueryParams();
        // 2. 获取请求参数中的authorization 参数
        String auth = params.getFirst("authorization");
        // 3. 判断参数是否等于 admin
        if ("admin".equals(auth)) {
            // 4. 是，放行
            return chain.filter(exchange);
        }

        // 5. 否，拦截
        // 5.1 设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        // 5.2 拦截请求
        return exchange.getResponse().setComplete();

    }
}

• 当访问服务时没有带上指定的从参数时，就会报设定的状态码 401
  
  

• 带上参数后就可以正常访问：
  

13. 小结

• 全局过滤器的作用是什么？
  对所有路由都生效的过滤器，并且可以自定义处理逻辑
• 实现全局过滤器的步骤？
  ①实现GlobalFilter接口
  ②添加@Order注解或实现Ordered接口
  ③编写处理逻辑

14. 过滤器执行顺序

• 请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter

• 请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器
  

• 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。

• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定

• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。

• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

• 可以参考下面几个类的源码来查看：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator
#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler
#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

15. 小结

• 路由过滤器、defaultFilter、全局过滤器的执行顺序？
  ①order值越小，优先级越高
  ②当order值一样时，顺序是defaultFilter最先，然后是局部的路由过滤器，最后是全局过滤器

16. 跨域问题处理

• 跨域：域名不一致就是跨域，主要包括：
  1、域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
  2、域名相同，端口不同：localhost:8080 和 localhost8081

• 跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

• 解决方案：CORS

• 网关处理跨域采用的同样是CORS方案，并且只需要简单配置即可实现：

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期