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

 更新时间:2024年06月04日 09:38:36   作者:好奇的菜鸟  
在Spring框架,尤其是Spring Cloud Gateway或Spring WebFlux项目中,Ordered接口扮演着重要的角色,特别是在实现全局过滤器(GlobalFilter)时,用于控制过滤器执行的优先级,下面将介绍如何在Spring项目中使用Ordered接口来管理Global Filter的执行顺序,需要的朋友可以参考下

在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()方法返回不同的优先级值,可以精确控制过滤器链中的执行顺序。

实现示例

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

// 导入必要的包
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的执行顺序,以满足应用的具体需求。

到此这篇关于Spring项目中Ordered接口的应用之全局过滤器(GlobalFilter)的顺序控制的文章就介绍到这了,更多相关Spring Ordered接口内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring WebFlux的使用指南

    Spring WebFlux的使用指南

    这篇文章主要介绍了Spring WebFlux的使用指南,帮助大家更好的理解和学习使用Spring框架,感兴趣的朋友可以了解下
    2021-05-05
  • springboot读取bootstrap配置及knife4j版本兼容性问题及解决

    springboot读取bootstrap配置及knife4j版本兼容性问题及解决

    这篇文章主要介绍了springboot读取bootstrap配置及knife4j版本兼容性问题及解决,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-06-06
  • java中以DES的方式实现对称加密并提供密钥的实例

    java中以DES的方式实现对称加密并提供密钥的实例

    这篇文章主要介绍了java中以DES的方式实现对称加密并提供密钥的实例的相关资料,这里提供实例帮助大家学习理解这部分知识,需要的朋友可以参考下
    2017-08-08
  • java poi解析word的方法

    java poi解析word的方法

    这篇文章主要为大家详细介绍了java poi解析word的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-05-05
  • jvm原理之SystemGC源码分析

    jvm原理之SystemGC源码分析

    这篇文章主要介绍了jvm源码分析之SystemGC的完全解读,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-01-01
  • Spring前后端跨域请求设置代码实例

    Spring前后端跨域请求设置代码实例

    这篇文章主要介绍了Spring前后端跨域请求设置代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • Java项目中Service 层不直接返回Result 对象的原因分析

    Java项目中Service 层不直接返回Result 对象的原因分析

    在Service层直接返回Result对象会导致业务逻辑与表现逻辑耦合,降低代码清晰度和可维护性,正确的做法是让每一层专注于自己的职责,保持代码可复用性,这篇文章给大家介绍为什么Java里面,Service 层不直接返回Result对象,感兴趣的朋友跟随小编一起看看吧
    2026-02-02
  • Java实现单例设计模式方法解析

    Java实现单例设计模式方法解析

    这篇文章主要介绍了Java实现单例设计模式方法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • Java基础知识精通循环结构与break及continue

    Java基础知识精通循环结构与break及continue

    循环结构是指在程序中需要反复执行某个功能而设置的一种程序结构。它由循环体中的条件,判断继续执行某个功能还是退出循环,选择结构用于判断给定的条件,根据判断的结果判断某些条件,根据判断的结果来控制程序的流程
    2022-04-04
  • SpringBoot读取配置文件的6种实现方式

    SpringBoot读取配置文件的6种实现方式

    这篇文章主要介绍了SpringBoot读取配置文件的6种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-04-04

最新评论