Spring中的PathVariable注释解析

更新时间：2021年10月25日 14:46:51 作者：zenglintao

这篇文章主要介绍了Spring中的PathVariable注释用法，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

Spring的PathVariable注释

就像@RequestParam一样，@PathVariable批注用于从HTTP request中提取数据。但是，它们略有不同。区别在于@RequestParam从URL获取参数，而@PathVariable只是从URI中提取参数。

例子

让我们假设你有一个以下 URL 的网站:

http://www.yourwebsite.net/employee/1

上面 URL 中的1表示雇员的 ID。到目前为止一切ok。但是现在，从 Spring 控制器看，路径看起来是这样的(取决于您给 id 的名称) ：

/employee/{id}

上面的 URL 路径对我们有什么帮助？因为这个{}语法(碰巧被称为 URI 模板) ，你现在可以把它传递给一个使用@pathvariable 的方法，你的方法和注释看起来如下所示:

@RequestMapping(value="/employee/{id}", method=RequestMethod.GET)
<Access Modifier> <Return Type> <Method Name> (@PathVariable <Type> id) { <body> }

从上面的代码片段可以看到，现在“ id”将从路径中引用{ id }。让我们用一个真实的例子来尝试：

@Controller
@SpringBootApplication
public class EmployeeManager {
   @RequestMapping(value=" /employee/{id}")
   public String pathVariableDemo(Model model, @PathVariable int id) {
      model.addAttribute("id", id);
      return "demo";
   }
}

现在，Spring查看输出id参数，并将其与模板变量“ id”进行匹配。

请记住，如果我的代码使用“ id”(参数)命名为其他名称，那么它将无法工作。然而，如果你不想对参数和模板变量使用相同的名字，你可以像这样命名 PathVariable 注释的名字：

@Controller
@SpringBootApplication
public class EmployeeManager {
   @RequestMapping(value=" /employee/{id}")
   public String pathVariableDemo(Model model, @PathVariable("id") int someRandomName) {
      model.addAttribute("id", someRandomName);
      return "demo";
   }
}

从上面的示例中可以看到，我将参数的名称更改为 _someRandomName，_但还添加了@PathVariable （“ id”），它再次指定了我们要引用的模板变量。

最终您有两个选择：

1.为方法参数使用相同的名称
2.在@PathVariable批注中指定模板变量的名称

多个@PathVariable批注

如果你可以有多个@pathvariable 会怎么样？我们能做到吗？是的，我们可以！事实上，这和添加一个@pathvariable 非常相似。

我们来演示一下：

@Controller
@SpringBootApplication
public class EmployeeManager {
   @RequestMapping(value="/{company}/employee/{id}", method=RequestMethod.GET)
   public String pathVariableDemo(@PathVariable("company") String companyName, @PathVariable("id") int employeeId) {
      // handle the code
      return "demo";
   }
}

从上面的代码片段中可以看到，我们有两个模板变量：

company
id

然后，我们提取每个模板变量，然后通过指定方法参数所引用的临时变量将它们“分配”给方法参数。

@PathVariable vs @RequestParam结论

尽管@PathVariable和@RequestParam都用于从URL提取值，但是可以根据URL的设计使用它们。

通常，@PathVariable通常用于RESTful Web服务中，而@RequestParam用于从查询参数中提取数据。

使用@PathVariable的坑

发现问题

前端路径拼接用户名，因为用户名中是带'.‘这个字符的。类似'Oliver.wang'。前端浏览器F12，发现路径正常拼接'xxxxxx/Oliver.wang?xxx=xxx',后端代码发现，controller层的参数，接收到只有'Oliver'。

解决过程

在方法中多加了一个参数(xxx,HttpServletRequest request){}，输出request.ServletPath(),发现路径正常'/xxx/xxx/Oliver.wang'。

解决方案

第一种：加上 {:.+} ，比如 @getMapping(“xxx/{name:.+}”)
第二种：UrlEncode
第三种：request.ServletPath() 拿到路径截取字符串
第四种：不拼接路径，改成'xxxxx?name=Oliver.wang' 请求参数

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

java压缩文件和下载图片示例
这篇文章主要为大家详细介绍了java压缩文件和下载图片示例,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2016-10-10
使用maven的profile构建不同环境配置的方法
这篇文章主要介绍了使用maven的profile构建不同环境配置的方法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-01-01
详解如何在springcloud分布式系统中实现分布式锁
最近在看分布式锁的资料，本文就介绍一下利用springcloud结合redis实现分布式锁，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-11-11
关于SpingMVC的<context:component-scan>包扫描踩坑记录
这篇文章主要介绍了关于SpingMVC的<context:component-scan>包扫描踩坑记录，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03
SpringBoot Web请求响应详细代码示例
在Web开发中请求和响应是必不可少的环节,Spring Boot Web应用中请求响应的分层解耦是构建高效、可维护系统的关键实践,下面这篇文章主要介绍了SpringBoot Web请求响应的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
2024-09-09
C/C++中的struct结构体详细解读
这篇文章主要介绍了C/C++中的struct结构体详细解读,结构体是由一批数据组合而成的结构型数据,组成结构型数据的每个数据称为结构型数据的“成员”,其描述了一块内存区间的大小及意义,需要的朋友可以参考下
2023-10-10
Java模拟实现斗地主发牌
这篇文章主要为大家详细介绍了Java实现模拟斗地主发牌，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-07-07
特殊数据结构之使用Java实现单调栈示例
这篇文章主要为大家介绍了特殊数据结构之使用Java实现单调栈示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-09-09
SpringBoot集成Swagger2构建在线API文档的代码详解
这篇文章主要介绍了SpringBoot集成Swagger2构建在线API文档,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12
SpringBoot环境配置知识总结
今天带大家了解SpringBoot环境配置的相关知识,文中有非常详细的代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
2021-05-05