SpringMVC的视图和视图解析器

Java知识点总结：想看的可以从这里进入

2.4、视图、视图解析器

视图是渲染数据模型并将内容展示给用户，而视图解析器是将逻辑视图解析成真正的视图。

Spring MVC 支持 ModelAndView、Model、Map、View、String 多种类型的返回值，但无论控制器方法的返回值是哪种类型，Spring MVC 内部最终都会将它们封装成一个 ModelAndView 对象，它由 model（模型数据）和 view（逻辑视图名）两部分组成，所以 Spring MVC 需要借助 ViewResolver（视图解析器）将 逻辑视图名解析为真正的 View 视图对象，然后才能响应给客户端展示。

Spring MVC 的核心理念是将 视图与 数据模型进行解耦，视图技术随场景选择：Thymeleaf、JSP、FreeMarker、Velocity、Excel 等等。其中spring6已经取消了对JSP、FreeMarker的支持。

2.4.1、视图

视图是用来展示数据模型的。SpringMVC中定义了多种视图，但是它们都需要满足一个视图接口：View：

public interface View {
    /**
	 * 包含响应状态代码的HttpServletRequest属性的名称
	 */
    String RESPONSE_STATUS_ATTRIBUTE = View.class.getName() + ".responseStatus";

    /**
	 * 包含带有路径变量的 Map 的HttpServletRequest属性的名称
	 */
    String PATH_VARIABLES = View.class.getName() + ".pathVariables";

    /**
	 *选择响应内容类型
	 */
    String SELECTED_CONTENT_TYPE = View.class.getName() + ".selectedContentType";

    /**
	 * 响应客户端的类型，可以使HTML、JSON、PDF等等
	 */
    @Nullable
    default String getContentType() {
        return null;
    }
    /**
	 *渲染的方法， model数据模型
	 */
    void render(@Nullable Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)
        throws Exception;

}

当控制器返回ModelAndView时，解析器进行解析，将数据模型传给 render 方法，进行视图渲染。SpringMVC中的视图很多，但常用的视图的实现类有：

实现类	说明
ThymeleafView	Thymeleaf 视图。使用 Thymeleaf 时，需要使用该视图类。
InternalResourceView	转发视图，通过它可以实现请求的转发跳转。它也是 JSP 视图。
RedirectView	重定向视图，通过它可以实现请求的重定向跳转。
FreeMarkerView	FreeMarker 视图.
MappingJackson2JsonView	JSON 视图。
AbstractPdfView	PDF 视图 。

视图一般分为两类:

• 逻辑视图：view 是一个字符串的逻辑视图名，需要解析。

  比如说ThymeleafView，它需要视图解析器根据配置去寻找我们完成的实际页面进行渲染

  //这两种方式返回的都是逻辑视图
  @RequestMapping("/test")
  public String test1(Model model) {
      return "success";
  }
  @RequestMapping("/test")
  public ModelAndView test1() {
      ModelAndView modelAndView = new ModelAndView();
      modelAndView.setViewName("success");
      return modelAndView;
  }
  

• 非逻辑视图：返回的是一个真正的视图对象，不需要解析

  如 MappingJackson2JsonView ，它返回的是JSON数据，不需要解析就可以将JSON视图直接展示给用户

  @RequestMapping("/test")
  @ResponseBody
  public ModelAndView test(d) {
      return "返回字符串";
  }
  

2.4.2、视图解析器

视图解析器用来解析逻辑视图，将其解析成真正的视图。

SpringMVC 提供了一个视图解析器的接口 ViewResolver，所有具体的视图解析器必须实现该接口。

public interface ViewResolver {
    /**
	 * 按名称解析给定的视图。,locale配置国际化，viewName就是传递的逻辑视图名字
	 */
    @Nullable
    View resolveViewName(String viewName, Locale locale) throws Exception;

}

SpringMVC中也有很多不同的视图解析器，

视图解析器	说明
BeanNameViewResolver	将视图解析后，映射成一个 Bean，视图的名称就是 Bean 的 id。
InternalResourceViewResolver	JSP的视图解析器，映射一个 JSP 文件。
FreeMarkerViewResolver	FreeMarker 视图解析器，映射成一个 FreeMarker 模板文件。
ThymeleafViewResolver	Thymeleaf视图解析器，映射成一个 Thymeleaf 模板文件。

使用它们需要在XML中进行配置，配置前缀和后缀后，就可以在Controller中使用了，它解析的路径是：前缀+方法中返回的路径+后缀，就能解析到一个真正的视图。

视图解析器也可以同时配置多个，其中可以使用 order 指定它们之间的解析优先级顺序，Spring MVC 会遍历所有视图解析器，并按照其优先级依次对逻辑视图名进行解析，直到解析成功并返回视图对象为止。

<!--视图解析器 解析jsp文件,假如视图名为hello，则页面为/WEB-INF/hello.jsp-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <!--逻辑视图名的规则，当控制器方法返回的逻辑视图名是以jsppage/开头时，它所对应的视图解析器才对视图进行解析。-->
    <property name="viewNames" value="jsppage/*"/>
    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
    <!--视图解析器的优先级，值越小，优先级越高-->
    <property name="order" value="2"/>
    <property name="prefix" value="/WEB-INF/"/>
    <property name="suffix" value=".jsp"/>
</bean>

<!--视图解析器 解析thymeleaf -->
<bean class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
    <!--视图解析器的优先级，值越小，优先级越高-->
    <property name="order" value="1"/>
     <!--定义视图文件的字符集-->
    <property name="characterEncoding" value="UTF-8"/>
    <!--配置前后缀-->
    <property name="templateEngine">
        <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
            <property name="templateResolver">
                <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                    <!-- 视图前缀 -->
                    <property name="prefix" value="/WEB-INF/templates/"/>
                    <!-- 视图后缀 -->
                    <property name="suffix" value=".html"/>
                    <property name="templateMode" value="HTML5"/>
                    <property name="characterEncoding" value="UTF-8"/>
                </bean>
            </property>
        </bean>
    </property>
</bean>