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

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 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()方法返回不同的优先级值,可以精确控制过滤器链中的执行顺序。

实现示例

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

// 导入必要的包
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模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
2月前
|
XML Java 数据格式
探索Spring之利剑:ApplicationContext接口
本文深入介绍了Spring框架中的核心接口ApplicationContext,解释了其作为应用容器的功能,包括事件发布、国际化支持等,并通过基于XML和注解的配置示例展示了如何使用ApplicationContext管理Bean实例。
112 6
|
6天前
|
网络协议 Java Shell
java spring 项目若依框架启动失败,启动不了服务提示端口8080占用escription: Web server failed to start. Port 8080 was already in use. Action: Identify and stop the process that’s listening on port 8080 or configure this application to listen on another port-优雅草卓伊凡解决方案
java spring 项目若依框架启动失败,启动不了服务提示端口8080占用escription: Web server failed to start. Port 8080 was already in use. Action: Identify and stop the process that’s listening on port 8080 or configure this application to listen on another port-优雅草卓伊凡解决方案
30 7
|
2月前
|
人工智能 前端开发 Java
Spring AI Alibaba + 通义千问,开发AI应用如此简单!!!
本文介绍了如何使用Spring AI Alibaba开发一个简单的AI对话应用。通过引入`spring-ai-alibaba-starter`依赖和配置API密钥,结合Spring Boot项目,只需几行代码即可实现与AI模型的交互。具体步骤包括创建Spring Boot项目、编写Controller处理对话请求以及前端页面展示对话内容。此外,文章还介绍了如何通过添加对话记忆功能,使AI能够理解上下文并进行连贯对话。最后,总结了Spring AI为Java开发者带来的便利,简化了AI应用的开发流程。
784 0
|
2月前
|
存储 JSON 前端开发
【Spring项目】表白墙,留言板项目的实现
本文主要介绍了表白墙项目的实现,包含前端和后端代码,以及测试
|
2月前
|
JSON 前端开发 Java
|
2月前
|
缓存 前端开发 Java
【Spring】——SpringBoot项目创建
SpringBoot项目创建,SpringBootApplication启动类,target文件,web服务器,tomcat,访问服务器
|
2月前
|
JavaScript Java Kotlin
深入 Spring Cloud Gateway 过滤器
Spring Cloud Gateway 是新一代微服务网关框架,支持多种过滤器实现。本文详解了 `GlobalFilter`、`GatewayFilter` 和 `AbstractGatewayFilterFactory` 三种过滤器的实现方式及其应用场景,帮助开发者高效利用这些工具进行网关开发。
355 1
|
2月前
|
XML 前端开发 安全
Spring MVC:深入理解与应用实践
Spring MVC是Spring框架提供的一个用于构建Web应用程序的Model-View-Controller(MVC)实现。它通过分离业务逻辑、数据、显示来组织代码,使得Web应用程序的开发变得更加简洁和高效。本文将从概述、功能点、背景、业务点、底层原理等多个方面深入剖析Spring MVC,并通过多个Java示例展示其应用实践,同时指出对应实践的优缺点。
127 2
|
27天前
|
XML Java 应用服务中间件
Spring Boot 两种部署到服务器的方式
本文介绍了Spring Boot项目的两种部署方式:jar包和war包。Jar包方式使用内置Tomcat,只需配置JDK 1.8及以上环境,通过`nohup java -jar`命令后台运行,并开放服务器端口即可访问。War包则需将项目打包后放入外部Tomcat的webapps目录,修改启动类继承`SpringBootServletInitializer`并调整pom.xml中的打包类型为war,最后启动Tomcat访问应用。两者各有优劣,jar包更简单便捷,而war包适合传统部署场景。需要注意的是,war包部署时,内置Tomcat的端口配置不会生效。
201 17
Spring Boot 两种部署到服务器的方式
|
27天前
|
Dart 前端开发 JavaScript
springboot自动配置原理
Spring Boot 自动配置原理:通过 `@EnableAutoConfiguration` 开启自动配置,扫描 `META-INF/spring.factories` 下的配置类,省去手动编写配置文件。使用 `@ConditionalXXX` 注解判断配置类是否生效,导入对应的 starter 后自动配置生效。通过 `@EnableConfigurationProperties` 加载配置属性,默认值与配置文件中的值结合使用。总结来说,Spring Boot 通过这些机制简化了开发配置流程,提升了开发效率。
59 17
springboot自动配置原理