12. Spring MVC的核心类和注解

1. DispatcherServlet

DispatcherServlet的全名是org.springframework.web.servlet.DispatcherServlet，它在程序中充当着前端控制器的角色

在使用时，只需将其配置在项目的web.xml文件中，其配置代码如下

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
    http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
	id="WebApp_ID" version="3.0">
	
	<servlet>
	   <servlet-name>springmvc</servlet-name>
	   <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	   
	   <!-- 初始化时加载配置文件 -->
	   <init-param>
	       <param-name>contextConfigLocation</param-name>
	       <param-value>classpath:springmvc-config.xml</param-value>
	   </init-param>
	   
	   <!-- 表示容器启动时立即加载servlet -->
	   <load-on-startup>1</load-on-startup>
	</servlet>
	
	<servlet-mapping>
	   <servlet-name>springmvc</servlet-name>
	   <url-pattern>/</url-pattern>
	</servlet-mapping>

</web-app>

< load-on-startup>元素和< init-param>元素都是可选的。如果< load-on-startup>元素的值为1，则在应用程序启动时会立即加载该Servlet；如果< load-on-startup>元素不存在，则应用程序会在第一个Servlet请求时加载该Servlet。如果< init-param>元素存在并且通过其子元素配置了Spring MVC配置文件的路径，则应用程序在启动时会加载配置路径下的配置文件；如果没有通过< init-param>元素配置，则应用程序会默认到WEB-INF目录下寻找如下方式命名的配置文件

servletName-servlet.xml

servletName指的是部署在web.xml中的DispatcherServlet的名称，在上面web.xml中的配置代码中即为springmvc，而-servlet.xml是配置文件名的固定写法，所以应用程序会在WEB-INF下寻找springmvc-servlet.xml

2. Controller注解类型

org.springframework.stereotype.Controller注解类型用于指示Spring类的实例是一个控制器，其注解形式为@Controller。该注解在使用时不需要再实现Controller接口，只需要将@Controller注解加入到控制器类上，然后通过Spring的扫描机制找到标注了该注解的控制器即可

@Controller
public class FirstController{
...
}

然后添加该包的注解扫描

<context:component-scan base-package="com.clarence.controller"/>

与实现了Controller接口的方式相比，使用注解的方式显然更加简单。同时，Controller接口的实现类只能处理一个单一的请求动作，而基于注解的控制器可以同时处理多个请求动作，在使用上更加的灵活。因此，在实际开发中通常都会使用基于注解的形式

使用注解方式时，程序的运行需要依赖Spring的AOP包，因此需要向lib目录中添加spring-aop-4.3.6.RELEASE.jar，否则程序运行时会报错

3. RequestMapping注解类型

3.1 @RequestMapping注解的使用

Spring通过@Controller注解找到相应的控制器类后，还需要知道控制器内部对每一个请求是如何处理的，这就需要使用org.springframework.web.bind.annotation.RequestMapping注解类型。RequestMapping注解类型用于映射一个请求或一个方法，其注解形式为@RequestMapping，可以使用该注解标注在一个方法或一个类上。

1. 标记在方法上
   当标注在一个方法上时，该方法将成为一个请求处理方法，它会在程序接收到对应的URL请求时被调用。使用@RequestMapping注解标注在方法上的示例如下

@Controller
public class FirstController{

    @RequestMapping(value="/firstController")
    public ModelAndView handleRequest(HttpServletRequest request,
            HttpServletResponse response) throws Exception {
        // 创建ModelAndView对象
        ModelAndView modelAndView = new ModelAndView();
        //...
        return modelAndView;
    }

}

使用@RequestMapping注解后，上述代码中的handleRequest()方法就可以通过地址：http://localhost:8080/chapter12/firstController进行访问

2. 标注在类上当标注在一个类上时，该类中的所有方法都将映射为相对于类级别的请求，表示该控制器所处理的所有请求都被映射到value属性值所指定的路径下。使用@RequestMapping注解标注在类上的示例如下。

@Controller
@RequestMapping(value="/hello")
public class FirstController{

    @RequestMapping(value="/firstController")
    public ModelAndView handleRequest(HttpServletRequest request,
            HttpServletResponse response) throws Exception {
        // 创建ModelAndView对象
        ModelAndView modelAndView = new ModelAndView();
        //...
        return modelAndView;
    }
}

由于在类上添加了@RequestMapping注解，并且其value属性值为“/hello”，所以上述代码方法的请求路径将变为：http://localhost:8080/chapter12/hello/firstController。如果该类中还包含其他方法，那么在其他方法的请求路径中也需要加入“/hello”

3.2 @RequestMapping注解的属性

@RequestMapping注解除了可以指定value属性外，还可以指定其他一些属性，这些属性如表12-1所示

在表12-1中，所有属性都是可选的，但其默认属性是value。当value是其唯一属性时，可以省略属性名，例如下面两种标注的含义相同

@RequestMapping(value="/firstController")
@RequestMapping("/firstController")

3.3 组合注解

在Spring框架的4.3版本中，引入了组合注解，来帮助简化常用的HTTP方法的映射，并更好地表达被注解方法的语义。其组合注解如下所示

@GetMapping：匹配GET方式的请求
@PostMapping：匹配POST方式的请求
@PutMapping：匹配PUT方式的请求
@DeleteMapping：匹配DELETE方式的请求
@PatchMapping：匹配PATCH方式的请求

以@GetMapping为例，该组合注解是@RequestMapping(method=RequestMethod.GET)的缩写，它会将HTTP GET映射到特定的处理方法上。在实际开发中，传统的@RequestMapping注解使用方式如下

@RequestMapping(value="/firstController",method=RequestMethod.GET)
@GetMapping("/firstController")

3.4 请求处理方法的参数类型和返回类型

在控制器类中，每一个请求处理方法都可以有多个不同类型的参数，以及一个多种类型的返回结果。如在前面的案例中，handleRequest()方法的参数就是对应请求的HttpServletRequest和HttpServletResponse两种参数类型。除此之外，还可以使用其他的参数类型，例如在请求处理方法中需要访问HttpSession对象，则可以添加HttpSession作为参数，Spring会将对象正确地传递给方法，其使用示例如下。

    @RequestMapping("/firstController")
    public ModelAndView modelAndView(HttpSession httpSession) {
        ModelAndView mav = new ModelAndView();
        return mav;
    }

在请求处理方法中，可以出现的参数类型如下：
javax.servlet.ServletRequest /javax.servlet.http.HttpServletRequest
javax.servlet.ServletResponse /javax.servlet.http.HttpServletResponse
javax.servlet.http.HttpSession
org.springframework.web.context.request.WebRequest或org.springframework.web.context.request.NativeWebRequest
java.util.Locale
java.util.TimeZone (Java 6+) / java.time.ZoneId (on Java 8)
java.io.InputStream / java.io.Reader
java.io.OutputStream / java.io.Writer
org.springframework.http.HttpMethod· java.security.Principal
@PathVariable、@MatrixVariable、@RequestParam、@RequestHeader、@RequestBody、@RequestPart、@SessionAttribute、@RequestAttribute注解
HttpEntity<? >
java.util.Map / org.springframework.ui.Model/org.springframework.ui.ModelMap
org.springframework.web.servlet.mvc.support.RedirectAttributes
org.springframework.validation.Errors/org.springframework.validation.BindingResult
org.springframework.web.bind.support.SessionStatus
org.springframework.web.util.UriComponentsBuilder

org.springframework.ui.Model类型不是一个Servlet API类型，而是一个包含了Map对象的Spring MVC类型。如果方法中添加了Model参数，则每次调用该请求处理方法时，Spring MVC都会创建Model对象，并将其作为参数传递给方法

Spring MVC所支持的常见方法返回类型如下。
ModelAndView
Model
Map
View
String
void
HttpEntity<? >或ResponseEntity<? >
Callable<? >
DeferredResult<? >

在上述所列举的返回类型中，常见的返回类型是ModelAndView、String和void。其中ModelAndView类型中可以添加Model数据，并指定视图；String类型的返回值可以跳转视图，但不能携带数据；而void类型主要在异步请求时使用，它只返回数据，而不会跳转视图。
由于ModelAndView类型未能实现数据与视图之间的解耦，所以在企业开发时，方法的返回类型通常都会使用String。并在参数中使用Model类型，通过该参数类型，即可添加需要在视图中显示的属性。

    @RequestMapping(value="/firstController")
    //@GetMapping("/firstController")
    public String handleRequest(HttpServletRequest request,
            HttpServletResponse response,Model model) throws Exception {
        // 创建ModelAndView对象
        model.addAttribute("msg","这是一个添加消息");
        //...
        return "/WEB-INF/jsp/first.jsp";
    }

String类型除了可以返回上述代码中的视图页面外，还可以进行重定向与请求转发

1. redirect重定向

return "redirect:queryUser"

2. forward请求转发

return "forward:editUser"

重定向和请求转发的区别：重定向会直接跳转，相当于重新打开一个页面，没有原先的参数；而请求转发会在容器内部将原有的请求转发给新的servlet，会带有原有的参数

4 ViewResolver（视图解析器）

Spring MVC中的视图解析器负责解析视图，可以通过在配置文件中定义一个ViewResolver来配置视图解析器，其配置示例如下。

	<!-- 视图解析器 -->
	<bean id="viewResolver"	class="org.springframework.web.servlet.view.InternalResourceViewResolver">
	   <property name="prefix" value="WEB-INF/jsp/"/>
	   <property name="suffix" value=".jsp"></property>	
	</bean>

定义了一个id为viewResolver的视图解析器，并设置了视图的前缀和后缀属性。这样设置后，方法中所定义的view路径将可以简化。例如，案例中的逻辑视图名只需设置为“first”，而不再需要设置为“/WEB-INF/jsp/first.jsp”，在访问时视图解析器会自动地增加前缀和后缀。