springMVC(7) ViewResolver实现之VelocityViewResolver

ViewResolver

springMVC的主流程我们可以大概将其概括为如下:

  1. 初始化
  2. HandlerMapping找到对应handler
  3. HandlerAdapter执行handler
  4. 通过ViewResolver找到viewName对应的view
  5. 使用view.render进行视图渲染

前面已经阅读了HandlerMapping和HandlerAdapter部分的源码,那接下来就是ViewResolver部分的源码。

首先是看一下ViewResolver接口的源码,

public interface ViewResolver {
   View resolveViewName(String viewName, Locale locale) throws Exception;
}

ViewResolver接口只有一个方法resolveViewName,也就是说ViewResolver的作用只有一个,就是将viewName解析成相应的view。

VelocityViewResolver

ViewResolver有许多不同的实现,这次我选择了阅读velocity的实现。

类图

VelocityViewResolver类图

执行过程

我下面按照VelocityViewResolver的执行顺序,将有关的主要方法都整合起来,

// AbstractCachingViewResolver
// 这个方法主要是做了一个缓存的功能。若已经存在,则直接取出;否则调用createView创建视图并将其缓存
public View resolveViewName(String viewName, Locale locale) throws Exception {
   if (!isCache()) {     // 判断是否使用缓存。可以通过设置cacheLimit属性为0来关闭缓存功能
      return createView(viewName, locale);
   }
   else {
      Object cacheKey = getCacheKey(viewName, locale);
      View view = this.viewAccessCache.get(cacheKey);
      if (view == null) {  // 此处的判断可以减少同步对于性能的影响
         synchronized (this.viewCreationCache) {
            view = this.viewCreationCache.get(cacheKey);
            if (view == null) {  // 没有缓存则创建view
               view = createView(viewName, locale);
               if (view == null && this.cacheUnresolved) {
                  view = UNRESOLVED_VIEW;
               }
               if (view != null) {   // 将新建的view添加进缓存
                  this.viewAccessCache.put(cacheKey, view);
                  this.viewCreationCache.put(cacheKey, view);
                  if (logger.isTraceEnabled()) {
                     logger.trace("Cached view [" + cacheKey + "]");
                  }
               }
            }
         }
      }
      return (view != UNRESOLVED_VIEW ? view : null);
   }
}

// UrlBasedViewResolver
protected View createView(String viewName, Locale locale) throws Exception {
   // 判断是否可以处理viewName,此处与viewNames属性有关,若未设置则默认可以
   if (!canHandle(viewName, locale)) {   
      return null;
   }
  
   // 对于redirect:开头的
   if (viewName.startsWith(REDIRECT_URL_PREFIX)) {
      String redirectUrl = viewName.substring(REDIRECT_URL_PREFIX.length());
      RedirectView view = new RedirectView(redirectUrl, isRedirectContextRelative(), isRedirectHttp10Compatible());
      return applyLifecycleMethods(viewName, view);
   }
  
   // 对于forward:开头的
   if (viewName.startsWith(FORWARD_URL_PREFIX)) {
      String forwardUrl = viewName.substring(FORWARD_URL_PREFIX.length());
      return new InternalResourceView(forwardUrl);
   }
  
   // 对于一般的情况
   return super.createView(viewName, locale);
}

// AbstractCachingViewResolver
// 调用loadView
protected View createView(String viewName, Locale locale) throws Exception {
   return loadView(viewName, locale);
}

// UrlBasedViewResolver
protected View loadView(String viewName, Locale locale) throws Exception {
   // 根据viewName创建出相应的view
   AbstractUrlBasedView view = buildView(viewName);
   View result = applyLifecycleMethods(viewName, view);
   // 此处会对创建出的view进行检查,判断是否存在相应资源
   return (view.checkResource(locale) ? result : null);
}

// UrlBasedViewResolver
// 由下面AbstractTemplateViewResolver的buildView方法调用
protected AbstractUrlBasedView buildView(String viewName) throws Exception {
   AbstractUrlBasedView view = (AbstractUrlBasedView) BeanUtils.instantiateClass(getViewClass());
  
   /* 设置view相应属性 */
   view.setUrl(getPrefix() + viewName + getSuffix()); // 将 前缀+viewName+后缀 拼接在一起构成url
   String contentType = getContentType();
   if (contentType != null) {
      view.setContentType(contentType);
   }
   view.setRequestContextAttribute(getRequestContextAttribute());
   view.setAttributesMap(getAttributesMap());
   if (this.exposePathVariables != null) {
      view.setExposePathVariables(exposePathVariables);
   }
   return view;
}

// AbstractTemplateViewResolver
// 由下面VelocityViewResolver的buildView方法调用
protected AbstractUrlBasedView buildView(String viewName) throws Exception {
   AbstractTemplateView view = (AbstractTemplateView) super.buildView(viewName);
  /* 设置相应属性 */
   view.setExposeRequestAttributes(this.exposeRequestAttributes);
   view.setAllowRequestOverride(this.allowRequestOverride);
   view.setExposeSessionAttributes(this.exposeSessionAttributes);
   view.setAllowSessionOverride(this.allowSessionOverride);
   view.setExposeSpringMacroHelpers(this.exposeSpringMacroHelpers);
   return view;
}

// VelocityViewResolver
protected AbstractUrlBasedView buildView(String viewName) throws Exception {
   VelocityView view = (VelocityView) super.buildView(viewName);
   /* 设置相应属性 */
   view.setDateToolAttribute(this.dateToolAttribute);
   view.setNumberToolAttribute(this.numberToolAttribute);
   if (this.toolboxConfigLocation != null) {
      ((VelocityToolboxView) view).setToolboxConfigLocation(this.toolboxConfigLocation);
   }
   return view;
}

用文字分析一下这个流程,如下:

  1. 先在缓存中查找
  2. 通过canHandle方法来判断是否解析
  3. 对于redirect和forward的方式进行单独处理
  4. 创建一个view实例,对该view进行各项属性的设置,例如url,contentType等
  5. 调用view的checkResource方法判断该view是否存在
  6. 将view存入缓存

总结

我们可以从源码中知道下面一些比较有用的信息:

  1. ViewResolver有一个缓存机制
    • 该缓存可以通过设置cacheLimit属性来控制最大容量,若cacheLimit为0,则不设置缓存
    • 该缓存会对不存在的viewName也同样进行缓存的
  2. ViewResolver可以通过设置viewNames属性来做viewName的拦截设置
  3. ViewResolver需要自己设置prefix和suffix属性来确定资源,也就是如果后缀名设置成jsp,也同样会去寻找jsp文件当作velocity文件来解析

ViewResolver的缓存机制

写着写着,发现ViewResolver采用了很特别的缓存机制,ViewResolver采用了两个缓存,其中第一个采用ConcurrentHashMap,第二个使用了LinkedHashMap。此处其实LinkedHashMap是为了做容量限制用的。因为ConcurrentHashMap支持并发,而LinkedHashMap支持容量限制,于是将通过LinkedHashMap的容量限制功能来实现ConcurrentHashMap的容量限制。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342