Spring Cloud Gateway 微服务统一入口与核心配置

2.1.3 编写启动类

创建一个标准的 Spring Boot 启动类。

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

2.1.4 配置路由

在 application.yml 中配置网关端口及路由规则。这里假设服务已注册到 Nacos。

server:
  port: 10030

spring:
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        server-addr: 110.41.51.65:10020
    gateway:
      routes:
        - id: product-service
          uri: lb://product-service
          predicates:
            - Path=/product/**
        - id: order-service
          uri: lb://order-service
          predicates:
            - Path=/order/**

配置说明：

• id：路由的唯一标识。
• uri：目标服务地址。使用 lb:// 前缀表示从注册中心获取服务列表并进行负载均衡。
• predicates：路由断言，只有匹配条件的请求才会被转发。例如 Path=/product/** 表示路径以 /product/ 开头的请求。

访问示例：http://127.0.0.1:10030/order/1 会被转发到 order-service。

2.2 Route Predicate Factories

2.2.1 Predicate 基础

Predicate 是 Java 8 提供的函数式接口，接收参数并返回布尔值，用于条件判断。在网关中，它决定了请求是否匹配某个路由。

@FunctionalInterface
public interface Predicate<T> {
    boolean test(T t);
}

实际使用中，我们可以直接使用 Lambda 表达式简化代码：

Predicate<String> predicate = s -> s.isEmpty();

2.2.2 路由断言工厂

Route Predicate Factory 将配置文件中的字符串规则转换为具体的匹配逻辑。例如 Path=/product/** 是由 PathRoutePredicateFactory 实现的。

Spring Cloud Gateway 内置了丰富的断言工厂，支持多种 HTTP 属性匹配（如时间、IP、Header 等），且支持 and 组合多个条件。

2.2.3 代码演示

除了路径匹配，我们还可以使用时间断言限制特定时间段内的访问。

spring:
  cloud:
    gateway:
      routes:
        - id: product-service
          uri: lb://product-service
          predicates:
            - Path=/product/**
            - After=2026-01-01T00:00:00.000+08:00[Asia/Shanghai]

这意味着只有在指定时间之后的请求才能通过该路由。

2.3 Gateway Filter Factories

Predicate 决定请求去哪，Filter 则决定在转发前后做什么处理。过滤器分为 Pre（前置）和 Post（后置）两种类型。

• Pre 类型：在转发到后端服务前执行，常用于鉴权、限流。
• Post 类型：在响应返回给客户端前执行，常用于日志记录、响应头修改。

根据作用范围，Filter 分为两类：

1. GatewayFilter：仅对单个或分组的特定路由生效。
2. GlobalFilter：对所有路由生效，适用于全局性的安全监控等功能。

2.3.1 GatewayFilter 使用

在配置文件中为特定路由添加过滤器。

spring:
  cloud:
    gateway:
      routes:
        - id: product-service
          uri: lb://product-service
          predicates:
            - Path=/product/**
          filters:
            - AddRequestParameter=userName,bite

此配置会在转发到 product-service 的请求中添加 userName=bite 参数。若需对所有路由生效，可使用 default-filters 配置。

2.3.2 GlobalFilter 使用

GlobalFilter 需要实现 GlobalFilter 接口。Spring Cloud Gateway 内置了一些全局过滤器，如 LoadBalancerClientFilter（负载均衡）、GatewayMetricsFilter（指标监控）等。

开启监控信息示例：

spring:
  cloud:
    gateway:
      metrics:
        enabled: true
  management:
    endpoints:
      web:
        exposure:
          include: "*"

访问 http://127.0.0.1:10030/actuator 即可查看相关监控数据。

2.4 过滤器执行顺序

当项目中同时存在 GatewayFilter 和 GlobalFilter 时，它们会被合并到一个过滤器链中排序执行。每个过滤器都需要指定 order 值，默认值为 0。

• order 值越小，优先级越高，执行越靠前。
• 若 order 相同，执行顺序通常为：defaultFilter > GatewayFilter > GlobalFilter。

可以通过实现 Ordered 接口或添加 @Order 注解来调整优先级。

2.5 自定义过滤器

2.5.1 自定义 GatewayFilter

继承 AbstractGatewayFilterFactory 即可轻松创建自定义的路由过滤器。

@Slf4j
@Service
public class CustomGatewayFilterFactory extends AbstractGatewayFilterFactory<CustomConfig> implements Ordered {

    public CustomGatewayFilterFactory() {
        super(CustomConfig.class);
    }

    @Override
    public GatewayFilter apply(CustomConfig config) {
        return (exchange, chain) -> {
            log.info("[Pre] Filter Request, name: {}", config.getName());
            // 执行业务逻辑
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                log.info("[Post] Response Filter");
            }));
        };
    }

    @Override
    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }
}

配合配置类 CustomConfig 使用，并在 YAML 中引用：

filters:
  - name: Custom
    args:
      name: custom filter

2.5.2 自定义 GlobalFilter

实现 GlobalFilter 接口即可，无需额外配置，会自动作用于所有请求。

@Slf4j
@Service
public class CustomGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("[Pre] CustomGlobalFilter enter...");
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {
            log.info("[Post] CustomGlobalFilter return...");
        }));
    }

    @Override
    public int getOrder() {
        return Ordered.LOWEST_PRECEDENCE;
    }
}

总结

本文详细介绍了 Spring Cloud Gateway 作为微服务统一入口的核心概念与实战配置。从基础的依赖引入、路由断言设置，到复杂的过滤器工厂机制及自定义扩展，涵盖了构建高性能网关所需的关键知识点。掌握这些内容，有助于开发者更好地管理微服务流量，提升系统的安全性与可维护性。