深入理解Spring Cloud Gateway全局过滤器：自定义MyGlobalFilter实现_springcloud gateway自定义全局过滤器-CSDN博客

本文链接：https://blog.csdn.net/Takumilove/article/details/140725801

文章目录

在微服务架构中，API Gateway作为客户端和服务端的中间层，起到了请求路由、负载均衡、安全验证等重要作用。而Spring Cloud Gateway作为一款功能强大的网关框架，广泛应用于各种微服务项目中。本文将带领大家深入了解如何在Spring Cloud Gateway中实现一个自定义的全局过滤器，并通过代码示例来展示其具体实现过程。

一、全局过滤器简介

Spring Cloud Gateway中的全局过滤器（Global Filter）是一种特殊类型的过滤器，它可以对所有经过网关的请求进行拦截处理。全局过滤器的常见应用场景包括：

日志记录：记录所有请求的详细信息。
统一身份认证：对所有进入系统的请求进行身份校验。
请求修改或增强：例如增加统一的请求头、修改URL等。

通过实现自定义全局过滤器，我们可以在网关层面轻松实现这些功能。

二、引入依赖

在开始编写代码之前，首先确保在Spring Cloud Gateway项目中引入了必要的依赖。以下是pom.xml文件中的相关依赖配置：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

spring-cloud-starter-gateway：引入Spring Cloud Gateway网关的核心依赖。
spring-boot-starter-webflux：Spring Cloud Gateway基于WebFlux进行构建，因此需要引入WebFlux相关依赖。

三、自定义全局过滤器的实现

接下来，我们将实现一个自定义的全局过滤器MyGlobalFilter，用于模拟请求的身份校验，并打印请求头信息。以下是完整的代码实现：

package com.hmall.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * 自定义全局过滤器实现
 * 该过滤器主要用于在网关层面模拟登录校验，并打印请求头信息
 */
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 获取当前的HTTP请求
        ServerHttpRequest request = exchange.getRequest();
        // 获取请求头信息
        HttpHeaders headers = request.getHeaders();

        // 模拟登录校验（此处仅打印请求头信息，实际中可添加身份校验逻辑）
        System.out.println("Request Headers: " + headers);

        // 将请求继续传递给下一个过滤器
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        // 返回过滤器的优先级，数值越小优先级越高
        return 0;
    }
}

代码解析

包路径及依赖导入

我们定义了过滤器的包路径，并引入了Spring Cloud Gateway相关的依赖包：

package com.hmall.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

实现GlobalFilter接口

MyGlobalFilter类实现了GlobalFilter接口，该接口定义了一个filter方法，用于拦截所有经过网关的请求。filter方法的主要作用是处理HTTP请求，并将其传递给下一个过滤器。

实现filter方法

在filter方法中，我们通过exchange.getRequest()获取当前的HTTP请求，并通过request.getHeaders()获取请求头信息。在这里可以添加自定义逻辑，例如模拟登录校验。

@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
    // 模拟登录校验：获取请求头信息
    ServerHttpRequest request = exchange.getRequest();
    HttpHeaders headers = request.getHeaders();
    System.out.println("Request Headers: " + headers);

    // 放行请求，传递给下一个过滤器
    return chain.filter(exchange);
}

实现Ordered接口

我们还实现了Ordered接口中的getOrder方法，用于指定过滤器的执行顺序。返回值越小，过滤器优先级越高。此处我们设置为0，表示最高优先级。
```
@Override
public int getOrder() {
    return 0;
}
```