后端必会的 Spring MVC 核心类和注解

GitHub：https://github.com/nateshao/ssm/tree/master/107-springmvc-demo

1. DispatcherServlet

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

1. <servlet> 
2.     <!-- 如果没有通过< init-param >元素配置，则应用程序会默认去WEB-INF目录下寻找以servletName-servlet.xml方式命名的配置文件，这里的servletName指下面的springmvc --> 
3.     <servlet-name>springmvc</servlet-name> 
4.     <servlet-class> 
5.           org.springframework.web.servlet.DispatcherServlet 
6.     </servlet-class> 
7. <!-- 如果< init-param >元素存在并且通过其子元素配置了Spring MVC配置文件的路径，则应用程序在启动时会加载配置路径下的配置文件 --> 
8.     <init-param> 
9.         <param-name>contextConfigLocation</param-name> 
10.         <param-value>classpath:springmvc-config.xml</param-value> 
11.     </init-param> 
12.     <load-on-startup>1</load-on-startup> 
13. </servlet> 
14. <servlet-mapping> 
15.     <servlet-name>springmvc</servlet-name> 
16.     <url-pattern>/</url-pattern> 
17. </servlet-mapping> 

2. @Controller注解类型

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

@Controller注解在控制器类中的使用示例如下：

1. @Controller 
2. public class HelloController { 
3.  
4.     @RequestMapping("hello") 
5.     public String hello(){ 
6.         return "hello"; 
7.     } 
8. } 

为了保证Spring能够找到控制器类，还需要在Spring MVC的配置文件中添加相应的扫描配置信息，一个完整的配置文件示例如下：

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <beans xmlns="http://www.springframework.org/schema/beans" 
3.             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
4.            <!-- 引入context信息 --> 
5.             xmlns:context="http://www.springframework.org/schema/context" 
6.             xsi:schemaLocation="http://www.springframework.org/schema/beans 
7.                                              http://www.springframework.org/schema/beans/spring-beans-4.3.xsd 
8.                                              http://www.springframework.org/schema/context  
9.                                              http://www.springframework.org/schema/context/spring-context-4.3.xsd"> 
10.     <!-- 指定需要扫描的 --> 
11.  <context:component-scan base-package="com.nateshao.controller" /> 
12. </beans>  

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

3. @RequestMapping注解类型

“Spring通过@Controller注解找到相应的控制器类后，还需要知道控制器内部对每一个请求是如何处理的，这就需要使用@RequestMapping注解类型，它用于映射一个请求或一个方法。使用时，可以标注在一个方法或一个类上。

1. 标注在方法上： 作为请求处理方法在程序接收到对应的URL请求时被调用：

1. @Controller 
2. public class FirstController{ 
3.  @RequestMapping(value="/firstController") 
4.  public ModelAndView handleRequest(HttpServletRequest request, 
5.    HttpServletResponse response) { 
6.                            ... 
7.   return mav; 

2. 标注在类上： 该类中的所有方法都将映射为相对于类级别的请求，表示该控制器所处理的所有请求都被映射到value属性值所指定的路径下。

1. @Controller 
2. @RequestMapping(value="/hello") 
3. public class FirstController{ 
4.  @RequestMapping(value="/firstController") 
5.  public ModelAndView handleRequest(HttpServletRequest request, 
6.    HttpServletResponse response) { 
7.                            ... 
8.   return mav; 
9.  } 
10. } 

由于在类上添加了@RequestMapping注解，并且其value属性值为“/hello”，所以上述代码方法的请求路径将变为：http://localhost:8080/106-springmvc-hello/hello

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

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

@RequestMapping(value="/firstController")

@RequestMapping("/firstController")

组合注解

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

Spring的4.3版本中的组合注解及其描述如下所示：

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

以@GetMapping为例，该组合注解是@RequestMapping(method = RequestMethod.GET)的缩写，它会将HTTP GET请求映射到特定的处理方法上。

在实际开发中，传统的@RequestMapping注解使用方式如下：

1. @RequestMapping(value="/user/{id}",method=RequestMethod.GET) 
2. public String selectUserById(String id){ 
3.     ... 
4. } 

使用@GetMapping注解后的简化代码如下：

1. @GetMapping(value="/user/{id}") 
2. public String selectUserById(String id){ 
3.     ... 
4. } 

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

在控制器类中，每一个请求处理方法都可以有多个不同类型的参数，以及一个多种类型的返回结果。在请求处理方法中，可以出现的参数类型如下：

1. javax.servlet.ServletRequest / javax.servlet.http.HttpServletRequest 
2. javax.servlet.ServletResponse / javax.servlet.http.HttpServletResponse 
3. javax.servlet.http.HttpSession 
4. org.springframework.web.context.request.WebRequest或 
5. org.springframework.web.context.request.NativeWebRequest 
6. java.util.Locale 
7. java.util.TimeZone (Java 6+) / java.time.ZoneId (on Java 8) 
8. java.io.InputStream / java.io.Reader 
9. java.io.OutputStream / java.io.Writer 
10. org.springframework.http.HttpMethod 
11. java.security.Principal 
12. @PathVariable、@MatrixVariable、@RequestParam、@RequestHeader、@RequestBody、@RequestPart、@SessionAttribute、@RequestAttribute注解 
13. HttpEntity<?> 
14. java.util.Map / org.springframework.ui.Model /org.springframework.ui.ModelMap 
15. org.springframework.web.servlet.mvc.support.RedirectAttributes 
16. org.springframework.validation.Errors /org.springframework.validation.BindingResult 
17. org.springframework.web.bind.support.SessionStatus 
18. org.springframework.web.util.UriComponentsBuilder 

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

请求处理方法的返回类型

Spring MVC所支持的常见方法返回类型如下：

由于ModelAndView类型未能实现数据与视图之间的解耦，所以在企业开发时，方法的返回类型通常都会使用String。

既然String类型的返回值不能携带数据，那么在方法中是如何将数据带入视图页面的呢?

通过Model参数类型，即可添加需要在视图中显示的属性，其示例代码如下：

1. @RequestMapping(value="/firstController") 
2. public String handleRequest(HttpServletRequest request, 
3.                                                HttpServletResponse response, Model model) { 
4.         model.addAttribute("msg", "这是我的第一个Spring MVC程序"); 
5.         return "/WEB-INF/jsp/first.jsp"; 
6. } 

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

1. redirect 重定向。例如，在修改用户信息操作后，将请求重定向到用户查询方法的实现代码如下:

1. @RequestMapping(value="/update") 
2. public String update(HttpServletRequest request,HttpServletResponse response, Model model){ 
3.        ...  
4.        return "redirect:queryUser"; 
5. } 

2. forward 请求转发。例如，用户执行修改操作时，转发到用户修改页面的实现代码如下:

1. @RequestMapping(value="/toEdit") 
2. public String update(HttpServletRequest request,HttpServletResponse response, Model model){ 
3.        ...  
4.        return "forward:editUser"; 
5. } 

4. ViewResolver(视图解析器)

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

1. <bean id="viewResolver"    class="org.springframework.web.servlet.view.InternalResourceViewResolver"> 
2.         <property name="prefix" value="/WEB-INF/jsp/" /> 
3.         <property name="suffix" value=".jsp" /> 
4. </bean> 

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

5. 基于注解的Spring MVC应用

代码附上!!

web.xml

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" 
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
4.          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" 
5.          version="4.0"> 
6.     <context-param> 
7.         <param-name>contextConfigLocation</param-name> 
8.         <param-value>/WEB-INF/applicationContext.xml</param-value> 
9.     </context-param> 
10.     <listener> 
11.         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> 
12.     </listener> 
13.     <servlet> 
14.         <servlet-name>dispatcher</servlet-name> 
15.         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 
16.         <load-on-startup>1</load-on-startup> 
17.     </servlet> 
18.     <servlet-mapping> 
19.         <servlet-name>dispatcher</servlet-name> 
20.         <!--        <url-pattern>*.form</url-pattern>--> 
21.         <url-pattern>/</url-pattern> 
22.     </servlet-mapping> 
23. </web-app> 

dispatcher-servlet.xml

1. <?xml version="1.0" encoding="UTF-8"?> 
2. <beans xmlns="http://www.springframework.org/schema/beans" 
3.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
4.        xmlns:context="http://www.springframework.org/schema/context" 
5.        xmlns:mvc="http://www.springframework.org/schema/mvc" 
6.        xsi:schemaLocation="http://www.springframework.org/schema/beans 
7.        http://www.springframework.org/schema/beans/spring-beans.xsd 
8.        http://www.springframework.org/schema/context 
9.        https://www.springframework.org/schema/context/spring-context.xsd 
10.        http://www.springframework.org/schema/mvc 
11.        https://www.springframework.org/schema/mvc/spring-mvc.xsd"> 
12.      
13.     <context:component-scan base-package="com.nateshao.controller"/> 
14.     <mvc:default-servlet-handler/> 
15.     <mvc:annotation-driven/> 
16.     <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver"> 
17.         <property name="prefix" value="/WEB-INF/jsp/"/> 
18.         <property name="suffix" value=".jsp"/> 
19.     </bean> 
20. </beans> 

 

 

hello.jsp

1. <%-- 
2.   Created by IntelliJ IDEA. 
3.   User: 邵桐杰 
4.   Date: 2021/10/16 
5.   Time: 21:34 
6.   To change this template use File | Settings | File Templates. 
7. --%> 
8. <%@ page contentType="text/html;charset=UTF-8" language="java" %> 
9. <html> 
10. <head> 
11.     <title>Title</title> 
12. </head> 
13. <body> 
14. ${msg} 
15. </body> 
16. </html> 

HelloController.java

1. package com.nateshao.controller; 
2.  
3. import org.springframework.stereotype.Controller; 
4. import org.springframework.ui.Model; 
5. import org.springframework.web.bind.annotation.RequestMapping; 
6. import javax.servlet.http.HttpServletRequest; 
7. import javax.servlet.http.HttpServletResponse; 
8. /** 
9.  * @date Created by 邵桐杰 on 2021/10/16 21:37 
10.  * @微信公众号 程序员千羽 
11.  * @个人网站 www.nateshao.cn 
12.  * @博客 https://nateshao.gitee.io 
13.  * @GitHub https://github.com/nateshao 
14.  * @Gitee https://gitee.com/nateshao 
15.  * Description: 
16.  */ 
17. @Controller 
18. public class HelloController { 
19.     @RequestMapping("/hello") 
20.     public String handleRequest(HttpServletRequest request, 
21.                                 HttpServletResponse response, Model model) throws Exception { 
22.         // 向模型对象中添加数据 
23.         model.addAttribute("msg", "这是我的第一个Spring MVC程序"); 
24.         // 返回视图页面 
25.         return "hello"; 
26.     } 
27. } 

总结

这一篇文章主要对Spring MVC的核心类及其相关注解的使用进行了详细的讲解。

• 首先介绍了DispatcherServlet的作用和配置;
• 然后介绍了@Controller以及@RequestMapping注解类型的相关知识;
• 最后讲解了视图解析器的定义和配置，并通过一个应用案例，将所讲解的内容进行了一个全面总结。

通过本章的学习，我相信我们能够了解Spring MVC核心类的作用，并掌握Spring MVC常用注解的使用。

原文链接：https://mp.weixin.qq.com/s/3vV5i-5DLlKCP4TWioyzwA