Velocity源码分析

最新推荐文章于 2024-02-21 22:15:34 发布
最新推荐文章于 2024-02-21 22:15:34 发布
阅读量714 收藏
点赞数
分类专栏： 其他

velocity模板渲染的步骤：

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

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

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

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


代码示例：

[html]  view plain copy print ?
  1. try {  
  2.             Velocity.init("velocity.properties");  
  3.             VelocityContext context = new VelocityContext();  
  4.             String templateFile = "template.vm";  
  5.             context.put("paramObject", "onlyone");  
  6.             Template template = null;  
  7.             template = Velocity.getTemplate(templateFile);  
  8.             BufferedWriter writer = new BufferedWriter(new FileWriter("velocity.data"));  
  9.             if (template != null) template.merge(context, writer);  
  10.             writer.flush();  
  11.             writer.close();  
  12.         } catch (Exception e) {  
  13.             e.printStackTrace();  
  14.         }  


原理分析：


整体工作流程图：


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属性对注入到上下文参数中

[html]  view plain copy print ?
  1. VelocityContext context = new VelocityContext();  
  2. 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
[html]  view plain copy print ?
  1.   <!--Spring 服务层的配置文件 -->  
  2.   <context-param>                     
  3.       <param-name>contextConfigLocation</param-name>  
  4.       <param-value>classpath:applicationContext.xml</param-value>  
  5.   </context-param>  
  6.     
  7.   <!--Spring 容器启动监听器 -->  
  8.   <listener>  
  9.       <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
  10.   </listener>  
  11.   
  12.   <!--  Spring MVC 的Servlet，它将加载WEB-INF/springDispatcher-servlet.xml 的配置文件，以启动Spring MVC模块-->  
  13.   <servlet>  
  14. <servlet-name>springDispatcher</servlet-name>  
  15. <servlet-class>  
  16.     org.springframework.web.servlet.DispatcherServlet  
  17. </servlet-class>  
  18. <init-param>  
  19.     <param-name>contextConfigLocation</param-name>  
  20.     <param-value>  
  21.         /WEB-INF/springDispatcher-servlet.xml  
  22.     </param-value>  
  23. </init-param>  
  24.   </servlet>  
  25.   
  26.   <servlet-mapping>  
  27.       <servlet-name>springDispatcher</servlet-name>  
  28.       <url-pattern>*.do</url-pattern>  
  29.   </servlet-mapping>  
springDispatcher-servlet.xml中的配置信息：
[html]  view plain copy print ?
  1. <--1、对模型视图名称的解析，即在模型视图名称添加前后缀 -->  
  2. <bean id="viewResolver" class="org.springframework.web.servlet.view.velocity.VelocityViewResolver">  
  3. <property   name="allowSessionOverride" value="true"/>  
  4. <property   name="exposeSessionAttributes" value="true"/>  
  5. <property name="cache" value="true"/>  
  6. <property name=”prefix” value=”/WEB-INF/templates/”/>  
  7. <property name="suffix" value=".vm"/>  
  8. <property name="contentType">  
  9.     <value>text/html;charset=UTF-8</value>  
  10. </property>  
  11. </bean>  
  12.   
  13. <--2、velocity的一些设置 -->  
  14. <bean id="velocityConfig" class="org.springframework.web.servlet.view.velocity.VelocityConfigurer">     
  15. <property   name="resourceLoaderPath">    
  16.         <value>velocity/</value>                            
  17. </property>  
  18. <property   name="velocityProperties">    
  19.        <props>    
  20.          <prop   key="input.encoding">UTF-8</prop>    
  21.          <prop   key="output.encoding">UTF-8</prop>  
  22.          <prop key="contentType">text/html;charset=UTF-8</prop>      
  23.        </props>    
  24. </property>   
  25. </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 源码例子
07-28
** Velocity 源码分析与应用实例 ** Velocity 是一个基于 Java 的模板引擎，它允许开发者将业务逻辑和页面展示分离，使得Web开发更加高效。Velocity 提供了一种简单但强大的语言来创建动态内容，其核心设计思想是...
velocity源码分析：velocity初始化
kuwoleft
07-28 199
velocity初始化类结构图： 描述： 1.RuntimeConstants定义常量，主要是velociyt初始化的配置项的key 2.四个方法实现该接口主要是共用公共定义的常量，发现很多开源框架喜欢继承公共常量定义的接口来公用变量。 3.RuntimeInstance类是velocity初始化的具体实现，里面定义了初始的顺序和步骤，具体接下来分析 4.RuntimeSin...
Velocity简单示例源码解析
精神分裂的二次元
05-27 369
在基于WEB的应用中，通常大多数情况下是在servlet里使用Velocity。在servlet里的Velocity基本应用是非常简单的，只需通过两个必要步骤就可以实现： 1. 继承org.apache.velocity.servlet.VelocityServlet抽象类： public class SampleServlet extends VelocityServlet 2. 仅需实...
Velocity源码阅读
weixin_33698043的博客
11-25 478
Velocity 是一个基于Java的模板引擎。它高效、简洁，且有很好的可扩展性，适合在Web项目中做为MVC模型中的视图，也可以在内容生成、数据转换等应用中独立使用。本文将以源码阅读的方式，浅析velocity的实现机制，并通过几个小例子来阐述velocity中主要使用的技术点。 1.下载源码 Velocity是Apache的顶级项目。可以从 ht...
深入解析Java模板引擎Velocity源码
### Velocity源码分析： #### Velocity版本信息： 在本例中，提供的压缩包文件名为`velocity-1.6.2`，代表了这是Velocity 1.6.2版本的源码。版本1.6.2属于Velocity历史上的一个稳定版本，对于学习和了解Velocity的...
Velocity 分析
04-16
源码分析可以帮助开发者更好地理解和定制Velocity以满足特定需求。此外，有一些工具可以帮助开发者更高效地使用Velocity，例如IDE插件、模板调试器等，它们可以提高开发效率并减少错误。 总的来说，Velocity是一个...
基于Java语言的模板引擎设计源码分析
最新发布
09-28
Java语言作为一种广泛使用的编程语言，拥有丰富的库和框架支持，其中模板引擎便...开发者通过分析该项目的源码，可以深入理解模板引擎的工作原理，掌握如何在实际项目中灵活运用模板技术来优化开发流程和提高开发效率。
深入解析Velocity源码实例及应用
综上所述，Velocity源码例子将涉及如何使用这些组件和概念来实现一个模板的处理流程。开发者可以通过阅读和分析源码来了解这些组件是如何协同工作来生成最终的输出。这些源码例子对于深入理解Velocity的工作原理以及...
velocity-1.7-sources.zip
09-20
velocity 的源代码 Velocity 是一个基于 Java 的模板引擎框架，提供的模板语言可以使用在 Java 中定义的对象和变量上。Velocity 是 Apache 基金会的项目，开发的目标是分离 MVC 模式中的持久化层和业务层。但是在实际应用过程中，Velocity 不仅仅被用在了 MVC 的架构中，还可以被用在以下一些场景中。 1.Web 应用：开发者在不使用 JSP 的情况下，可以用 Velocity 让 HTML 具有动态内容的特性。 2. 源代码生成：Velocity 可以被用来生成 Java 代码、SQL 或者 PostScript。有很多开源和商业开发的软件是使用 Velocity 来开发的。 3. 自动 Email：很多软件的用户注册、密码提醒或者报表都是使用 Velocity 来自动生成的。使用 Velocity 可以在文本文件里面生成邮件内容，而不是在 Java 代码中拼接字符串。 4. 转换 xml：Velocity 提供一个叫 Anakia 的 ant 任务，可以读取 XML 文件并让它能够被 Velocity 模板读取。一个比较普遍的应用是将 xdoc 文档转换成带样式的 HTML 文件。
velocity源码分析：上下文承载类
madding
08-13 2765
老规矩，线上类图 由于这个代码结构比较简单，因此不做介绍，具体代码的缝合点在具体功能点中介绍（涉及到ast）。 记住几个点即可： 1.VelocityContexty可作为所有上下文承载点，因为其实现了三个接口：Context，InternalEventContext，InternalHousekeepingContext 2.InternalContextBase是个
velocity源代码分析
SAN_YUN的专栏
05-23 200
Velocity就是一个template引擎，或是代码生成器。 由template，engine，context组成。 1. 首先创建一个template（如果是用在web上就是一个html文件），将需要参数化或实例化的地方用跟context有关的符号标记出来,标记时使用velocity template language。而template应该可以是任意的文本。 2. ...
velocity源码分析：事件处理
madding
08-07 5053
velocity提供了一些扩展点,如： 指令扩展、事件处理等。本文主要阐述基于事件处理的扩展，并提供一些事例。 本文讨论的velocity版本如下： URL: http://svn.apache.org/repos/asf/velocity/engine/trunk Repository Root: http://svn.apache.org/repos/asf Repository UU
spring mvc整合velocity源码分析
gaohe7091的专栏
06-22 2150
spring整合velocity 首先看下springMVC整合velocity的
Velocity工作原理解析和优化
weixin_34080571的博客
10-25 518
在MVC开发模式下，View离不开模板引擎，在Java语言中模板引擎使用得最多是JSP、Velocity和FreeMarker，在MVC编程开发模式中，必不可少的一个部分是V的部分。V负责前端的页面展示，也就是负责生产最终的HTML，V部分通常会对应一个编码引擎，当前众多的MVC框架都已经可以将V部分独立开来，可以与众多的模板引擎集成。 Velocity...
Velocity模板引擎
Mason's Blog
08-23 3070
package zoer; import java.io.StringWriter; import org.apache.velocity.Template; import org.apache.velocity.VelocityContext; import org.apache.velocity.app.VelocityEngine; public class Hello
Velocity
记录点滴
02-21 1138
示例：在celo01.vm中定义组件，在下边可重复复用该组件。
【模板引擎】velocity
文艺倾年的博客
08-05 4537
Velocity是一个基于Java的模板引擎，可以通过特定的语法获取在java对象的数据 , 填充到模板中，从而实现界面和java代码的分离 !Velocity主要分为app、context、runtime和一些辅助util几个部分。app模块 : 主要封装了一些接口 , 暴露给使用者使用。主要有两个类，分别是Velocity(单例)和VelocityEngine。Context模块 : 主要封装了模板渲染需要的变量Runtime模块 : 整个Velocity的核心模块，Runtime模块会将加载的模板解析
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值