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

酷磊君_8505

酷磊君_8505

2026-07-19

697人浏览

原创

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 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 {
  public static class Config { }
  @Override
  public GatewayFilter apply(Config config) {
    return (exchange, chain) -> {
      // 获取当前匹配的 Route
      Route route = exchange.getRequiredAttribute(GATEWAY_ROUTE_ATTR);
      // 读取 metadata
      Map metadata = route.getMetadata();
      Boolean authRequired = (Boolean) metadata.get("auth-required");
      List perms = (List) metadata.get("permissions");
      // 后续逻辑...
      return chain.filter(exchange);
    };
  }

dcc-cli-gateway
dcc-cli-gateway

通过 `dcc-mcp-cli` 命令行工具控制实时 DCC 主机(Maya、Blender、Houdini、Photoshop、3ds Max 以及自定义的 Studio 工具)。 针对 ClawHub、OpenClaw、Cursor、Claude 和支持 shell 的 Agent 主机:验证网关健康状态、列出已注册的 DCC 实例、搜索工具、检查 Schema、调用工具——全程无需直接编写或发送 MCP 请求。 若系统中未安装 `dcc-mcp-cli`,需先征得用户同意,再从 GitHub

下载

如果坚持用注解:只能作用于配置类,再映射到 Route ID

你可以定义一个配置类,用注解标记 Route ID 和参数,然后在启动时将这些注解信息注册到内存 Map(如 ConcurrentHashMap<String, Map<String, Object>>),再在 Filter 中根据 route.getId() 查表获取配置。

  • 示例注解:

@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 config = routeConfigMap.get(routeId);
if (config != null && Boolean.TRUE.equals(config.get("auth-required"))) { ... }

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

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

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java gate

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

10877

6

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

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

2023.07.05

8002

9

java自学难吗
java自学难吗

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

2023.07.31

6932

8

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

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

2023.08.01

1164

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1416

5

java有什么用
java有什么用

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

2023.08.02

2869

5

java在线网站
java在线网站

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

2023.08.03

20151

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1255

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习