@RequestMapping是一个用来处理请求地址映射的注解,可用于类或者方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。
@RequestMapping注解有六个属性,下面进行详细的说明。
value:指定请求的实际地址,指定的地址可以是URI Template模式。
value的uri值为以下三类:
A) 可以指定为普通的具体值;
B) 可以指定为含有某变量的一类值;
C) 可以指定为含正则表达式的一类值;
method:指定请求的method类型,GET、POST、PUT、DELETE等。
consumes:指定处理请求的提交内容类型(Content-Type),例如application/json
produces:指定返回的内容类型
params:指定request中必须包含某些参数值才让该方法处理。
headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。
根据他们处理的request的不同内容部分分为四类:
A:处理request uri部分的注解:@PathVariable;
B:处理request header部分的注解:@RequestHeader, @CookieValue;
C:处理request body部分的注解:@RequestParam, @RequestBody;
D:处理attribute类型的注解:@SessionAttributes, @ModelAttribute、@SessionAttribute;
1.@PathVariable
当使用@RequestMapping URI template样式映射时,即someUrl/{paramId},这时的paramId可通过@PathVariable注解绑定它传过来的值到方法的参数上。
2.@RequestHeader、@CookieValue
@RequestHeader注解可以把Request请求header部分的值绑定到方法的参数上。
@CookieValue可以把Request header中关于cookie的值绑定到方法的参数上。
3.@RequestParam
A)常用来处理简单类型的绑定,通过Request.getParameter() 获取的String可直接转换为简单类型的情况( String> 简单类型的转换操作由ConversionService配置的转换器来完成);因为使用request.getParameter()方式获取参数,所以可以处理get 方式中queryString的值,也可以处理post方式中 body data的值;
B)用来处理ContentType: 为 application/x-www-form-urlencoded编码的内容,提交方式GET、POST;
C) 该注解有两个属性: value、required; value用来指定要传入值的id名称,required用来指示参数是否必须绑定;
4.@RequestBody
该注解常用来处理ContentType: 不是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;
5.@SessionAttributes
默认情况下Spring MVC将模型中的数据存储到request域中。当一个请求结束后,数据就失效了。如果要跨页面使用。那么需要使用到session。而@SessionAttributes注解就可以使得模型中的数据存储一份到session域中。
@Controller @SessionAttributes("user") public class ModelController { @ModelAttribute("user") public User initUser(){ User user = new User(); user.setName("default"); return user; } }
6.@SessionAttribute是用于获取已经存储的session数据,并且作用在方法的层面上。
@RequestMapping("/session") public String session( @SessionAttribute("user") User user ){ // do something return "index"; }
7.@ModelAttribute
①:方法返回值为void,@ModelAttribute注解没有指定任何属性,这样的话需要将Model或者map传入方法中,如下:
key为user1,value为User对象,可以用 ${requestScope.user1.userName} 取出
@ModelAttribute //@ModelAttribute 没有指定值,且被修饰的方法返回值为void,则需要借助map或者model将数据模型放入request域 public void getUser(Map<String, Object> map) { System.out.println("ModelAttribute1.."); map.put("user1", new User("kelin","123aaa")); }
②:方法返回值为普通的pojo,@ModelAttribute注解没有指定任何属性,这样的话,request域中存入的对象名字默认为类型首字母小写,如下:
key为user(类型首字母小写),value为User对象,可以用 ${requestScope.user.userName} 取出
@ModelAttribute //@ModelAttribute 没有指定值,且被修饰方法有pojo类型的返回值,则request域中 key为返回值类型第一个字母小写的字符串,value为返回值 public User getUser() { System.out.println("ModelAttribute2.."); return new User("kelin","123aaa"); }
③:方法返回值为普通的pojo,@ModelAttribute注解指定了value属性,这样的话,request域中就放入了一个对象,如下:
key为user2,value为User对象,可以用 ${requestScope.user2.userName} 取出
@ModelAttribute("user2") //@ModelAttribute 的值就是request域中的key,被该注解修饰的方法的返回值为对应的value public User getUser() { System.out.println("ModelAttribute3.."); return new User("kelin","123aaa"); }
④:两个注解同时修饰方法,看注释解释,有点不一样,返回的东西不是视图,而是request域中的值,返回的视图变成了 @RequestMapping中指定的value
/* * @ModelAttribute 和 @RequestMapping 同时修饰一个方法 * * @ModelAttribute 中value为 request域中的key,被修饰的方法返回值为request域中的value * @RequestMapping 中value为 返回的视图名,此例中相当于定向到xxx/testModelAttribute4.jsp */ @ModelAttribute(value="user") @RequestMapping(value="/testModelAttribute4..") public User testModelAttribute() { return new User("kelin","123aaa"); }
⑤:@ModelAttribute 修饰方法参数(最常用),参数直接封装到对象中,比如常用的 pageNo,pageSize...
/* * @ModelAttribute用于修饰入参,前台传过来的值自动赋予入参对于的属性 */ @RequestMapping("/testModelAttribute5") public String testModelAttribute(@ModelAttribute User user) { return "modelAttribute"; }