spring cloud 学习笔记(6)：Gateway网关路由、过滤器

前言

为什么需要网关？

Gateway网关是我们服务的守门神，是所有微服务的统一入口
网关的核心功能特性：
①请求路由 ②权限控制 ③限流

架构图：

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

权限控制： 网关作为微服务的入口，需要校验用户是否有请求资格，如果没有则拦截
限流：当请求量过高时，在网关中按照微服务能够接受的速度来放行请求，避免服务压力过大

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

一、统一网关Gateway搭建

1、创建新的module，导入依赖

<!--网关-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--Eureka服务发现依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

2、编写配置文件和路由规则

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:80 # nacos地址（我这里还是用的nginx反向代理，你们可以启动一个单体的nacos，用8848端口）
    gateway:
      routes:
        - id: user-service # 路由id，自定义，只需要唯一即可
          uri: lb://user-service # 路由的目标地址，lb表示负载均衡，后面跟服务名称
          # uri: http://localhost:8081 # 路由的目标地址，http就是固定地址
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要是以/user开头的，就符合规则
        - id: order-service # 按照上面的写法，再配置一下order-service
          uri: lb://order-service 
          predicates: 
            - Path=/order/** 
        #uri使用的http协议，固定地址
        - id: 163
          uri: http://www.163.com
          predicates:
            - Path=/163
            - Method=POST,GET   #请求方法

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

前提将user-service和order-service注册到Nacos，并启动

重启网关，访问http://localhost:10010/user/1 时，符合/user/**规则，请求转发到http://user-service/user/1，结果如下

{
    "id": 1,
    "username": "柳岩",
    "address": "湖南省衡阳市"
}

访问http://localhost:10010/order/101 时，符合/order/**规则，请求转发到http://order-service/order/101，结果如下

{
    "id": 101,
    "price": 699900,
    "name": "Apple 苹果 iPhone 12 ",
    "num": 1,
    "userId": 1,
    "user": {
        "id": 1,
        "username": "柳岩",
        "address": "湖南省衡阳市"
    }
}

网关路由执行流程：

4、总结

二、路由断言工厂

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

关于更详细的使用方法，可以参考官方文档：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

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

三、路由过滤器

1、什么是路由过滤器

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

2、过滤器工厂

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

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

官方文档的使用举例:

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
        - AddRequestHeader=X-Request-red, blue

关于更详细的使用方法，可以参考官方文档：https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

3、请求头过滤器实例

下面我们以AddRequestHeader为例：
需求：给所有进入user-service的请求都添加一个请求头：Truth=Hello, bansui!
①修改配置文件，添加路由过滤即可

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:80 # nacos地址
    gateway:
      routes:
        - id: user-service
          uri: lb://user-service
          predicates:
            - Path=/user/**
          filters:
            - AddRequestHeader=Truth=Hello, bansui! # 添加请求头

当前过滤器写在user-service路由下，因此仅仅对访问user-service的请求有效，我们在UserController中编写对应的方法来测试

@GetMapping("/test")
public void test(@RequestHeader("Truth") String tmp) {
    System.out.println(tmp);
}

重启网关和user-service，打开浏览器访问http://localhost:10010/user/test， 控制台会输出Truth=Hello, bansui!，证明我们的配置已经生效

4、默认过滤器

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

default-filters: 
        - AddRequestHeader=Truth=Hello, bansui! # 添加请求头

重启网关和user-service，打开浏览器访问http://localhost:10010/user/test， 控制台依旧输出Truth=Hello, bansui!，证明我们的配置已经生效

四、全局过滤器

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

自定义全局过滤器、过滤器的执行顺序

五、跨域问题

1、什么是跨域问题

• 跨域：域名不一致就是跨域，主要包括
  1. 域名不同：www.baidu.com和www.baidu.org，www.js.com和miaosha.js.com
  2. 域名相同，端口不同：localhost:8080和localhost:8081
• 跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题
• 解决方案：CORS
  • CORS是一个W3C标准，全称是”跨域资源共享”（Cross-origin resource sharing）。
  • 它允许浏览器向跨源服务器，发出XMLHttpRequest请求，从而克服了AJAX只能同源使用的限制。

2、解决跨域问题

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

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

到此我们就了解如何使用SpringCloud Gateway了！