velocity模板渲染的步骤：

1） 首先初始化启动Velocity引擎，可以通过Velocity.init()或者新建VelocityEngine类，并调用其中的init()方法；

2） 创建一个VelocityContext对象，将变量名与值关联起来，与HashMap对象相类似。可以直接将值传递给页面进行引用；

3） 获取一个模板，利用Velocity.getTemplate()获取一个渲染模板，即要将数据最终渲染在哪个页面上去。

4） 创建一个输出流，将上述创建的数据最终渲染到模板上，采用的方法template.merge()

代码示例：

try {

            Velocity.init("velocity.properties");

            VelocityContext context = new VelocityContext();

            String templateFile = "template.vm";

            context.put("paramObject", "onlyone");

            Template template = null;

            template = Velocity.getTemplate(templateFile);

            BufferedWriter writer = new BufferedWriter(new FileWriter("velocity.data"));

            if (template != null) template.merge(context, writer);

            writer.flush();

            writer.close();

        } catch (Exception e) {

            e.printStackTrace();

        }

原理分析：


整体工作流程图：

1. Velocity引擎初始化及启动

Velocity引擎在启动时,无论是采用Velocity.init()还是采用新建VelocityEngine的方式均会调用RuntimeInstance类中的init方法，通过设置的引擎属性初始化引擎，包括国际化支持，ResourceLoader设置，字符编码来完成一些属性资源及原始指令的加载工作。

1）initializeProperties()方法：初始化velocity的全局属性信息，即velocity.properties中配置的信息。首先会加载velocity自身所带的一个全局velocity.properties文件（org\apache\velocity\runtime\defaults\velocity.properties），若用户自己有写velocity.properties文件，则会将其中已经加载的一些属性覆盖掉。

2）initializeLog()方法：初始化velocity的日志信息。

3）initializeResourceManager()方法：初始化velocity的资源管理。

4）initializeDirectives()方法：初始化velocity中的语法法则。

5）initializeEventHandlers()方法：初始化事件句柄。

6）initializeParserPool()方法：初始化velocity的解析工具。

7）initializeIntrospection()方法：根据所获取到的uberspect名称实例化类。

8）vmFactory.initVelocimacro()方法：实例化VM工厂，它将从运行时中获取属性值，并初始化所有的宏。

2. 查找并解析模板

通过资源加载器（ResourceLoader）将模板文件加载到内存（转化为InputStream），然后通过AST（Abstract Syntax Tree）解析器将InputStream解析为一个AST。上面的代码，当执行Velocity.getTemplate("template.vm")时，首先通过ResourceLoader将以字节流的形式加载template.vm文件，然后通过Parser生成如下Token集合：{[<html> <body> Hello], [$foo], [world! </body> </html> ]}，可以发现velocity根本不关心模板最终要渲染出来的是html还是其他什么东西，在此处对于velocity而言html标签意味着就是纯文本标签。最终构建的AST如下：

根节点下有三个子节点：

[<html> <body> Hello]    对应ASTText节点（纯文本节点）

[$foo]  对应ASTReference节点（需要替换的引用节点）

[world! </body> </html> ] 对应ASTText节点 （纯文本节点）

Velocity引擎在这里有个优化策略，可以针对生成的语法树进行cache

 

深入分析：


  • Velocity为其模板语法定义了一份jjt文件，根据这份jjt文件，使用JJTree生成一个语法解析器。
  • Velocity将模板解析的过程完全交给了语法解析器，调用解析器的parse方法直接得到AST，这一棵AST的每一个节点都对应一个SimpleNode的子类，其中不同的语法元素对应的不同的SimpleNode，比如#if条件表达式对应的SimpleNode是ASTIfStatement，而#stop指令对应的SimpleNode是ASTStop。
  • 得到了AST以后，模板的渲染就比较简单了，无非就是递归地调用各个节点的SimpleNode的render方法来完成模板的渲染过程。

在了解了模板的渲染过程后，那模板上的方法是如何在渲染过程中执行的？对于Velocity里面的引用，比如$Person这样的，最后都被解析成AST中的ASTReference节点，而对于$Person.name这样的，ASTReference下面有一个ASTIdentifier节点，$Person.saySomething()这样的，ASTReference下面有一个ASTMethod节点。不论是ASTMethod还是ASTIdentifier，最后都是通过Uberspect和Introspector这两个类来完成对方法的查找，最后调用各种Executor来实现对方法的调用。

Uberspect这个类的功能是通过反射（Reflection）和内省（Introspection）来完成对需要调用的方法的获取的，而Introspector这个类的功能是根据方法名和方法参数在一个类中查找Method对象。另外，为了提高性能，会对Method的数据进行了缓存（见IntrospectionCacheData，IntrospectorCache和IntrospectorCacheImpl三个类），以便下次快速可以找到。

找到Method以后，具体的方法的执行由各个Executor控制，每一个Executor都继承了AbstractExecutor，给外部提供统一的接口去调用。

3.上下文VelocityContext

将k--v属性对注入到上下文参数中

 VelocityContext context = new VelocityContext();

 context.put("paramObject", "onlyone");

4. 模板渲染，输出字符流

当执行template.merge(context, writer);时，模板遍历其对应的AST树，执行每个节点的渲染过程。如ASTText节点只是简单的将文本写入writer。ASTReference节点需要从context中获取引用的参数paramObject的值onlyone将${paramObject}替换，并写入到writer中。Velocity的AST中有多种节点，如ASTIdentitor等，有些需要反射机制处理。当整个AST遍历结束，也就意味着模板渲染结束，渲染的结果写入writer流中。
Spring与Velocity的整合


Spring MVC是基于DispatcherServlet拦截请求并找到相应的控制器进行业务逻辑处理。Velocity与Spring整合主要需要配置的一些文件。
web.xml 
    <!--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/springDispatcher-servlet.xml 的配置文件，以启动Spring MVC模块-->

    <servlet>

		<servlet-name>springDispatcher</servlet-name>

		<servlet-class>

			org.springframework.web.servlet.DispatcherServlet

		</servlet-class>

		<init-param>

			<param-name>contextConfigLocation</param-name>

			<param-value>

				/WEB-INF/springDispatcher-servlet.xml

			</param-value>

		</init-param>

    </servlet>

    <servlet-mapping>

        <servlet-name>springDispatcher</servlet-name>

        <url-pattern>*.do</url-pattern>

    </servlet-mapping>

springDispatcher-servlet.xml中的配置信息：

<--1、对模型视图名称的解析，即在模型视图名称添加前后缀 -->

<bean id="viewResolver" class="org.springframework.web.servlet.view.velocity.VelocityViewResolver">

<property   name="allowSessionOverride" value="true"/>

<property   name="exposeSessionAttributes" value="true"/>

<property name="cache" value="true"/>

<property name=”prefix” value=”/WEB-INF/templates/”/>

<property name="suffix" value=".vm"/>

<property name="contentType">

    <value>text/html;charset=UTF-8</value>

</property>

</bean>

<--2、velocity的一些设置 -->

<bean id="velocityConfig" class="org.springframework.web.servlet.view.velocity.VelocityConfigurer">

<property   name="resourceLoaderPath">

        <value>velocity/</value>

</property>

<property   name="velocityProperties">

       <props>

         <prop   key="input.encoding">UTF-8</prop>

         <prop   key="output.encoding">UTF-8</prop>

         <prop key="contentType">text/html;charset=UTF-8</prop>

       </props>

</property>

</bean>

1处的工作即是定义模型视图名称的解析规则，这里我们采用的是velocity模板视图解析器，这样Spring就与velocity模板技术整合起来了。Spring的Dispatcher中有一个属性为viewResolver，通过它来寻找真正的视图对象。
2处定义了velocity的一些属性配置，包括资源的加载路径和页面的编码格式等。

参考资料：

Velocity内部实现的介绍：http://agapple.iteye.com/blog/1071438
velocity引擎源码学习一：http://bojiang.iteye.com/blog/1159313
velocity中的Introspection介绍：http://bojiang.iteye.com/blog/1159293
velocity的优化记录：http://agapple.iteye.com/blog/1051724

Velocity源码分析的更多相关文章

  1. [Android实例] Scroll原理-附ScrollView源码分析

    想象一下你拿着放大镜贴很近的看一副巨大的清明上河图, 那放大镜里可以看到的内容是很有限的, 而随着放大镜的上下左右移动,就可以看到不同的内容了 android中手机屏幕就相当于这个放大镜, 而看到的内 ...

  2. BIZ中model.getSql源码分析

    功能:根据model.xml文件中配置的sql,获取对应的动态sql结果. 实例代码:String sql1 = model.getSql(dao.dbMeta());String sql2 = mo ...

  3. springMVC源码分析--视图View（一）

    之前的博客springMVC源码分析--HttpMessageConverter数据转化(一)中我们已经介绍了数据返回值的处理,在博客springMVC源码分析--ViewResolver视图解析器( ...

  4. Facebook Rebound 弹性动画库 源码分析

    Rebound源码分析 让动画不再僵硬:Facebook Rebound Android动画库介绍一文中介绍了rebound这个库. 对于想体验一下rebound的效果,又懒得clone和编译代码的, ...

  5. [Android实例] Scroll原理-附ScrollView源码分析 （转载）

    想象一下你拿着放大镜贴很近的看一副巨大的清明上河图, 那放大镜里可以看到的内容是很有限的, 而随着放大镜的上下左右移动,就可以看到不同的内容了 android中手机屏幕就相当于这个放大镜, 而看到的内 ...

  6. 精尽Spring MVC源码分析 - 寻找遗失的 web.xml

    该系列文档是本人在学习 Spring MVC 的源码过程中总结下来的,可能对读者不太友好,请结合我的源码注释 Spring MVC 源码分析 GitHub 地址 进行阅读 Spring 版本:5.2. ...

  7. ABP源码分析一：整体项目结构及目录

    ABP是一套非常优秀的web应用程序架构,适合用来搭建集中式架构的web应用程序. 整个Abp的Infrastructure是以Abp这个package为核心模块(core)+15个模块(module ...

  8. HashMap与TreeMap源码分析

    1. 引言     在红黑树--算法导论(15)中学习了红黑树的原理.本来打算自己来试着实现一下,然而在看了JDK(1.8.0)TreeMap的源码后恍然发现原来它就是利用红黑树实现的(很惭愧学了Ja ...

  9. nginx源码分析之网络初始化

    nginx作为一个高性能的HTTP服务器,网络的处理是其核心,了解网络的初始化有助于加深对nginx网络处理的了解,本文主要通过nginx的源代码来分析其网络初始化. 从配置文件中读取初始化信息 与网 ...

随机推荐

  1. NET笔记——IOC详解和Unity基础使用介绍

    说起IOC,可能很多初学者不知道是用来做什么的,今天正好有点时间,就来扫扫盲,顺便巩固下自己. IOC全称是Inversion Of Control,意为控制反转(这些自然百度也有),可什么是控制反转 ...

  2. 隐藏 Status Bar

    iOS6和iOS7在隐藏 Status Bar 三种方式比较: Storyboard 界面上选中UIViewController,最右边Simulated Metrics找到 Status Bar 设 ...

  3. Cocoa Touch 框架

    Cocoa Touch包括: (1)Core Animation: 通过Core Animation,可以通过一个基于独立图层的简单的编程模型来创建丰富的用户体验. (2)Core Audio: Co ...

  4. VC释放EXE资源文件

    原文地址:http://blog.csdn.net/wangningyu/article/details/4378378 今天有个朋友问到VC能否释放多个EXE.DLL或WAV等文件,我便做了个实例给 ...

  5. CTSC && APIO 总结

    先说CTSC吧,第一试其实不难但是下意识觉得CTSC不就只能骗分吗,然后就全上暴力了.然而第二题再一次看漏了条件,即答案总和小于等于1e6.第三题现在回想起来要不然就是没有思考,要不然就是没学过数学, ...

  6. CENTOS6上禁用IPV6和DHCP

    centos 6禁用ipv6方法   首先,在终端输入 ip -6 addr show 和 lsmod | grep ipv6查询一下有无安装IPV6模块,或用netstat -nuptl查看是否有i ...

  7. FFMPEG之TimeBase成员理解

    http://blog.csdn.net/supermanwg/article/details/14521869

  8. 在html中嵌入markdown

    在博客园网页里写markdown的时候, 某些特殊内容想加上自定义的css, 于是用<div class="xxx">包裹起来, 但是发现该<div>中的m ...

  9. 子查询解嵌套not in 无法展开改写

    SQL> explain plan for select * from OPS$CZTEST1.SAVJ_ATOMJOURBAK where ((list_flag = '1' and prt_ ...

  10. 【HDOJ】2473 Junk-Mail Filter

    并查集删除结点,方法是构建虚拟点,做映射. #include <stdio.h> #include <string.h> #define MAXNUM 1000050 int ...