SpringCloud Gateway 服务网关的快速入门

╰+哭是因爲堅強的太久メ 2024-04-07 15:11 69阅读 0赞

> 作者：[大三的土狗][Link 1]  
> 专栏：[SpringCloud][]  
> ![在这里插入图片描述][c3d674d122e8490686a667ef2264ffd4.png]

#### 快速导航 ####

*  前言
 *   *  1、Gateway 简介
     *  2、Gateway 特点
     *  3、Gateway快速入门
     *   *   *  1、创建gateway服务
             *  2、引入依赖
             *  3、编写启动类
             *  4、编写配置文件
             *  5、测试
     *  4、断言工厂
     *  5、过滤器工厂
     *   *   *  1、路由过滤器的种类
             *  2、请求头过滤器
             *  3、默认过滤器
     *  6、全局过滤器
     *   *   *  1、全局过滤器作用
             *  2、自定义全局过滤器
             *  3、过滤器执行顺序
     *  7、跨域问题
 *  总结

## 前言 ##

>   Spring Cloud Gateway 旨在提供一种简单而有效的方式来路由到 API，并为它们提供横切关注点，例如：安全性、监控/指标和弹性。 网关作为系统的唯一流量入口，封装内部系统的架构，所有请求都先经过网关，由网关将请求路由到合适的微服务。文本仅仅简单的介绍了对 Spring Cloud Gateway 的认识及使用。

### 1、Gateway 简介 ###

Gateway网关官网链接： https://spring.io/projects/spring-cloud-gateway

![在这里插入图片描述][9216abfea1984a02b0a5b6fe014c7a7b.png]

1、网关的**核心功能特性**：

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

2、架构图：

![在这里插入图片描述][511256fafa5741c5bed0c0ab355eca1d.png]

### 2、Gateway 特点 ###

*  基于 Spring Framework 5、Project Reactor 和 Spring Boot 2.0 构建
 *  能够匹配任何请求属性的路由。
 *  谓词和过滤器特定于路由。
 *  断路器集成。
 *  Spring Cloud Discovery客户端集成
 *  易于编写谓词和过滤器
 *  请求速率限制
 *  路径重写

### 3、Gateway快速入门 ###

##### 1、创建gateway服务 #####

创建SpringBoot工程gatewaway

![在这里插入图片描述][24e9aefea0d34fccb547d6d16f1418db.png]

##### 2、引入依赖 #####

引入依赖，nacos和网关gateway的依赖。

<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>

##### 3、编写启动类 #####

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class GatewayApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(GatewayApplication.class, args);
        }
    }

##### 4、编写配置文件 #####

编写基础配置和路由规则，创建application.yml文件，内容如下：

server:
      port: 10086 # 网关端口
    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是负载均衡，根据服务名拉取服务列表，实现负载均衡。

##### 5、测试 #####

当访问http://localhost:10086/user/1时，符合`/user/**`规则，请求转发到uri：http://user-service/user/1，得到了结果：

![在这里插入图片描述][43fdde4b79434ddb90ac6195d21763d6.png]

简单来说，当来了一个请求时，都会经过网关判断是否符合规则，如果符合规则则跳转到相应地址。

### 4、断言工厂 ###

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

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

`org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory`类来

SpringCloudGateway 的断言工厂在还有下面十几个:

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

### 5、过滤器工厂 ###

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

##### 1、路由过滤器的种类 #####

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

<table> 
 <thead> 
  <tr> 
   <th><strong>名称</strong></th> 
   <th><strong>说明</strong></th> 
  </tr> 
 </thead> 
 <tbody> 
  <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>

##### 2、请求头过滤器 #####

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

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

##### 3、默认过滤器 #####

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

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

### 6、全局过滤器 ###

##### 1、全局过滤器作用 #####

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

定义方式是实现GlobalFilter接口。

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

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

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

##### 2、自定义全局过滤器 #####

定义全局过滤器，拦截请求，判断请求的参数是否满足条件，参数中是否有authorization，authorization参数值是否为admin，如果同时满足则放行，否则拦截。

在gateway中定义一个过滤器，代码如下。

@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();
        }
    }

##### 3、过滤器执行顺序 #####

请求进入网关会碰到三类过滤器：

*  当前路由的过滤器
 *  DefaultFilter
 *  GlobalFilter

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

排序的规则如下：

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

### 7、跨域问题 ###

在gateway服务的application.yml文件中，根据需求添加下面的配置。

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

## 总结 ##

>   API Gateway（APIGW / API网关），是出现在系统边界上的一个面向API的、串行集中式的强管控服务，这里的边界是企业IT系统的边界，可以理解为 企业级应用防火墙，主要起到 隔离外部访问与内部系统的作用。简单来说，当来了一个请求时，都会经过网关，进行把关。在微服务概念的流行之前，API网关就已经诞生了，例如银行、证券等领悦常见的前置机系统，它也是解决访问认证、报文转换、访问统计等问题的。
> 
>   最后，每日毒鸡汤：“三人省力，四人更簡單，衆人團結緊，百事能成功。”

[Link 1]: https://blog.csdn.net/qq_53463544?type=blog
[SpringCloud]: https://blog.csdn.net/qq_53463544/category_11977470.html?spm=1001.2014.3001.5482
[c3d674d122e8490686a667ef2264ffd4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/8f50f989eb68403e9d4e0166fe7013bf.png
[9216abfea1984a02b0a5b6fe014c7a7b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/2b54bead274546f4b022927f4f029e16.png
[511256fafa5741c5bed0c0ab355eca1d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/675f0807d9f64128bc313f4c255e2be4.png
[24e9aefea0d34fccb547d6d16f1418db.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/563577818dbc40ae8d246b7c173f087b.png
[43fdde4b79434ddb90ac6195d21763d6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/ff97f600dc9e422f9b0d99448f1627d5.png