SpringMVC注解详解

1.映射请求注解:@RequestMapping

       标记在类上：提供初步的请求映射信息。相对于WEB 应用的根目录

       标记在方法上：提供进一步的细分映射信息。相对于标记在类上的 URL。

       若类上未标注 @RequestMapping，则方法处标记的 URL 相对于 WEB 应用的根目录

       作用：DispatcherServlet 截获请求后，就通过控制器上 @RequestMapping 提供的映射信息确定请求所对应的处理方法。 

(1) RequestMapping映射请求方式：

     value：指定请求的实际地址，指定的地址可以是URI Template 模式（后面将会说明）；

     method：指定请求的method类型， GET、POST、PUT、DELETE等；

@Controller
@RequestMapping("/springmvc")
public class SpringMVCController {
   @RequestMapping(value="/testMethord",method=RequestMethod.POST)
   public String testMethord(){
       System.out.println("testMethord...");
       return "success";
   }
}

说明：默认后面是get请求，如果为post请求，必须在请求页面的method后面加post方式请求;

          如果是get请求，默认在method方法体后面和请求体后面的method后面都不用写。

          注意：post请求不能以超链接形式提交，只能以表单的形式提交，而get请求可以既可以以表单的形式提交，也可以以post的形式提交。

get方式请求:
<a href="springmvc/testMethord">testMethord</a><br/><br/>
post 方式请求：
<form action="springmvc/testMethord" method="post">
     <input type="submit" value="submit">
</form>

(2) RequestMapping映射请求参数和请求头:

     params： 指定request中必须包含某些参数值是，才让该方法处理。

     headers： 指定request中必须包含某些指定的header值，才能让该方法处理请求。

/*
可以使用 params 和 headers 来更加精确的映射请求. params 和 headers 支持简单的表达式.
*/
@RequestMapping(value="/testParamsAndHeaders",
    params={params={"username","age!=10"},
    headers = { "Accept-Language=en-US,zh;q=0.8" })
  public String testParamsAndHeaders(){
    System.out.println("testParamsAndHeaders...");
    return "success";
  }

<!--设置请求参数和请求头信息 -->
<a href="springmvc/testParamsAndHeaders">testParamsAndHeaders</a>

(3) consumes，produces；

     consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;

//方法仅处理request Content-Type为“application/json”类型的请求。
@Controller 
@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json") 
public void addPet(@RequestBody Pet pet, Model model) {     
    // implementation omitted 
} 

     produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；

//方法仅处理request请求中Accept头中包含了"application/json"的请求，同时暗示了返回的内容类型为application/json;
@Controller 
@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json") 
@ResponseBody 
public Pet getPet(@PathVariable String petId, Model model) {     
    // implementation omitted 
}

(4) RequestMapping映射请求占位符PathVariable注解:

     通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：

①定义控制器方法
/*
 @PathVariable 注解可以将请求URL路径中的请求参数，传递到处理请求方法的入参中
*/
@RequestMapping(value="/testPathVariable/{id}")
public String testPathVariable(@PathVariable("id") Integer id){
   System.out.println("testPathVariable...id="+id);
   return "success";
}

②请求链接
<!-- 测试 @PathVariable -->
<a href="springmvc/testPathVariable/1">testPathVariable</a><br/><br/>

2.请求数据传入注解：

(1) @RequestParam注解 : 在处理方法入参处使用 @RequestParam 可以把请求参数传递给请求方法。

     value：参数名

     required：是否必须。默认为 true, 表示请求参数中必须包含对应的参数，若不存在，将抛出异常

     defaultValue: 默认值，当没有传递参数时使用该值

     ①增加控制器方法

@RequestMapping(value="/testRequestParam")
public String RequestParam(
      @RequestParam(value="username") String username,
      @RequestParam(value="age",required=false,defaultValue="0") Integer age
      ){
  System.out.println("username="+username+"----"+"age="+age);
return "success";
}

     ②增加页面链接

<a href="springmvc/testRequestParam?username=tom&age=10">testRequestParam</a>

(2) @RequestHeader:映射请求头信息

     ①增加控制器方法

@RequestMapping(value="/testRequestHeader")
public String testRequestHeader(@RequestHeader(value="Accept-Language") String abc){
     System.out.println("testRequestHeader - Accept-Language："+abc);
     return "success";
}

     ②增加页面链接

<a href="springmvc/testRequestHeader">testRequestHeader</a>

(3) @CookieValue: 映射一个 Cookie值

     ① 增加控制器方法

@RequestMapping("/testCookieValue")
public String testCookieValue(@CookieValue("JSESSIONID") String sessionId) {
     System.out.println("testCookieValue: sessionId: " + sessionId);
     return "success";
}

     ② 增加页面链接

<a href="springmvc/testCookieValue">testCookieValue</a>

(4) 使用pojo作为参数：使用 POJO 对象绑定请求参数值

　　Spring MVC 会按请求参数名和 POJO 属性名进行自动匹配，自动为该对象填充属性值。支持级联属性。

     ① 填加控制器方法、表单页面

@RequestMapping("/testPOJO")
public void testPOJO(User user){
  System.out.println(user);
  return "success";
}

     ② 增加页面链接

<!-- 测试pojo对象传参，支持级联属性 -->
<form action="springmvc/testPOJO" method="post">
     username：<input type="text" name="username"/><br>
     password:<input type="password" name="password"><br>
     email:<input type="text" name="email"/><br>
     age:<input type="text" name="age"/><br>
     city:<input type="text" name="address.city"/><br>
     province:<input type="text" name="address.province"/>
     <input type="submit" value="提交"/>
</form>

     ③ 如果有中文乱码，在web.xml中需要配置字符编码过滤器，且配置其他过滤器之前，否则不起作用。

<!--  配置字符集,解决中文乱码问题 -->
        <filter>
               <filter-name> encodingFilter</filter-name >
               <filter-class> org.springframework.web.filter.CharacterEncodingFilter </filter-class>
               <init-param>
                      <param-name> encoding</param-name >
                      <param-value> UTF-8</param-value >
               </init-param>
               <init-param>
                      <param-name> forceEncoding</param-name >
                      <param-value> true</param-value >
               </init-param>
        </filter>
        <filter-mapping>
               <filter-name> encodingFilter</filter-name >
               <url-pattern> /*</url-pattern >
        </filter-mapping>

3.响应数据传出

SpringMVC中提供了以下几种途径输出模型数据：

     ① ModelAndView: 处理方法返回值类型为 ModelAndView 时, 方法体即可通过该对象添加模型数据.

     ② Map 及 Model: 入参为 org.springframework.ui.Model、org.springframework.ui.ModelMap 或 java.uti.Map 时，处理方法返回时，Map 中的数据会自动添加到模型中。

     ③ @SessionAttributes: 将模型中的某个属性暂存到 HttpSession 中，以便多个请求之间可以共享这个属性。

     ④ @ModelAttribute: 方法入参标注该注解后, 入参的对象就会放到数据模型中

(1) 处理模型数据之 ModelAndView:

     ① 控制器处理方法的返回值如果为 ModelAndView, 则其既包含视图信息，也包含模型数据信息。

     ② 添加模型数据:

MoelAndView addObject(String attributeName, Object attributeValue)

ModelAndView addAllObject(Map<String, ?> modelMap)

     ③设置视图:

void setView(View view)

void setViewName(String viewName)

     ④ 实验代码

     a.增加控制器方法

// 目标方法的返回类型可以是ModelAndView类型,其中包含视图信息和模型数据信息.
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
     System.out.println("testModelAndView");
     String viewName = "success";
     ModelAndView mv = new ModelAndView(viewName );
     mv.addObject("time",new Date().toString()); //实质上存放到request域中
     return mv;
}

      b.增加页面链接

<!--测试 ModelAndView 作为处理返回结果 -->
<a href="springmvc/testModelAndView">testModelAndView</a>

      c.增加成功页面，显示数据

time: ${requestScope.time }

(2) 处理模型数据Map(方法的入参可以是Map，Model，ModelMap但是我们一般使用Map ):

①增加控制器方法

// 目标方法的返回类型也可以是一个Map类型参数
@RequestMapping("testMap")
public String testMap(Map<String,Object> map){
    System.out.println(map.getClass().getName());
    //org.springframework.validation.support.BindingAwareModelMap
    map.put("names", Arrays.asList("Tom","Jerry","Kite"));
    return "success";
}

②增加页面链接

<!-- 测试 Map 作为处理返回结果 -->
<a href="springmvc/testMap">testMap</a>

③增加成功页面，显示结果

names: ${requestScope.names }

     注意：Map集合的泛型，key为String,Value为Object。

(3)  处理模型数据之 SessionAttributes 注解：

   (1) 若希望在多个请求之间共用某个模型属性数据，则可以在控制器类上标注一个 @SessionAttributes, Spring MVC 将在模型中对应的属性暂存到 HttpSession 中。
    @SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外，还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中
例如：
    ① @SessionAttributes(types=User.class) 会将隐含模型中所有类型为 User.class 的属性添加到会话中。
    ② @SessionAttributes(value={“user1”, “user2”})
    ③ @SessionAttributes(types={User.class, Dept.class})

    ④ @SessionAttributes(value={“user1”, “user2”}, types={Dept.class}) 

   (2).实验代码：

@Controller
//@SessionAttributes("user")
@SessionAttributes(value={"user"},types={String.class})
public class SpringMVCController {
    /**
    * @SessionAttributes
    *  除了可以通过属性名指定需要放到会话中的属性外(实际上是通过value指定key值)，
    *  还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中(实际上是通过types指定类型)
    * 注意：只能放在类的上面，不能修饰方法
    */
    @RequestMapping("/testSessionAttributes")
    public String testSessionAttributes(Map<String,Object> map){
    User user = new User(null,"Tom","123","tom@163.com",22);
    map.put("user", user);
    map.put("school", "清华大学");
    //默认是被存放到request 域，如果设置了@SessionAttribute注解，就同时存放到session域中
    return "success";
    }
}

<!--测试 @SessionAttribute 将数据存放到session域中 -->
<a href="testSessionAttributes">testSessionAttributes</a>
request user : ${requestScope.user } <br><br>
session user : ${sessionScope.user } <br><br>
request school : ${requestScope.school } <br><br>
session school : ${sessionScope.school } <br><br>

(4) @ModelAttribute注解:

     ①   @ModelAttribute注解

     ② @ModelAttribute注解之示例代码

     在方法定义上使用 @ModelAttribute 注解：Spring MVC 在调用目标处理方法前，会先逐个调用在方法级上标注@ModelAttribute 的方法。

     在方法的入参前使用 @ModelAttribute 注解：可以从隐含对象中获取隐含的模型数据中获取对象，再将请求参数绑定到对象中，再传入入参,将方法入参对象添加到模型中.

     a.页面表单

<!--测试 @ModelAttribute 类似Struts2框架的模型驱动 -->
<!--
    模拟修改操作：
    1.原始数据为：1,Tom,123456,tom@atguigu.com,12
    2.密码不需要修改
    3.表单回显，模拟操作直接在表单value属性上赋值
-->
<form action="springmvc/testModelAttribute" method="POST">
    <input type="hidden" name="id" value="1"><br>
    username: <input type="text" name="username" value="Tom"/>
    email: <input type="text" name="email" value="tom@163.com"/>
    age: <input type="text" name="age" value="12"/>
    <input type="submit" value="Submit"/>
</form>

     b.增加@ModelAttribute注解

// 由 @ModelAttribute 标记的方法(getUser), 会在每个目标方法(testModelAttribute)执行之前被 SpringMVC 调用!
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user){
    System.out.println("user="+user);
    return "success";
}

@ModelAttribute
public void getUser(@RequestParam(value="id",required=false) Integer id,Map<String,Object> map){
    if(id!=null){
    //模拟从数据库中获取到的user对象
    User user = new User(1,"Tom","123456","tom@atguigu.com",12);
    System.out.println("从数据库中查询的对象：user="+user );
    map.put("user", user);
    }
}

     ③ @ModelAttribute注解之运行原理

     a.执行@ModelAttribute注解所修饰的方法，将从数据库中获取的对象存放到Map集合中，key为user
     b.SpringMVC从Map集合中获取 user对象，将表单数据封装到与参数名称对应的user对象属性上
     c.SpringMVC将user对象作为参数，传递给目标方法。

     d.注意：@ModelAttribute 注解修饰的方法中，放入到Map集合中的key值，应该和目标方法参数类型的类名称首字母小写一致。