Spring Cloud Gateway 统一服务入口实战指南

2.1.3 编写启动类

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

2.1.4 添加路由配置

创建 application.yml 文件，配置如下：

server:
  port: 10030
spring:
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        server-addr: nacos-server-address: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：路由断言，匹配符合规则的请求。

访问示例：http://127.0.0.1:10030/order/1

2.2 Route Predicate Factories

2.2.1 Predicate 基础

Predicate 是 Java 8 提供的函数式接口，接收参数返回布尔值，用于条件过滤。

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

2.2.2 路由断言工厂

Route Predicate Factory 负责将配置文件中的字符串规则转换为路由判断条件。例如 Path=/product/** 由 PathRoutePredicateFactory 实现。Spring Cloud Gateway 内置了多种断言，支持组合使用。

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

过滤器（Filter）用于在请求处理前后执行逻辑。分为 Pre（前置）和 Post（后置）类型。

• Pre：转发到后端前执行，适合鉴权、限流。
• Post：响应返回给客户端前执行，适合日志记录、数据修改。

按作用范围分为两类：

1. GatewayFilter：作用于单个或分组路由。
2. GlobalFilter：作用于所有路由。

2.3.1 GatewayFilter 使用

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

filters:
  - AddRequestParameter=userName,bite

该配置仅对 /product/** 路径生效，会在请求头中添加 userName=bite 参数。

若需对所有路由生效，可使用 default-filters：

spring:
  cloud:
    gateway:
      default-filters:
        - AddResponseHeader=X-Response-Default-Red,Default-Blue
        - PrefixPath=/httpbin

2.3.2 GlobalFilter

全局过滤器无需额外配置，自动应用于所有请求。常用于安全性、监控等全局功能。

启用 Actuator 监控指标：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

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 相同，顺序为：defaultFilter > GatewayFilter > GlobalFilter。

2.5 自定义过滤器

开发者可根据业务需求扩展过滤器，支持 GatewayFilter 和 GlobalFilter 两种模式。

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

配置类：

@Data
public class CustomConfig {
    private String name;
}

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 服务，有效管理微服务入口。