SpringMVC中的ModelAndView与视图解析器详解

### Spring MVC 中的 ModelAndView 与视图解析器详解 #### 1. ModelAndView 概述 Spring 的 MVC 框架围绕处理器（控制器）返回 `org.springframework.web.servlet.ModelAndView` 对象的概念构建。`ModelAndView` 因其包含的内容而得名，借助模型，视图应能够渲染出合适的响应并返回给客户端。 模型是一个映射，包含键（字符串）和对应的值，代表条目的实际值。在渲染视图时，该映射会根据所使用的视图技术而可用（例如，使用 Velocity 时在 `VelocityContext` 中，使用 JSP 时在请求上下文中）。 处理请求应返回一个 `ModelAndView` 对象。`DispatcherServlet` 知道如何使用 `ModelAndView` 对象，最终需要一个具体的 `org.springframework.web.servlet.View` 实例来负责渲染视图，例如 JavaServer Page 或 Velocity 模板。可以使用具体的视图对象或逻辑名称来构建 `ModelAndView` 对象。为了从逻辑视图名称获取视图，会使用 `org.springframework.web.servlet.view.ViewResolver`。视图解析器管理逻辑视图名称与其对应的具体 `View` 对象之间的映射。`ViewResolver` 接口的不同实现，在实际进行映射时具有不同的行为。 #### 2. 不同的视图解析器 ##### 2.1 UrlBasedViewResolvers `org.springframework.web.servlet.view.UrlBasedViewResolver` 将逻辑视图名称直接映射到 URL，并将其传递给指定的视图类。视图类再使用该 URL 来渲染响应。URL 可以指向 JavaServer Page、Velocity 模板或 XSLT 样式表等。可以通过以下几种方式配置 `UrlBasedViewResolver`： - 首先需要指定一个视图类，该视图类最终将渲染视图（如 JSP、Velocity 模板等）。 - 还可以使用前缀和后缀来调整 URL 的创建方式。 `UrlBasedViewResolver` 有两种形式：`InternalResourceViewResolver` 和 `VelocityViewResolver`，它们之间只有细微的差别。 - `InternalResourceViewResolver` 是一个方便的解析器，它已经设置了一个特定的视图类（`InternalResourceView`），但仍然允许你覆盖它。 - `VelocityViewResolver` 会将一些特定于 Velocity 的属性应用于它创建的所有视图，同样也允许你覆盖这些属性，其中包括 `NumberTool` 和 `DateTool` 对象，它们可以方便地格式化数字和日期。 示例代码如下： ```xml <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="viewClass"> <value>org.springframework.web.servlet.view.JstlView</value> </property> <property name="prefix"><value>/WEB-INF/jsps</value></property> <property name="suffix"><value>.jsp</value></property> </bean> ``` 这将使逻辑视图名称 `welcome` 映射到 `/WEB-INF/jsps/welcome.jsp`。指定的 `JstlView` 类将导致一个特殊的 Java 标准标签库对象合并到请求上下文中。 ##### 2.2 BeanNameViewResolver 和 XmlViewResolver `org.springframework.web.servlet.view.BeanNameViewResolver` 和 `org.springframework.web.servlet.view.XmlViewResolver` 都提供了从 `BeanFactory` 中检索视图的功能。 - `BeanNameViewResolver` 仅查询其声明所在的 `BeanFactory`。 ```xml <bean id="welcome" class="org.springframework.web.servlet.view.JstlView"> <property name="url"><value>/WEB-INF/jsps/welcome.jsp</value></property> </bean> <bean class="org.springframework.web.servlet.view.BeanNameViewResolver"/> ``` 假设使用上述配置，当返回逻辑视图名称 `welcome` 时，`BeanNameViewResolver` 将从上下文中检索视图 bean 并使用它来渲染 JSP。 - `XmlViewResolver` 基本行为与 `BeanNameViewResolver` 相同，但有一个区别：当需要视图时，会实例化并检查一个专门用于保存视图的 `BeanFactory`。这意味着你必须在单独的文件中声明 bean，例如 `/WEB-INF/views/views.xml`，并按如下方式配置 `XmlViewResolver`： ```xml <bean class="org.springframework.web.servlet.view.XmlViewResolver"> <property name="location"><value>/WEB-INF/views/views.xml</value></property> </bean> ``` ##### 2.3 ResourceBundleViewResolver `org.springframework.web.servlet.view.ResourceBundleViewResolver` 的行为与 `XmlViewResolver` 相似，但使用前者时，会使用包含 bean 定义的资源束而不是 XML 文件。`ResourceBundleViewResolver` 允许根据用户请求中的区域设置提供本地化视图。 示例代码如下： ```properties # /WEB-INF/classes/views.properties index.class=org.springframework.web.servlet.view.JstlView index.url=/WEB-INF/jsps/index.jsp welcome.url=/WEB-INF/jsps/welcome.jsp store.url=/WEB-INF/jsps/store.jsp # /WEB-INF/classes/views_nl.properties welcome.url=/WEB-INF/jsps/nl/welcome.jsp ``` ```xml <bean class="org.springframework.web.servlet.view.ResourceBundleView"> <property name="baseName"><value>views</value></property> <property name="defaultParentView"><value>index</value></property> </bean> ``` 上述代码示例展示了两个属性文件，其中一个是默认文件，包含三个视图，第二个文件为特定语言覆盖了一个视图。需要注意的是，最好不要提供单独的 JSP 来进行本地化，而是使用 JSTL 本地化标签或 Spring 消息标签对 JSP 本身进行本地化。 启动时，视图解析器将使用 bean 定义中指定的基名加载资源束。视图将根据与请求关联的区域设置进行解析。视图解析器的 bean 定义中还定义了一个 `defaultParentView`。由于在定义每个视图时指定视图类会很麻烦，因此对于任何缺失的值（如视图类），将使用默认父视图。当然，始终可以进行覆盖。 #### 3. 视图解析器链 虽然在大多数情况下一个视图解析器就足够了，但 Spring 提供了将视图解析器链接起来的可能性。在需要备用方案、支持不同的视图技术或模板存储在不同位置等情况下，链接视图解析器是理想的选择。 Spring 对视图解析器链的约定是，如果一个视图解析器从 `resolveViewName()` 方法返回 `null`，它将开始寻找其他视图解析器，让它们尝试解析视图。 在展示如何链接视图解析器的示例之前，需要知道有些视图解析器总是尝试解析视图名称，而不考虑底层资源是否存在。所有将控制权交给引擎或其他机制的视图解析器都属于这种情况，因为在资源不存在时，这些机制不会通知视图解析器。具体来说，所有 `UrlBasedViewResolvers`（如 `InternalResourceViewResolver`、`FreeMarkerViewResolver` 和 `VelocityViewResolver`）都属于这种情况。因此，这些视图解析器必须始终位于链的末尾。 ##### 3.1 覆盖特定视图 以下示例展示了如何使用两个视图解析器：一个基于 bean 名称，另一个基于内部资源。此示例展示了如何仅覆盖一个视图。在这种情况下，我们希望将一个特定请求的结果以 Excel 文件而不是 JSP 生成的 HTML 页面呈现。 ```xml <bean id="viewResolverOne" class="org.springframework.web.servlet.view.BeanNameViewResolver"> <property name="order"><value>1</value></property> </bean> <bean id="viewResolverTwo" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="order"><value>2</value></propert ```