SpringCloud组件--Gateway网关SpringCloud组件 -- Gateway的基本使用、断言工厂、过

一、前言

我们为什么需要网关？

当我们所有的服务摆在那里允许任何人发送请求访问是不是不太安全？

不是所有的业务都是对外公开的！

网关是我们服务的守门神，是所有微服务的统一入口，一切请求都要先到网关，再到微服务。

它可以帮助我们统一的进行一些操作，处理一些问题。

网关的核心功能特性：

请求路由、负载均衡：
- 一切请求都必须先经过gateway网关，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务同时部署多个时，还需要做负载均衡，也就是根据规则具体转发到某个服务。
身份认证和权限校验：
- 网关作为微服务入口，需要校验用户是否有请求资格，如果没有则进行拦截。
请求限流:
- 当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。处理跨域我们可以在网关中统一处理跨域问题，而不必单独在每个项目中处理。

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

gateway
zuul

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

二、基本使用

1.创建gateway服务，引入依赖(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.编写配置文件

server:
  port: 10010

spring:
  application:
    name: gateway-server
  cloud:
    nacos:
      server-addr: localhost:8848
    gateway:
      routes: #网关路由配置
        - id: user-server #路由id,自定义,只要唯一即可(唯一标识)
          uri: lb://user-server #路由的目标地址 lb是负载均衡,后面跟微服务名称
          predicates: #路由断言,判断请求是否符合路由规则的条件
            - Path=/user/** #只要以user开头的请求都符合,都会路由到user-server微服务中

        - id: order-server
          uri: lb://order-server
          predicates:
            - Path=/order/**

3.测试

4.流程图

三、断言工厂

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

四、过滤器

GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理： Spring提供了31种不同的路由过滤器工厂。例如：

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

1.路由过滤器

下面我们以AddRequestHeader 为例来讲解。

需求：给所有进入userservice的请求添加一个请求头：Truth=guanzhi is freaking awesome!
- 只需要修改gateway服务的application.yml文件，添加路由过滤即可：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 路由过滤器
        - AddRequestHeader=Truth, guanzhi is freaking awesome! # 添加请求头

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

2.默认过滤器

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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤器
      - AddRequestHeader=Truth, guanzhi is freaking awesome!

3.全局过滤器

(1)作用

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

区别在于：

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

定义方式是实现GlobalFilter接口。在filter中编写自定义逻辑，可以实现下列功能：

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

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

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

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

在gateway中定义一个过滤器类：

@Component
//@Order(-1) //设置过滤器优先级,越小优先级越高,默认2147483647
public class AuthorizeFilter implements GlobalFilter, Ordered {

    /**
     *  处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     * @param exchange 请求上下文，里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
    **/
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //1.从request对象中获取请求参数
        ServerHttpRequest request = exchange.getRequest(); //此request非Servlet中的request对象
        MultiValueMap<String, String> queryParams = request.getQueryParams(); //参数名为key,值为value
        //2.获取authorization参数
        String authorization = queryParams.getFirst("authorization");
        //3.校验
        if(authorization.equals("admin")) {
            //3.1成功,放行
            return chain.filter(exchange); //放行到下一个过滤器(网关中请求信息经过路由后,还要经过过滤器链)
        }
        //4.失败,设置状态码401,并结束
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() { //通过接口实现Ordered重写方法 与 注解形式设置优先级效果一样
        return -1;
    }
}

(3)测试

未传递请求参数,会被拦截

传递指定参数后,放行

4.过滤器优先级

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

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

排序的规则：

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

五、解决跨域问题

1.什么是跨域 跨域：域名不一致或端口不一致，主要包括：

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

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

例如:前端8090端口访问后端10010网关端口

解决方案：CORS

2.解决方案

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

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

3.配置解读

add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
- 网关特有配置,Ajax采用CORS方案(浏览器询问服务器让不让跨域,请求方式为opinions,默认情况下这种请求会被网关拦截)
maxAge: 360000 # 这次跨域检测的有效期
- 每次请求浏览器都询问服务器的话,压力太大,可配置有效期,在有效期内不会发起询问,直接放行
'[/**]': 拦截哪些请求, /**为拦截一切请求(凡是进入网关的请求都做跨域处理)

SpringCloud组件--Gateway网关