SpringMVC基础(5): SpringMVC常用注解

CodingALife

已于 2022-02-06 02:28:16 修改

阅读量1.6k

点赞数

分类专栏： SpringMVC 文章标签： java

于 2021-04-29 15:14:48 首次发布

原文链接：https://chenchenchen.blog.csdn.net/article/details/99655322?utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromMachineLearnPai2%7Edefault-2.control&dist_request_id=&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Ede

版权

SpringMVC 专栏收录该内容

12 篇文章 7 订阅

订阅专栏

1、handler method 参数绑定常用注解

2、常用注解

1、 @PathVariable

2、 @RequestHeader、@CookieValue

3、@Re Body

5、@RequestBody和@RequestParam区别

6、@RequestParam，@PathParam，@PathVariable等注解区别

1、handler method 参数绑定常用注解

我们根据他们处理的Request的不同分为四类：

处理request uri 部分（这里指uri template中variable，不含queryString部分）的注解： @PathVariable，@ReqeustParam；
处理request header部分的注解： @RequestHeader, @CookieValue；
处理request body部分的注解：@RequestParam, @RequestBody；
处理attribute类型的注解： @SessionAttributes, @ModelAttribute；

2、常用注解

1、 @PathVariable

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

示例代码：10.25.240.193:8080//owners/Hello/risk

则Hello绑定到ownerId，risk绑定到petId上

@Controller  
@RequestMapping("/owners/{ownerId}")  
public class RelativePathUriTemplateController {  
  
  @RequestMapping("/pets/{petId}")  
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
    // implementation omitted  
  }  
}

上面代码把URI template 中变量 ownerId的值和petId的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable("name")指定uri template中的名称。

2、 @RequestHeader、@CookieValue

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

这是一个Request 的header部分：

Host                    localhost:8080  
Accept                  text/html,application/xhtml+xml,application/xml;q=0.9  
Accept-Language         fr,en-gb;q=0.7,en;q=0.3  
Accept-Encoding         gzip,deflate  
Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7  
Keep-Alive              300

@RequestMapping("/show")  
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,  
                              @RequestHeader("Keep-Alive") long keepAlive)  {  
  //...  
}

上面的代码，把request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。

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

例如有如下Cookie值：

JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84  

@RequestMapping("/displayHeaderInfo.do")  
public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {  
  //...  
}

即把JSESSIONID的值绑定到参数cookie上。

3、@Re Body

@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用来指示参数是否必须绑定；

示例代码：

Get
download?poiId=1&shopName=hello

@RequestMapping(value = "/download", method = RequestMethod.GET)
    public ResponseEntity download(HttpServletRequest request,@RequestParam(value = "poiId") Long poiId, @RequestParam(value = "shopName") String shopName) {
        
}

@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;

示例代码：

 @ResponseBody
 @RequestMapping(value = "/query", method = RequestMethod.POST)
 public Map queryTaskByConditions(@RequestBody TaskVo taskVo) {
      ...
}
封装对象
public class TaskVo {
    /**
     * 当前页码
     */
    @NotNull
    private Integer pageNo;
    /**
     * 每页大小
     */
    @NotNull
    private Integer pageSize;

    /**
     *名称
     */
    private String shopName;

    /**
     * poi
     */
    @Pattern(regexp = "[0-9]*$")
    private String shopId;

    @Pattern(regexp = "[0-9]*$")
    private String taskIdStr;
}
或
 @ResponseBody
 @RequestMapping(value = "/query", method = RequestMethod.POST)
 public Map queryTaskByConditions(@RequestBody Map<String,Object params) {
      ...
}

4、@SessionAttributes, @ModelAttribute

@SessionAttributes:

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

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

@Controller  
@RequestMapping("/editPet.do")  
@SessionAttributes("pet")  
public class EditPetForm {  
    // ...  
}

@ModelAttribute

该注解有两个用法，一个是用于方法上，一个是用于参数上；

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

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

A） @SessionAttributes 启用的attribute 对象上；

B） @ModelAttribute 用于方法上时指定的model对象；

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

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

@ModelAttribute  
public Account addAccount(@RequestParam String number) {  
    return accountManager.findAccount(number);  
}

这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；

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

@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)  
public String processSubmit(@ModelAttribute Pet pet) {  
     
}

首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上