SpringMvc动态获取http参数的注解详解

SpringMVC中@RequestMapping(value="/page/{id}",method=RequestMethod.GET)中的value值可以指定处理请求的url、method可以指定处理请求的方式,SpringMvc可以通过@RequestParam@PathVariable等注解动态获取调用方传来的参数。但SpringMvc获取部分参数的注解是不相同的,下面我们就来看一下SpringMvc获取不同部分参数的注解。

1.接收Request uri部分中参数的注解:@PathVariable;

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

@Controller  
@RequestMapping("/user/{userId}")  
public class RelativePathUriTemplateController {  
  
  @RequestMapping("/books/{bookId}")  
  public void findPet(@PathVariable String userId, @PathVariable String bookId) {      
  }  
}  

上面代码将URI template中变量userId的值和bookId的值,绑定到方法的参数上。若方法的参数名称和需要绑定的template中的变量名称不一致,需要在@PathVariale("userId")指定uri template中的名称。

2.接收request header部分的注解@RequestHeader,@CookieValue;

@RequestHeader注解,可以把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  

Controller中使用@RequestHeader获取header中的参数:

@RequestMapping("/displayHeaderInfo.do")  
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的值绑定到方法的参数上。

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

上面就是将JSESSIONID的值绑定到参数cookie上。

3.接收request body部分的注解:@RequestParam,@RequestBody;
@RequestParam使用场景:
A)常用来处理简单类型的绑定,通过Reqeust.getParameter()获取的String可以直接转化为简单类型的情况;因为使用request.getParameter()方式获取参数,所以可以处理get方式中queryString的值,也可以获取Post方式中body data的值;
B)用来处理Content-Type:为application/x-www-form-urlencoded编码的内容,提交方式GET、POST;
C)该注解有两个属性:value、required;value用来指定要传入值得id名称,required用来指示参数是否必须绑定;

@Controller  
@RequestMapping("/pets")  
@SessionAttributes("pet")  
public class EditPetForm {  
  
  
    @RequestMapping(method = RequestMethod.GET)  
    public String setupForm(@RequestParam("petId") int petId, ModelMap model) {  
        Pet pet = this.clinic.loadPet(petId);  
        model.addAttribute("pet", pet);  
        return "petForm";  
    }  
}

@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里,这种情况特殊需求下使用,详情查看FormHttpMessageConverter api;

@RequestMapping(value = "/something", method = RequestMethod.PUT)  
public void handle(@RequestBody String body, Writer writer) throws IOException {  
 writer.write(body);  
}  

4.接收attribute类型的注解:@SessionAttributes,@ModelAttribute;
@SessionAttributes:
该注解用来绑定HttpSession中的attribute对象的值,便于在方法中的参数中使用。
该注解有value、types两个属性,可以通过名字和类型指定要使用的attribute对象;

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

@ModelAttribute
该注解有两个用法:通常用来处理@RequestMapping之前,为请求绑定需要从后台查询的model;
用于参数上时:用来通过名称对应,将相应名称的值绑定到注解的参数bean上;要绑定的值来源于:
A)@SessionAttribute启用的attribute对象上;
B)@ModelAttribute用于方法上时指定的model对象;
C)上述两种情况都没有时,new一个需要绑定的bean对象,然后将request中按名称对应的方式把值绑定到bean中

@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对象的各属性上。

参考文献:http://blog.csdn.net/walkerjong/article/details/7946109

你可能感兴趣的:(SpringMvc动态获取http参数的注解详解)