SpringMVC标签用法

package com.bbwu.springmvc.handlers;

import java.io.IOException;

import java.io.Writer;

import java.util.Arrays;

import java.util.Date;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Controller;

import org.springframework.web.bind.annotation.CookieValue;

import org.springframework.web.bind.annotation.ModelAttribute;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestHeader;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.bind.annotation.SessionAttributes;

import org.springframework.web.servlet.ModelAndView;

import com.bbwu.springmvc.entities.User;

@SessionAttributes(value={"user"},types={String.class})

@RequestMapping("/springmvc")

@Controller

public class SpringMVCTest {

private static final String SUCCESS = "success";

/**

* 1.有 @ModelAttribute 标记的方法，会在每个目标方法执行之前被 SpringMVC 调用！

* 2.@ModelAttribute 注解也可以来修饰目标方法POJO 类型的入参，其value 属性值有如下的作用：

* 1).SpringMVC 会使用 value 属性值在 implicatModel 中查找对应对的对象，若存在则会直接传入到目标方法的入参中

* 2).SpringMVC 会以 value 为 key, POJO 类型的对象为 value,存入到request 中

*

* @param id

* @param map

*/

@ModelAttribute

public void getUser(@RequestParam(value="id",required=false) Integer id,Map<String,Object> map){

if(id != null){

//模拟从数据库中获取对象

User user = new User(1,"Tom","123456","[e-mail]",12);

System.out.println("从数据库中获取一个对象："+user);

map.put("user", user);

}

}

/**

* 运行流程：

* 1.执行@ModelAttribute 注解修饰的方法: 从数据库中取出对象，把对象放入到了Map 中，键为：user

* 2.SpringMVC 从 Map 中取出User 对象，并把表单的请求参数赋给该User 对象的对应属性

* 3.SpringMVC 把上述对象传入目标方法的参数。

* 

* 注意：在@ModelAttribute 修饰的方法中，放到到Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致.

* 

* 源代码分析：

* 1.首先调用@ModelAttribute 注解修饰的方法。实际上把@ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中。

* 2.解析请求处理器的目标参数，实际上该目标参数来自于 WebDataBinder 对象的 target属性

* 1).创建WebDataBinder 对象：

* a.确定 objectName 属性：若传入的 attrName 属性 为"",则 objectName 为类名第一个字母小写

* 注意:attrName 若目标方法的POJO 属性使用了 @ModelAttribute 来修饰，则attrName 值即为@ModelAttribute 的 value 属性值

* b.确定 target 属性

* 在implicitModel 中查找 attrName 对应的属性值。若存在，OK.

* 若不存在，则验证当前Handler 是否使用了 @SessionAttributes 进行修饰，若使用了，则尝试从 Session中获取 attrName 对应的属性值。

* 若 session 中没有对应的属性值，则抛出了异常

* 若 Handler 没有使用@SessionAttributes进行修饰，或@SessionAttributes 中没有使用value 值指定的key

* 和 attrName 相匹配，则通过返射创建了POJO 对象

* 

* 2).SpringMVC 把表单的请求参数给了WebDataBinder 的target 对应的属性

* 3).SpringMVC 会把WebDataBinder 的attrName 和 target 给到 implicitModel

* 4).把WebDataBinder 的 target 作为参数传给目标方法的入参

* 

* 

* @param user

* @return

*/

@RequestMapping(value={"/testModelAttribute"})

public String testModelAttribute(@ModelAttribute(value="user") User user){

System.out.println("修改：" + user);

return SUCCESS;

}

/**

* @SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外(实际上使用的是 value 属性值)，

* 还可以通过模型属性的对象类型指定哪些模型需要放到会话中(实际上使用的是 types 属性值)

* 

* 注意：该注解只能放在类的上面，而不能修饰放在方法上面

* @param map

* @return

*/

@RequestMapping("/testSessionAttribute")

public String testSessionAttribute(Map<String, Object> map){

User user = new User("Rome", "123", "[e-mail]", 20);

map.put("user", user);

map.put("school", "atguigu");

return SUCCESS;

}

/**

* 目标方法可以添加 Map 类型的参数(这际上也可以是 Model 类型 或 ModelMap 类型)

* @param map

* @return

*/

@RequestMapping(value="/testMap")

public String testMap(Map<String, Object> map){

System.out.println(map.getClass().getName());

map.put("names", Arrays.asList("Tom","Jerry","Mike"));

return SUCCESS;

}

/**

* 目标方法的返回值可以是ModelAndView 类型

* 其中可以包含视图各模型信息, 模型数据存放在request域中

* @return

*/

@RequestMapping("/testModelAndView")

public ModelAndView testModelAndView(){

String viewName = SUCCESS;

ModelAndView modelAndView = new ModelAndView(viewName);

//添加模型数据到 ModelAndView 中

modelAndView.addObject("time", new Date());

return modelAndView;

}

/**

* 可以使用 Servlet 原生的 API 作为目标方法的参数 具体支持以下类型：

* HttpServletReqeust

* HttpServletResponse

* HttpSession

* java.security.Principal

* Locale

* InputStream

* OutputStream

* Reader

* Writer

* @param request

* @param response

* @return

* @throws IOException 

*/

@RequestMapping("/testServletAPI")

public void testServletAPI(HttpServletRequest request,HttpServletResponse response,Writer out) throws IOException{

System.out.println("testServletAPI, " + request + ", "+response);

out.write("hello springmvc ");

//return SUCCESS;

}

/**

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

* 如：user.username、user.age、user.address.city

* @param user

* @return

*/

@RequestMapping("/testPojo")

public String testPojo(User user){

System.out.println("testPojo: "+user);

return SUCCESS;

}

@RequestMapping(value="/testCookieValue")

public String testCookieValue(@CookieValue(value="JSESSIONID") String sessionId){

System.out.println("testCookieValue, JSESSIONID:" + sessionId);

return SUCCESS;

}

/**

* 了解：

* 映射请求头信息

* 用法同@RequestParam

* @param al

* @return

*/

@RequestMapping(value="/testRequestHeader")

public String testRequestHeader(@RequestHeader(value="Accept-Language") String al){

System.out.println("testRequestHeader,Accept-Language:" + al);

return SUCCESS;

}

/**

* @RequestParam 来映射请求参数

* value 值即请求参数的参数名

* required 该参数是否必须。 默认为 true

* defaultValue 请求参数的默认值

* @param un

* @param age

* @return

*/

@RequestMapping(value="testRequestParam")

public String testRequestParam(@RequestParam(value="username") String un,@RequestParam(value="age",required=false,defaultValue="0") int age){

System.out.println("testRequestParam username:" + un+", age:"+age);

return SUCCESS;

}

/**

* 1.@RequestMapping 的 value、method、params 及 headers 分别表示

* 请求URL、请求方法、请求参数 及 请求头 的映射物权法件，他们之间是 与  的关系，

* 联合使用多个条件可让请求映射更加精确化。

* 2.RequestMapping支持 Ant 风格资源地址

* Ant 风格资源地址支持3种匹配符：

*  ?: 匹配文件名中的一个字符

*  *: 匹配文件名中的任意字符

*  **: 匹配多层路径

* 3.Rest 风格的 URL

* 以CRUD 为例：

* 新增： /order POST

* 修改：/order/1 PUT

* 获取：/order/1 GET

* 删除：/order/1 DELETE

* 

* 如何发送 PUT 请求和 DELETE 请求呢？

* 1.需要配置HiddenHttpMethodFilter

* 2.需要发送POST 请求

* 3.需要在发送POST 请求时携带一个 name="_method" 的隐藏域，值为DELETE 或 PUT

* 

* 在SpringMVC 的目标方法中如何午到id 呢?

* 使用@PathVariable 注解

*/

@RequestMapping(value="/testRest/{id}",method=RequestMethod.GET)

public String testRestGet(@PathVariable("id") Integer id){

System.out.println("TestRest Get:"+id);

return SUCCESS;

}

@RequestMapping(value="/testRest",method=RequestMethod.POST)

public String testRestPost(){

System.out.println("TestRest POST");

return SUCCESS;

}

@RequestMapping(value="/testRest/{id}",method=RequestMethod.DELETE)

public String testRestDelete(@PathVariable("id") Integer id){

System.out.println("TestRest DELETE:"+id);

return SUCCESS;

}

@RequestMapping(value="/testRest/{id}",method=RequestMethod.PUT)

public String testRestPut(@PathVariable("id") Integer id){

System.out.println("TestRest PUT:"+id);

return SUCCESS;

}

/**

* @PathVariable 可以来映射 URL 中的占位符到目标方法的参数中

* @param id

* @return

*/

@RequestMapping("/testPathVariable/{id}")

public String testPathVariable(@PathVariable("id") Integer id){

System.out.println("testPathVariable:" + id);

return SUCCESS;

}

@RequestMapping(value="/testAntPath/*/abc")

public String testAntPath(){

System.out.println("testAntPath");

return SUCCESS;

}

/**

* 了解： 可以使用params 和 headers 来更加精确的映射请求。 params 和 headers 支持简单的表达式

* @return

*/

@RequestMapping(value="/testParamsAndHeaders",params={"username","age!=10"})

public String testParamsAndHeaders(){

System.out.println("testParamsAndHeaders");

return SUCCESS;

}

/**

* 使用 method 属性来指定请求方式

* @return

*/

@RequestMapping(value="/testMethod",method=RequestMethod.POST)

public String testMethod(){

System.out.println("testMethod");

return SUCCESS;

}

/**

* 1.@RequestMapping 除了修改方法，还可来修饰类

* 2.使用位置：

* 1).类定义处：提供初步的请求映射信息。相对于WEB 应用的根目录

* 2).方法处：提供进一步的细分映射信息。相对于类定义处的URL。

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

* @return

*/

@RequestMapping("/testRequestMapping")

public String testRequestMapping(){

System.out.println("testRequestMapping");

return SUCCESS;

}

}