Spring MVC的核心类和注解

Posted 2021-09-08 shi_zi_183

Spring MVC的核心类和注解

在Spring 2.5之前，只能使用实现Controller接口的方式开发一个控制器。在Spring 2.5之后，新增加了基于注解的控制器以及其他一些常用注解，这些注解的使用极大地减少了程序员的开发工作。

DispatchServlet

DispatchServlet的全名是org.springframework.web.servlet.DispatchServlet，它在程序中充当着前端控制器的角色。在使用时，只需将其配置在项目的web.xml文件中

  	<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>
  	<load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
  	<servlet-name>springmvc</servlet-name>
  	<url-pattern>/</url-pattern>
  </servlet-mapping>

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

servletName-servlet.xml

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

Controller注解类型

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

pack com.ex.controller;
import org.springframework.stereotype.Controller;
...
@Controller
public class FirstController{
	...
}

为了保证Spring能够找到控制器类，还需要再Spring MVC的配置文件中添加相应的扫描配置信息，
1）在配置文件的声明中引入spring-context。
2）使用<context:component-scan>元素指定需要扫描的类包。
一个完整的配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">
	<context:component-scan base-package="com.ex.controller"/>
</beans>

<context:component-scan>元素的属性base-package指定了需要扫描的类包为com.ex.controller。在运行时，该类包及其子包下所有标注了注解的类都会被Spring所处理。
与实现了Controller接口的方式相比，使用注解的方式显然更加简单。同时，Controller接口的实现类只能处理一个单一的请求动作，而基于注解的控制器可以同时处理多个请求动作，在使用上更加的灵活。因此，在实际开发中通常都会使用基于注解的形式。
注：使用注解方式时，程序的运行需要依赖Spring的AOP包，因此需要向lib目录中添加spring-aop-4.3.6.RELEASE.jar，否则程序运行时会报错。

RequestMapping注解类型

@RequestMapping注解的使用

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

package com.ex.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
...
@Controller
public class FirstController{
	@RequestMapping(value="/firstController")
	public ModelAndView handleRequest(HttpServletRequest request,HttpServletResponse response){
		...
		return mav;
	}
}

使用@RequestMapping注解后，上述代码中的handleRequest()方法就可以通过地址：http://localhost:8080/chapter12/firstController进行访问。
2、标注在类上
当标注在一个类上时，该类中的所有方法都将映射为相对于类级别的请求，表示该控制器所处理的所有请求都被映射到value属性值所指定的路径下。使用@RequestMapping注解标注在类上

package com.ex.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
...
@Controller
@RequestMapping(value="/hello")
public class FirstController{
	@RequestMapping(value="/firstController")
	public ModelAndView handleRequest(HttpServletRequest request,HttpServletResponse response){
		...
		return mav;
	}
}

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

@RequestMapping注解的属性

@RequestMapping注解除了可以指定value属性外，还可以指定其他一些属性

属性名	类型	描述
name	String	可选属性，用于为映射地址指定别名
value	String[]	可选属性，同时也是默认属性，用于映射一个请求和一种方法，可以标注在一个方法或一个类上
method	RequestMethod[]	可选属性，用于指定该方法用于处理哪种类型的请求方法，其请求方法包括GET、POST、HEAD、OPTIONS、PUT、PATCH、DELETE和TRACE。例如method=RequestMethod.GET表示只支持GET请求，如果需要支持多个请求方式则需要通过{}写成数组的形式，并且多个请求方式之间是有英文逗号分隔
params	String[]	可选属性，用于指定Request中必须包括某些参数的值，才可以通过其标注的方式处理。
headers	String[]	可选属性，用于指定Request中必须包含某些指定的header的值，才可以通过其标注的方法处理。
consumes	String[]	可选属性，用于指定处理请求的提交内容类型(Content-type)，比如application/json、text/html等。
produces	String[]	可选属性，用于指定返回的内容类型，返回的内容类型必须时request请求头(Accept)中所包含的类型。

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

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

组合注解

前面对@RequestMapping注解及其属性进行了讲解，而在Spring框架的4.3版本中，引入了组合注解，来帮助简化常用的HTTP方法的映射，并更好地表达被注解方法的语义。其组合注解如下所示
1、GetMapping：匹配GET方式的请求。
2、PostMapping：匹配POST方式的请求。
3、PutMapping：匹配PUT方式的请求。
4、DeleteMapping：匹配Delete方式的请求。
5、PatchMapping：匹配Patch方式的请求。
以@GetMapping为例，该组合注解是@RequestMapping(method=RequestMethod.GET)的缩写，它会将HTTP GET映射到特定的处理方法上。使用新注解后，可以省略method属性，从而简化代码。

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

在控制器类中，每个请求处理方法都可以有多种不同类型的参数，以及一个多种类型的返回结果。‘
在请求处理方法中，可以出现的参数类型如下
1）javax.servlet.ServletRequest/javax.servlet.http.HttpServletRequest
2）javax.servlet.ServletResponse/javax.servlet.http.HttpServletResponse
3）javax.servlet.http.HttpSession
4）org.spingframework.web.context.request.WebRequest或org.spingframework.web.context.request.NativeWebRequest
5）java.util.Locale
6）java.util.TimeZone/java.time.Zoneld
7）java.io.InputStream/java.io.Reader
8）java.io.OutputStream/java.io.Writer
9）org.springframework.http.HttpMethod
10）java.security.Principal
11）@PathVariable、@MatrixVariable、@RequestParam、@RequestHeader、@RequestBody、@RequestPart、@SessionAttribute、@RequestAttribute注解
12）HttpEntity<?>
13）java.util.Map/org.springframework.ui.Model/org.springframework.ui.ModelMap
14）org.springframework.web.servlet.mvc.support.RedirectAttributes
15）org.springframework.validation.Errors/org.springframework.validation.BindingResult
16）org.springframework.web.bind.support.SessionStatus
17）org.springframework.web.util.UriComponentsBuilder
需要注意的是，org.springframework.ui.Model类型不是一个Servlet API类型，而是一个包含了Map对象的Spring MVC类型。如果方法中添加了Model参数，则每次调用该请求处理方法时，Spring MVC都会创建Model对象，并将其作为参数传递给方法。
Spring MVC所支持的常见方法返回类型
1）ModelAndView
2）Model
3）Map
4）View
5）String
6）void
7）HttpEntity<?>或ResponseEntity<?>
8）Callable<?>
9）DeferredResult<?>
在上述所列举的返回类型中，常见的返回类型是ModelAndView、String和void。其中ModelAndView类型中可以添加Model数据，并指定视图；String类型的返回值可以跳转视图，但不能携带数据；而void类型主要在异步请求时使用，它只返回数据，而不会跳转视图。
由于ModelAndView类型未能实现数据与视图之间的解耦，所以在企业开发时，方法的返回类型通常都会使用String。既然String类型的返回值不能携带数据，但是通过Model参数类型可以添加需要在视图中显示的属性。

@RequestMapping("/firstController")
public String handleRequest(HttpServletRequest request,HttpServletResponse response,Model model){
		model.addAttribute("msg","这是我的第一个Spring MVC程序");
		return "/WED-INF/jsp/first.jsp";
}

1、redirect重定向

@RequestMapping("/update")
public String update(HttpServletRequest request,HttpServletResponse response,Model model){
		...
		return "redirect:queryUser";
}

2、forward请求转发

@RequestMapping("/update")
public String update(HttpServletRequest request,HttpServletResponse response,Model model){
		...
		return "forward:queryUser";
}

具体之后再学习。

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"/>
</bean>

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

基于注解的Spring MVC应用

搭建项目环境

在Eclipse中，创建一个名为chapter12的Web项目，将chapter11项目中的所有JAR包以及编写的所有文件复制到chapter12项目，并向lib目录添加Spring AOP所需的JAR包

修改配置文件

在springmvc-config.xml中添加注解扫描配置，并定义视图解析器

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd">
	<context:component-scan base-package="com.ex.controller"/>
	<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
	<property name="prefix" value="/WEB-INF/jsp/"/>
	<property name="suffix" value=".jsp"/>
</bean>
</beans>

修改Controller类

package com.ex.controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
@Controller
@RequestMapping("/hello")
public class FirstController{
	@RequestMapping("/firstController")
	public String handleRequest(HttpServletRequest request,
			HttpServletResponse response,Model model) throws Exception {
		model.addAttribute("msg", "这是我的第一个Spring MVC程序");
		return "first";
	}
}

启动项目，测试应用