@RequestParam、@RequestBody、@PathVariable 等注解详解

本文详细介绍了Spring MVC中参数绑定的原理与实践,包括不同类型的注解如何处理各种请求内容,如路径变量、请求头、Cookie值、请求体等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类:(主要讲解常用类型)

A、处理requet uri 部分(这里指uri template中variable,不含queryString部分)的注解:   @PathVariable;

B、处理request header部分的注解:   @RequestHeader, @CookieValue;

C、处理request body部分的注解:@RequestParam,  @RequestBody;

D、处理attribute类型是注解: @SessionAttributes, @ModelAttribute;


在写正文之前,先铺垫一下基础,当你读到下面的文章的时候就基本不会再去百度该方面的内容了哈:

补充基础1:{

在Form元素的语法中,EncType表明提交数据的格式 用 Enctype 属性指定将数据回发到服务器时浏览器使用的编码类型。 下边是说明: application/x-www-form-urlencoded: 窗体数据被编码为名称/值对。这是标准的编码格式。 multipart/form-data: 窗体数据被编码为一条消息,页上的每个控件对应消息中的一个部分。 text/plain: 窗体数据以纯文本形式进行编码,其中不含任何控件或格式字符。
 补充
form的enctype属性为编码方式,常用有两种:application/x-www-form-urlencoded和multipart/form-data,默认为application/x-www-form-urlencoded。 当action为get时候,浏览器用x-www-form-urlencoded的编码方式把form数据转换成一个字串(name1=value1&name2=value2...),然后把这个字串append到url后面,用?分割,加载这个新的url。 当action为post时候,浏览器把form数据封装到http body中,然后发送到server。 如果没有type=file的控件,用默认的application/x-www-form-urlencoded就可以了。 但是如果有type=file的话,就要用到multipart/form-data了。浏览器会把整个表单以控件为单位分割,并为每个部分加上Content-Disposition(form-data或者file),Content-Type(默认为text/plain),name(控件name)等信息,并加上分割符(boundary)。

}

 

1、 @PathVariable 

当使用@RequestMapping URI template 样式映射时, 即 someUrl/{paramId}, 这时的paramId可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

示例代码:

[java]  view plain  copy
  1. @Controller  
  2. @RequestMapping("/owners/{ownerId}")  
  3. public class RelativePathUriTemplateController {  
  4.   
  5.   @RequestMapping("/pets/{petId}")  
  6.   public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
  7.     // implementation omitted  
  8.   }  
  9. }  
上面代码把URI template 中变量 ownerId的值和petId的值,绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致,需要在@PathVariable("name")指定uri template中的名称。

2、 @RequestHeader、@CookieValue

@RequestHeader 注解,可以把Request请求header部分的值绑定到方法的参数上。

示例代码:

这是一个Request 的header部分:

[plain]  view plain  copy
  1. Host                    localhost:8080  
  2. Accept                  text/html,application/xhtml+xml,application/xml;q=0.9  
  3. Accept-Language         fr,en-gb;q=0.7,en;q=0.3  
  4. Accept-Encoding         gzip,deflate  
  5. Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7  
  6. Keep-Alive              300  

[java]  view plain  copy
  1. @RequestMapping("/displayHeaderInfo.do")  
  2. public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,  
  3.                               @RequestHeader("Keep-Alive"long keepAlive)  {  
  4.   
  5.   //...  
  6.   
  7. }  
上面的代码,把request header部分的 Accept-Encoding的值,绑定到参数encoding上了, Keep-Alive header的值绑定到参数keepAlive上。


@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。

例如有如下Cookie值:

[java]  view plain  copy
  1. JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84  
参数绑定的代码:

[java]  view plain  copy
  1. @RequestMapping("/displayHeaderInfo.do")  
  2. public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {  
  3.   
  4.   //...  
  5.   
  6. }  
即把JSESSIONID的值绑定到参数cookie上。


3、@RequestParam, @RequestBody

@RequestParam 

A) 常用来处理简单类型的绑定,通过Request.getParameter() 获取的String可直接转换为简单类型的情况( String--> 简单类型的转换操作由ConversionService配置的转换器来完成);因为使用request.getParameter()方式获取参数,所以可以处理get 方式中queryString的值,也可以处理post方式中 body data的值;

B)用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容,提交方式GET、POST;

C) 该注解有两个属性: value、required; value用来指定要传入值的id名称,required用来指示参数是否必须绑定;

示例代码:

[java]  view plain  copy
  1. @Controller  
  2. @RequestMapping("/pets")  
  3. @SessionAttributes("pet")  
  4. public class EditPetForm {  
  5.   
  6.     // ...  
  7.   
  8.     @RequestMapping(method = RequestMethod.GET)  
  9.     public String setupForm(@RequestParam("petId"int petId, ModelMap model) {  
  10.         Pet pet = this.clinic.loadPet(petId);  
  11.         model.addAttribute("pet", pet);  
  12.         return "petForm";  
  13.     }  
  14.   
  15.     // ...  


@RequestBody

该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容,例如application/json, application/xml等;

它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body,然后绑定到相应的bean上的。

因为配置有FormHttpMessageConverter,所以也可以用来处理 application/x-www-form-urlencoded的内容,处理完的结果放在一个MultiValueMap<String, String>里,这种情况在某些特殊需求下使用,详情查看FormHttpMessageConverter api;

示例代码:

[java]  view plain  copy
  1. @RequestMapping(value = "/something", method = RequestMethod.PUT)  
  2. public void handle(@RequestBody String body, Writer writer) throws IOException {  
  3.   writer.write(body);  
  4. }  

4、@SessionAttributes, @ModelAttribute

@SessionAttributes:

该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数里使用。

该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute 对象;

示例代码:

[java]  view plain  copy
  1. @Controller  
  2. @RequestMapping("/editPet.do")  
  3. @SessionAttributes("pet")  
  4. public class EditPetForm {  
  5.     // ...  
  6. }  


@ModelAttribute

该注解有两个用法,一个是用于方法上,一个是用于参数上;

用于方法上时:  通常用来在处理@RequestMapping之前,为请求绑定需要从后台查询的model;

用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上;要绑定的值来源于:

A) @SessionAttributes 启用的attribute 对象上;

B) @ModelAttribute 用于方法上时指定的model对象;

C) 上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中。


用到方法上@ModelAttribute的示例代码:

[java]  view plain  copy
  1. // Add one attribute  
  2. // The return value of the method is added to the model under the name "account"  
  3. // You can customize the name via @ModelAttribute("myAccount")  
  4.   
  5. @ModelAttribute  
  6. public Account addAccount(@RequestParam String number) {  
  7.     return accountManager.findAccount(number);  
  8. }  

这种方式实际的效果就是在调用@RequestMapping的方法之前,为request对象的model里put(“account”, Account);


用在参数上的@ModelAttribute示例代码:

[java]  view plain  copy
  1. @RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)  
  2. public String processSubmit(@ModelAttribute Pet pet) {  
  3.      
  4. }  
首先查询 @SessionAttributes有无绑定的Pet对象,若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象,若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。

补充讲解:

问题: 在不给定注解的情况下,参数是怎样绑定的?

通过分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代码发现,方法的参数在不给定参数的情况下:

若要绑定的对象时简单类型:  调用@RequestParam来处理的。  

若要绑定的对象时复杂类型:  调用@ModelAttribute来处理的。

这里的简单类型指Java的原始类型(boolean, int 等)、原始类型对象(Boolean, Int等)、String、Date等ConversionService里可以直接String转换成目标对象的类型;


下面贴出AnnotationMethodHandlerAdapter中绑定参数的部分源代码:

[java]  view plain  copy
  1. private Object[] resolveHandlerArguments(Method handlerMethod, Object handler,  
  2.             NativeWebRequest webRequest, ExtendedModelMap implicitModel) throws Exception {  
  3.   
  4.         Class[] paramTypes = handlerMethod.getParameterTypes();  
  5.         Object[] args = new Object[paramTypes.length];  
  6.   
  7.         for (int i = 0; i < args.length; i++) {  
  8.             MethodParameter methodParam = new MethodParameter(handlerMethod, i);  
  9.             methodParam.initParameterNameDiscovery(this.parameterNameDiscoverer);  
  10.             GenericTypeResolver.resolveParameterType(methodParam, handler.getClass());  
  11.             String paramName = null;  
  12.             String headerName = null;  
  13.             boolean requestBodyFound = false;  
  14.             String cookieName = null;  
  15.             String pathVarName = null;  
  16.             String attrName = null;  
  17.             boolean required = false;  
  18.             String defaultValue = null;  
  19.             boolean validate = false;  
  20.             Object[] validationHints = null;  
  21.             int annotationsFound = 0;  
  22.             Annotation[] paramAnns = methodParam.getParameterAnnotations();  
  23.   
  24.             for (Annotation paramAnn : paramAnns) {  
  25.                 if (RequestParam.class.isInstance(paramAnn)) {  
  26.                     RequestParam requestParam = (RequestParam) paramAnn;  
  27.                     paramName = requestParam.value();  
  28.                     required = requestParam.required();  
  29.                     defaultValue = parseDefaultValueAttribute(requestParam.defaultValue());  
  30.                     annotationsFound++;  
  31.                 }  
  32.                 else if (RequestHeader.class.isInstance(paramAnn)) {  
  33.                     RequestHeader requestHeader = (RequestHeader) paramAnn;  
  34.                     headerName = requestHeader.value();  
  35.                     required = requestHeader.required();  
  36.                     defaultValue = parseDefaultValueAttribute(requestHeader.defaultValue());  
  37.                     annotationsFound++;  
  38.                 }  
  39.                 else if (RequestBody.class.isInstance(paramAnn)) {  
  40.                     requestBodyFound = true;  
  41.                     annotationsFound++;  
  42.                 }  
  43.                 else if (CookieValue.class.isInstance(paramAnn)) {  
  44.                     CookieValue cookieValue = (CookieValue) paramAnn;  
  45.                     cookieName = cookieValue.value();  
  46.                     required = cookieValue.required();  
  47.                     defaultValue = parseDefaultValueAttribute(cookieValue.defaultValue());  
  48.                     annotationsFound++;  
  49.                 }  
  50.                 else if (PathVariable.class.isInstance(paramAnn)) {  
  51.                     PathVariable pathVar = (PathVariable) paramAnn;  
  52.                     pathVarName = pathVar.value();  
  53.                     annotationsFound++;  
  54.                 }  
  55.                 else if (ModelAttribute.class.isInstance(paramAnn)) {  
  56.                     ModelAttribute attr = (ModelAttribute) paramAnn;  
  57.                     attrName = attr.value();  
  58.                     annotationsFound++;  
  59.                 }  
  60.                 else if (Value.class.isInstance(paramAnn)) {  
  61.                     defaultValue = ((Value) paramAnn).value();  
  62.                 }  
  63.                 else if (paramAnn.annotationType().getSimpleName().startsWith("Valid")) {  
  64.                     validate = true;  
  65.                     Object value = AnnotationUtils.getValue(paramAnn);  
  66.                     validationHints = (value instanceof Object[] ? (Object[]) value : new Object[] {value});  
  67.                 }  
  68.             }  
  69.   
  70.             if (annotationsFound > 1) {  
  71.                 throw new IllegalStateException("Handler parameter annotations are exclusive choices - " +  
  72.                         "do not specify more than one such annotation on the same parameter: " + handlerMethod);  
  73.             }  
  74.   
  75.             if (annotationsFound == 0) {// 若没有发现注解  
  76.                 Object argValue = resolveCommonArgument(methodParam, webRequest);    //判断WebRquest是否可赋值给参数  
  77.                 if (argValue != WebArgumentResolver.UNRESOLVED) {  
  78.                     args[i] = argValue;  
  79.                 }  
  80.                 else if (defaultValue != null) {  
  81.                     args[i] = resolveDefaultValue(defaultValue);  
  82.                 }  
  83.                 else {  
  84.                     Class<?> paramType = methodParam.getParameterType();  
  85.                     if (Model.class.isAssignableFrom(paramType) || Map.class.isAssignableFrom(paramType)) {  
  86.                         if (!paramType.isAssignableFrom(implicitModel.getClass())) {  
  87.                             throw new IllegalStateException("Argument [" + paramType.getSimpleName() + "] is of type " +  
  88.                                     "Model or Map but is not assignable from the actual model. You may need to switch " +  
  89.                                     "newer MVC infrastructure classes to use this argument.");  
  90.                         }  
  91.                         args[i] = implicitModel;  
  92.                     }  
  93.                     else if (SessionStatus.class.isAssignableFrom(paramType)) {  
  94.                         args[i] = this.sessionStatus;  
  95.                     }  
  96.                     else if (HttpEntity.class.isAssignableFrom(paramType)) {  
  97.                         args[i] = resolveHttpEntityRequest(methodParam, webRequest);  
  98.                     }  
  99.                     else if (Errors.class.isAssignableFrom(paramType)) {  
  100.                         throw new IllegalStateException("Errors/BindingResult argument declared " +  
  101.                                 "without preceding model attribute. Check your handler method signature!");  
  102.                     }  
  103.                     else if (BeanUtils.isSimpleProperty(paramType)) {// 判断是否参数类型是否是简单类型,若是在使用@RequestParam方式来处理,否则使用@ModelAttribute方式处理  
  104.                         paramName = "";  
  105.                     }  
  106.                     else {  
  107.                         attrName = "";  
  108.                     }  
  109.                 }  
  110.             }  
  111.   
  112.             if (paramName != null) {  
  113.                 args[i] = resolveRequestParam(paramName, required, defaultValue, methodParam, webRequest, handler);  
  114.             }  
  115.             else if (headerName != null) {  
  116.                 args[i] = resolveRequestHeader(headerName, required, defaultValue, methodParam, webRequest, handler);  
  117.             }  
  118.             else if (requestBodyFound) {  
  119.                 args[i] = resolveRequestBody(methodParam, webRequest, handler);  
  120.             }  
  121.             else if (cookieName != null) {  
  122.                 args[i] = resolveCookieValue(cookieName, required, defaultValue, methodParam, webRequest, handler);  
  123.             }  
  124.             else if (pathVarName != null) {  
  125.                 args[i] = resolvePathVariable(pathVarName, methodParam, webRequest, handler);  
  126.             }  
  127.             else if (attrName != null) {  
  128.                 WebDataBinder binder =  
  129.                         resolveModelAttribute(attrName, methodParam, implicitModel, webRequest, handler);  
  130.                 boolean assignBindingResult = (args.length > i + 1 && Errors.class.isAssignableFrom(paramTypes[i + 1]));  
  131.                 if (binder.getTarget() != null) {  
  132.                     doBind(binder, webRequest, validate, validationHints, !assignBindingResult);  
  133.                 }  
  134.                 args[i] = binder.getTarget();  
  135.                 if (assignBindingResult) {  
  136.                     args[i + 1] = binder.getBindingResult();  
  137.                     i++;  
  138.                 }  
  139.                 implicitModel.putAll(binder.getBindingResult().getModel());  
  140.             }  
  141.         }  
  142.   
  143.         return args;  
  144.     }  

RequestMappingHandlerAdapter中使用的参数绑定,代码稍微有些不同,有兴趣的同仁可以分析下,最后处理的结果都是一样的。

示例:

[java]  view plain  copy
  1. @RequestMapping ({"/""/home"})  
  2.     public String showHomePage(String key){  
  3.           
  4.         logger.debug("key="+key);  
  5.           
  6.         return "home";  
  7.     }  
这种情况下,就调用默认的@RequestParam来处理。

[java]  view plain  copy
  1. @RequestMapping (method = RequestMethod.POST)  
  2. public String doRegister(User user){  
  3.     if(logger.isDebugEnabled()){  
  4.         logger.debug("process url[/user], method[post] in "+getClass());  
  5.         logger.debug(user);  
  6.     }  
  7.   
  8.     return "user";  
  9. }  

这种情况下,就调用@ModelAttribute来处理。

Ajax中content-type设置:

引言: 在Http请求中,我们每天都在使用Content-type来指定不同格式的请求信息,但是却很少有人去全面了解content-type中允许的值有多少,这里将讲解Content-Type的可用值,以及在Spring MVC中如何使用它们来映射请求信息。

1.  Content-Type

  MediaType,即是Internet Media Type,互联网媒体类型;也叫做MIME类型,在Http协议消息头中,使用Content-Type来表示具体请求中的媒体类型信息。

[html]  view plain  copy
  1. 类型格式:type/subtype(;parameter)? type  
  2. 主类型,任意的字符串,如text,如果是*号代表所有;   
  3. subtype 子类型,任意的字符串,如html,如果是*号代表所有;   
  4. parameter 可选,一些参数,如Accept请求头的q参数, Content-Type的 charset参数。   
 例如: Content-Type: text/html;charset:utf-8;

 常见的媒体格式类型如下:

  •     text/html : HTML格式
  •     text/plain :纯文本格式      
  •     text/xml :  XML格式
  •     image/gif :gif图片格式    
  •     image/jpeg :jpg图片格式 
  •     image/png:png图片格式

   以application开头的媒体格式类型:

  •    application/xhtml+xml :XHTML格式
  •    application/xml     : XML数据格式
  •    application/atom+xml  :Atom XML聚合格式    
  •    application/json    : JSON数据格式
  •    application/pdf       :pdf格式  
  •    application/msword  : Word文档格式
  •    application/octet-stream : 二进制流数据(如常见的文件下载)
  •    application/x-www-form-urlencoded : <form encType=””>中默认的encType,form表单数据被编码为key/value格式发送到服务器(表单默认的提交数据的格式)

   另外一种常见的媒体格式是上传文件之时使用的:

  •     multipart/form-data : 需要在表单中进行文件上传时,就需要使用该格式

     以上就是我们在日常的开发中,经常会用到的若干content-type的内容格式。

2.   Spring MVC中关于关于Content-Type类型信息的使用

    首先我们来看看RequestMapping中的Class定义:

[html]  view plain  copy
  1. @Target({ElementType.METHOD, ElementType.TYPE})  
  2. @Retention(RetentionPolicy.RUNTIME)  
  3. @Documented  
  4. @Mapping  
  5. public @interface RequestMapping {  
  6.       String[] value() default {};  
  7.       RequestMethod[] method() default {};  
  8.       String[] params() default {};  
  9.       String[] headers() default {};  
  10.       String[] consumes() default {};  
  11.       String[] produces() default {};  
  12. }  
value:  指定请求的实际地址, 比如 /action/info之类。
method:  指定请求的method类型, GET、POST、PUT、DELETE等
consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;
produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回
params: 指定request中必须包含某些参数值是,才让该方法处理
headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求

其中,consumes, produces使用content-typ信息进行过滤信息;headers中可以使用content-type进行过滤和判断。

3. 使用示例

  3.1 headers

[html]  view plain  copy
  1. @RequestMapping(value = "/test"method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")    
  2. public void testHeaders(@PathVariable String ownerId, @PathVariable String petId) {        
  3.   // implementation omitted    
  4. }   
  这里的Headers里面可以匹配所有Header里面可以出现的信息,不局限在Referer信息。

  示例2

[html]  view plain  copy
  1. @RequestMapping(value = "/response/ContentType"headers = "Accept=application/json")    
  2. public void response2(HttpServletResponse response) throws IOException {    
  3.     //表示响应的内容区数据的媒体类型为json格式,且编码为utf-8(客户端应该以utf-8解码)    
  4.     response.setContentType("application/json;charset=utf-8");    
  5.     //写出响应体内容    
  6.     String jsonData = "{\"username\":\"zhang\", \"password\":\"123\"}";    
  7.     response.getWriter().write(jsonData);    
  8. }    
服务器根据请求头“Accept=application/json”生产json数据。

当你有如下Accept头,将遵守如下规则进行应用:
①Accept:text/html,application/xml,application/json
      将按照如下顺序进行produces的匹配 ①text/html ②application/xml ③application/json
②Accept:application/xml;q=0.5,application/json;q=0.9,text/html
      将按照如下顺序进行produces的匹配 ①text/html ②application/json ③application/xml
      参数为媒体类型的质量因子,越大则优先权越高(从0到1)
③Accept:*/*,text/*,text/html
      将按照如下顺序进行produces的匹配 ①text/html ②text/* ③*/*


即匹配规则为:最明确的优先匹配。



<think>好的,我现在需要回答用户关于Spring MVC中@RequestParam@RequestBody@PathVariable的区别及使用场景的问题。用户已经提供了一些相关的引用内容,我需要结合这些引用和我的知识来整理出一个清晰、准确的回答。首先,我需要明确这三个注解各自的用途和区别。根据引用[2]和[4],@PathVariable用于处理URL路径中的模板变量,通常在RESTfulAPI中使用,将URL中的占位符绑定到方法的参数上。例如,/user/{id}中的{id}可以通过@PathVariable获取。接下来是@RequestParam,引用[1]和[4]提到,它主要用于获取请求参数,通常来自查询字符串(即URL中的?后面的参数)。比如/user?name=John中的name参数可以通过@RequestParam("name")来绑定。需要注意的是,@RequestParam的参数默认是必须的,但可以通过required属性设置为可选。 然后是@RequestBody,引用[3]和[4]出,它用于将请求体的内容绑定到方法的参数上,通常处理POST请求中的JSON或XML数据。例如,前端发送一个JSON对象,后端使用@RequestBody将其转换为对应的Java对象。 接下来要分析它们的区别。根据引用[4],@RequestParam@PathVariable的主要区别在于参数的来源:@RequestParam来自查询参数,而@PathVariable来自URL路径中的占位符。而@RequestBody则是处理请求体中的数据,适用于非表单数据,如JSON/XML。使用场景方面,@PathVariable适合RESTful风格的URL,比如获取资源ID;@RequestParam适合过滤或可选参数;@RequestBody适合接收复杂的结构化数据,比如表单提交或AJAX请求中的JSON数据。 另外要注意的是,@RequestBody通常与POST或PUT请求一起使用,而@RequestParam@PathVariable可以用于各种HTTP方法。还要考虑参数是否必填,比如@RequestParam默认必填,而@PathVariable因为URL结构通常也是必填的。需要验证这些信息是否正确。例如,@PathVariable是否真的只能用于路径参数,而@RequestParam用于查询参数?是的,根据Spring文档,确实如此。@RequestBody是否只能处理POST请求的body内容?是的,尤其是非表单编码的数据。可能用户还会混淆这些注解的使用场景,比如什么时候用@RequestParam@PathVariable,或者何时选择@RequestBody。因此,在回答中需要明确各自的应用示例,帮助用户理解。 最后,生成相关问题时要围绕这三个注解的对比、使用注意事项、以及常见错误等。例如,如何处理可选参数,或者当参数在URL路径和查询字符串中同时存在时的处理方式。总结一下,我需要将这三个注解的区别从参数来源、HTTP请求的位置、数据处理方式、使用场景等方面进行对比,并给出示例代码,确保用户能够清晰理解它们的不同之处和正确用法。</think>### Spring MVC中@RequestParam@RequestBody@PathVariable的区别 #### 一、核心区别对比 | 特性 | @RequestParam[^1] | @PathVariable[^2] | @RequestBody[^3] | |--------------------|---------------------------|--------------------------|---------------------------| | **参数来源** | URL查询参数(?key=value) | URL路径占位符(/{id}) | HTTP请求体(Request Body)| | **数据格式** | 键值对形式 | 简单类型 | JSON/XML等结构化数据 | | **HTTP方法适用性** | 所有方法 | 所有方法 | 主要POST/PUT/PATCH | | **必填性** | 默认必填(可配置) | 必填 | 必填 | | **示例URL** | `/user?name=John` | `/user/123` | POST `/user` (Body传JSON) | #### 二、使用场景详解 1. **@PathVariable** ```java // 获取RESTful风格资源标识符 @GetMapping("/products/{id}") public Product getProduct(@PathVariable Long id) { return productService.findById(id); } ``` - 适用场景:资源定位(如`/api/users/{userId}`) - 特点:直接嵌入URL路径,增强语义化[^2] 2. **@RequestParam** ```java // 处理分页查询参数 @GetMapping("/articles") public Page<Article> listArticles( @RequestParam(defaultValue = "0") int page, @RequestParam(defaultValue = "10") int size) { return articleService.getPage(page, size); } ``` - 适用场景:过滤条件、可选参数、分页参数 - 特点:支持默认值设置(`defaultValue`属性) 3. **@RequestBody** ```java // 接收JSON格式的用户注册数据 @PostMapping("/register") public ResponseEntity<?> registerUser(@RequestBody UserDTO userDto) { userService.createUser(userDto); return ResponseEntity.ok().build(); } ``` - 适用场景:表单提交、复杂对象传输 - 特点:自动反序列化JSON到Java对象[^3] #### 三、组合使用示例 ```java // 同时使用路径变量和查询参数 @PutMapping("/books/{isbn}/stock") public void updateStock( @PathVariable String isbn, @RequestParam int delta, @RequestBody StockUpdateLog log) { inventoryService.adjustStock(isbn, delta, log); } ``` - `{isbn}`来自路径参数 - `delta`来自查询参数 - `log`来自请求体JSON #### 四、特殊处理机制 1. **参数绑定规则** - @PathVariable根据名称自动匹配,若名称不一致需定`value`属性: ```java @GetMapping("/{userId}") public User getUser(@PathVariable("userId") Long id) {...} ``` - @RequestParam支持数组参数: ```java // URL示例:/search?categories=java&categories=spring public List<Result> search(@RequestParam List<String> categories) {...} ``` 2. **Content-Type处理** @RequestBody需要明确定请求头: ```http POST /api/data Content-Type: application/json {"name":"test","value":42} ``` #### 五、常见错误场景 1. **缺少必需参数** ```java // 触发MissingServletRequestParameterException public String handle(@RequestParam String requiredParam) {...} ``` 2. **类型转换失败** ```java // 若URL传参?id=abc 会触发TypeMismatchException public String getById(@RequestParam Long id) {...} ``` 3. **JSON解析错误** ```java // 请求体JSON字段与DTO不匹配时触发HttpMessageNotReadableException public void create(@RequestBody Product product) {...} ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值