Zuul配置文件中如何设置路由规则和过滤器？

Question

**问题描述：** 在使用 Netflix Zuul 作为网关服务时，如何在配置文件中正确设置路由规则和自定义过滤器？常见的问题包括路由路径不匹配、忽略特定路径失败、过滤器未生效或执行顺序错误等。例如，为何配置了 `ignored-patterns` 仍被路由？为何自定义过滤器未按预期执行？如何通过 `application.yml` 或 `properties` 文件实现动态路由与过滤逻辑？这些问题常导致请求无法正确转发或过滤逻辑失效，影响微服务架构的正常运作。

Answer 1

一、Zuul 网关路由配置与过滤器设置概述

Netflix Zuul 是一个基于 JVM 的路由和过滤器框架，广泛用于微服务架构中作为 API 网关。其核心功能包括动态路由、监控、弹性和安全控制。正确配置路由规则与自定义过滤器是实现 Zuul 功能的关键。

• 路由规则决定了请求如何被转发到下游服务
• 过滤器用于在请求处理前后执行自定义逻辑，如鉴权、限流、日志等

二、Zuul 路由规则配置详解

1. 基本路由配置

Zuul 支持通过 application.yml 或 application.properties 文件配置路由规则。以下是一个典型的 application.yml 配置示例：

zuul:
  routes:
    users:
      path: /api/users/**
      serviceId: user-service
      stripPrefix: true
    orders:
      path: /api/orders/**
      serviceId: order-service
      stripPrefix: false

• path：匹配的请求路径
• serviceId：注册在 Eureka 中的服务名称
• stripPrefix：是否移除前缀

2. 忽略特定路径配置

使用 ignored-patterns 可以忽略某些路径不被 Zuul 处理，例如：

zuul:
  ignored-patterns: /api/users/admin/**

但有时即使配置了该参数，某些路径仍然被路由。原因可能包括：

1. 路径匹配顺序问题：Zuul 使用最长匹配原则
2. 正则表达式不匹配：需使用通配符或正则表达式
3. 服务注册问题：被忽略的服务仍被注册

三、Zuul 自定义过滤器配置与执行顺序

1. 过滤器类型与生命周期

Zuul 的过滤器分为四种类型，执行顺序如下：

类型	作用	执行顺序
pre	请求路由前执行	最先执行
route	处理实际请求路由	第二阶段
post	请求路由后执行	第三阶段
error	处理异常情况	最后执行

2. 自定义过滤器未生效的常见原因

• 未正确注册为 Spring Bean
• 未实现正确的 filterType() 和 filterOrder() 方法
• 过滤器被禁用（shouldFilter() 返回 false）

示例代码：

public class CustomPreFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 1;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        ctx.addZuulRequestHeader("X-Custom-Header", "CustomValue");
        return null;
    }
}

四、动态路由与过滤逻辑实现

1. 动态路由原理

Zuul 可通过集成 Eureka 实现服务发现，动态获取服务实例。结合 ServiceInstanceChooser 可以实现负载均衡路由。

2. 动态过滤逻辑

可以通过配置中心（如 Spring Cloud Config、Alibaba Nacos）动态更新过滤器逻辑，例如：

zuul:
  filters:
    custom:
      enabled: true
      config:
        logEnabled: true
        authEnabled: false

在过滤器中读取这些配置并决定是否执行相应逻辑。

3. 路由与过滤流程图

graph TD A[客户端请求] --> B{路由匹配} B -->|匹配| C[执行Pre过滤器] C --> D[执行Route过滤器] D --> E[调用下游服务] E --> F[执行Post过滤器] B -->|不匹配| G[返回404] C -->|过滤失败| H[执行Error过滤器] H --> I[返回错误信息]