Tiny模板引擎的实现方式原来是采用的编译方式,最近发生了一些问题,所以我以为有必要把编译方式调整为解释方式,为此就开始了这次实现活动。html
当时采用编译方式,主要是考虑到编译方式在运行时没必要再去遍历语法树,所以就采用了编译方式。可是在实际应用当中,出现了以下问题:java
因为采用的是编译方式,这个时候就存在在一个选择,即:Java源代码落地或不落地的选择。若是Java文件不落地,则在有问题的时候,若是想要进行代码调试(虽然这种场景并很少见),那么就没有源代码可供调试。若是Java代码落地,则会存在一个问题,那就是资源文件在磁盘文件中产生冲突的问题。算法
一样的问题对于class文件也存在,若是不落地,那么每次应用重启动的时候,都要从新编译这些文件以产生class文件;若是落地,则也会产生冲突的问题。express
固然,Tiny模板引擎经过增长一个配置项,解决了这个冲突的问题,可是因为增长了一个配置项,从客观上增长了维护人员的工做量,也容易形成当维护人员不了解这里面的道道,忘记设置从而致使在一台服务器中部署多个Tiny应用时多个应用中的模板文件生成的java文件和class文件的冲突,从而致使出现问题。数组
采用编译方式的时候,因为每一个模板文件都要生成一个类,每一个宏也要生成一个类,在宏调用过程当中,也要生成一些类。(原本是能够不生成这些类的,可是因为Tiny模板引擎支持了一些很是有用的特性,因此宏调用时时采用编译方式,就要生成一些内嵌类来完成)。这样,就会生成大量的Java类,从工程很是大的时候,就会致使PermSize打败很是大。尤为是在系统还在调试的时候,模板文件变化的时候,就要从新编译生成新的类,为了不必须从新启动应用服务器才能生生效,所以采用了本身编写ClassLoader的方式来达到即时刷新的问题,可是因为Java的垃圾回收机制,决定了垃圾不是及时回收的,可是因为每一个类都要有一个ClassLoader来支持,以便及时替换,所以这会进一步放大内存的占用。性能优化
因为Tiny模板引擎中提供了宏,而这些宏能够独立存在,所以在应用启动的时候就必须加载全部的宏到内存中,以便查找。因此就致使第一次启动的时候,因为要编译全部的宏文件并加载之,致使启动速度很是慢。在之后的启动的时候,也必须检测模板文件与生成的类是否一致,是否有被修改过,当a项目规模比较大的时候,这个时间也是比较长的。尤为是在开发期,启动时间增长10秒,都会让开发人员感受到难以忍受。服务器
采用编译方式的问题,在访问上也有一些问题。框架
为了提高应用启动时间,只有宏文件是在启动时预选编译好并加载了的,而模板文件和布局文件则没有这种待遇,这就致使若是在访问的时候,第一次访问的时候,须要编译模板文件为java文件,再把java文件编译为class文件,若是此次访问还用到了布局文件,还import了其它的模板文件,那么悲剧了,第一个访问者可能要多等待几秒钟的时间。同时,为了不屡次编译状况的地生,还要增长同步锁,这样会进一步影响到访问的效率。函数
具体尚未测试过ClassLoader太多对性能有多大的影响,可是毛估估是有必定影响的,毕竟要增长查找的层数。干的活多了,干的活慢了也是天然的,人是这样,计算机也是一样的道理。布局
因为采用解释方式,所以没必要生成java源文件和class文件,所以也就不存在文件路径冲突的问题;一样也不存在PermSize和众多ClassLoader大量占用内存的问题。
因为采用解释方式,第一次加载,只定性扫描部分关系的内容便可,所以扫描速度很是快;只有在直接执行的时候,才须要更详细的处理,同时因为不须要进行编译,不须要作同步处理,所以加载速度会比编译方式高许多,尤为是和编译方式的第一次加载时间相比。
访问速度方面的问题,我原来的感受来讲,感受编译方式会快一些,毕竟它不用再云遍历语法树,可是实际执行下来,感受解释方式大体有一倍左右的提高,我分析了一下缘由,大体能够认为是以下缘由:1.因为Java的优化策略,致使使用频率高的访问会进行深度性能优化,采用解释方式,因为用到的就是那几个函数,所以能够很快知足Java虚拟机的要求,更早的进行深度优化;2.因为解释方式和编译方式相比,能够采用更优化的解决方案,所以遍历语法树的时间由避免作一些事情弥补回来了,所以感觉性能反而更高一点点。总之,此次编译改解释,的效果仍是明显的,各方面全面让我满意,尤为是前面担忧的执行效率方面也有大概50%左右的提高是让我喜出望外的。还有一个意外之喜是经过把编译方式改为解释执行方式,代码规模缩小了近一半,由原来的8000+行,变成4000+行。同时,因为没必要要依赖JDT,antlr也只要依赖runtime包便可,还顺便减小了3M的WAR包大小。
OK,说了这么多,那就说说此次改造过程。
因为团队去岛国旅游,当时把这个任务交给一个留守同窗来完成,可是先后两周的时候,没有提交出我满意的结果,因为看不到后续完成的时间节点,没有办法,只好我老先生亲自动手来完成了,OK开工,相信仔细阅读下面一节内容的同窗,会对ANTLR解释引擎的开发有深刻了解,甚至拿个人代码照葫芦画瓢,直接就可用。
解释引擎总控类是解释引擎的核心,因为这个东东是为了Tiny模板引擎定制编写的,所以若是有同窗要拿来改造,请照葫芦画瓢便可。因为类不大,我就直接贴源码上来,以便亲们理解和我下面讲解。
public class TemplateInterpreter { TerminalNodeProcessor[] terminalNodeProcessors = new TerminalNodeProcessor[200]; Map<Class<ParserRuleContext>, ContextProcessor> contextProcessorMap = new HashMap<Class<ParserRuleContext>, ContextProcessor>(); OtherTerminalNodeProcessor otherNodeProcessor = new OtherTerminalNodeProcessor(); public void addTerminalNodeProcessor(TerminalNodeProcessor processor) { terminalNodeProcessors[processor.getType()] = processor; } public void addContextProcessor(ContextProcessor contextProcessor) { contextProcessorMap.put(contextProcessor.getType(), contextProcessor); } public TinyTemplateParser.TemplateContext parserTemplateTree(String sourceName, String templateString) { char[] source = templateString.toCharArray(); ANTLRInputStream is = new ANTLRInputStream(source, source.length); // set source file name, it will be displayed in error report. is.name = sourceName; TinyTemplateParser parser = new TinyTemplateParser(new CommonTokenStream(new TinyTemplateLexer(is))); return parser.template(); } public void interpret(TemplateEngineDefault engine, TemplateFromContext templateFromContext, String templateString, String sourceName, TemplateContext pageContext, TemplateContext context, Writer writer) throws Exception { interpret(engine, templateFromContext, parserTemplateTree(sourceName, templateString), pageContext, context, writer); writer.flush(); } public void interpret(TemplateEngineDefault engine, TemplateFromContext templateFromContext, TinyTemplateParser.TemplateContext templateParseTree, TemplateContext pageContext, TemplateContext context, Writer writer) throws Exception { for (int i = 0; i < templateParseTree.getChildCount(); i++) { interpretTree(engine, templateFromContext, templateParseTree.getChild(i), pageContext, context, writer); } } public Object interpretTree(TemplateEngineDefault engine, TemplateFromContext templateFromContext, ParseTree tree, TemplateContext pageContext, TemplateContext context, Writer writer) throws Exception { Object returnValue = null; if (tree instanceof TerminalNode) { TerminalNode terminalNode = (TerminalNode) tree; TerminalNodeProcessor processor = terminalNodeProcessors[terminalNode.getSymbol().getType()]; if (processor != null) { returnValue = processor.process(terminalNode, context, writer); } else { returnValue = otherNodeProcessor.process(terminalNode, context, writer); } } else if (tree instanceof ParserRuleContext) { ContextProcessor processor = contextProcessorMap.get(tree.getClass()); if (processor != null) { returnValue = processor.process(this, templateFromContext, (ParserRuleContext) tree, pageContext, context, engine, writer); } if (processor == null || processor != null && processor.processChildren()) { for (int i = 0; i < tree.getChildCount(); i++) { Object value = interpretTree(engine, templateFromContext, tree.getChild(i), pageContext, context, writer); if (value != null) { returnValue = value; } } } } else { for (int i = 0; i < tree.getChildCount(); i++) { Object value = interpretTree(engine, templateFromContext, tree.getChild(i), pageContext, context, writer); if (returnValue == null && value != null) { returnValue = value; } } } return returnValue; } public static void write(Writer writer, Object object) throws IOException { if (object != null) { writer.write(object.toString()); writer.flush(); } } }
因此逻辑仍是比较清晰,最复杂的核心算法也只有30行,不论是什么样层级的同窗,看这些代码都没有任何难度了。
须要交待的一件事情是:为何ContextProcessor的处理类是用Map保存的,而TerminalNodeProcessor则是用数组?这里主要是为了考虑到TerminalNode都有一个类型,用数据的方式速度更快一些。
上面说到有两个接口,一个是处理TerminalNodeProcessor,另一个是处理ContextProcessor的,下面交待一下这两个接口。
public interface TerminalNodeProcessor<T extends ParseTree> { int getType(); Object process(T parseTree, TemplateContext context, Writer writer) throws Exception; }
public interface ContextProcessor<T extends ParserRuleContext> {
Class<T> getType();
boolean processChildren();
Object process(TemplateInterpreter interpreter, TemplateFromContext templateFromContext, T parseTree, TemplateContext pageContext, TemplateContext context, TemplateEngineDefault engine, Writer writer) throws Exception;
}
至此,整个解析引擎的框架就搭好了,剩下要作的就是去写这些处理器了。
public class DoubleNodeProcessor implements TerminalNodeProcessor<TerminalNode> { public int getType() { return TinyTemplateParser.FLOATING_POINT; } public boolean processChildren() { return false; } public Object process(TerminalNode terminalNode, TemplateContext context, Writer writer) { String text=terminalNode.getText(); return Double.parseDouble(text); } }
这货的意思是:若是是Double类型的数据,就把字符串转换成Double值返回。
public class StringDoubleNodeProcessor implements TerminalNodeProcessor<TerminalNode> { public int getType() { return TinyTemplateParser.STRING_DOUBLE; } public boolean processChildren() { return false; } public Object process(TerminalNode terminalNode, TemplateContext context, Writer writer) { String text=terminalNode.getText(); text=text.replaceAll("\\\\\"","\""); text=text.replaceAll("[\\\\][\\\\]","\\\\"); return text.substring(1, text.length() - 1); } }
其它的和这个大同小异,总之很是简单,想看的同窗能够本身去看源码,这里就不贴了。
public class ForProcessor implements ContextProcessor<TinyTemplateParser.For_directiveContext> { public Class<TinyTemplateParser.For_directiveContext> getType() { return TinyTemplateParser.For_directiveContext.class; } public boolean processChildren() { return false; } public Object process(TemplateInterpreter interpreter, TemplateFromContext templateFromContext, TinyTemplateParser.For_directiveContext parseTree, TemplateContext pageContext, TemplateContext context, TemplateEngineDefault engine, Writer writer) throws Exception { String name = parseTree.for_expression().IDENTIFIER().getText(); Object values = interpreter.interpretTree(engine, templateFromContext, parseTree.for_expression().expression(),pageContext, context, writer); ForIterator forIterator = new ForIterator(values); context.put("$"+name + "For", forIterator); boolean hasItem = false; while (forIterator.hasNext()) { TemplateContext forContext=new TemplateContextDefault(); forContext.setParent(context); hasItem = true; Object value = forIterator.next(); forContext.put(name, value); try { interpreter.interpretTree(engine, templateFromContext, parseTree.block(),pageContext, forContext, writer); } catch (ForBreakException be) { break; } catch (ForContinueException ce) { continue; } } if (!hasItem) { TinyTemplateParser.Else_directiveContext elseDirectiveContext = parseTree.else_directive(); if (elseDirectiveContext != null) { interpreter.interpretTree(engine, templateFromContext, elseDirectiveContext.block(), pageContext,context, writer); } } return null; } }
是否是很是简单?
public class MapProcessor implements ContextProcessor<TinyTemplateParser.Expr_hash_mapContext> { public Class<TinyTemplateParser.Expr_hash_mapContext> getType() { return TinyTemplateParser.Expr_hash_mapContext.class; } public boolean processChildren() { return false; } public Object process(TemplateInterpreter interpreter, TemplateFromContext templateFromContext, TinyTemplateParser.Expr_hash_mapContext parseTree, TemplateContext pageContext, TemplateContext context, TemplateEngineDefault engine, Writer writer) throws Exception { List<TinyTemplateParser.ExpressionContext> expressions = parseTree.hash_map_entry_list().expression(); List<TinyTemplateParser.ExpressionContext> expressionContexts = expressions; Map<String, Object> map = new HashMap<String, Object>(); if (expressions != null) { for (int i = 0; i < expressions.size(); i += 2) { String key = interpreter.interpretTree(engine, templateFromContext, expressions.get(i), pageContext,context, writer).toString(); Object value = interpreter.interpretTree(engine, templateFromContext, expressions.get(i + 1),pageContext, context, writer); map.put(key, value); } } return map; } }
我已经拿了最复杂的两个来说了,其它的就更简单了,所以就再也不贴了,关心的同窗们能够去看源代码。
欢迎访问开源技术社区:http://bbs.tinygroup.org。本例涉及的代码和框架资料,将会在社区分享。《本身动手写框架》成员QQ群:228977971,一块儿动手,了解开源框架的奥秘!或点击加入QQ群:http://jq.qq.com/?_wv=1027&k=d0myfX