Gateway服务网关

1、简介

1.1 概念

API网关是一个服务器，是系统对外的唯一入口。API网关封装了系统内部架构，为每个客户端提供一个定制的API。API网关方式的核心要点是，所有的客户端和消费端都通过统一的网关接入微服务，在网关层处理所有的非业务功能。

网关也是提供REST/HTTP的访问API。服务端通过API-GW注册和管理服务。

1.2 为什么需要网关

不同的微服务一般会有不同的网络地址，客户端在访问这些微服务时必须记住几十甚至几百个地址，这对于客户端方来说太复杂也难以维护。

这就需要一个微服务网关，介于客户端与服务器之间的中间层，所有的外部请求都会先经过微服务网关。客户端只需要与网关交互，只知道一个网关地址即可。

网关功能：

• 身份认证和权限校验

• 服务路由、负载均衡

• 请求限流

1.3 网关的技术实现

在SpringCloud中网关的实现包括两种：

• geteway
• zuul

Zuul是基于Servlet的实现，属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

2、搭建网关服务

2.1 创建网关module

2.2 引入依赖

引入SpringCloudGeteway的依赖和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.3 配置启动类

2.4 编写路由配置以及nacos地址

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

2.5 Gateway路由流程

2.6 总结

2.6.1 网关搭建步骤

​ 1、创建项目，引入nacos服务发现和gateway依赖

​ 2、配置application.yml，包括服务基本信息、nacos地址、路由

2.6.2 路由配置包括

2.6.2.1 路由id

​ 路由的唯一标识

2.6.2.2 路由目标（uri）

​ 路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

2.6.2.3 路由断言（predicates）

​ 判断请求是否符合要求，符合则转发到路由目的地

2.6.2.4 路由过滤器（filters）

​ 对请求或响应做处理

3、断言工厂

3.1 作用

路由断言工厂Route Predicate Factory

• 我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件

• 例如Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的

• 像这样的断言工厂在SpringCloudGateway还有十几个

名称	说明	示例
After	是某个时间点后的请求	- After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before	是某个时间点之前的请求	- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between	是某两个时间点之前的请求	- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie	请求必须包含某些cookie	- Cookie=chocolate, ch.p
Header	请求必须包含某些header	- Header=X-Request-Id, \d+
Host	请求必须是访问某个host（域名）	- Host=.somehost.org,.anotherhost.org
Method	请求方式必须是指定方式	- Method=GET,POST
Path	请求路径必须符合指定规则	- Path=/red/{segment},/blue/**
Query	请求参数必须包含指定参数	- Query=name, Jack或者- Query=name
RemoteAddr	请求者的ip必须是指定范围	- RemoteAddr=192.168.1.1/24
Weight	权重处理

查看官方文档

3.2 总结

PredicateFactory(断言工厂)的作用：

​ 读取用户定义的断言条件，对请求做出判断

**Path=/user/的含义：

​ 路径是以/user开头的就认为是符合的

4、过滤器

4.1 过滤器基础

4.1.1 过滤器的生命周期

Spring Cloud Gateway 的 Filter 的生命周期不像 Zuul 的那么丰富，它只有两个：“pre” 和 “post”。

​ PRE： 这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择 请求的微服务、记录调试信息等。

​ POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的 HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

4.1.2 过滤器类型

从作用范围可分为另外两种GatewayFilter 与 GlobalFilter。

• GatewayFilter：应用到单个路由或者一个分组的路由上。

• GlobalFilter：应用到所有的路由上。

4.2网关过滤器GatewayFilter

4.2.1 简介

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

4.2.2 过滤器工厂

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

名称	说明
AddRequestHeader	给当前请求添加一个请求头
RemoveRequestHeader	移除请求中的一个请求头
AddResponseHeader	给响应结果中添加一个响应头
RemoveResponseHeader	从响应结果中移除有一个响应头
RequestRateLimiter	限制请求的流量

我们可以参考官方文档

4.2.2.1 案例(给请求添加请求头)

给所有进入userservice的请求添加一个请求头：Truth=springcloud isfreaking awesome!

实现方式：在gateway中修改application.yml文件，给userservice的路由添加过滤器filters:

server:
  port: 10010 
spring:
  application:
    name: gateway 
  cloud:
    nacos:
      server-addr: localhost:8848 
    gateway:
      routes:
        - id: user-service 
          uri: lb://userservice 
          predicates: 
            - Path=/user/** 
          filters: #过滤器
            - AddRequestHeader=Truth,SpringCloud is freaking aowsome!
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**

4.2.2.2 默认过滤器

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

server:
  port: 10010 
spring:
  application:
    name: gateway 
  cloud:
    nacos:
      server-addr: localhost:8848 
    gateway:
      routes:
        - id: user-service 
          uri: lb://userservice 
          predicates: 
            - Path=/user/** 
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
      default-filters: #默认过滤器
        - AddRequestHeader=Truth,SpringCloud is freaking aowsome!

4.2.3 总结

网关过滤器的作用是什么？

1. 对路由的请求或响应做加工处理，比如添加请求头
2. 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么？

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

4.3 全局过滤器GlobalFilter

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。

区别在于GatewayFilter通过配置定义，处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。

4.3.1 定义方式

实现GlobalFilter接口

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

4.3.2 案例(拦截并判断用户身份)

需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

• 参数中是否有authorization，
• authorization参数值是否为admin

如果同事满足则放行，否则拦截。

4.3.2.1 代码实现

在gateway中新建GlobalFilter接口的实现类AuthorizeFilter：

@Component
//@Order(-1)//设置过滤器的顺序 或者通过实现Ordered接口。值越小优先级越高
public class AuthorizeFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //1.获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> parms = request.getQueryParams();
        //2.获取参数中的authorization参数
        String auth = parms.getFirst("authorization");
        //3.判断参数值是否等于admin。
        if("admin".equals(auth)){//4.是，放行
            return chain.filter(exchange);
        }
        //5.不满足，拦截
        //5.1 设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.valueOf(401));
        //5.2 拦截请求
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

4.3.3 总结

​ 全局过滤器的作用是什么？

​ 对所有路由都生效的过滤器，并且可以自定义处理逻辑

​ 实现全局过滤器的步骤？

• 实现GlobalFilter接口

• 添加@Order注解或实现Ordered接口

• 编写处理逻辑

4.4 过滤器执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、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排序，组织过滤器链

5、跨域问题

跨域：域名不一致就是跨域，主要包括：

• 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
• 域名相同，端口不同：localhost:8080和localhost8081

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

解决方案：CORS

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

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