Spring中的PathVariable注释解析

2024-12-09 17:49:09

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' 请求参数

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

聊聊@RequestParam,@PathParam,@PathVariable等注解的区别

@RequestParam 和 @PathVariable 注解是用于从request中接收请求的,两个都可以接收参数,关键点不同的是@RequestParam 是从request里面拿取值,而 @PathVariable 是从一个URI模板里面来填充 @RequestParam 看下面一段代码: http://localhost:8080/springmvc/hello/101?param1=10&param2=20 根据上面的这个URL,你可以用这样的方式来进行获取 public Strin
SpringMVC中使用@PathVariable绑定路由中的数组的方法

问题描述在开发批量删除功能时,往往都是多条数据,所以前台需要传一个数组给后台,但是怎么在URL中绑定一个数组,同时在后台用@PathVariable来绑定呢? 原来的做法后台: 前台: 以上是之前项目的截图,直接拿过来啦!!!
基于@PathVariable注解的用法说明

带占位符的 URL 是 Spring3.0 新增的功能,该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义. 通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中:URL 中的 {xxx} 占位符可以通过 @PathVariable("xxx") 绑定到操作方法的入参中. 补充:@PathVariable接收两个参数首先,@PathVariable无法接收对象,但是可以接收多个值 var data = obj.data;
@PathVariable注解,让spring支持参数带值功能的案例

@PathVariable的作用获取URL动态变量,例如 @RequestMapping("/users/{userid}") @ResponseBody public String getUser(@PathVariable String userid){ return "userid=" + userid; } @PathVariable的包引用 spring自从3.0版本就引入了org.springframework.web.bind.annotation.
SpringMVC使用@PathVariable接收参数过程解析

PathVariable 映射 URL 绑定的占位符带占位符的 URL 是 Spring3.0 新增的功能,该功能在SpringMVC 向 REST 目标挺进发展过程中具有里程碑的意义通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中:URL 中的 {xxx} 占位符可以通过@PathVariable("xxx") 绑定到操作方法的入参中. 使用MVC时,总是出现一些问题,当然都是使用造成的. 今天遇到一个问题,使用@PathVariable
Spring中的PathVariable注释解析

目录 Spring的PathVariable注释例子多个@PathVariable批注 @PathVariable vs @RequestParam结论使用@PathVariable的坑发现问题解决过程解决方案 Spring的PathVariable注释就像@RequestParam一样,@PathVariable批注用于从HTTP request中提取数据.但是,它们略有不同.区别在于@RequestParam从URL获取参数,而@PathVariable只是从URI中提取参数.
Spring中自定义Schema如何解析生效详解

前言随着 Spring Boot 的日渐流行,应用里的大部分配置都被隐藏了起来,我们仅需要关心真正的业务内容, Controller, Service, Repository,拿起键盘就是一通业务代码的Coding,具体的 Component Scan,View,PlaceHolder ... 都可以抛在脑后.但其实这种零配置在 Java 应用开发中,还真不太久. 「由奢入俭难」,不少开发者都经历过 Spring XML 配置的冗长,再回到这种配置确实不好受. 但有些时候,由于配置的内容在 S
关于Spring中的三级缓存解析

目录 Spring的三级缓存 spring三级缓存代码流程图 Spring的三级缓存 Spring三级缓存是为了解决对象间的循环依赖问题. A依赖B,B依赖A,这就是一个简单的循环依赖. 我们来先看看三级缓存的源码. (1)查看“获取Bean”的源码,注意getSingleton()方法. public class DefaultSingletonBeanRegistry extends SimpleAliasRegistry implements SingletonBeanRegistry {
Spring中Xml属性配置的解析全过程记录

1 工程概述 1.1 pom文件 <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <spring.ver
Spring5源码解析之Spring中的异步和计划任务

Java提供了许多创建线程池的方式,并得到一个Future实例来作为任务结果.对于Spring同样小菜一碟,通过其scheduling包就可以做到将任务线程中后台执行. 在本文的第一部分中,我们将讨论下Spring中执行计划任务的一些基础知识.之后,我们将解释这些类是如何一起协作来启动并执行计划任务的.下一部分将介绍计划和异步任务的配置.最后,我们来写个Demo,看看如何通过单元测试来编排计划任务. 什么是Spring中的异步任务? 在我们正式的进入话题之前,对于Spring,我们需要理解下它实
Spring中@DependsOn注解的作用及实现原理解析

本文给大家讲解Spring中@DependsOn注解的作用及实现原理! 官方文档解释 Beans on which the current bean depends. Any beans specified are guaranteed to be created by the container before this bean. Used infrequently in cases where a bean does not explicitly depend on another thro
解析Spring中面向切面编程

一.AOP--另一种编程思想 1.1.什么是 AOP AOP (Aspect Orient Programming),直译过来就是面向切面编程.AOP 是一种编程思想,是面向对象编程(OOP)的一种补充.面向对象编程将程序抽象成各个层次的对象,而面向切面编程是将程序抽象成各个切面. 从<Spring实战(第4版)>图书中扒了一张图: 从该图可以很形象地看出,所谓切面,相当于应用对象间的横切点,我们可以将其单独抽象为单独的模块. 1.2.为什么需要 AOP 想象下面的场景,开发中在多个模块间有
spring mvc中的@PathVariable动态参数详解

目录 spring mvc @PathVariable动态参数 spring mvc是如何做到根据参数名动态绑定参数的? 反射获取参数名 -parameters参数 -g参数 ASM SpringMVC的处理方式总结 spring mvc @PathVariable动态参数 spring mvc中的@PathVariable是用来获得请求url中的动态参数的,十分方便 @Controller public class TestController { @RequestMapping(value
spring mvc中的@PathVariable获得请求url中的动态参数

spring mvc中的@PathVariable是用来获得请求url中的动态参数的,十分方便,复习下: @Controller public class TestController { @RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET) public String getLogin(@PathVariable("userId") String user
基于Spring中的线程池和定时任务功能解析

1.功能介绍 Spring框架提供了线程池和定时任务执行的抽象接口:TaskExecutor和TaskScheduler来支持异步执行任务和定时执行任务功能.同时使用框架自己定义的抽象接口来屏蔽掉底层JDK版本间以及Java EE中的线程池和定时任务处理的差异. 另外Spring还支持集成JDK内部的定时器Timer和Quartz Scheduler框架. 2.线程池的抽象:TaskExecutor TaskExecutor涉及到的相关类图如下: TaskExecutor接口源代码如下所示: p