API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) · 课时

自定义请求与响应过滤器

开发自定义过滤器，注入用于修改传入请求或传出响应的特定逻辑。

自定义请求与响应过滤器 是 CoddyKit 上的免费 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课时。这是第 2 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

Why Custom Filters?

Spring Cloud Gateway offers many built-in filters, but sometimes you need very specific logic. Custom filters let you inject your own code into the request/response flow.

This allows for highly tailored processing, such as custom authentication checks, unique logging formats, or specific header manipulations.

The GatewayFilter Interface

To create a custom filter, you'll implement the GatewayFilter interface. This interface has one main method: filter().

ServerWebExchange exchange: Provides access to the HTTP request and response.
GatewayFilterChain chain: Allows you to pass the request to the next filter or the target service.

You'll also often implement Ordered to define your filter's execution priority.

Basic Request Logger Filter

Let's create a simple filter that logs the incoming request path and method. This filter will run before the request is forwarded to the backend service.

Notice how chain.filter(exchange) is called to continue the processing.

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 MyLoggingFilter implements GatewayFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("Incoming Request:");
        System.out.println("  Path: " + exchange.getRequest().getPath());
        System.out.println("  Method: " + exchange.getRequest().getMethod());
        return chain.filter(exchange); // Pass to next filter/service
    }

    @Override
    public int getOrder() {
        return -1; // Execute early
    }

    public static void main(String[] args) {
        MyLoggingFilter filter = new MyLoggingFilter();
        System.out.println("This filter logs request details.");
        System.out.println("In a Spring Gateway app, this code runs for each matched request.");
        System.out.println("The 'filter' method is the core logic, 'getOrder' sets priority.");
    }
}

Registering Your Custom Filter

Once you've created your filter class, you need to tell Spring Cloud Gateway to use it. You can register it either in your application.yml or programmatically.

For simple filters, registering directly on a route is common. For more complex, reusable filters, a filter factory is often used (covered later).

spring:
  cloud:
    gateway:
      routes:
        - id: my_custom_route
          uri: http://localhost:8081
          predicates:
            - Path=/api/**
          filters:
            - MyLoggingFilter # Name of your @Component filter

Accessing Request & Response

The ServerWebExchange object is your gateway to everything about the current HTTP interaction. It contains the ServerHttpRequest and ServerHttpResponse.

exchange.getRequest(): Get details about the incoming request (headers, body, path).
exchange.getResponse(): Modify the outgoing response (headers, status code).

Remember, these are reactive types, so operations often return Mono or Flux.

Modifying Request Headers

You might need to add or modify headers before forwarding a request to a backend service. For example, injecting an authentication token or a tracing ID.

Since ServerHttpRequest is immutable, you must build a new request using mutate() and then update the exchange.

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 AddAuthHeaderFilter implements GatewayFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String authToken = "my-secret-token-123"; // Get from config/service
        ServerWebExchange mutatedExchange = exchange.mutate()
            .request(builder -> builder.header("X-Auth-Token", authToken))
            .build();
        System.out.println("Added X-Auth-Token header to request.");
        return chain.filter(mutatedExchange); // Use the mutated exchange
    }

    @Override
    public int getOrder() {
        return 0; // After logging, before forwarding
    }

    public static void main(String[] args) {
        AddAuthHeaderFilter filter = new AddAuthHeaderFilter();
        System.out.println("This filter adds an 'X-Auth-Token' header.");
        System.out.println("It uses 'exchange.mutate().request(...).build()' to modify the request.");
    }
}

Modifying Response Headers

Custom filters can also modify the response *after* the backend service has sent its reply. This is useful for adding security headers, caching directives, or custom metadata.

The trick is to use exchange.getResponse().beforeCommit() to hook into the response lifecycle, or reactive chaining.

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 AddResponseHeaderFilter implements GatewayFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {
            // This code runs AFTER the response from backend is received
            exchange.getResponse().getHeaders().add("X-Gateway-Processed", "true");
            System.out.println("Added X-Gateway-Processed header to response.");
        }));
    }

    @Override
    public int getOrder() {
        return 1; // After request processing
    }

    public static void main(String[] args) {
        AddResponseHeaderFilter filter = new AddResponseHeaderFilter();
        System.out.println("This filter adds 'X-Gateway-Processed' to the response.");
        System.out.println("It uses 'chain.filter(exchange).then(Mono.fromRunnable(...))' for post-processing.");
    }
}

Controlling Filter Order

When you have multiple custom filters, their execution order matters. The Ordered interface (and its getOrder() method) lets you define this.

Lower values (e.g., -1) mean higher priority (execute earlier).
Higher values (e.g., 1) mean lower priority (execute later).
Filters with the same order might run in an undefined sequence.

Use Ordered.HIGHEST_PRECEDENCE or LOWEST_PRECEDENCE for extreme cases.

Custom GatewayFilter Factories

For more advanced scenarios, especially when your filter needs configuration (e.g., a specific header name, a threshold value), you can create a GatewayFilterFactory.

This allows you to define a filter with parameters that can be configured directly in your application.yml, making your filters highly reusable and flexible.

You'd extend AbstractGatewayFilterFactory and define a configuration class for its properties.

Filter Logic Check

Consider a custom GatewayFilter that needs to both add a request header and then, after the backend responds, add a response header. Which parts of the filter() method would you modify?

Recap: Custom Filter Power

You've learned how to create custom GatewayFilters in Spring Cloud Gateway. These filters are powerful tools for injecting specific logic into your API Gateway's request and response flow.

Implement GatewayFilter and Ordered.
Use ServerWebExchange for request/response access.
Mutate requests and use reactive chaining for response modification.
Control execution order with getOrder().

Custom filters give you fine-grained control to tailor your gateway's behavior precisely.

常见问题解答

「自定义请求与响应过滤器」课时是免费的吗？

是的 — 「自定义请求与响应过滤器」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课程的其余内容，请升级到 CoddyKit PRO。 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课程共包含 4 节课。

「自定义请求与响应过滤器」这节课中我会学到什么？

开发自定义过滤器，注入用于修改传入请求或传出响应的特定逻辑。你通过在浏览器中直接运行的动手代码来练习 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 需要有经验吗？

无需任何先前经验。CoddyKit 上的 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。这是第 2 节课，共 4 节。

「自定义请求与响应过滤器」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课中编写并运行代码吗？

能。每节 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway) 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

← 返回 API Gateway & Reverse Proxy (Nginx + Spring Cloud Gateway)