SpringMVC：注解开发

@RequestMapping 使用

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

@RestController=@Controller+@ResponseBody

URL路径映射

@RequestMapping(value="/item")或@RequestMapping("/item") value的值是数组，可以将多个url映射到同一个方法，如：

@RestController
@RequestMapping("/home ")
public class IndexController {

    @RequestMapping(value = {
        " ",
        "/page ",
        "page* ",
        "view/*,**/msg "
    })
    String indexMultipleMapping() {
        return "Hello from index multiple mapping. ";
    }
}

如下的这些 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进行分类管理。

@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;
	}
...
}

商品列表请求路径为：“/items/queryItems.action”。

限定请求方法

出于安全性考虑，对http的链接进行方法限制。

HTTP 请求的方法：RequestMethod.GET、RequestMethod.POST、RequestMethod.DELETE、RequestMethod.PUT、RequestMethod.PATCH

//商品信息修改页面显示
@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;
}

如果限制请求为post方法（method={RequestMethod.GET}），进行get请求，报错：

带有@RequestParam的RequestMapping

@RequestParam注解配合@RequestMapping一起使用，可以将请求的参数同处理方法的参数绑定在一起。
@RequestParam 的使用：

通过在@RequestParam里边指定request传入参数名称和形参进行绑定；
@RequestParam Integer items_id：传入参数、形参均为items_id；

@RequestParam(value="id") Integer items_id：传入参数为id，形参为items_id；
通过required属性指定参数是否必须要传入；
@RequestParam(value="id",required=true) Integer items_id
通过defaultValue可以设置默认值，如果形参没有传入，将默认值和形参绑定；
@RequestParam(value="id",required=true,defaultValue="10001") Integer items_id

//商品信息修改页面显示
@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";
}

处理生产和消费对象

可以使用@RequestMapping注解的produces和consumes这两个元素来缩小请求映射类型的范围。

用@RequestMapping的produces元素结合@ResponseBody注解，来请求的媒体类型产生对象；
用@RequestMapping的comsumes元素结合@RequestBody注解，来请求的媒体类型消费对象；

如：

@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 ";
    }
}

在这段代码中，getProduces()处理方法会产生一个JSON响应，getConsumes()处理方法可以同时处理请求中的JSON和XML内容。

处理消息头

@RequestMapping注解提供了header元素来根据请求中的消息头内容缩小请求映射的范围。指定消息头，如：

@RestController
@RequestMapping("/home ")
public class IndexController {
    @RequestMapping(value = "/head ", headers = {"content-type=text/plain"})
    String post() {
        return "Mapping applied along with headers ";
    }
}

如上代码段， @RequestMapping注解的headers属性将映射范围缩小到了post()方法，使post()只会处理url为“/home/head”并且content-type为“text/plain”的请求。
指定多个消息头，如：

@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 ";
    }
}

如上代码段， post()会处理url为“/home/head”，并且content-type为“text/plain”和“text/html”的请求。

处理请求参数

@RequestMapping 直接的params元素可以进一步帮助我们缩小请求映射的定位范围。使用params元素，可以让多个处理方法处理params不一样的同一个URL请求。
如：

@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;
    }
}

如上代码段，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 注解可以同@PathVaraible注解一起使用，用来处理动态的 URI，URI 的值可以作为控制器中处理方法的参数。

可以使用正则表达式，以只处理匹配到的动态URI。
@PathVariable 同 @RequestParam的运行方式不同。使用 @PathVariable 是为了从 URI 里取到查询参数值，而使用 @RequestParam 是为了从 URI 模板中获取参数值。

@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 ";
    }
}

如上代码段：

方法 getDynamicUriValue() 会在“localhost:8080/home/fetch/10”的请求时执行；
方法 getDynamicUriValueRegex() 会在“localhost:8080/home/fetch/category/shirt”的请求时执行；
如果请求是“/home/fetch/10/shirt”，则会抛出异常，因为这个URI并不能匹配正则表达式；

默认的处理方法

在Controller中可以有一个默认的处理方法，它在发起请求默认 URI 时被执行。
如：

@RestController
@RequestMapping("/home")
public class IndexController {
    @RequestMapping()
    String
    default () {
        return "This is a default method for the class ";
    }
}

如上代码段，发起请求“/home”将会由 default() 来处理，因为方法的 @RequestMapping 注解并没有指定任何值。

快捷方式（组合注解）

Spring 4.3 引入了方法级注解的变体，也被叫做 @RequestMapping 的组合注解，组合注解可以更好的表达被注解方法的语义。它们所扮演的角色就是针对 @RequestMapping 的封装，而且成了定义端点的标准方法。
方法级别的注解变体，如：

GetMapping ：相当于 @RequestMapping(method =RequestMethod.GET) 的一个快捷方式；
PostMapping ：...;
PutMapping ：...;
DeleteMapping ：...;
PatchMapping ：...;

每个变体都可以使用带有方法属性的 @RequestMapping 注解来互换实现。

组合注解的使用如下：

@RestController
@RequestMapping("/home")
public class IndexController {
    @GetMapping("/person")
    public @ResponseBody ResponseEntity < String > getPerson() {
        return new ResponseEntity < String > ("Response from GET", HttpStatus.OK);
    }
    @GetMapping("/person/{id}")
    public @ResponseBody ResponseEntity < String > getPersonById(@PathVariable String id) {
        return new ResponseEntity < String > ("Response from GET with id " + id, HttpStatus.OK);
    }
    @PostMapping("/person")
    public @ResponseBody ResponseEntity < String > postPerson() {
        return new ResponseEntity < String > ("Response from POST method", HttpStatus.OK);
    }
    @PutMapping("/person")
    public @ResponseBody ResponseEntity < String > putPerson() {
        return new ResponseEntity < String > ("Response from PUT method", HttpStatus.OK);
    }
    @DeleteMapping("/person")
    public @ResponseBody ResponseEntity < String > deletePerson() {
        return new ResponseEntity < String > ("Response from DELETE method", HttpStatus.OK);
    }
    @PatchMapping("/person")
    public @ResponseBody ResponseEntity < String > patchPerson() {
        return new ResponseEntity < String > ("Response from PATCH method", HttpStatus.OK);
    }
}

Handler方法返回值

ModelAndView

controller方法中定义ModelAndView对象并返回，对象中可添加model数据、指定view。

@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;

}

itemsList页面代码如：

<%@ page language="java" contentType="text/html; charset=UTF-8"
	pageEncoding="UTF-8"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>查询商品列表</title>
</head>
<body>
	<form
		action="${pageContext.request.contextPath }/items/queryItems.action"
		method="post">
		查询条件：
		<table width="100%" border=1>
			<tr>
				<td><input type="submit" value="查询" /></td>
			</tr>
		</table>
		商品列表：
		<table width="100%" border=1>
			<tr>
				<td>商品名称</td>
				<td>商品价格</td>
				<td>生产日期</td>
				<td>商品描述</td>
				<td>操作</td>
			</tr>
			<c:forEach items="${itemsList }" var="item">
				<tr>
					<td>${item.name }</td>
					<td>${item.price }</td>
					<td><fmt:formatDate value="${item.createtime}"
							pattern="yyyy-MM-dd HH:mm:ss" /></td>
					<td>${item.detail }</td>

					<td><a href="${pageContext.request.contextPath }/items/editItems.action?id=${item.id}">修改</a></td>
				</tr>
			</c:forEach>

		</table>
	</form>
</body>
</html>

void

在controller方法形参上可以定义request和response，使用request或response指定响应结果：

使用request转向页面，如：
request.getRequestDispatcher("页面路径").forward(request, response);
通过response页面重定向：
response.sendRedirect("url")
通过response指定响应结果，例如响应json数据如下：
response.setCharacterEncoding("utf-8");

response.setContentType("application/json;charset=utf-8");

response.getWriter().write("json串");

字符串

Handler方法返回字符串内容，可以用作指定逻辑视图、转发或重定向，如：

@RequestMapping("/editItemsSubmit")
public String editItemsSubmit(HttpServletRequest request,Integer id,ItemsCustom itemsCustom)throws Exception {
	
	//调用service更新商品信息，页面需要将商品信息传到此方法
	itemsService.updateItems(id, itemsCustom);
	
	//重定向到商品查询列表
	//return "redirect:queryItems.action";
	//页面转发
	//return "forward:queryItems.action";
	//转到"items/editItems"页面
	// return "items/editItems";
	return "success";
}

逻辑视图名

controller方法返回字符串可以指定逻辑视图名，通过视图解析器解析为物理视图地址。
如：return "items/editItems";，经过视图解析器解析为jsp物理路径：“/WEB-INF/jsp/item/editItem.jsp”。

Redirect重定向

Contrller方法返回结果重定向到一个url地址。
如：return "redirect:queryItem.action";，重定向到“queryItem.action”地址（request无法带过去）。

redirect方式相当于“response.sendRedirect()”，转发后浏览器的地址栏变为转发后的地址。
转发即执行了一个新的request和response，原来的参数在转发时就不能传递到下一个url，如果要传参数可以在url后边加参数，如：“redirect:queryItem?...&…..”。

forward转发

controller方法执行后继续执行另一个controller方法。
如：return "forward:editItem.action";，结果转发到“editItem.action”（request可以带过去）。

forward方式相当于“request.getRequestDispatcher().forward(request,response)”，转发后浏览器地址栏还是原来的地址。
转发并没有执行新的request和response，而是和转发前的请求共用一个request和response。所以转发前请求的参数在转发后仍然可以读取到。

参数绑定

参数绑定：即处理器适配器HandlerAdapter在执行Handler之前需要把http请求的key/value数据绑定到Handler方法形参数上。
早期springmvc采用PropertyEditor（属性编辑器）进行参数绑定将request请求的参数绑定到方法形参上，3.X之后springmvc就开始使用Converter进行参数绑定。

默认支持的参数类型

处理器形参中添加如下类型的参数处理适配器会默认识别并进行赋值：

HttpServletRequest：通过request对象获取请求信息；
HttpServletResponse：通过response处理响应信息；
HttpSession：通过session对象得到session中存放的对象；

Model/ModelMap：Model是一个接口，ModelMap是其实现类，其作用是通过Model或ModelMap将数据填充到request域，以向页面传递数据，如：

@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";
}

页面通过${itemsCustom.XXXX}获取item对象的属性值。
使用Model和ModelMap的效果一样，如果直接使用Model，springmvc会实例化ModelMap。

简单类型

不使用@RequestParam，要求request传入参数名称和 Handler方法的形参名称一致，方可绑定成功。
使用@RequestParam，不用限制request传入参数名称和 Handler方法的形参名称一致。

类型	示例
Integer	Handler方法： `public String editItem(Model model, Integer id) throws Exception{}` 请求url： `http://localhost:8080/springmvc_mybatis/item/editItem.action?id=1001`
String	Handler方法： `public String editItem(Model model, Integer id, String name) throws Exception {}` 请求url： `http://localhost:8080/springmvc_mybatis/item/editItem.action?id=1001&name=eijux`
Float/Double	Handler方法： `public String editItem(Model model, Integer id, Float price) throws Exception {}` 请求url： `http://localhost:8080/springmvc_mybatis/item/editItem.action?id=1001&price=10.28`
Booblean	Handler方法： `public String editItem(Model model, Integer id, Boolean status) throws Exception {}` 请求url： `http://localhost:8080/springmvc_mybatis/item/editItem.action?id=1001&status=false`
@RequestParam	Handler方法： `public String editItems(Model model,@RequestParam(value="id",required=true,defaultValue="1001") Integer items_id)throws Exception {}` 请求url： `http://localhost:8080/springmvc_mybatis/item/editItem.action?id=1002` 参见：#带有@RequestParam的RequestMapping

pojo

简单pojo

请求的参数名称和pojo的属性名称一致，会自动将请求参数赋值给pojo的属性。
如：

View：（请求的参数name与pojo属性名称对应，“http://localhost:8080/springmvc_mybatis/item/editItemSubmit.action?name=eijux&price=10.28”）
```
...
    <input type="text" name="name"/>
    <input type="text" name="price"/>
...
```

Handler：（形参为pojo）

@RequestMapping("/editItemSubmit")
public String editItemSubmit(Model model,Items items)throws Exception{
...
}

pojo：

public class Items {
    private Integer id;
    private String name;
    private Float price;
...
}

包装pojo

如果采用类似struts中“对象.属性”的方式命名，需要将pojo对象作为一个包装对象的属性，而action中以该包装对象作为形参。
如：

View：（请求的参数name与“Vo对象的pojo属性.pojo的属性名称”对应）

...
    <input type="text" name="items.name"/>
    <input type="text" name="items.price"/>
...

Handler：（形参为Vo）

@RequestMapping("/editItemSubmit")
public String editItemSubmit(Model model,QueryVo queryVo)throws Exception{
...
}

Vo：

Public class QueryVo {
    private Items items;
...
}

pojo：

public class Items {
    private Integer id;
    private String name;
    private Float price;
...
}

自定义参数绑定

自定义Converter

自定义Converter类必须实现Converter接口：

package org.springframework.core.convert.converter;

public interface Converter<S, T> {
	T convert(S var1);
}

如，自定义日期格式进行参数绑定：

package cn.itcast.ssm.controller.converter;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

import org.springframework.core.convert.converter.Converter;

public class CustomDateConverter implements Converter<String,Date>{

	@Override
	public Date convert(String source) {
		
		//实现 将日期串转成日期类型(格式是yyyy-MM-dd HH:mm:ss)
		
		SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
		
		try {
			//转成直接返回
			return simpleDateFormat.parse(source);
		} catch (ParseException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		//如果参数绑定失败返回null
		return null;
	}
}

配置Converter

Converter配置

使用<mvc:annotation-driven>

使用HandlerAdapter

<mvc:annotation-driven conversion-service="conversionService"></mvc:annotation-driven>

<!-- 注解适配器 -->
<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
	 <property name="webBindingInitializer" ref="customBinder"></property> 
</bean>

<!-- 自定义webBinder -->
<bean id="customBinder" class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">
	<property name="conversionService" ref="conversionService" />
</bean>

<!-- conversionService -->
<bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean">
	<!-- converters -->
	<property name="converters">
		<list>
			<bean class="cn.itcast.ssm.controller.converter.CustomDateConverter"/>
		</list>
	</property>
</bean>

集合

字符串数组

参数为字符串数组时，Handlder中需使用数组接受参数。
如：

View：页面选中多个checkbox向Handler方法传递参数

...
    <input type="checkbox" name="item_id" value="001"/>
    <input type="checkbox" name="item_id" value="002"/>
    <input type="checkbox" name="item_id" value="002"/>
...

Handler：Controller方法中可以用String[]接收

@RequestMapping("/deleteitem")
public String deleteitem(String[] item_id)throws Exception{
    System.out.println(item_id);
...
}

List

List中存放对象，并将定义的List放在包装类中，action使用包装对象接收。
如：

View：

静态代码：

...
	<tr>
		<td>
			<input type="text" name="itemsList[0].id" value="${item.id}"/>
		</td>
		<td>
			<input type="text" name="itemsList[0].name" value="${item.name}"/>
		</td>
		<td>
			<input type="text" name="itemsList[0].price" value="${item.price}"/>
		</td>
	</tr>
	<tr>
		<td>
			<input type="text" name="itemsList[1].id" value="${item.id}"/>
		</td>
		<td>
			<input type="text" name="itemsList[1].name" value="${item.name}"/>
		</td>
		<td>
			<input type="text" name="itemsList[1].price" value="${item.price}"/>
		</td>
	</tr>
...

动态代码：

...
	<c:forEach items="${itemsList}" var="item" varStatus="s">
	<tr>
		<td><input type="text" name="itemsList[${s.index}].id" value="${item.id}"/></td>
		<td><input type="text" name="itemsList[${s.index}].name" value="${item.name}"/></td>
		<td><input type="text" name="itemsList[${s.index}].price" value="${item.price}"/></td>
	</tr>
	</c:forEach>
...

Handler：（形参为pojo）

@RequestMapping("/editItemSubmit")
public String editItemSubmit(Model model,QueryVo queryVo)throws Exception{
	System.out.println(queryVo.getItemList());
...
}

QueryVo：

Public class QueryVo {
	//商品列表
	Private List<Items> itemList;

	//get
	...
	//set
	...
}

pojo：（略）

Map

将Map对象放在包装类中，并添加get/set方法，action使用包装对象接收。（类似于List）
如：

View：

...
	<tr>
		<td><input type="text" name="itemInfo['name']"/></td>
		<td><input type="text" name="itemInfo['price']"/></td>
	</tr>
...

Handler：（形参为pojo）

@RequestMapping("/editItemSubmit")
public String editItemSubmit(Model model,QueryVo queryVo)throws Exception{
	System.out.println(queryVo.getItemInfo());
...
}

QueryVo：

Public class QueryVo {
	
	private Map<String, Object> itemInfo = new HashMap<String, Object>();

	//get
	...
	//set
	...
}

pojo：（略）

SpringMVC：注解开发

目录

@RequestMapping 使用

URL路径映射

窄化请求映射

限定请求方法

带有@RequestParam的RequestMapping

处理生产和消费对象

处理消息头

处理请求参数

处理动态URI

默认的处理方法

快捷方式（组合注解）

Handler方法返回值

ModelAndView

void

字符串

逻辑视图名

Redirect重定向

forward转发

参数绑定

默认支持的参数类型

简单类型

pojo

简单pojo

包装pojo

自定义参数绑定

自定义Converter

配置Converter

集合

字符串数组

List

Map

导航菜单

SpringMVC：注解开发

@RequestMapping 使用

URL路径映射

窄化请求映射

限定请求方法

带有@RequestParam的RequestMapping

处理生产和消费对象

处理消息头

处理请求参数

处理动态URI

默认的处理方法

快捷方式（组合注解）

Handler方法返回值

ModelAndView

void

字符串

逻辑视图名

Redirect重定向

forward转发

参数绑定

默认支持的参数类型

简单类型

pojo

简单pojo

包装pojo

自定义参数绑定

自定义Converter

配置Converter

集合

字符串数组

List

Map

导航菜单

搜索