读书人
栏目▼

Spring MVC学习之5:总结

发布时间： 2013-02-24 17:58:56 作者： rapoo

Spring MVC学习之五:总结

一个简单的基于注解的 Controller

使用过低版本 Spring MVC 的读者都知道：当创建一个 Controller 时，我们需要直接或间接地实现 org.springframework.web.servlet.mvc.Controller 接口。一般情况下，我们是通过继承 SimpleFormController 或 MultiActionController 来定义自己的 Controller 的。在定义 Controller 后，一个重要的事件是在 Spring MVC 的配置文件中通过 HandlerMapping 定义请求和控制器的映射关系，以便将两者关联起来。

来看一下基于注解的 Controller 是如何定义做到这一点的，下面是使用注解的 BbtForumController：


清单 1. BbtForumController.java
                package com.baobaotao.web;import com.baobaotao.service.BbtForumService;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.ModelAttribute;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;import java.util.Collection;@Controller                   //<——①@RequestMapping("/forum.do")public class BbtForumController {    @Autowired    private BbtForumService bbtForumService;    @RequestMapping //<——②    public String listAllBoard() {        bbtForumService.getAllBoard();        System.out.println("call listAllBoard method.");        return "listBoard";    }}

从上面代码中，我们可以看出 BbtForumController 和一般的类并没有区别，它没有实现任何特殊的接口，因而是一个地道的 POJO。让这个 POJO 与众不同的魔棒就是 Spring MVC 的注解！

在 ① 处使用了两个注解，分别是 @Controller 和 @RequestMapping。在“使用 Spring 2.5 基于注解驱动的 IoC”这篇文章里，笔者曾经指出过 @Controller、@Service 以及 @Repository 和 @Component 注解的作用是等价的：将一个类成为 Spring 容器的 Bean。由于 Spring MVC 的 Controller 必须事先是一个 Bean，所以 @Controller 注解是不可缺少的。

真正让 BbtForumController 具备 Spring MVC Controller 功能的是 @RequestMapping 这个注解。@RequestMapping 可以标注在类定义处，将 Controller 和特定请求关联起来；还可以标注在方法签名处，以便进一步对请求进行分流。在 ① 处，我们让 BbtForumController 关联“/forum.do”的请求，而 ② 处，我们具体地指定 listAllBoard() 方法来处理请求。所以在类声明处标注的 @RequestMapping 相当于让 POJO 实现了 Controller 接口，而在方法定义处的 @RequestMapping 相当于让 POJO 扩展 Spring 预定义的 Controller（如 SimpleFormController 等）。

为了让基于注解的 Spring MVC 真正工作起来，需要在 Spring MVC 对应的 xxx-servlet.xml 配置文件中做一些手脚。在此之前，还是先来看一下 web.xml 的配置吧：


清单 2. web.xml：启用 Spring 容器和 Spring MVC 框架
                <?xml version="1.0" encoding="UTF-8"?><web-app xmlns="http://java.sun.com/xml/ns/javaee"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee    http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">    <display-name>Spring Annotation MVC Sample</display-name>    <!--  Spring 服务层的配置文件 -->    <context-param>        <param-name>contextConfigLocation</param-name>        <param-value>classpath:applicationContext.xml</param-value>    </context-param>         <!--  Spring 容器启动监听器 -->    <listener>        <listener-class>org.springframework.web.context.ContextLoaderListener        </listener-class>    </listener>    <!--  Spring MVC 的Servlet，它将加载WEB-INF/annomvc-servlet.xml 的    配置文件，以启动Spring MVC模块-->    <servlet>        <servlet-name>annomvc</servlet-name>        <servlet-class>org.springframework.web.servlet.DispatcherServlet        </servlet-class>        <load-on-startup>2</load-on-startup>    </servlet>    <servlet-mapping>        <servlet-name>annomvc</servlet-name>        <url-pattern>*.do</url-pattern>    </servlet-mapping></web-app>

web.xml 中定义了一个名为 annomvc 的 Spring MVC 模块，按照 Spring MVC 的契约，需要在 WEB-INF/annomvc-servlet.xml 配置文件中定义 Spring MVC 模块的具体配置。annomvc-servlet.xml 的配置内容如下所示：

清单 3. annomvc-servlet.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:p="http://www.springframework.org/schema/p"     xmlns:context="http://www.springframework.org/schema/context"    xsi:schemaLocation="http://www.springframework.org/schema/beans     http://www.springframework.org/schema/beans/spring-beans-2.5.xsd    http://www.springframework.org/schema/context     http://www.springframework.org/schema/context/spring-context-2.5.xsd">         <!-- ①：对web包中的所有类进行扫描，以完成Bean创建和自动依赖注入的功能 -->    <context:component-scan base-package="com.baobaotao.web"/>    <!-- ②：启动Spring MVC的注解功能，完成请求和注解POJO的映射 -->    <bean class="org.springframework.web.servlet.mvc.annotation.        AnnotationMethodHandlerAdapter"/>    <!--  ③：对模型视图名称的解析，即在模型视图名称添加前后缀 -->    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"         p:prefix="/WEB-INF/jsp/" p:suffix=".jsp"/></beans>

因为 Spring 所有功能都在 Bean 的基础上演化而来，所以必须事先将 Controller 变成 Bean，这是通过在类中标注 @Controller 并在 annomvc-servlet.xml 中启用组件扫描机制来完成的，如 ① 所示。

在 ② 处，配置了一个 AnnotationMethodHandlerAdapter，它负责根据 Bean 中的 Spring MVC 注解对 Bean 进行加工处理，使这些 Bean 变成控制器并映射特定的 URL 请求。

而 ③ 处的工作是定义模型视图名称的解析规则，这里我们使用了 Spring 2.5 的特殊命名空间，即 p 命名空间，它将原先需要通过 <property> 元素配置的内容转化为 <bean> 属性配置，在一定程度上简化了 <bean> 的配置。

启动 Tomcat，发送 http://localhost/forum.do URL 请求，BbtForumController 的 listAllBoard() 方法将响应这个请求，并转向 WEB-INF/jsp/listBoard.jsp 的视图页面。

回页首

让一个 Controller 处理多个 URL 请求

在低版本的 Spring MVC 中，我们可以通过继承 MultiActionController 让一个 Controller 处理多个 URL 请求。使用 @RequestMapping 注解后，这个功能更加容易实现了。请看下面的代码：

清单 3. 每个请求处理参数对应一个 URL

                package com.baobaotao.web;import com.baobaotao.service.BbtForumService;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;@Controllerpublic class BbtForumController {    @Autowired    private BbtForumService bbtForumService;    @RequestMapping("/listAllBoard.do") // <—— ①    public String listAllBoard() {        bbtForumService.getAllBoard();        System.out.println("call listAllBoard method.");        return "listBoard";    }    @RequestMapping("/listBoardTopic.do") // <—— ②    public String listBoardTopic(int topicId) {        bbtForumService.getBoardTopics(topicId);        System.out.println("call listBoardTopic method.");        return "listTopic";    }}

在这里，我们分别在 ① 和 ② 处为 listAllBoard() 和 listBoardTopic() 方法标注了 @RequestMapping 注解，分别指定这两个方法处理的 URL 请求，这相当于将 BbtForumController 改造为 MultiActionController。这样 /listAllBoard.do 的 URL 请求将由 listAllBoard() 负责处理，而 /listBoardTopic.do?topicId=1 的 URL 请求则由 listBoardTopic() 方法处理。

对于处理多个 URL 请求的 Controller 来说，我们倾向于通过一个 URL 参数指定 Controller 处理方法的名称（如 method=listAllBoard），而非直接通过不同的 URL 指定 Controller 的处理方法。使用 @RequestMapping 注解很容易实现这个常用的需求。来看下面的代码：


清单 4. 一个 Controller 对应一个 URL，由请求参数决定请求处理方法
                package com.baobaotao.web;import com.baobaotao.service.BbtForumService;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;@Controller@RequestMapping("/bbtForum.do")  // <—— ① 指定控制器对应URL请求public class BbtForumController {    @Autowired    private BbtForumService bbtForumService;    // <—— ② 如果URL请求中包括"method=listAllBoard"的参数，由本方法进行处理    @RequestMapping(params = "method=listAllBoard")     public String listAllBoard() {        bbtForumService.getAllBoard();        System.out.println("call listAllBoard method.");        return "listBoard";    }    // <—— ③ 如果URL请求中包括"method=listBoardTopic"的参数，由本方法进行处理    @RequestMapping(params = "method=listBoardTopic")    public String listBoardTopic(int topicId) {        bbtForumService.getBoardTopics(topicId);        System.out.println("call listBoardTopic method.");        return "listTopic";    }}

在类定义处标注的 @RequestMapping 让 BbtForumController 处理所有包含 /bbtForum.do 的 URL 请求，而 BbtForumController 中的请求处理方法对 URL 请求的分流规则在 ② 和 ③ 处定义分流规则按照 URL 的 method 请求参数确定。所以分别在类定义处和方法定义处使用 @RequestMapping 注解，就可以很容易通过 URL 参数指定 Controller 的处理方法了。

@RequestMapping 注解中除了 params 属性外，还有一个常用的属性是 method，它可以让 Controller 方法处理特定 HTTP 请求方式的请求，如让一个方法处理 HTTP GET 请求，而另一个方法处理 HTTP POST 请求，如下所示：


清单 4. 让请求处理方法处理特定的 HTTP 请求方法
                package com.baobaotao.web;import com.baobaotao.service.BbtForumService;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;@Controller@RequestMapping("/bbtForum.do")  public class BbtForumController {    @RequestMapping(params = "method=createTopic",method = RequestMethod.POST)    public String createTopic(){        System.out.println("call createTopic method.");        return "createTopic";    }}

这样只有当 /bbtForum.do?method=createTopic 请求以 HTTP POST 方式提交时，createTopic() 方法才会进行处理。

回页首

处理方法入参如何绑定 URL 参数

按契约绑定

Controller 的方法标注了 @RequestMapping 注解后，它就能处理特定的 URL 请求。我们不禁要问：请求处理方法入参是如何绑定 URL 参数的呢？在回答这个问题之前先来看下面的代码：

清单 5. 按参数名匹配进行绑定

                    @RequestMapping(params = "method=listBoardTopic")    //<—— ① topicId入参是如何绑定URL请求参数的？    public String listBoardTopic(int topicId) {         bbtForumService.getBoardTopics(topicId);        System.out.println("call listBoardTopic method.");        return "listTopic";    }

当我们发送 http://localhost//bbtForum.do?method=listBoardTopic&topicId=10 的 URL 请求时，Spring 不但让 listBoardTopic() 方法处理这个请求，而且还将 topicId 请求参数在类型转换后绑定到 listBoardTopic() 方法的 topicId 入参上。而 listBoardTopic() 方法的返回类型是 String，它将被解析为逻辑视图的名称。也就是说 Spring 在如何给处理方法入参自动赋值以及如何将处理方法返回值转化为 ModelAndView 中的过程中存在一套潜在的规则，不熟悉这个规则就不可能很好地开发基于注解的请求处理方法，因此了解这个潜在规则无疑成为理解 Spring MVC 框架基于注解功能的核心问题。

我们不妨从最常见的开始说起：请求处理方法入参的类型可以是 Java 基本数据类型或 String 类型，这时方法入参按参数名匹配的原则绑定到 URL 请求参数，同时还自动完成 String 类型的 URL 请求参数到请求处理方法参数类型的转换。下面给出几个例子：

读书人网 >VC/MFC

热点推荐

触屏版 | 电脑版

读书人网 m.reader8.net