day04-视图和视图解析器

打印 上一主题 下一主题

主题 767|帖子 767|积分 2301

视图和视图解析器

1.基本介绍


  • 在SpringMVC中的目标方法,最终返回的都是一个视图(有各种视图)
    注意,这里的视图是一个类对象,不是一个页面!!

  • 返回的视图都会由一个视图解析器来处理(视图解析器有很多种)

2.自定义视图

2.1为什么需要自定义视图


  • 在默认情况下,我们都是返回默认的视图,然后返回的视图交由 SpringMVC 的 InternalResourcesViewResolver 默认视图解析器来处理的:

  • 在实际开发中,因为业务需求,我们有时候需要自定义视图解析器
  • 视图解析器可以配置多个,按照指定的顺序来对视图进行解析。如果上一个视图解析器不匹配,下一个视图解析器就会去解析视图,以此类推。
2.2应用实例

执行流程:

  • view.jsp,请求到 Handler
    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <html>
    3. <head>
    4.     <title>自定义视图测试</title>
    5. </head>
    6. <body>
    7. <h1>自定义视图测试</h1>
    8. <a target="_blank" href="https://www.cnblogs.com/goods/buy">点击到自定义视图</a>
    9. </body>
    10. </html>
    复制代码
  • GoodsHandler.java
    1. package com.li.web.viewresolver;
    2. import org.springframework.stereotype.Controller;
    3. import org.springframework.web.bind.annotation.RequestMapping;
    4. /**
    5. * @author 李
    6. * @version 1.0
    7. */
    8. @RequestMapping(value = "/goods")
    9. @Controller
    10. public class GoodsHandler {
    11.     @RequestMapping(value = "/buy")
    12.     public String buy(){
    13.         System.out.println("----------buy()---------");
    14.         return "liView";//自定义视图名
    15.     }
    16. }
    复制代码
  • 自定义视图 MyView.java
    1. package com.li.web.viewresolver;
    2. import org.springframework.stereotype.Component;
    3. import org.springframework.web.servlet.view.AbstractView;
    4. import javax.servlet.http.HttpServletRequest;
    5. import javax.servlet.http.HttpServletResponse;
    6. import java.util.Map;
    7. /**
    8. * @author 李
    9. * @version 1.0
    10. * 1. MyView 继承了AbstractView,就可以作为了一个视图使用
    11. * 2. @Component(value = "myView") ,该视图会注入到容器中,id为 liView
    12. */
    13. @Component(value = "liView")
    14. public class MyView extends AbstractView {
    15.     @Override
    16.     protected void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) throws Exception {
    17.         //1.完成视图渲染
    18.         System.out.println("进入到自己的视图...");
    19.         //2.并且确定我们要跳转的页面,如 /WEB-INF/pages/my_view.jsp
    20.         /*
    21.          * 1.下面就是请求转发到 /WEB-INF/pages/my_view.jsp
    22.          * 2.该路径会被springmvc解析成 /web工程路径/WEB-INF/pages/my_view.jsp
    23.          */
    24.         request.getRequestDispatcher("/WEB-INF/pages/my_view.jsp")
    25. <context:component-scan base-package="com.li.web"/>
    26. <bean >
    27.    
    28.     <property name="prefix" value="/WEB-INF/pages/"/>
    29.     <property name="suffix" value=".jsp"/>
    30. </bean>
    31. <bean >
    32.     <property name="order" value="99"/>
    33. </bean>
    34. <mvc:annotation-driven></mvc:annotation-driven>
    35. <mvc:default-servlet-handler/>.forward(request, response);
    36.     }
    37. }
    复制代码
  • 结果页面 my_view.jsp
    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <html>
    3. <head>
    4.     <title>my_view</title>
    5. </head>
    6. <body>
    7. <h1>进入到my_view页面</h1>
    8. <p>从自定义视图来的...</p>
    9. </body>
    10. </html>
    复制代码
  • springDispatcherServlet-servlet.xml 配置自定义视图解析器
    1. <context:component-scan base-package="com.li.web"/>
    2. <bean >
    3.    
    4.     <property name="prefix" value="/WEB-INF/pages/"/>
    5.     <property name="suffix" value=".jsp"/>
    6. </bean>
    7. <bean >
    8.     <property name="order" value="99"/>
    9. </bean>
    10. <mvc:annotation-driven></mvc:annotation-driven>
    11. <mvc:default-servlet-handler/>
    复制代码
  • 测试,访问view.jsp,点击超链接

  • 成功跳转到 my_view.jsp

  • 后台输出如下:说明整个执行流程如图所示。

2.3创建自定义视图的步骤


  • 自定义一个视图:创建一个 View 的 bean,该 bean 需要继承自 AbstractView,并实现renderMergedOutputModel方法
  • 并把自定义 View 加入到 IOC 容器中
  • 自定义视图的视图解析器,使用 BeanNameViewResolver,这个视图解析器也需要配置到 ioc 容器文件中
  • BeanNameViewResolver 的调用优先级需要设置一下,设置 order 比 Integer.MAX_VALUE 小的值,以确保其在默认的视图解析器之前被调用
2.4Debug源码-自定义视图解析器执行流程

自定义视图-工作流程:

  • SpringMVC 调用目标方法,返回自定义 View 在 IOC 容器中的 id
  • SpringMVC 调用 BeanNameViewResolver 视图解析器:从 IOC 容器中获取返回 id 值对应的 bean,即自定义的 View 的对象
  • SpringMVC 调用自定义视图的 renderMergedOutputModel 方法,渲染视图
  • 说明:如果 SpringMVC 调用 Handler 的目标方法时,返回的自定义 View ,在 IOC 容器中的 id 不存在,则仍然按照默认的视图解析器机制处理。
Debug-01
(1)在GoodsHandler的目标方法中打上断点:
(2)点击debug,访问view.jsp,点击超链接,可以看到后台光标跳转到断点处:
(3)在源码 BeanNameViewResolver 的 resolveViewName 方法处打上断点:
(4)点击Resume,光标跳转到了这个断点处,viewName 的值就是自定义视图对象的 id:这里完成视图解析
resolveViewName 方法如下:
  1. @Override
  2. @Nullable
  3. public View resolveViewName(String viewName, Locale locale) throws BeansException {
  4.    //获取ioc容器对象
  5.    ApplicationContext context = obtainApplicationContext();
  6.    //如果容器对象中不存在 目标方法返回的自定义视图对象id
  7.    if (!context.containsBean(viewName)) {
  8.       // Allow for ViewResolver chaining...
  9.       //就返回null,让默认的视图解析器处理该视图
  10.       return null;
  11.    }
  12.    //判断自定义的视图是不是 org.springframework.web.servlet.View 类型
  13.    if (!context.isTypeMatch(viewName, View.class)) {
  14.       //如果不是
  15.       if (logger.isDebugEnabled()) {
  16.          logger.debug("Found bean named '" + viewName + "' but it does not implement View");
  17.       }
  18.       // Since we're looking into the general ApplicationContext here,
  19.       // let's accept this as a non-match and allow for chaining as well...
  20.       return null;
  21.    }
  22.    //如果是,就返回这个自定义视图对象
  23.    return context.getBean(viewName, View.class);
  24. }
复制代码
(5)在自定义视图对象里打上断点:
(6)点击 resume,光标跳转到该断点:在这里完成视图渲染,并转发到结果页面
(7)最后由 tomcat 将数据返回给客户端:
2.5Debug源码-默认视图解析器执行流程

将默认视图解析器的优先级调高:
debug-02
(1)仍然在GoodsHandler中添加断点:
(2)浏览器访问 view.jsp,可以看到后台光标跳转到了断点处:
(3)分别在默认视图解析器(InternalResourceViewResolver)和自定义视图解析器(BeanNameViewResolver) 中的方法中打上断点:
(4)点击resume,可以看到光标先跳到了默认视图解析器的 buildView 方法中:因为默认解析器的优先级在之前设置为最高。
buildView 方法:
  1. @Override
  2. protected AbstractUrlBasedView buildView(String viewName) throws Exception {
  3.    //根据目标方法返回的viewName创建一个View对象
  4.    InternalResourceView view = (InternalResourceView) super.buildView(viewName);
  5.    if (this.alwaysInclude != null) {
  6.       view.setAlwaysInclude(this.alwaysInclude);
  7.    }
  8.    view.setPreventDispatchLoop(true);
  9.    return view;
  10. }
复制代码
这个 View 对象的 url 是按照你配置的前缀和后缀,拼接完成的 url
(5)之后就会到该View对象进行视图渲染,然后由Tomcat将数据返回给客户端。
但是如果该url下没有/WEB-INF/pages/liView.jsp文件,就会报错:
2.6Debug源码-自定义View不存在,会走默认视图解析机制

视图解析器可以配置多个,按照指定的顺序来对视图进行解析。如果上一个视图解析器不匹配,下一个视图解析器就会去解析视图,以此类推:

  • 在容器文件中,将默认的视图解析器调用优先级降低,提高自定义视图解析器的调用优先级。见2.2的容器文件配置
  • 删除2.2中的自定义视图MyView.java。也就是说,自定义视图解析器解析目标方法返回的视图对象时,将会无法解析该视图,因为它不存在。
  • 这时就会去调用下一个优先级的视图解析器,即默认视图解析器。
debug-03
(1)仍然在GoodsHandler中添加断点:
(2)浏览器访问 view.jsp,可以看到后台光标跳转到了断点处:
(3)在自定义的视图解析器 BeanNameViewResolver 中打上断点:
(4)点击resume,可以看到光标跳转到该断点处:
(5)因为在容器文件中找不到该视图对象的id了,因此会进入第一个分支,方法直接返回 null
(6)点击step over,光标跳转到中央控制器的 resolveViewName 方法中:
  1. @Nullable
  2. protected View resolveViewName(String viewName, @Nullable Map<String, Object> model,
  3.       Locale locale, HttpServletRequest request) throws Exception {
  4.    if (this.viewResolvers != null) {
  5.       //循环调用视图解析器,直到某个视图解析器返回的view不为null
  6.       for (ViewResolver viewResolver : this.viewResolvers) {
  7.          View view = viewResolver.resolveViewName(viewName, locale);
  8.          if (view != null) {
  9.             return view;
  10.          }
  11.       }
  12.    }
  13.    return null;
  14. }
复制代码
因为自定义视图解析器会返回 null,因此这里进入第二次循环,由默认的视图解析器去进行解析,然后返回对应的视图:
(7)在该方法中打上断点,点击 resume,可以看到此时 view 是由默认的视图解析器返回的视图对象,走的是默认机制。
(8)下一个就按照默认机制拼接的 url 去访问该页面,并进行渲染。然后由Tomcat返回给客户端。如果根据 url 找不到该页面,就报404错误。
补充:如果默认视图解析器优先级高,自定义的视图解析器优先级低,但是默认视图解析器返回的的View为null,这时候会继续调用自定义的视图解析器吗?
答:事实上,默认视图解析器返回的 View 不会为 null。
因为它是根据目标方法返回的字符串+你配置的前后缀进行 url 的拼接。只要目标方法返回了一个字符串,默认视图处理器就不会返回 null。
如果目标方法返回的是 null 呢?将会以目标方法的路径名称+配置的前后缀作为寻找页面的 url
因此在循环调用视图处理器的时候,一旦循环到默认视图处理器,就不会调用后面的自定义视图解析器。
3.目标方法直接指定转发或重定向

3.1使用实例

目标方法中指定转发或者重定向:

  • 默认返回的方式是请求转发,然后用视图处理器进行处理。
  • 但是也可以在目标方法中直接指定重定向或者转发的 url 的地址。
  • 注意:如果指定重定向,则不能定向到 /WEB-INF 目录中。因为该目录为 Tomcat 的内部目录。
例子

  • view.jsp
    1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    2. <html>
    3. <head>
    4.     <title>请求转发或重定向</title>
    5. </head>
    6. <body>
    7. <h1>请求转发或重定向</h1>
    8. <a target="_blank" href="https://www.cnblogs.com/goods/order">测试在目标方法找中指定请求转发或重定向</a>
    9. </body>
    10. </html>
    复制代码
  • GoodsHandler.java
    1. package com.li.web.viewresolver;
    2. import org.springframework.stereotype.Controller;
    3. import org.springframework.web.bind.annotation.RequestMapping;
    4. /**
    5. * @author 李
    6. * @version 1.0
    7. */
    8. @RequestMapping(value = "/goods")
    9. @Controller
    10. public class GoodsHandler {
    11.     //演示直接指定请求转发或者重定向
    12.     @RequestMapping(value = "/order")
    13.     public String order() {
    14.         System.out.println("=========order()=========");
    15.         //请求转发到 /WEB-INF/pages/my_view.jsp
    16.         //下面的路径会被解析/web工程路径/WEB-INF/pages/my_view.jsp
    17.         return "forward:/WEB-INF/pages/my_view.jsp";
    18.     }
    19. }
    复制代码
  • 访问 view.jsp,点击超链接:

  • 成功进入到请求转发的页面:
    请求转发也可以转发到WEB-INF目录之外的页面。

  • 修改 GoodsHandler.java 的 order 方法:
    1. //演示直接指定请求转发或者重定向
    2. @RequestMapping(value = "/order")
    3. public String order() {
    4.     System.out.println("=========order()=========");
    5.     //重定向
    6.     //1.对于重定向来说,不能重定向到/WEB-INF/目录下
    7.     //2.redirect 为重定向的关键字
    8.     //3./login.jsp 是在服务器解析的,解析为 /web工程路径/login.jsp
    9.     return "redirect:/login.jsp";
    10. }
    复制代码
  • redeployTomcat,访问 view.jsp,点击超链接,可以看到成功重定向到 login.jsp页面

3.2Debug-指定请求转发流程分析


免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x
回复

使用道具 举报

0 个回复

正序浏览

快速回复

您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

海哥

金牌会员
这个人很懒什么都没写!

标签云

快速回复 返回顶部 返回列表