在最近的ICMS项目中,为了实现完全的分离业务和视图部分(同时也需要视图偶尔能调用业务逻辑用用),所以决定引入已经非常成熟的开源搜索引擎Nvelocity.
但很可惜的是Nvelocity 的最新版本0.4.2 也在2003 年停止了更新和维护,其中引用的其他开源组件也都是当时的版本,比如:
Log4Net版本是2002 年的 1.2.0.(而今的Nhibernate 3中自带的Log4Net 版本为2010年10月版本号1.2.10)
当ICMS项目同时引入Nvelocity 和 Nhibernate 3 后,由于项目引用只能引入一个版本的log4Net, 终于。。。。杯具发生了.
1、当项目中使用新版的Log4Net 时,Nhibernat OK 正常,可是Nvelocity 对新版的Log4Net 不兼容,因为新版的Log4Net 已经取消了很多命名空间,初始化方式也不同,甚至日志的分级也有些改变。所以调用Nvelocity 运行后直接异常。(NND,Nvelocity 竟然还没有取消写日志的函数。)
2、干脆替换成Nvelocity支持的老版本的Log4Net,又餐具了!当Nhibernate 检测到 log4Net 存在时,就试图加载,因为Log4Net 版本差异太大,所以Nheibernate 也异常了。。。 (⊙o⊙)!
这简直是一山不能容二虎啊,考虑到未来可能对ICMS日志进行统一处理,还是决定花点时间改造Nvelocity ,以支持新版的Log4Net。这次虽然我碰上Nvelocity 和Nhibernate 之间的Log4Net 的兼容性问题,想想还有很多其他开源组件或项目也都是用基于Log4Net 的,估计遇到我这样问题的人应该不少吧!
改造中。。。
重写了Nvelocity 中的Log4Net 的引用和调用部分开发,支持最新版本1.2.10 。
为了方便其他人的使用,我打包重新封装了(2003 年的Nvelocity 好像是基于.net 1.x 编写的啊!!!)
可能还有很多人对Nvelocity 比较陌生,我大致按照我的理解介绍一下Nvelocity ,同时包含一些开发中的经验知识点。
NVelocity 特点介绍:
NVelocity 是基于Java 的模板引擎Velocity 的.net 版本,在JAVA的模板引擎界还是赫赫有名的。
NVelocity 的模板语法基于SUN的Bean 语法结构,所以它是非常灵活的。
业务可以完全和视图模板隔离,NVelocity 直接使用业务中的结果类型进行模板的组织构造,当然还可以直接使用业务中给出的自定义类型。
Nvelocity 使用方面的简单介绍:
Nvelocity模板的定义
可以是任意文本文件,注意文件编码最好是UTF-8;官方给出的模板文件扩展名为 “.vm”,不过可以自己随意定义。
这里我定义了一个模板,/VT/Hello1.vm
内容如下:
${bill}
<br>#set($count=8)
#foreach ($i in ${bill})
${owner}:您的 $i 号${type}在 ${date} 已支付<br>
#end
初始化Nvelocity:
//初始化Velocity 实例,可以采用单例模式节省内存,提高执行效率
VelocityEngine vltEngine = new VelocityEngine();
//初始化Velocity 的属性
ExtendedProperties props = new ExtendedProperties();
//模板文件路径属性是必须要声明的,这里设置根路径即可,具体模板载入可以使用相对路径,不设置载入模板会异常。
props.SetProperty(RuntimeConstants_Fields.FILE_RESOURCE_LOADER_PATH, Context.Request.PhysicalApplicationPath);//日志路径属性设置
props.SetProperty(RuntimeConstants_Fields.RUNTIME_LOG, Context.Request.PhysicalApplicationPath + props.GetString(RuntimeConstants_Fields.RUNTIME_LOG, "nvelocity.log"));
vltEngine.Init(props);
指定模板并输出业务结果数据:
//加载指定模板,指定上面定义的根路径 的相对路径即可
Template vltTemplate = vltEngine.GetTemplate("/VT/Hello1.vm");
//结果上下文保持器,填充数据
VelocityContext vltContext = new VelocityContext();
vltContext.Put("owner", "Unmi");vltContext.Put("bill", new List<int>() { 1, 2, 3, 4 });vltContext.Put("type", "报销单");vltContext.Put("date", DateTime.Now.ToLongDateString());
StringWriter sw = new StringWriter();
//内容和模板合并
vltTemplate.Merge(vltContext, sw);//lt1 是页面中的Label 控件。
lt1.Text = sw.GetStringBuilder().ToString();
最终页面结果输出:
System.Collections.Generic.List`1[System.Int32]
Unmi:您的 1 号报销单在 2010年12月24日 已支付
Unmi:您的 2 号报销单在 2010年12月24日 已支付
Unmi:您的 3 号报销单在 2010年12月24日 已支付
Unmi:您的 4 号报销单在 2010年12月24日 已支付
其实Nvelocity 超简单,语法也非常简单,下方有模板语法文档的下载,模板语法不分Velocity 和Nvelocity 版本。
另外注意:NVelocity 大部分情况下是区分大小写的,请务必注意。
我改版后的源码和Assembly 点这里下载: Velocity项目源码下载
Nvelocity 模板语法文档点这里下载: Velocity 语法文档下载