Spring Cloud 学习笔记四：服务网关（Gateway）

在微服务架构中，随着服务数量的增加，客户端直接与服务进行通信的方式会变得越来越复杂。为了简化客户端与服务之间的交互，同时实现一些跨服务的通用功能（如认证、限流、监控等），Spring Cloud 引入了服务网关（Gateway）的概念。本篇文章将详细介绍Spring Cloud Gateway的基本概念、使用场景、核心组件以及如何配置和使用它。

一、Spring Cloud Gateway 概述

Spring Cloud Gateway 是基于 Spring Framework 5, Project Reactor 和 Spring WebFlux 的 API 网关，它为微服务架构提供了一种简单而有效的方式来路由和过滤请求。Spring Cloud Gateway 不仅具备传统网关的功能，如路由转发、负载均衡等，还通过提供丰富的路由匹配和过滤功能，使得开发者可以轻松地实现复杂的路由逻辑和请求处理流程。

二、核心组件

1. Route（路由）

路由是 Gateway 的基本构建块，它定义了请求应该如何被转发到哪个服务。路由包含了一系列属性，如 ID、目标 URI、断言（Predicate）和过滤器（Filter）。

断言（Predicate）：用于匹配来自客户端的请求。如果请求与断言相匹配，则路由到目标 URI。
过滤器（Filter）：对请求和响应进行处理的逻辑，可以在请求被转发到目标服务之前或之后执行。

2. Predicate（断言）

Spring Cloud Gateway 提供了多种内置断言，用于匹配 HTTP 请求的不同属性，如路径、头信息、请求方法等。开发者也可以根据需要自定义断言。

3. Filter（过滤器）

过滤器可以在请求被路由前后对请求和响应进行加工处理。Spring Cloud Gateway 的过滤器分为 GatewayFilter 和 GlobalFilter 两种。GatewayFilter 是应用于单个路由的过滤器，而 GlobalFilter 则是应用于所有路由的过滤器。

三、使用场景

路由转发：将外部请求转发到内部微服务。
负载均衡：配合负载均衡器（如 Ribbon）实现请求的负载均衡。
认证授权：在请求到达目标服务之前进行身份验证和授权。
限流熔断：对请求进行限流，防止服务过载；在目标服务不可用时，提供熔断逻辑。
日志记录：记录请求和响应的详细信息，便于监控和故障排查。
四、配置示例

1. 添加依赖

在 Maven 的 pom.xml 文件中添加 Spring Cloud Gateway 的依赖：

<dependency>  
    <groupId>org.springframework.cloud</groupId>  
    <artifactId>spring-cloud-starter-gateway</artifactId>  
</dependency>

2. 配置路由

在 application.yml 或 application.properties 中配置路由规则：

spring:  
  cloud:  
    gateway:  
      routes:  
      - id: myroute  
        uri: http://example.com  
        predicates:  
        - Path=/mypath/**  
        filters:  
        - StripPrefix=1

上述配置定义了一个名为 myroute 的路由，它将所有以 /mypath/ 开头的请求转发到 http://example.com，并移除请求路径中的第一个路径段。

3. 自定义过滤器

可以通过实现 GlobalFilter 或 GatewayFilter 接口来创建自定义过滤器。

实现GlobalFilter

如果你想要创建一个全局过滤器，可以这样做：

java
import org.springframework.cloud.gateway.filter.GatewayFilterChain;  
import org.springframework.cloud.gateway.filter.GlobalFilter;  
import org.springframework.core.Ordered;  
import org.springframework.stereotype.Component;  
import org.springframework.web.server.ServerWebExchange;  
import reactor.core.publisher.Mono;  
  
@Component  
public class MyGlobalFilter implements GlobalFilter, Ordered {  
  
    @Override  
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {  
        // 在请求被处理之前执行  
        System.out.println("Before request is sent through the filter chain");  
  
        // 继续执行其他过滤器直到服务  
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {  
            // 在响应返回给客户端之后执行  
            System.out.println("After response is returned from the filter chain");  
        }));  
    }  
  
    @Override  
    public int getOrder() {  
        // 设置过滤器的执行顺序，数字越小，优先级越高  
        return -1;  
    }  
}

实现GatewayFilter

如果你想要为特定的路由创建过滤器，可以这样做：

java
import org.springframework.cloud.gateway.filter.GatewayFilter;  
import org.springframework.cloud.gateway.filter.GatewayFilterChain;  
import org.springframework.core.Ordered;  
import org.springframework.web.server.ServerWebExchange;  
import reactor.core.publisher.Mono;  
  
public class MyGatewayFilter implements GatewayFilter, Ordered {  
  
    @Override  
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {  
        // 在请求被处理之前执行  
        System.out.println("Before request is processed by MyGatewayFilter");  
  
        // 继续执行其他过滤器或服务  
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {  
            // 在响应返回给客户端之后执行  
            System.out.println("After response is processed by MyGatewayFilter");  
        }));  
    }  
  
    @Override  
    public int getOrder() {  
        // 设置过滤器的执行顺序  
        return 0;  
    }  
}

但是，对于GatewayFilter，你通常需要在路由配置中显式地引用它，而Spring Cloud Gateway并不直接支持将自定义的GatewayFilter实现作为Bean注入到路由配置中（至少在不使用额外代码或配置的情况下）。相反，你可以通过实现GatewayFilterFactory来创建可配置的过滤器工厂，然后在YAML或properties文件中配置这些过滤器。

实现GatewayFilterFactory

java
import org.springframework.cloud.gateway.filter.GatewayFilter;  
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;  
import org.springframework.stereotype.Component;  
  
import java.util.function.Predicate;  
  
@Component  
public class MyGatewayFilterFactory extends AbstractGatewayFilterFactory<MyGatewayFilterFactory.Config> {  
  
    public MyGatewayFilterFactory() {  
        super(Config.class);  
    }  
  
    public static class Config {  
        // 可以添加配置属性  
    }  
  
    @Override  
    public GatewayFilter apply(Config config) {  
        return (exchange, chain) -> {  
            // 过滤器逻辑  
            System.out.println("Applying MyGatewayFilterFactory with config: " + config);  
            return chain.filter(exchange);  
        };  
    }  
}

五、总结
Spring Cloud Gateway 提供了强大的路由和过滤功能，是微服务架构中不可或缺的一部分。通过合理使用 Spring Cloud Gateway，可以极大地简化客户端与微服务之间的交互，提高系统的可扩展性和可维护性。