Gateway服务网关

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，基于 Spring 5.0、Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关。它旨在为微服务架构提供一种简单有效的统一 API 路由管理方式。Spring Cloud Gateway 提供了动态路由、过滤器和负载均衡等功能，使得微服务间的通信更加高效和安全。它可以轻松集成各种微服务，并提供统一的入口，简化了微服务的管理和监控。Spring Cloud Gateway 的设计使其具备高扩展性和高可用性，能够满足大规模微服务架构的需求。

1. 为什么需要网关

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

1.1 网关的核心功能特性

1. 权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

2. 统一入口：
   网关作为所有客户端请求的单一入口点，简化了客户端与后端服务的交互，隐藏了内部服务的复杂性，提供了一个统一的访问接口。

3. 路由：
   网关负责将请求路由到正确的后端服务。根据请求的 URL、HTTP 方法、请求头等信息进行智能路由，确保请求被正确处理。当然路由的目标服务有多个时，还需要做负载均衡。

4. 负载均衡：
   网关可以分发客户端请求到多个后端服务实例，提供负载均衡功能，提升系统的可靠性和性能，确保请求得到快速响应。

5. 请求限流：
   网关可以实现限流策略，控制每秒钟允许的最大请求数，防止系统过载，保护后端服务免受流量突增或恶意请求的影响，提升系统的稳定性。

6. 安全性：
   网关可以集中处理认证和授权，确保只有经过验证的请求才能访问后端服务。同时，它还可以提供其他安全功能，如防火墙、IP 白名单等，保护系统的安全性。

1.2 网关的实现方式

在 Spring Cloud 中，网关的实现主要包括两种：

1. Zuul：
   Zuul 是基于 Servlet 的实现，属于阻塞式编程。它作为 Netflix 开源的 API 网关，提供了动态路由、监控、弹性、安全等功能。然而，由于它基于阻塞式 I/O 模型，在处理大量并发请求时性能有限。

2. Spring Cloud Gateway：
   Spring Cloud Gateway 是基于 Spring 5 中提供的 WebFlux，属于响应式编程的实现。它利用 Project Reactor 和 Netty 提供非阻塞、事件驱动的 I/O 处理，具备更好的性能和更低的延迟。Spring Cloud Gateway 支持动态路由、过滤器、负载均衡等功能，同时具有较高的扩展性和灵活性。

相比之下，Spring Cloud Gateway 具有以下优势：

• 高性能：利用非阻塞 I/O 模型，能够更高效地处理大量并发请求。
• 响应式编程：基于响应式编程模型，能够提供更低的延迟和更高的吞吐量。
• 简化配置：提供更简单、直观的配置方式，方便开发人员进行网关的配置和管理。

总之，Spring Cloud Gateway 作为新一代的网关解决方案，在性能、扩展性和灵活性方面都优于 Zuul，适用于现代微服务架构的需求。

2. 搭建Gateway服务网关

搭建网关的基本路由功能步骤如下：

1. 创建SpringBoot工程gateway，引入网关依赖
2. 编写启动类
3. 编写基础配置和路由规则
4. 启动网关服务进行测试

2.1 创建gateway服务，引入依赖

创建网关模块

*引入依赖

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

<!-- 项目依赖 -->
   <dependencies>

       <!-- Spring Cloud Alibaba Nacos 服务发现启动器 -->
       <dependency>
           <groupId>com.alibaba.cloud</groupId>
           <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
           <version>2023.0.1.2</version>
       </dependency>

       <!-- Spring Cloud Gateway 启动器 -->
       <dependency>
           <groupId>org.springframework.cloud</groupId>
           <artifactId>spring-cloud-starter-gateway</artifactId>
           <version>4.1.5</version>
           <exclusions>
               <!-- 排除 Spring Boot Web 启动器 -->
               <exclusion>
                   <groupId>org.springframework.boot</groupId>
                   <artifactId>spring-boot-starter-web</artifactId>
               </exclusion>
           </exclusions>
       </dependency>

       <!-- Spring Boot 核心启动器 -->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter</artifactId>
           <version>3.3.2</version>
       </dependency>

       <!-- Jackson 数据绑定库 -->
       <dependency>
           <groupId>com.fasterxml.jackson.core</groupId>
           <artifactId>jackson-databind</artifactId>
           <version>2.17.2</version> <!-- 请使用与项目兼容的版本 -->
       </dependency>

       <!-- Jackson 核心库 -->
       <dependency>
           <groupId>com.fasterxml.jackson.core</groupId>
           <artifactId>jackson-core</artifactId>
           <version>2.17.2</version>
       </dependency>

       <!-- Jackson 注解库 -->
       <dependency>
           <groupId>com.fasterxml.jackson.core</groupId>
           <artifactId>jackson-annotations</artifactId>
           <version>2.17.2</version>
       </dependency>

       <!-- Spring Cloud 负载均衡器 -->
       <dependency>
           <groupId>org.springframework.cloud</groupId>
           <artifactId>spring-cloud-loadbalancer</artifactId>
           <version>4.1.4</version>
       </dependency>
   </dependencies>

[!tip]

在我使用的时候直接继承的父类Maven，但是出现可以运行但是访问http://localhost:10010/order/106等出现资源找不到404，大概问题是依赖冲突了。

编写基础配置和路由规则

Gateway本身就是一个微服务模块，所以也要向nacos注册。

创建application.yml文件，内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

server:
  port: 10010 # 网关端口，指定网关服务监听的端口号

spring:
  application:
    name: gateway # 服务名称，指定网关服务在 Spring 应用中的名称

  cloud:
    nacos:
      discovery:
        server-addr: 192.168.80.1:80/nacos # Nacos 服务地址，指定 Nacos 注册中心的地址，通过 Nginx 代理访问

    gateway:
      routes: # 网关路由配置，用于定义各种路由规则
        - id: user-service # 路由ID，自定义的唯一标识符
          # uri: http://127.0.0.1:8081 # 静态路由目标地址，用于将请求转发到指定的地址
          uri: lb://user-service # 动态路由目标地址，使用负载均衡，将请求转发到名为 'user-service' 的服务实例
          predicates: # 路由断言条件，决定请求是否匹配该路由规则
            - Path=/user/** # 路径断言，只要请求路径以 /user/ 开头，就匹配该路由规则

        - id: order-service # 路由ID，自定义的唯一标识符
          uri: lb://order-service # 动态路由目标地址，使用负载均衡，将请求转发到名为 'order-service' 的服务实例
          predicates: # 路由断言条件，决定请求是否匹配该路由规则
            - Path=/order/** # 路径断言，只要请求路径以 /order/ 开头，就匹配该路由规则

将符合Path 规则的一切请求，都代理到 uri参数指定的地址。

本例中，将 /user/**开头的请求，代理到lb://user-service，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

启动测试

启动nacos集群、Ngnix、order-service微服务、user-service微服务、gateway微服务。

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

3. 网关路由的流程图

整个访问的流程如下：

3.1 总结

网关搭建步骤

1. 创建项目，引入nacos服务发现和gateway依赖

2. 配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括

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

4. 路由断言工厂

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

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

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

处理的，像这样的断言工厂在SpringCloudGateway还有十几个:

Spring-Cloud-Gateway官方参考文档

5. 过滤器工厂

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

5.1 路由过滤器的种类

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

GatewayFilter Factories官方参考文档

5.2 请求头过滤器

以AddRequestHeader 为例，给所有进入userservice的请求添加一个请求头：Header=Camellia·XIAOHUA

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

1
2
3
4
5
6
7
8
9
10
11

spring:
  cloud:
    gateway:
      routes: # 网关路由配置，用于定义各种路由规则
        - id: user-service # 路由ID，自定义的唯一标识符
          # uri: http://127.0.0.1:8081 # 静态路由目标地址，用于将请求转发到指定的地址
          uri: lb://user-service # 动态路由目标地址，使用负载均衡，将请求转发到名为 'user-service' 的服务实例
          predicates: # 路由断言条件，决定请求是否匹配该路由规则
            - Path=/user/** # 路径断言，只要请求路径以 /user/ 开头，就匹配该路由规则
          filters:
            - AddRequestHeader=Header, Camellia·XIAOHUA # 请求过滤器，添加一个请求头

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

5.3 默认过滤器

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

server:
  port: 10010 # 网关端口，指定网关服务监听的端口号

spring:
    gateway:
      routes: # 网关路由配置，用于定义各种路由规则
        - id: user-service # 路由ID，自定义的唯一标识符
          # uri: http://127.0.0.1:8081 # 静态路由目标地址，用于将请求转发到指定的地址
          uri: lb://user-service # 动态路由目标地址，使用负载均衡，将请求转发到名为 'user-service' 的服务实例
          predicates: # 路由断言条件，决定请求是否匹配该路由规则
            - Path=/user/** # 路径断言，只要请求路径以 /user/ 开头，就匹配该路由规则

        - id: order-service # 路由ID，自定义的唯一标识符
          uri: lb://order-service # 动态路由目标地址，使用负载均衡，将请求转发到名为 'order-service' 的服务实例
          predicates: # 路由断言条件，决定请求是否匹配该路由规则
            - Path=/order/** # 路径断言，只要请求路径以 /order/ 开头，就匹配该路由规则
            - Before=2030-01-20T17:42:47.789-07:00[Asia/Shanghai] # 时间断言，只在指定时间之前匹配
      default-filters: # 默认过滤项，应用于所有路由
        - AddRequestHeader=Header, Global filters! # 请求过滤器，添加一个全局请求头

5.4 总结

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

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

defaultFilters的作用是什么？

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

6. 全局过滤器

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

6.1 全局过滤器作用

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

定义方式是实现GlobalFilter接口。

1
2
3
4
5
6
7
8
9
10

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

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

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

6.2 自定义全局过滤器

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

• 参数中是否有authorization，

• authorization参数值是否为admin

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

实现：

在gateway中定义一个过滤器：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

package gateway;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * 授权过滤器，用于在网关层进行请求的授权检查
 */
// @Order(-1) // 如果需要指定过滤器的优先级，取消注释此行。值越小，优先级越高。
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {

    /**
     * 过滤器的核心方法，用于处理请求过滤逻辑
     * @param exchange 包含了请求和响应的上下文信息
     * @param chain 用于传递请求到下一个过滤器
     * @return 表示异步完成的Mono对象
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1. 获取请求对象
        ServerHttpRequest request = exchange.getRequest();

        // 2. 获取请求参数
        MultiValueMap<String, String> params = request.getQueryParams();

        // 3. 获取请求参数中的 "authorization" 参数值
        String auth = params.getFirst("authorization");

        // 4. 判断 "authorization" 参数是否为 "admin"
        if ("admin".equals(auth)) {
            // 4.1 如果参数为 "admin"，则放行请求
            return chain.filter(exchange);
        }

        // 5. 如果参数不是 "admin"，则拦截请求
        // 5.1 设置HTTP状态码为401 Unauthorized
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);

        // 5.2 拦截请求，终止请求链
        return exchange.getResponse().setComplete();
    }

    /**
     * 指定过滤器的顺序
     * @return 过滤器的优先级，值越小优先级越高
     */
    @Override
    public int getOrder() {
        return -1;
    }
}

方法二：@Order(-1) 值越小，优先级越高。

6.3 过滤器执行顺序

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

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

排序的规则是什么呢？

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

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

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

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

7. 跨域问题

7.1 什么是跨域问题

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

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

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

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

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

7.2 解决跨域问题

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

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

[!tip]

在跨域配置中，allowedOrigins 中的地址是前端应用的地址。这个地址指的是你允许进行跨域请求的源。

例如，如果你的前端应用运行在 http://localhost:8090，那么你应该在 allowedOrigins 中包含这个地址，以允许从这个地址发起的跨域请求。