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

相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
相关文章
|
1月前
|
监控 Java API
Spring Boot 3.2 结合 Spring Cloud 微服务架构实操指南 现代分布式应用系统构建实战教程
Spring Boot 3.2 + Spring Cloud 2023.0 微服务架构实践摘要 本文基于Spring Boot 3.2.5和Spring Cloud 2023.0.1最新稳定版本,演示现代微服务架构的构建过程。主要内容包括: 技术栈选择:采用Spring Cloud Netflix Eureka 4.1.0作为服务注册中心,Resilience4j 2.1.0替代Hystrix实现熔断机制,配合OpenFeign和Gateway等组件。 核心实操步骤: 搭建Eureka注册中心服务 构建商品
370 3
|
1月前
|
人工智能 监控 安全
如何快速上手【Spring AOP】?核心应用实战(上篇)
哈喽大家好吖~欢迎来到Spring AOP系列教程的上篇 - 应用篇。在本篇,我们将专注于Spring AOP的实际应用,通过具体的代码示例和场景分析,帮助大家掌握AOP的使用方法和技巧。而在后续的下篇中,我们将深入探讨Spring AOP的实现原理和底层机制。 AOP(Aspect-Oriented Programming,面向切面编程)是Spring框架中的核心特性之一,它能够帮助我们解决横切关注点(如日志记录、性能统计、安全控制、事务管理等)的问题,提高代码的模块化程度和复用性。
|
1月前
|
安全 算法 Java
在Spring Boot中应用Jasypt以加密配置信息。
通过以上步骤,可以在Spring Boot应用中有效地利用Jasypt对配置信息进行加密,这样即使配置文件被泄露,其中的敏感信息也不会直接暴露给攻击者。这是一种在不牺牲操作复杂度的情况下提升应用安全性的简便方法。
706 10
|
2月前
|
Java 关系型数据库 数据库连接
Spring Boot项目集成MyBatis Plus操作PostgreSQL全解析
集成 Spring Boot、PostgreSQL 和 MyBatis Plus 的步骤与 MyBatis 类似,只不过在 MyBatis Plus 中提供了更多的便利功能,如自动生成 SQL、分页查询、Wrapper 查询等。
267 3
|
2月前
|
Java 测试技术 Spring
简单学Spring Boot | 博客项目的测试
本内容介绍了基于Spring Boot的博客项目测试实践,重点在于通过测试驱动开发(TDD)优化服务层代码,提升代码质量和功能可靠性。案例详细展示了如何为PostService类编写测试用例、运行测试并根据反馈优化功能代码,包括两次优化过程。通过TDD流程,确保每项功能经过严格验证,增强代码可维护性与系统稳定性。
154 0
|
2月前
|
存储 Java 数据库连接
简单学Spring Boot | 博客项目的三层架构重构
本案例通过采用三层架构(数据访问层、业务逻辑层、表现层)重构项目,解决了集中式开发导致的代码臃肿问题。各层职责清晰,结合依赖注入实现解耦,提升了系统的可维护性、可测试性和可扩展性,为后续接入真实数据库奠定基础。
265 0
|
2月前
|
Java 应用服务中间件 Maven
第01课:Spring Boot开发环境搭建和项目启动
第01课:Spring Boot开发环境搭建和项目启动
494 0
|
6月前
|
Java 测试技术 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——少量配置信息的情形
本课主要讲解Spring Boot项目中的属性配置方法。在实际开发中,测试与生产环境的配置往往不同,因此不应将配置信息硬编码在代码中,而应使用配置文件管理,如`application.yml`。例如,在微服务架构下,可通过配置文件设置调用其他服务的地址(如订单服务端口8002),并利用`@Value`注解在代码中读取这些配置值。这种方式使项目更灵活,便于后续修改和维护。
96 0
|
6月前
|
Java 数据库 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
234 0
|
6月前
|
Java 微服务 Spring
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——少量配置信息的情形
在微服务架构中,随着业务复杂度增加,项目可能需要调用多个微服务。为避免使用`@Value`注解逐一引入配置的繁琐,可通过定义配置类(如`MicroServiceUrl`)并结合`@ConfigurationProperties`注解实现批量管理。此方法需在配置文件中设置微服务地址(如订单、用户、购物车服务),并通过`@Component`将配置类纳入Spring容器。最后,在Controller中通过`@Resource`注入配置类即可便捷使用,提升代码可维护性。
102 0