SpringCloud的网关Gateway

谁践踏了优雅 2023-10-15 17:41 56阅读 0赞

## 一、Gateway的作用 ##

> 1.权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。  
> 2.路由和负载均衡：一切请求都必须先经过 gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。  
> 3.限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。  
>

## 二、使用步骤 ##

### 1、依赖和配置 ###

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>

server:
      port: 10010 # 网关端口
    spring:
      application:
        name: gateway # 服务名称
      cloud:
        nacos:
          server-addr: localhost: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 是负载均衡(LoadBalance)，根据服务名拉取服务列表，实现负载均衡。
> 
> 重启网关，访问 http://localhost:10010/user/1 时，符合 /user/\*\* 规则，请求转发到 uri：http://userservice/user/1

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_9_color_FFFFFF_t_70_g_se_x_16]

多个 predicates 的话，要同时满足规则，下文有例子。

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_20_color_FFFFFF_t_70_g_se_x_16]

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

### 2、路由断言 ###

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

例如 Path=/user/\*\* 是按照路径匹配，这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory 类来处理的，像这样的断言工厂在 Spring Cloud Gateway 还有十几个

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

一般的，我们只需要掌握 Path，加上官方文档的例子，就可以应对各种工作场景了。

predicates:
      - Path=/order/**
      - After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]

详情见->[Gateway 服务网关断言工厂\_928-y的博客-CSDN博客][Gateway _928-y_-CSDN]

## 三、过滤器工厂 ##

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

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_20_color_FFFFFF_t_70_g_se_x_16 1]

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>名称</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>AddRequestHeader</td> 
   <td>给当前请求添加一个请求头</td> 
  </tr> 
  <tr> 
   <td>RemoveRequestHeader</td> 
   <td>移除请求中的一个请求头</td> 
  </tr> 
  <tr> 
   <td>AddResponseHeader</td> 
   <td>给响应结构中添加一个响应头</td> 
  </tr> 
  <tr> 
   <td>RemoveResponseHeader</td> 
   <td>从响应结果中移除有一个响应头</td> 
  </tr> 
  <tr> 
   <td>RequestRateLimiter</td> 
   <td>限制请求的流量</td> 
  </tr> 
 </tbody> 
</table>

下面我们以 AddRequestHeader 为例：  
需求：给所有进入 userservice 的请求添加一个请求头：sign=xn2001.com is eternal

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

spring:
      cloud:
        gateway:
          routes: # 网关路由配置
            - id: user-service # 路由id，自定义，只要唯一即可
              # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
              uri: lb://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
              predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
                - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
              filters:
                - AddRequestHeader=sign, xn2001.com is eternal # 添加请求头

如何验证，我们修改 userservice 中的一个接口

@GetMapping("/{id}")
    public User queryById(@PathVariable("id") Long id, @RequestHeader(value = "sign", required = false) String sign) {
        log.warn(sign);
        return userService.queryById(id);
    }

重启两个服务，访问：http://localhost:10010/user/1

可以看到控制台打印出了这个请求头

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_20_color_FFFFFF_t_70_g_se_x_16 2]

上面介绍的过滤器工厂，网关提供了 31 种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求，做自己的业务逻辑则没办法实现。

## 四、全局过滤器 ##

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与 GatewayFilter 的作用一样。区别在于 GlobalFilter 的逻辑可以写代码来自定义规则；而 GatewayFilter 通过配置定义，处理逻辑是固定的。

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

参数中是否有 authorization  
authorization 参数值是否为 admin  
如果同时满足则放行，否则拦截。

@Component
    public class AuthorizeFilter implements GlobalFilter, Ordered {
    
        // 测试：http://localhost:9007//hello/feifn?authorization=admin
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
            // 获取第一个 authorization 参数
            String authorization = exchange.getRequest().getQueryParams().getFirst("authorization");
            if ("admin".equals(authorization)){
                // 放行
                return chain.filter(exchange);
            }
            // 设置拦截状态码信息
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            // 设置拦截
            return exchange.getResponse().setComplete();
        }
    
        // 设置过滤器优先级，值越低优先级越高
        // 也可以使用 @Order 注解
        @Override
        public int getOrder() {
            return 0;
        }
    }

## 五、过滤器顺序 ##

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

请求路由后，会将三者合并到一个过滤器链（集合）中，排序后依次执行每个过滤器.

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_20_color_FFFFFF_t_70_g_se_x_16 3]

排序的规则

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

详细解释见[Filter（过滤器)\_928-y的博客-CSDN博客][Filter_928-y_-CSDN]

## 六、跨域问题 ##

不了解跨域问题的同学可以百度了解一下；在 Gateway 网关中解决跨域问题还是比较方便的。

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

[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_9_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/cdfd08e37151439da751778a3c7a1a63.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA==,size_9,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/d4c2a936046b489c9877a79b67b53339.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA==,size_20,color_FFFFFF,t_70,g_se,x_16
[Gateway _928-y_-CSDN]: https://blog.csdn.net/Isonion/article/details/132731626
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/93af2b8422e34d3e915230b9f8113cf8.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/3770d12211324e0299be191086333d2b.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/9b7ae5c509fd4084b106887918d89bd0.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5Yid57qnamF2YeiPnOm4n-eoi-W6j-WRmA==,size_20,color_FFFFFF,t_70,g_se,x_16
[Filter_928-y_-CSDN]: https://blog.csdn.net/Isonion/article/details/132736763