讲师中心 微信公众号
AI工具推荐 视频效率加速

Java中 Spring Cloud Gateway 自定义 GatewayFilterFactory 怎么读取 Route 上的注解属性

酷磊君_8505

酷磊君_8505

发布时间:2026-07-19 14:21:39

|

697人浏览过

|

来源于php中文网

原创

Route没有注解属性,因为它是通过RouteDefinition解析、RouteLocator组装的不可变数据对象,不经过Spring容器Bean创建流程,故不保留注解元信息;应使用metadata传参。

java中 spring cloud gateway 自定义 gatewayfilterfactory 怎么读取 route 上的注解属性

Spring Cloud Gateway 的 GatewayFilterFactory 本身无法直接读取 Route 上的注解属性,因为 Route 是配置驱动(YAML/Properties 或 Java DSL)构建的,**不基于 Spring Bean + 注解的生命周期**,所以像 @Route(value = "my-route", tags = "auth") 这样的自定义注解在 Route 对象上并不存在 —— Route 实例(Route 类)是纯数据对象,没有注解元信息。

为什么 Route 没有注解属性?

Route 由 RouteDefinition 解析而来,最终是通过 RouteLocator(如 CachingRouteLocator)组装的不可变对象。它不经过 Spring 容器的 Bean 创建流程,因此不会保留任何类/方法上的注解。你写的注解如果加在配置类或方法上,**不会自动绑定到 Route 实例**。

替代方案:用 Route 的元数据(Metadata)传参

最标准、推荐的做法是把“想当注解用”的配置项,写进 Route 的 metadata 字段,然后在自定义 GatewayFilterFactory 中读取:

  • YAML 配置示例:

  routes:
  - id: user-service
   uri: lb://user-service
   predicates:
   - Path=/api/users/**
   metadata:
    auth-required: true
    permissions: ["USER_READ", "USER_WRITE"]

立即学习“Java免费学习笔记(深入)”;

java后端编程
java后端编程

专用于 Java Spring Boot 后端开发的专业技能。当用户提出以下需求时,应调用此技能:构建 REST API、创建 Spring Boot 项目、编写 Java 后端服务、配置数据库访问(JPA / MyBatis)、处理认证与授权(Spring Security / JWT)、实现微服务架构(Spring Cloud)、排查 Spring Boot 相关错误、审查 Java 代码质量,或执行任何与 Spring Boot / Java 后端相关的任务。

下载
  • Java DSL(等效):

route(r -> r.path("/api/users/**")
  .uri("lb://user-service")
  .metadata("auth-required", "true")
  .metadata("permissions", List.of("USER_READ", "USER_WRITE")))

  • 在自定义 GatewayFilterFactory 中获取:

public class AuthCheckGatewayFilterFactory
    extends AbstractGatewayFilterFactory<AuthCheckGatewayFilterFactory.Config> {
  public static class Config { }
  @Override
  public GatewayFilter apply(Config config) {
    return (exchange, chain) -> {
      // 获取当前匹配的 Route
      Route route = exchange.getRequiredAttribute(GATEWAY_ROUTE_ATTR);
      // 读取 metadata
      Map<String, Object> metadata = route.getMetadata();
      Boolean authRequired = (Boolean) metadata.get("auth-required");
      List<String> perms = (List<String>) metadata.get("permissions");
      // 后续逻辑...
      return chain.filter(exchange);
    };
  }
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface RouteConfig {
  String id();
  boolean authRequired() default false;
  String[] permissions() default {};
}

  • 在 @Configuration 类中扫描并缓存:

@PostConstruct
void initRouteConfigs() {
  for (Class<?> cls : routeConfigClasses) {
    RouteConfig ann = cls.getAnnotation(RouteConfig.class);
    if (ann != null) {
      routeConfigMap.put(ann.id(), Map.of(
        "auth-required", ann.authRequired(),
        "permissions", List.of(ann.permissions())
      ));
    }
  }
String routeId = route.getId();
Map<String, Object> config = routeConfigMap.get(routeId);
if (config != null && Boolean.TRUE.equals(config.get("auth-required"))) { ... }

小结:优先选 metadata,慎用注解模拟

metadata 是 Gateway 原生支持的扩展机制,轻量、清晰、可配置化,适合大多数场景;而注解方案需自行维护映射关系、增加启动开销、不利于动态路由变更,仅在已有大量注解驱动配置且需复用时考虑。不要试图给 Route 对象“加注解”,它不是被 Spring 管理的 Bean。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

10937

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

8062

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

6972

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1184

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

968

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1416

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2889

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20171

2023.08.03

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn