0

0

Quarkus 中使用 JAX-RS 客户端处理可变长度路径参数的正确方式

花韻仙語

花韻仙語

发布时间:2026-01-25 11:57:01

|

609人浏览过

|

来源于php中文网

原创

Quarkus 中使用 JAX-RS 客户端处理可变长度路径参数的正确方式

quarkus 的 microprofile rest client 中,若需调用路径深度动态、含多级斜杠(如 `/json/employees/dwight/jobs/...`)的 rest 接口,直接传入含 `/` 的字符串会导致自动 url 编码(如 `/` → `%2f`),破坏原始路径语义;正确解法是结合 jax-rs 路径正则表达式与 `@pathparam`,精准捕获未编码的完整子路径。

要实现真正“透传”任意长度、含多级斜杠的路径片段(例如 /employees/Dwight/jobs/assistantRegionalManager/salary),关键在于让 JAX-RS 路由引擎将整个路径段视为一个原子单元,而非按 / 拆分解析。此时不能依赖默认的路径参数行为(它会将 / 视为分隔符并自动编码),而应使用 JAX-RS 内置的正则路径约束(Path Regex)机制。

✅ 正确写法如下:

@Path("/json")
@RegisterRestClient(configKey = "json-api")
public interface JsonService {

    @GET
    @Path("/{varPath:.+}")  // ← 核心:".+" 匹配一个或多个任意字符(含 '/'),且不触发分段编码
    Response getJson(@PathParam("varPath") String endpoint);
}
  • {varPath:.+} 中的 :.+ 是 JAX-RS 标准语法,表示该路径参数需匹配正则 .+(即非空、贪婪匹配所有后续字符,包括 /);

  • @PathParam("varPath") String 直接接收原始路径片段,不会被客户端自动 URL 编码 —— 因为 JAX-RS 运行时已将其作为整体捕获,绕过了逐段解析逻辑;

  • 示例调用:

    Build AI
    Build AI

    为您的业务构建自己的AI应用程序。不需要任何技术技能。

    下载
    JsonService client = RestClientBuilder.newBuilder()
        .baseUri(URI.create("https://api.example.com"))
        .build(JsonService.class);
    
    Response res1 = client.getJson("employees/Dwight/jobs/assistantRegionalManager/salary");
    Response res2 = client.getJson("games/theLastOfUs/rating");

    将分别发出请求:

    • GET /json/employees/Dwight/jobs/assistantRegionalManager/salary
    • GET /json/games/theLastOfUs/rating

⚠️ 注意事项:

  • ❌ 不要使用 @Encoded:它仅影响 @QueryParam 或 @MatrixParam 的编码行为,对 @PathParam 无效;
  • ❌ 避免 /{varPath}(无正则):JAX-RS 会将其按 / 切分为多个空参数,导致 404 或错误解析;
  • ❌ 不要传入 List:Quarkus REST Client 不支持该类型作为 @PathParam 绑定目标,编译或运行时报错;
  • ✅ 确保服务端路由也支持通配(如 Spring Boot 用 @GetMapping("/json/**"),或 Quarkus 服务端用 @Path("/json/{path:.+}")),否则响应 404 与客户端无关;
  • ? 若路径含敏感字符(如空格、#、?),仍需由调用方预处理(如 URLEncoder.encode(..., "UTF-8")),但本场景中纯路径语义的 / 已被正则保障原样传递。

总结:可变长嵌套路径的本质是「路径段透传」,而非「参数拼接」。唯一可靠、标准、零侵入的方案就是 JAX-RS 路径正则 /{param:regex} —— 它既是规范要求,也是 Quarkus、OpenLiberty、Thorntail 等主流 MicroProfile 实现的通用能力。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

111

2025.08.06

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

135

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

390

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

69

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

34

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

115

2025.12.24

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

417

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

44

2026.01.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号