起因
上周在调试ftl模板的时候,出现一个诡异的现象。ftl模板中笔者是这样写的。
附图:
当时觉得代码太长,界面放不下就进行了换行(很程序猿的做法),之后导出excel,发现itemName字段导出的内容前面有7个空格,后面有6个空格,与预期不符。经过调试发现freemarker会将enter键解释为6个空格,tab键解释为1个空格(以后编写ftl的小伙伴可以注意一下)。之后断断续续研究了一下freemarker的结构(说实话一开始看真的是懵的)。
freemarker设计模式
访问者模式+解释器模式
访问者模式
访问者模式主要包含两个部分,访问者和被访问的元素(即数据)。访问者会重载visit方法,参数是抽象被访问的元素的各个具体实现。
举例:
public class visitor{
public void visit(TemplateElementA){...}
public void visit(TemplateElementB){...}
}
abstract public class TemplateElement{}
public class TemplateElementA extends TemplateElement{}
public class TemplateElementB extends TemplateElement{}
在freemarker中,Enviroment充当的是访问者,TemplateElement充当的是被访问的元素,其中TemplateElement是抽象的类,下面有各种具体的实现。
举例:
MixedContent extends TemplateElement:封装模板数组
DollarVariable extends TemplateElement:解释为带${}符号的模板
TextBlock extends TemplateElement:解释为ftl原生语言的模板(<Cell><Data></Data></Cell>)
IteratorBlock extends TemplateElement:解释为带循环结构的模板(<#list></#list>)
观点
访问者模式适用于结构(被访问数据)不经常变化,但是对于结构的操作经常变化的系统。后来笔者思考了一下为什么freemarker适合这种模式?因为ftl模板的语言结构是固定的,模板被分解为各种TemplateElement的数量基本也是固定的。
解释器模式
定义一种文法,如ftl模板语言,解释器模式可以定义出其文法的一种表示,并定义出一个解释器,该解释器使用该表示来解释语言中的句子。这种行为让笔者想起了大学时代的编译原理,是比较生涩难懂的。
例如:freemarker表达式<Cell><Data>${item}</Data></Cell>,会被解释成三个部分,分别是
<Cell><Data>
${item}
<Cell><Data>
访问者模式中已经指出,前面两个标签在freemarker中被定义为TextBlock,中间要填充的变量被定义为DollarVariable。
Enviroment(访问者)会根据不同类型的TemplateElement(被访问的元素)调用不同的accept方法,不同的accept方法调用不同的Expression进行文法解析。
具体的模式附图: