REST接口开发中怎么使用 @PathVariable 获取路径参数

陌浩酱_9113

陌浩酱_9113

2026-09-25

898人浏览

原创

@pathvariable用于从restful url路径中提取变量值,支持单个/多个变量、类型转换、jsr-303校验及可选参数(required=false),但不支持默认值。

rest接口开发中怎么使用 @pathvariable 获取路径参数

在 REST 接口开发中,@PathVariable 用于从 URL 路径中提取变量值,是 Spring MVC 提供的核心注解之一。它适用于设计符合 RESTful 风格的资源路径(如 /users/123、/orders/2024/05),让接口语义清晰、可读性强。

基本用法:绑定单个路径变量

URL 中用花括号 {} 定义占位符,方法参数用 @PathVariable 注解声明,Spring 会自动将对应路径段映射为参数值:

@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
    return userService.findById(id);
}

访问 GET /users/101 时,id 就会被解析为 101。默认情况下,参数名需与路径变量名一致;若不一致,需显式指定名称:

@GetMapping("/users/{userId}")
public User getUserById(@PathVariable("userId") Long id) {
    return userService.findById(id);
}

多个路径变量同时使用

一个 URL 可含多个路径变量,每个都用 @PathVariable 绑定:

@GetMapping("/orders/{year}/{month}")
public List<order> getOrdersByYearMonth(
        @PathVariable Integer year,
        @PathVariable Integer month) {
    return orderService.findByYearAndMonth(year, month);
}</order>

访问 /orders/2024/05 即可正确提取两个参数。也可混合使用 @PathVariable 和 @RequestParam(如分页参数):

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

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

下载
  • @PathVariable:取自路径本身,不可省略(除非设 required = false)
  • @RequestParam:取自查询字符串,如 ?page=1&size=10

类型转换与合法性校验

Spring 会自动将路径段字符串转为目标类型(如 Long、Integer、String)。若转换失败(如传入非数字),默认返回 400 Bad Request。可在参数上加 @Valid 或自定义校验:

@GetMapping("/users/{id}")
public User getUserById(@PathVariable @Min(1) Long id) {
    return userService.findById(id);
}

注意:@PathVariable 支持 JSR-303 校验,但需开启验证支持(如添加 @Validated 到类或方法上)。

可选路径变量与默认值

路径变量默认必须存在。如需设为可选,需配合 required = false,并使用包装类型或 Optional:

@GetMapping("/products/{category}/{subCategory}")
public List<product> getProducts(
        @PathVariable String category,
        @PathVariable(required = false) String subCategory) {
    return productService.findByCategory(category, subCategory);
}</product>

此时 /products/electronics 合法(subCategory 为 null),但 /products 仍非法(category 是必需的)。不支持直接设默认值,如需默认行为,建议在业务逻辑中处理 null。

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

9017

6

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

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

2023.07.05

6222

9

java自学难吗
java自学难吗

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

2023.07.31

5572

8

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

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

2023.08.01

1004

3

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

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

2023.08.02

828

3

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

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

2023.08.02

1176

5

java有什么用
java有什么用

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

2023.08.02

2389

5

java在线网站
java在线网站

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

2023.08.03

19731

3

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

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

2023.08.03

1075

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习