Spring项目中Ordered接口的应用:全局过滤器(GlobalFilter)的顺序控制

在Spring框架,尤其是Spring Cloud Gateway或Spring WebFlux项目中,Ordered接口扮演着重要的角色,特别是在实现全局过滤器(GlobalFilter)时,用于控制过滤器执行的优先级。下面将介绍如何在Spring项目中使用Ordered接口来管理Global Filter的执行顺序。

Ordered接口简介

Ordered接口位于org.springframework.core包下,定义了单一方法getOrder(),用于返回一个整数值来表明组件的排序优先级。该接口有两个静态常量:

  • HIGHEST_PRECEDENCE:设置最高优先级,值为Integer.MIN_VALUE。
  • LOWEST_PRECEDENCE:设置最低优先级,值为Integer.MAX_VALUE。

全局过滤器(GlobalFilter)与Ordered

GlobalFilter介绍

在Spring Cloud Gateway或WebFlux应用中,GlobalFilter是一种可以对所有进入网关的请求或从网关出去的响应进行拦截处理的机制。它们允许开发者实现跨切割点的逻辑,如鉴权、日志记录、请求改写等。

控制执行顺序

为了确保过滤器按照预期的顺序执行,实现Ordered接口变得尤为重要。不同的过滤器可能依赖于其他过滤器的操作结果,或者有特定的执行要求,通过实现getOrder()方法返回不同的优先级值,可以精确控制过滤器链中的执行顺序。

实现示例

假设我们要创建一个简单的日志记录过滤器和一个鉴权过滤器,并且希望鉴权操作发生在日志记录之前,我们可以这样做:

java 复制代码
// 导入必要的包
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.OrderedGatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;

@Component
public class LoggingFilter extends AbstractGatewayFilterFactory<Object> implements Ordered {

    @Override
    public GatewayFilter apply(Object config) {
        return (exchange, chain) -> {
            // 在此处实现日志记录逻辑
            System.out.println("Logging before request...");
            return chain.filter(exchange).then(Mono.fromRunnable(() -> 
                System.out.println("Logging after response..."))); 
        };
    }

    @Override
    public int getOrder() {
        // 设置此过滤器的执行优先级,数值越大,执行越晚
        return -10;
    }
}

@Component
public class AuthFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 在此处实现鉴权逻辑
        System.out.println("Authenticating request...");
        // 假设鉴权通过,继续处理请求
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        // 设置此过滤器的执行优先级,数值越小,执行越早
        return -20;
    }
}

说明

  • LoggingFilter实现了日志记录功能,并通过getOrder()方法设置了较低的优先级,意味着它将在大多数其他过滤器之后执行。
  • AuthFilter负责鉴权逻辑,通过实现Ordered接口并返回较高的优先级值,确保其在日志记录之前执行。

通过这种方式,开发者可以精确地控制不同Global Filter的执行顺序,以满足应用的具体需求。

相关推荐
NGINX开源社区4 分钟前
与我们交流:NGINX Gateway Fabric 与 NGINX Ingress Controller 社区会议
java·服务器·前端
鶴哥只手遮天7 分钟前
Spring Framework 7.0.9 深度剖析-16-异步与调度
java·后端·开源
十年Java程序媛15 分钟前
Java 多线程基础与锁机制|进程线程、synchronized、volatile、Lock 面试全梳理
java·spring boot·面试
弈栈录15 分钟前
大模型服务抽象:兼容 OpenAI、通义千问与本地模型
java·后端·架构
鶴哥只手遮天23 分钟前
Spring Framework 7.0.9 深度剖析-06-Bean 生命周期与依赖注入原理
java·后端·开源
唐钰小宝B31 分钟前
深度解读 JDK 8、JDK 11、JDK 17 和 JDK 21 的区别
java·开发语言·windows
golang学习记39 分钟前
最新版VS Code开发Spring Boot项目保姆级教程
java·spring boot·vscode·后端
叶总没有会1 小时前
RabbitMQ基础--java客户端
java·rabbitmq·java-rabbitmq
小陈不好吃2 小时前
Java 泛型与类型擦除:从 PECS 原则到 TypeToken 绕过
java·开发语言·windows·pecs 原则·typetoken绕过
鶴哥只手遮天2 小时前
Spring Framework 7.0.9 深度剖析-03-IoC 容器核心:BeanFactory 与 BeanDefinition 体系
java·后端·开源