04_微服务之GateWay服务网关

1. 为什么需要网关

Gateway网关是我们服务的守门神，所有微服务的统一入口

在没有网关时一个请求过来可以直接调用微服务, 显然这是不合理的:例如没权限的用户访问了管理员的服务

同时Gateway有自己的负载均衡, 与Ribbon的负载均衡不同, Ribbon的负载均衡是指微服务间调用时的负载均衡,是对内的; 而nginx则是对Nacos的负载均衡; 而Gateway的负载均衡是指请求到服务时的负载均衡, 是对外的, 即请求路由->负载均衡

网关的核心功能特性：

• 请求路由(URL到函数的映射)
• 权限控制(那SpringSecurity呢)
• 限流(对微服务的保护)

特性解释:

权限控制：

​ 网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截

路由和负载均衡：

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

限流：

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

加入网关之后的架构图：

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

• gateway
• zuul

其中Zuul是基于Servlet的实现，属于阻塞式编程(资源不可用时阻塞, 直到有反馈(返回数据或超时))。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现(基于数据流和变化传递的声明式的编程范式)，具备更好的性能

2. 使用姿势

网关是一个独立的服务, 因此需要创建一个全新的服务模块, 基本步骤如下：

1. 创建SpringBoot工程gateway，引入网关依赖与Nacos服务发现

   接着编写启动类

2. 编写基础配置和路由规则

3. 启动网关服务进行测试

接着开始正题:

2.1 导依赖建模块

首先是导依赖, 需要Gateway的starter依赖以及nacos的服务发现依赖:

<dependency>
    <groupId>org.springframework.cloudgroupId>
    <artifactId>spring-cloud-starter-gatewayartifactId>
dependency>

<dependency>
    <groupId>com.alibaba.cloudgroupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>

2.2 基础配置与路由规则:

其中一个routes下可以配置多个id的不同属性(数组)

而uri中的lb写法,lb:loadBalance(负载均衡), 因此此时网关会根据lb后的服务名从注册中心拿具体地址, 当访问gateway网关时会根据地址判断哪个服务并做负载均衡

而当使用lb写法时需要增加predicates属性写路由规则,predicates也可以配置数组, 其中predicates:断言, 即布尔表达式, 也就是判断请求是否符合路由规则的条件

因此除了必须配置的端口名称nacos地址之外, gateway的路由routes可以配置多个id, 每个id配置俩个东西:

uri, 一般使用lb开头,lb://服务名称

predicates, 断言, 路由规则

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

此时配置完, 通过Gateway网关的10010端口也可以访问其他资源, 例如http://localhost:10010/user/1就可以访问userservice, 不用再去访问userservice的路径

也就是说网关相当于一个中介, 帮我们判断有没有资格访问, 接着他在负载均衡去远程调用

2.2.1 断言工厂

我们在配置文件中写的断言规则只是字符串，这些字符串会被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	权重处理

其中比较常用的是Path这种路由工程就可以了

2.2.2 过滤器工厂

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

2.2.2.1 路由过滤器

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

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

以AddRequestHeader 为例:

需求：给所有进入userservice的请求添加一个请求头：GatewayFilter=AddRequestHeader

只需要修改gateway服务的application.yml文件，添加路由过滤即可：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
          - Path=/user/** 
        # 过滤器配置:
        filters: 
          # 添加请求头
          - AddRequestHeader=GatewayFilter, AddRequestHeader 

这里的逗号不是配置多个头的意思, 而是键,值

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

2.2.2.2 默认过滤器:default-filters

前面的路由过滤器只能对当前配置的服务生效, 而当需要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

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

2.2.2.3 全局过滤器:GlobalFilter

上面学习的过滤器，Gateway网关提供了31种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求，做自己的业务逻辑则没办法实现, 因此Gateway提供了全局过滤器, 让我们通过写代码的形式完成特定业务的过滤器

这也是全局过滤器与默认过滤器的区别

使用步骤:

1. 实现GlobalFilter接口, 并重写对应方法, GlobalFilter源码:

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

​ 其中第一个参数做数据处理, 第二个参数用于放行

2. 在filter中编写自定义逻辑，可以实现下列功能：

• 登录状态判断
• 权限校验
• 请求限流等

3. 示例:

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.获取authorization参数
        String auth = params.getFirst("authorization");
        // 3.校验
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.拦截
        // 4.1.禁止访问，设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.结束处理
        return exchange.getResponse().setComplete();
    }
}

注意:

1. 这里获得的Servlet与web学习的Servlet不同, 因此API也不同, 写的时候仿照上面即可

2. 返回的Mono对象可以通过chain.filter(exchange)或者exchange.getResponse().setComplete()获取

3. 这里的response中的setStatusCode()可以设置返回的状态码, 其中参数通过枚举获取

4. 这里的request获取参数得到的是MultiValueMap

5. 需要加上@Component注解

6. @Order(-1)是配置过滤器访问顺序, 顺序越小越先执行

   也可以通过实现@Ordered接口并重写方法实现

2.2.2.4 总结

路由过滤器的作用:

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

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

defaultFilters的作用:

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

全局过滤器的作用:

① 通过代码形式完成特定业务逻辑的过滤功能

2.2.3 过滤器执行顺序

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

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

为什么三种不同类型的过滤器可以做到放到一个List集合中呢?

首先当前路由过滤器与默认过滤器其实都是GatewayFilter类型, 只是配置时范围不同

而全局过滤器GlobalFilter则是通过

org.springframework.cloud.gateway.filter.AdaptCachedBodyGlobalFilter适配器进行准换的

排序的规则是什么呢？

• 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增, 因此会出现默认过滤器的声明顺序与路由过滤器的都是1,2,3…的情况
• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行

如图：

详细内容，可以查看源码：

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

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

2.3 跨域问题

2.3.1.什么是跨域问题

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

• 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

• 域名相同，端口不同：localhost:8080和localhost8081

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

解决方案：CORS，这里不再赘述CORS。不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html

2.3.2.模拟跨域问题

当发生可以在浏览器控制台看到下面的错误：

从localhost:8090访问localhost:10010，端口不同，显然是跨域的请求。

2.3.3.解决跨域问题

在gateway服务的application.yml文件中，添加下面的配置：

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

3. 网关作用

主要就是防暴露端口(访问全部先通过gateway再到服务), 以及解决跨域问题