Spring Boot中的路径变量示例详解

更新时间：2025年07月14日 11:01:47 作者：罗1213

SpringBoot中PathVariable通过@PathVariable注解实现URL参数与方法参数绑定,支持多参数接收、类型转换、可选参数、默认值及正则约束,是构建RESTful API的核心工具,本文给大家介绍Spring Boot中的路径变量示例,感兴趣的朋友一起看看吧

一. 基本用法与参数映射

1.路径定义

在URL路径中用 {} 包裹变量名，例如：

@GetMapping("/users/{userId}")

2.参数绑定

- 默认映射：当参数名与路径变量名一致时，可以省略路径变量名，例如：

@GetMapping("/users/{userId}")
public User getUser(@PathVariable Long userId) {
    // 业务逻辑
}

- 显式指定：若参数名与变量名不同，通过 @PathVariable("变量名") 指定，例如：

@GetMapping("/users/{userId}")
public User getUserById(@PathVariable("userId") Long id) {
    // 业务逻辑
}

二.多参数接收

在方法中多次使用 @PathVariable 接收多个参数，例如：

@GetMapping("/users/{userId}/orders/{orderId}")
public Order getOrder(
    @PathVariable Long userId,
    @PathVariable Long orderId) {
    // 业务逻辑
}

三、类型转换

- 自动转换：Spring Boot会自动将路径变量的字符串值转换为方法参数的类型，支持基本数据类型（如 int 、 long ）、包装类（如 Integer 、 Long ）、 String 等。

- 异常处理：若类型转换失败，Spring Boot会抛出 TypeMismatchException 异常，可通过自定义异常处理器进行处理。

四. 可选参数与默认值

1.非必填参数

通过 @PathVariable(required = false) 设置参数为可选，未传值时参数值为 null ，例如：

@GetMapping("/users/{id}/info")
public UserInfo getUserInfo(
    @PathVariable("id") Long id,
    @PathVariable(required = false) String type) {
    // 业务逻辑
}

2.默认值设置

使用 @PathVariable(defaultValue = "默认值") 指定默认值，当未传值时使用该默认值，例如：

@GetMapping("/page/{pageNum}")
public List<User> getUsers(
    @PathVariable(defaultValue = "1") int pageNum) {
    // 业务逻辑
}

五. 正则表达式约束

通过 {变量名:正则表达式} 限制参数格式，例如：

@GetMapping("/images/{name:\\d{4}-\\d{2}-\\d{2}\\.jpg}") 
// 匹配YYYY-MM-DD.jpg格式
public Image getImage(@PathVariable String name) {
    // 业务逻辑
}

六、总结

路径变量是 Spring Boot 中构建 RESTful API 的重要工具，通过 @PathVariable 注解实现 URL 参数与方法参数的绑定。它支持多种功能，包括：单个和多个路径变量的接收。自动类型转换和异常处理。可选参数和默认值的设置。正则表达式约束，用于限制参数格式

到此这篇关于Spring Boot中的路径变量的文章就介绍到这了,更多相关Spring Boot路径变量内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java中@ConfigurationProperties实现自定义配置绑定问题分析
这篇文章主要介绍了@ConfigurationProperties实现自定义配置绑定问题，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2021-08-08
springBoot接入阿里云oss的实现步骤
这篇文章主要介绍了springBoot接入阿里云oss的实现步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-01-01
java实现HmacSHA256算法进行加密方式
这篇文章主要介绍了java实现HmacSHA256算法进行加密方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-08-08
RabbitMQ消息有效期与死信的处理过程
利用DLX，当消息在一个队列中变成死信 (dead message) 之后，它能被重新publish到另一个Exchange，这个Exchange就是DLX，本文重点给大家介绍RabbitMQ消息有效期与死信的相关知识，感兴趣的朋友跟随小编一起看看吧
2022-03-03
SpringBoot 创建对象常见的几种方式小结
Spring Boot中创建对象的几种常见方式包括使用@Component、@Service、@Repository或@Controller注解,本文就来详细的介绍一下,感兴趣的可以了解一下
2024-11-11
详解阿里云maven镜像库配置（gradle,maven）
这篇文章主要介绍了详解阿里云maven镜像库配置（gradle,maven），小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-02-02
Spring Boot处理全局统一异常的两种方法与区别
这篇文章主要给大家介绍了关于Spring Boot处理全局统一异常的两种方法与区别，文中通过示例代码介绍的非常详细，对大家学习或者使用Spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-06-06
解读yml文件中配置时间类型的转换方式
这篇文章主要介绍了yml文件中配置时间类型的转换方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-12-12
Spark学习笔记（一）Spark初识【特性、组成、应用】
这篇文章主要介绍了Spark学习笔记之Spark初识,简单分析了spark四大特性、基本组成、应用场景,需要的朋友可以参考下
2020-02-02
Java NegativeArraySizeException异常解决方案
这篇文章主要介绍了Java NegativeArraySizeException异常解决方案,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-08-08