查看“SpringMVC：注解开发”的源代码

[[category:SpringMVC]]

== @RequestMapping 使用==
在SpringMVC中，[[RequestDispatcher]]（在Front Controller之下）这个servlet负责将进入的HTTP请求路由到控制器的处理方法，并通过RequestMapping注解指定请求与处理方法之间的映射关系。<br/>
@RequestMapping注解可以在Controller类及类中方法的级别上使用。

=== URL路径映射 ===
<syntaxhighlight lang="java" inline>@RequestMapping(value="/item")</syntaxhighlight>或<syntaxhighlight lang="java" inline>@RequestMapping("/item")</syntaxhighlight>
value的值是数组，可以将多个url映射到同一个方法，如：
<syntaxhighlight lang="java">
@RestController
@RequestMapping("/home ")
public class IndexController {

    @RequestMapping(value = {
        " ",
        "/page ",
        "page* ",
        "view/*,**/msg "
    })
    String indexMultipleMapping() {
        return "Hello from index multiple mapping. ";
    }
}
</syntaxhighlight>
如下的这些 URL 都会由 indexMultipleMapping() 来处理：
* localhost:8080/home
* localhost:8080/home/
* localhost:8080/home/page
* localhost:8080/home/pageabc
* localhost:8080/home/view/
* localhost:8080/home/view/view

=== 窄化请求映射 ===
在class上添加@RequestMapping(url)指定通用请求前缀， 限制此类下的所有方法请求url必须以请求前缀开头，通过此方法对url进行分类管理。<br/>
<syntaxhighlight lang="java">
@Controller
@RequestMapping("/items")
public class ItemsController {

	@Autowired
	private ItemsService itemsService;

	// 商品查询
	@RequestMapping("/queryItems")
	public ModelAndView queryItems(HttpServletRequest request) throws Exception {

		List<ItemsCustom> itemsList = itemsService.findItemsList(null);
		
		ModelAndView modelAndView = new ModelAndView();
		modelAndView.addObject("itemsList", itemsList);
		modelAndView.setViewName("items/itemsList");

		return modelAndView;
	}
...
}
</syntaxhighlight>
商品列表请求路径为：“/items/queryItems.action”。

=== 限定请求方法 ===
出于安全性考虑，对http的链接进行方法限制。<br/>
* HTTP 请求的方法：<syntaxhighlight lang="java" inline>RequestMethod.GET</syntaxhighlight>、<syntaxhighlight lang="java" inline>RequestMethod.POST</syntaxhighlight>、<syntaxhighlight lang="java" inline>RequestMethod.DELETE</syntaxhighlight>、<syntaxhighlight lang="java" inline>RequestMethod.PUT</syntaxhighlight>、<syntaxhighlight lang="java" inline>RequestMethod.PATCH</syntaxhighlight>

<syntaxhighlight lang="java">
//商品信息修改页面显示
@RequestMapping(value="/editItems",method={RequestMethod.POST,RequestMethod.GET})
public ModelAndView editItems()throws Exception {
	
	ItemsCustom itemsCustom = itemsService.findItemsById(1);
	
	ModelAndView modelAndView = new ModelAndView();
	modelAndView.addObject("itemsCustom", itemsCustom);
	modelAndView.setViewName("items/editItems");
	
	return modelAndView;
}
</syntaxhighlight>
如果限制请求为post方法（method={RequestMethod.GET}），进行get请求，报错：
[[File:RequestMapping请求限定.png|400px]]

=== 带有@RequestParam的RequestMapping ===
@RequestParam注解配合@RequestMapping一起使用，可以将请求的参数同处理方法的参数绑定在一起。<br/>
@RequestParam 的使用：
# 通过在@RequestParam里边指定request传入参数名称和形参进行绑定；
#: <syntaxhighlight lang="java" inline>@RequestParam Integer items_id</syntaxhighlight>：传入参数、形参均为items_id；
#: <syntaxhighlight lang="java" inline>@RequestParam(value="id") Integer items_id</syntaxhighlight>：传入参数为id，形参为items_id；
# 通过required属性指定参数是否必须要传入；
#: <syntaxhighlight lang="java" inline>@RequestParam(value="id",required=true) Integer items_id</syntaxhighlight>
# 通过defaultValue可以设置默认值，如果形参没有传入，将默认值和形参绑定；
#: <syntaxhighlight lang="java" inline>@RequestParam(value="id",required=true,defaultValue="10001") Integer items_id</syntaxhighlight>
<syntaxhighlight lang="java">
//商品信息修改页面显示
@RequestMapping(value="/editItems",method={RequestMethod.POST,RequestMethod.GET})
public String editItems(Model model,@RequestParam(value="id",required=true) Integer items_id)throws Exception {
	
	ItemsCustom itemsCustom = itemsService.findItemsById(items_id);
	
	//通过形参中的model将model数据传到页面
	//相当于modelAndView.addObject方法
	model.addAttribute("itemsCustom", itemsCustom);
	
	return "items/editItems";
}
</syntaxhighlight>

=== 处理生产和消费对象 ===
可以使用@RequestMapping注解的<syntaxhighlight lang="java" inline>produces</syntaxhighlight>和<syntaxhighlight lang="java" inline>consumes</syntaxhighlight>这两个元素来缩小请求映射类型的范围。
# 用@RequestMapping的<syntaxhighlight lang="java" inline>produces</syntaxhighlight>元素结合<syntaxhighlight lang="java" inline>@ResponseBody</syntaxhighlight>注解，来用请求的媒体类型产生对象；
# 用@RequestMapping的<syntaxhighlight lang="java" inline>comsumes</syntaxhighlight>元素结合<syntaxhighlight lang="java" inline>@RequestBody</syntaxhighlight>注解，来用请求的媒体类型消费对象；
如：
<syntaxhighlight lang="java">
@RestController
@RequestMapping("/home ")
public class IndexController {
    @RequestMapping(value = "/prod ", produces = {"application/JSON "})
    @ResponseBody
    String getProduces() {
        return "Produces attribute ";
    }

    @RequestMapping(value = "/cons ", consumes = {"application/JSON ","application/XML "})
    @RequestBody
    String getConsumes() {
        return "Consumes attribute ";
    }
}
</syntaxhighlight>
在这段代码中，getProduces()处理方法会产生一个JSON响应，getConsumes()处理方法可以同时处理请求中的JSON和XML内容。

=== 处理消息头 ===
@RequestMapping注解提供了<syntaxhighlight lang="java" inline>header</syntaxhighlight>元素来根据请求中的消息头内容缩小请求映射的范围。
指定消息头，如：
<syntaxhighlight lang="java">
@RestController
@RequestMapping("/home ")
public class IndexController {
    @RequestMapping(value = "/head ", headers = {"content-type=text/plain"})
    String post() {
        return "Mapping applied along with headers ";
    }
}
</syntaxhighlight>
如上代码段， @RequestMapping注解的headers属性将映射范围缩小到了post()方法，使post()只会处理url为“/home/head”并且content-type为“text/plain”的请求。<br/>
指定多个消息头，如：
<syntaxhighlight lang="java">
@RestController
@RequestMapping("/home ")
public class IndexController {
    @RequestMapping(value = "/head ", headers = {
        "content-type=text/plain ",
        "content-type=text/html "
    }) String post() {
        return "Mapping applied along with headers ";
    }
}
</syntaxhighlight>
如上代码段， post()会处理url为“/home/head”，并且content-type为“text/plain”和“text/html”的请求。<br/>

=== 处理请求参数 ===
@RequestMapping 直接的<syntaxhighlight lang="java" inline>params</syntaxhighlight>元素可以进一步帮助我们缩小请求映射的定位范围。使用<syntaxhighlight lang="java" inline>params</syntaxhighlight>元素，可以让多个处理方法处理params不一样的同一个URL请求。<br/>
如：
<syntaxhighlight lang="java">
@RestController
@RequestMapping("/home ")
public class IndexController {
    @RequestMapping(value = "/fetch", params = {"id=10"})
    String getParams(@RequestParam("personId") String id) {
        return "Fetched parameter using params attribute =  " + id;
    }
    @RequestMapping(value = "/fetch", params = {"personId=20"})
    String getParamsDiff(@RequestParam("personId") String id) {
        return "Fetched parameter using params attribute =  " + id;
    }
    @RequestMapping(value = "/fetch", params = {"username","age!=10"})
    public String getParamsDifferent() {
        System.out.println("testParamsAndHeaders");
        return SUCCESS;
    }
}
</syntaxhighlight>
如上代码段，getParams() 和 getParamsDifferent() 两个方法都能处理相同的一个 URL (“/home/fetch”) ，但是会根据 params 元素的配置不同而决定具体来执行哪一个方法：
# URL 为“/home/fetch?id=10”时，getParams() 会执行；
# URL 为“/home/fetch?personId=20”时，getParamsDiff() 会执行；
# URL 包含时“username”和“age”，且“age”不等于“10”时（如“/home/fetch?username=ejiux&age=26”），getParamsDifferent() 会执行；

=== 处理动态URI ===
@RequestMapping 注解可以同<syntaxhighlight lang="java" inline>@PathVaraible</syntaxhighlight>注解一起使用，用来处理动态的 URI，URI 的值可以作为控制器中处理方法的参数。<br/>
* 可以使用正则表达式，以只处理匹配到的动态URI。
* @PathVariable 同 @RequestParam的运行方式不同。使用 @PathVariable 是为了从 URI 里取到查询参数值，而使用 @RequestParam 是为了从 URI 模板中获取参数值。
<syntaxhighlight lang="java">
@RestController
@RequestMapping("/home ")
public class IndexController {
    @RequestMapping(value = "/fetch/{id} ", method = RequestMethod.GET)
    String getDynamicUriValue(@PathVariable String id) {
        System.out.println("ID is  " + id);
        return "Dynamic URI parameter fetched ";
    }
    @RequestMapping(value = "/fetch/{id:[a-z]+}/{name} ", method = RequestMethod.GET)
    String getDynamicUriValueRegex(@PathVariable("name") String name) {
        System.out.println("Name is  " + name);
        return "Dynamic URI parameter fetched using regex ";
    }
}
</syntaxhighlight>
如上代码段：
# 方法 getDynamicUriValue() 会在“localhost:8080/home/fetch/10”的请求时执行；
# 方法 getDynamicUriValueRegex() 会在“localhost:8080/home/fetch/category/shirt”的请求时执行；
# 如果请求是“/home/fetch/10/shirt”，则会抛出异常，因为这个URI并不能匹配正则表达式；

=== 默认的处理方法 ===

=== 快捷方式 ===

== Handler方法返回值 ==
=== ModelAndView ===
=== void ===
=== 字符串 ===
==== 逻辑视图名 ====
==== Redirect重定向 ====
==== forward转发 ====

== 参数绑定 ==
=== 默认支持的参数类型 ===
=== 简单类型 ===
=== pojo ===
=== 集合 ===
=== 自定义参数绑定 ===

== 示例代码 ==
=== 需求 ===
=== dao ===
=== service ===
=== controller ===
=== 页面 ===