第 12 章 Spring MVC 的核心类 和 注解

在 Spring 2.5 之前，只能使用实现 Controller 接口的方式来开发一个控制器，第 11 章的入门案例就是使用的此种方式。 在 Spring 2.5 之后，新增加了基于注解的控制器以及其他一些常用注解，这些注解的使用极大地减少了程序员的开发工作。 接下来，本章将对 Spring MVC 中的常用核心类及其常用注解进行详细的讲解。

DispatcherServlet

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

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

在上述代码中， <Ioad-on-startup>元素和<init-param>元素都是可选的。 如果<Ioad-on-startup>元素的值为 1 ，则在应用程序启动时会立即加载该 Servlet; 如果<Ioad-on-startup>元 素不存在，则应用程序会在第一个 Servlet 请求时加载该 Servlet。 如果<init-param>元素存在并且通过其子元素配置了 Sprihg 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 的扫描机制找到标注了该注解的控制器即可。
@Controller 注解在控制器类中的使用示例如下。

package com.neuedu.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-4.3.xsd
  http://www.springframework.org/schema/context
  http://www.springframework.org/schema/context/spring-context-4.3.xsd ">  
  <!-- 配置处理器 Handle，映射"/firstController"请求 -->
  <context:component-scan base-package="com.neuedu.controller">
</beans>

在文件中， <context:component-scan>元素的属性 base-package 指定了需要扫描的类包为 com.neuedu.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 注解标注在方法上的示例如下。
@Controller
public class FirstController{  
  @RequestMapping(value="/firstController") 
  public ModelAndView handleRequest(HttpServletRequest arg0, HttpServletResponse arg1) throws Exception {
      ...
      return mav;
  }
}

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

  1. 标注在类上
    当标注在一个类上时，该类中的所有方法都将映射为相对于类级别的请求，表示该控制器所处理的所有请求都被映射到 value 属性值所指定的路径下。 使用@RequestMapping 注解标注在类上的示例如下。
@Controller
@RequestMapping(value="/hello") 
public class FirstController{  
  @RequestMapping(value="/firstController") 
  public ModelAndView handleRequest(HttpServletRequest arg0, HttpServletResponse arg1) throws Exception {
      ...
      return mav;
  }
}

由于在类上添加了@RequestMapping 注解， 并且其 value 属性值为 "/hello" ，所以上述代码方法的请求路径将变为 : http://localhost:8080/springmvc01/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 方法的映射，并更好地表达被注解方法的语义。 其组合注解如下所示。

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

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

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

而使用新注解@GetMapping 后，可以省略 method 属性，从而简化代码，其使用方式如下。

  @RequestMapping(value="/user/{id}") 
  public String selectUserById(String id){
      ...
  }
  • 请求处理万法的参擞类型相返回类型

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

  @RequestMapping(value="/firstController") 
  public ModelAndView(HttpSession session){
      ...
      return mav;
  }

在请求处理方法中，可以出现的参数类型如下。



需要注意的是， org.springframework.ui.Model 类型不是一个 Servlet API 类型，而是一个包含了 Map 对象的 Spring MVC 类型。 如果方法中添加了 Model 参数，则每次调用该请求处理方法时， Spring MVC 都会创建 Model 对象，并将其作为参数传递给方法。
在入门案例中，请求处理方法返回的是一个 ModelAndView 类型的数据。 除了此种类型外， 请求处理方法还可以返回其他类型的数据。 Spring MVC 所支持的常见方法返回类型如下。

  • ModelAndView
  • Model
  • Map
  • View
  • String
  • void
  • HttpEntity<?>或 ResponseEntity<?>
  • Callable<?>
  • DeferredResult<?>

在上述所列举的返回类型中，常见的返回类型是 ModelAndView、 String 和 void。 其中 ModelAndView 类型中可以添加 Model 数据，并指定视图；String 类型的返回值可以跳转视图，但不能携带数据;而 void 类型主要在异步请求时使用，它只返回数据，而不会跳转视图 。
由于 ModelAndView 类型未能实现数据与视图之间的解耦，所以在企业开发时，方法的返回类型通常都会使用 String。 既然 String 类型的返回值不能携带数据，那么在方法中是如何将数据带入视图页面的呢? 这就用到了上面所讲解的 Model 参数类型，通过该参数类型，即可添加需要在视图中显示的属性。
返回 String 类型方法的示例代码如下。

  @RequestMapping(value="/firstController") 
  public String handleRequest(HttpServletRequest request, HttpServletResponse response,Model model) throws Exception {
      //向模型对象中添加数据
      model.addAttribute("msg","这是我的第一个Spring MVC 程序！");
      //返回视图页面
      return "/WEB-INF/jsp/frist.jsp";
  }

在上述方法代码中，增加了一个 Model 类型的参数，通过该参数实例的 addAttribute() 方法即可添加所需数据。
String 类型除了可以返回上述代码中的视图页面外，还可以进行重定向与请求转发，具体方式如下。

  1. redirect 重定向
    例如，在修改用户信息操作后，将请求重定向到用户查询方法的实现代码如下。
  @RequestMapping(value="/update") 
  public String handleRequest(HttpServletRequest request, HttpServletResponse response,Model model) throws Exception {
      ...
      //请求重定向
      return "redirect:queryUser";
  }
  1. forward 请求转发
    例如，用户执行修改操作时，转发到用户修改页面的实现代码如下。
  @RequestMapping(value="/toEdit") 
  public String handleRequest(HttpServletRequest request, HttpServletResponse response,Model model) throws Exception {
      ...
      //请求转发
      return "forward:editUser"; 
  }

关于重定向和转发的具体使用，我们在后面章节中会有具体的应用案例，由于篇幅有限，这里就不再过多介绍。

ViewResolver (视图解析器）

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

  <!-- 定义视图解析器  -->
  <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
      <!-- 设置前缀  -->
      <property name="prefix" value="/WEB-INF/jsp/" /> 
      <!-- 设置后缀  -->
      <property name="suffix" value=".jsp" /> 
  </bean>

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

应用案例——基于注解的 Spring MVC应用

通过前几个小节的学习，相信大家对 Spring MVC 的核心类和注解的使用已经有了一个初步的了解。 为了帮助大家掌握这些知识，我在这里将通过前面所学内容，以注解的方式对入门案例进行改写，具体实现步骤如下。

  • 搭建项目环境

在 Eclipse 中，创建一个名为 springmvc02 的 Web 项目，将 springmvc01 项目中的所有 JAR 包以及编写的所有文件复制到 springmvc02 项目，并向 lib 目录添加 Spring AOP 所需的 JAR ( spring-aop-4.3.6.RELEASE.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-4.3.xsd
   http://www.springframework.org/schema/context 
   http://www.springframework.org/schema/context/spring-context-4.3.xsd">
  <!-- 指定需要扫描的包  -->
  <context:component-scan base-package="com.neuedu.controller" />
  <!-- 定义视图解析器  -->
  <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
      <!-- 设置前缀  -->
      <property name="prefix" value="/WEB-INF/jsp/" /> 
      <!-- 设置后缀  -->
      <property name="suffix" value=".jsp" /> 
  </bean>
</beans>

在文件中，首先通过组件扫描器指定了需要扫描的包，然后定义了视图解析器，并在视图解析器中设置了视图文件的路径前缀和文件后缀名。

  • 修改 Controller 类

修改 FirstController 类，在类和方法上添加相应注解，文件如下所示。

package com.neuedu.controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
/**
* 控制器类
*/
@Controller
@RequestMapping(value="/hello") 
public class FirstController{  
    @RequestMapping(value="/firstController") 
    public String handleRequest(HttpServletRequest request, HttpServletResponse response,Model model) throws Exception {
        //向模型对象中添加数据
        model.addAttribute("msg","这是我的第一个Spring MVC 程序！");
        //返回视图页面
        return "frist";
    }
}

在文件中，使用了@Controller 注解来标注控制器类，并使用了@RequestMapping 注解标注在类名和方法名上来映射请求方法。 在项目启动时， Spring 就会扫描到此类，以及此类中标注了@RequestMapping 注解的方法。 由于标注在类上的@RequestMapping 注解的 value 值为 "/hello" ，因此类中所有请求方法的路径都需要加上 "/hello"。 由于类中的 handlerRequest() 方法的返回类型为 String ，而 String 类型的返回值又无法携带数据，所以需要通过参数 Model 对象的 addAttribute()方法来添加数据信息。 因为在配置文件的视图解析器中定义了视图文件的前缀和后缀名，所以 handleRequest()方法只需返回视图名 "first" 即可，在访问此方法时，系统会自动访问 "/WEB-INF/jsp/" 路径下名称为 first 的 JSP 文件。

  • 启动项目，测试应用

将项目发布到 Tomcat 服务器并启动，在浏览器中访问地址:http://localhost:8888/springmvc02/hello/firstController，其显示效果如图所示。


从图中可以看出，通过注解的方式 ， 同样实现了第一个 Spring MVC 程序的运行。

本章小结

本章主要对 Spring MVC 的核心类及其相关注解的使用进行了详细的讲解。 首先介绍了 DispatcherServlet 的作用和配置;然后介绍了 Controller 和 RequestMapping 注解类型的相关知识;最后讲解了视图解析器的定义和配置，并通过一个应用案例，将本章所讲解的内容进行了一个全面总结。 通过本章的学习，大家能够了解 Spring MVC 核心类的作用，并掌握 Spring MVC 常用注解的使用。

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 218,546评论 6赞 507
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 93,224评论 3赞 395
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 164,911评论 0赞 354
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,737评论 1赞 294
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,753评论 6赞 392
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,598评论 1赞 305
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,338评论 3赞 418
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,249评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,696评论 1赞 314
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3赞 336
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,731评论 5赞 346
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,348评论 3赞 330
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1赞 270
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3赞 370
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2赞 355

推荐阅读更多精彩内容