Java 中怎么通过 @PathVariable 获取 REST 接口路径中的占位符参数

雨雪吖_2772

雨雪吖_2772

2026-09-19

853人浏览

原创

@pathvariable用于绑定url路径占位符参数,支持单个/多个变量、自动类型转换及异常处理,但不支持required=false,可选场景应改用@requestparam或双路径设计。

java 中怎么通过 @pathvariable 获取 rest 接口路径中的占位符参数

在 Spring Boot 的 REST 接口中,@PathVariable 是获取 URL 路径中占位符参数的标准方式。它直接绑定请求路径里的变量名到方法参数上,无需解析字符串或手动截取。

基础用法:匹配单个路径变量

URL 中用 {xxx} 定义占位符,方法参数用 @PathVariable("xxx") 绑定:

@GetMapping("/users/{id}")
public String getUserById(@PathVariable("id") Long id) {
    return "User ID: " + id;
}

访问 /users/123 时,id 自动被解析为 Long 类型的 123。若参数名与占位符名一致(如都叫 id),可省略括号内容:

@GetMapping("/users/{id}")
public String getUserById(@PathVariable Long id) { // 省略名称,自动按参数名匹配
    return "User ID: " + id;
}

多个路径变量:支持组合路径

URL 可包含多个占位符,对应多个 @PathVariable 参数:

@GetMapping("/users/{userId}/orders/{orderId}")
public String getOrderDetail(
        @PathVariable Long userId,
        @PathVariable Long orderId) {
    return "User " + userId + " order " + orderId;
}

访问 /users/100/orders/200 即可分别提取两个值。注意顺序无关,Spring 按变量名匹配,不是按参数位置。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

类型转换与异常处理

@PathVariable 支持自动类型转换(如 StringLongIntegerUUID 等)。若传入非法值(如 /users/abc 请求 Long id),Spring 默认返回 400 Bad Request

若需自定义错误响应,可用 @ExceptionHandler 捕获 TypeMismatchException 或全局处理 MethodArgumentTypeMismatchException

可选路径变量(不推荐,慎用)

路径变量默认是必须的。若想设为可选,不能直接加 required = false@PathVariable 不支持该属性)。替代方案是:

  • 用两个不同路径映射(如 /users/users/{id}
  • 改用 @RequestParam 配合查询参数(如 /users?id=123
  • 使用正则表达式限定路径(如 @GetMapping("/users/{id:\d+}")),让非法格式根本无法匹配到该接口

不建议强行“模拟可选路径变量”,会破坏 RESTful 设计原则,也增加路由歧义风险。

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

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

8617

6

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

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

2023.07.05

5822

9

java自学难吗
java自学难吗

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

2023.07.31

5252

8

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

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

2023.08.01

964

3

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

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

2023.08.02

808

3

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

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

2023.08.02

1136

5

java有什么用
java有什么用

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

2023.08.02

2269

5

java在线网站
java在线网站

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

2023.08.03

19631

3

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

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

2023.08.03

1035

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习