gateway之过滤器（Filter）详解

文章目录

什么是过滤器
- 过滤器的种类
总结

什么是过滤器

在Spring Cloud中，过滤器（Filter）是一种关键的组件，用于在微服务架构中处理和转换传入请求以及传出响应。过滤器位于服务网关或代理中，并通过拦截请求和响应流量来提供各种功能。

过滤器在请求的不同生命周期阶段执行特定的操作，例如鉴权、认证、请求转发、限流、日志记录等。它们可以在服务调用链中的不同位置进行配置和应用，以实现各种需求和业务规则。

Spring Cloud Gateway和Zuul是两个常用的Spring Cloud组件，提供了内置的过滤器机制。

Spring Cloud Gateway使用GatewayFilter来定义过滤器。GatewayFilter可以在请求进入网关时、在路由转发之前或之后，以及在响应返回给客户端之前或之后执行操作。它们提供了丰富的功能和扩展性，如鉴权、限流、重试、请求转发、修改请求/响应等。

Zuul使用Zuul Filter来实现过滤器功能。Zuul Filter分为四种类型：pre、route、post和error。pre过滤器在请求被路由之前执行，可用于鉴权、请求限制等操作；route过滤器用于将请求路由到具体的服务实例；post过滤器在请求已经被路由到目标服务并得到响应后执行，可进行响应的日志记录、统计信息收集等操作；error过滤器处理在整个请求生命周期中发生的错误。

通过编写和配置过滤器，我们可以根据特定需求对请求和响应进行操作，从而实现强大的功能和逻辑。过滤器能够提高安全性、稳定性和可维护性，并且与Spring Cloud的其他组件集成，使得微服务架构更加灵活和可扩展。

过滤器的种类

在Spring Cloud中，过滤器（Filter）根据其作用和所处的阶段，可以分为以下几种类型：

全局过滤器（Global Filters）：全局过滤器是应用于所有进入服务网关或代理的请求和响应的过滤器。它们可以执行跨服务的通用功能，如鉴权、请求日志记录、性能监控等。全局过滤器对整个微服务架构起到了全局影响，因此需要谨慎使用。

前置过滤器（Pre Filters）：前置过滤器在路由转发之前执行。它们可以处理请求的验证、鉴权、参数校验等操作。前置过滤器可以拦截请求并进行必要的修改，例如添加头信息、修改请求路径等。通过前置过滤器，我们可以在请求进入系统之前对其进行预处理。

路由过滤器（Route Filters）：路由过滤器在请求被路由到目标服务实例之前执行。它们可以修改请求的URL、请求头、请求体等，并决定请求应该被路由到哪个服务实例。通过路由过滤器，我们可以实现动态路由、负载均衡等功能。

后置过滤器（Post Filters）：后置过滤器在请求已经被路由到目标服务实例并得到响应后执行。它们可以对响应进行处理，例如日志记录、结果转换、添加响应头等。后置过滤器常用于统一处理响应，确保响应符合统一的格式和标准。

错误过滤器（Error Filters）：错误过滤器用于处理在请求生命周期中发生的错误。它们可以捕获异常、记录错误信息，并提供适当的响应给客户端。错误过滤器可以增强系统的健壮性，使其能够更好地处理异常情况。

除全局过滤器外，其他均属于局部过滤器

局部过滤器

局部过滤器（Local Filters）指的是应用于特定路由或服务实例的过滤器。它们可以针对某个具体的路由进行处理，并只对该路由的请求和响应生效。后置过滤器是局部过滤器的一种形式，它在请求被路由到目标服务实例并得到响应后执行。

通过定义后置过滤器，您可以对从后端服务返回的响应进行处理和修改。例如，您可以在后置过滤器中添加响应头、记录日志、转换响应结果等操作。后置过滤器提供了一个在请求生命周期的最后阶段对响应进行加工的机会。

代码示例

以下是一个路由过滤器的例子

import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.stereotype.Component;

@Component
public class CustomRouteFilter extends AbstractGatewayFilterFactory<CustomRouteFilter.Config> {

    public CustomRouteFilter() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            // 在路由请求之前执行的操作
            System.out.println("执行路由过滤器");
            // 可以根据需要对请求进行修改、验证等操作

            return chain.filter(exchange);
        };
    }

    public static class Config {
        // 配置参数（可选）
    }

}

在上述示例中，我们创建了一个名为CustomRouteFilter的类，并继承了AbstractGatewayFilterFactory。同样，Config是用于配置参数的类，根据需要进行自定义。

然后，我们重写了apply方法，并在其中编写了自定义的路由过滤器逻辑。在这个示例中，我们简单地打印了一条消息，表示路由过滤器被执行。

通过将此自定义路由过滤器添加到Spring Cloud Gateway的路由配置中，它将在路由请求之前执行特定逻辑。您还可以根据需要对请求进行修改、验证等操作。

全局过滤器

全局过滤器是应用于所有进入服务网关或代理的请求和响应的过滤器。它们可以执行跨服务的通用功能，如鉴权、请求日志记录、性能监控等。全局过滤器对整个微服务架构起到了全局影响，因此需要谨慎使用。

代码示例

在全局过滤器中，过滤的类需要去实现GlobalFilter 接口。

@Component
public class LogFilter implements GlobalFilter {
    Logger log=  LoggerFactory.getLogger(this.getClass());
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info(exchange.getRequest().getPath().value());
        return chain.filter(exchange);
    }
}

此代码为记录日志的全局过滤器，当执行时，会在控制台记录其对应的日志信息。
在这里插入图片描述

总结

作为Spring Cloud Gateway中的重要组件，Filter可以对传入的HTTP请求进行处理，以便对其进行修改或验证，或者在路由到目标服务之前/之后执行特定逻辑。Filter是Gateway的核心部分，用于提供一种通用的机制来处理HTTP请求，并帮助实现更强大、高效和安全的网关。

Spring Cloud Gateway提供了三种不同类型的Filter：全局过滤器、局部前置过滤器和局部后置过滤器。其中，全局过滤器将应用于所有路由，而局部过滤器则仅适用于指定的路由。

通过自定义Filter，我们可以实现多种自定义需求。例如，我们可以创建一个针对具体请求路径的认证过滤器，以验证用户是否有访问相应资源的权限；也可以编写一个记录日志的Filter，在请求被路由到目标服务之前/之后输出相关日志信息。

编写自定义Filter的步骤通常包括以下几点：

创建一个继承AbstractGatewayFilterFactory的Filter类。
在Filter类中重写apply方法并编写自定义逻辑。
配置Filter类中所需的参数（可选）。
在Spring Cloud Gateway的路由配置中添加Filter。
当然，需要根据实际需求进行调整，例如定义不同类型、不同粒度的Filter等等。

总之，Filters提供了一种灵活、可靠且可扩展的机制，以便应对各种需求。在开发网关时，Filter是非常重要的组件，其在保证高效性和可扩展性方面都具有重要作用。