FTL 入门

最近的项目中用的是ftl文件而不是传统的jsp,于是上网查了一下,感觉这是个好东西,于是准备记录下来。
以下摘自百度百科。



1.概念
FreeMarker是一款模板引擎: 即一种基于模板和要改变的数据, 并用来生成输出文本(HTML网页、电子邮件、配置文件、源代码等)的通用工具。
它不是面向最终用户的,而是一个Java类库,是一款程序员可以嵌入他们所开发产品的组件。

FreeMarker是免费的,基于Apache许可证2.0版本发布。
其模板编写为FreeMarker Template Language(FTL),属于简单、专用的语言。需要准备数据在真实编程语言中来显示,比如数据库查询和业务运算, 之后模板显示已经准备好的数据。
在模板中,主要用于如何展现数据, 而在模板之外注意于要展示什么数据。

与JSP相比,FreeMarker的一个优点在于不能轻易突破模板语言开始编写Java代码,因此降低了领域逻辑漏进视图层的危险几率。
但缺点是需要一点附加配置来将其平稳地集成到应用程序中,一些IDE(集成开发环境)可能并不完全支持它,当然还有开发者或设计者也许需要学习一门陌生的模板语言。
相关的JAR文件将要添加到WEB-INF/lib(在需要的时候,它们包含在Spring中)。


2.原理说明
2.1 举例
假设在一个应用系统中需要一个HTML页面如下:
<html>
    <head>
        <title>Welcome!title>
    head>
    <body>
        <h1>Welcome Big Joe!h1>
        <p>Our latest product:
        <a href="products/greenmouse.html">green mousea>!
    body>
html>
页面中的用户名(即上面的“Big Joe”)是登录这个网页的访问者的名字, 并且最新产品的数据应该来自于数据库才能随时更新。
所以,不能直接在HTML页面中输入“Big Joe”、“greenmouse”及链接, 不能使用静态HTML代码。

可以使用要求输出的模板来解决,模板和静态页面是相同的,只是它会包含一些FreeMarker将它们变成动态内容的指令:
<html>
    <head>
        <title>Welcome!title>
    head>
    <body>
        <h1>Welcome ${user}!h1>
        <p>Our latest product:
        <a href="${latestProduct.url}">${latestProduct.name}a>!
    body>
html>

2.2 原理
模板文件存放在Web服务器上,当有人来访问这个页面,FreeMarker就会介入执行,然后动态转换模板,用最新的数据内容替换模板中${...}的部分,之后将结果发送到访问者的Web浏览器中。
访问者的Web浏览器就会接收到例如第一个HTML示例那样的内容(也就是没有FreeMarker指令的HTML代码),访问者也不会察觉到服务器端使用的FreeMarker。
PS:存储在Web服务器端的模板文件是不会被修改的;替换也仅仅出现在Web服务器的响应中。
(root)
  |
  +- user = "Big Joe"
  |
  +- latestProduct
      |
      +- url = "products/greenmouse.html"
      |
      +- name = "green mouse"


3.基本语法
3.1语法概述
3.1.1   ${...}:FreeMarker将会输出真实的值来替换大括号内的表达式,这样的表达式被称为interpolation(插值)。
3.1.2   注释:注释和HTML的注释也很相似,但是它们使用<#-- and -->来标识。不像HTML注释那样,FTL注释不会出现在输出中(不出现在访问者的页面中),因为FreeMarker会跳过它们。
3.1.3   FTL标签(FreeMarker模板的语言标签):FTL标签和HTML标签有一些相似之处,但是它们是FreeMarker的指令,是不会在输出中打印的。这些标签的名字以#开头。(用户自定义的FTL标签则需要使用@来代替#)


3.2指令详解
3.2.1   if else
<#if condition>
    ...
<#elseif condition2>
    ...
<#elseif condition3>
    ...
<#else>
    ...
#if>
if、elseif和else指令可以用来条件判断是否越过模板的一个部分。
condition必须计算成布尔值,否则错误将会中止模板处理。
elseif和else必须出现在if内部(也就是在if的开始标签和结束标签之间)。
if中可以包含任意数量的elseif(包括0个),而结束时else也是可选的。

3.2.2   list
假设 users 包含['Joe''Kate''Fred'] 序列:
<#list users as user>
    

${user}

#list>
 
输出:
    

Joe

    

Kate

    

Fred

list指令执行在list开始标签和list结束标签(list中间的部分)之间的代码,对于在序列(或集合)中每个值指定为它的第一个参数。
对于每次迭代,循环变量将会存储当前项的值。循环变量仅仅存在于list标签体内。
而且从循环中调用的宏/函数不会看到它(就像它只是局部变量一样)。
<#list>与<#else>、<#sep>组合是可选的,而且仅从FreeMarker 2.3.23版本开始支持。


3.2.3   include
将版权信息单独存放在页面文件 copyright_footer.html 中:
<hr>
<i>
    Copyright (c) 2000 <a href="http://www.baidu.com">Baidu Inca>,
    <br>
    All Rights Reserved.
i>
 
当需要用到这个文件时,可以使用 include 指令来插入:
<html>
    <head>
        <title>Test pagetitle>
    head>
    <body>
        <h1>Test pageh1>
        <p>Blah blah...
        <#include "/copyright_footer.html">
    body>
html>
include可以在模板中插入另外一个FreeMarker模板文件(由路径参数指定)。
被包含模板的输出格式是在include标签出现的位置插入的。被包含的文件和包含它的模板共享变量,就像是被复制粘贴进去的一样。
include指令不能由被包含文件的内容所替代,它只是当FreeMarker每次在模板处理期间到达include指令时处理被包含的文件。
所以对于如果include在list循环之中的例子,可以为每个循环周期内指定不同的文件名。


3.3 内建函数
 
内建函数很像子变量(也像Java中的方法),它们并不是数据模型中的东西,是FreeMarker在数值上添加的。
为了清晰子变量是哪部分,使用?(问号)代替,.(点)来访问它们。

常用内建函数的示例:
  • user?html给出user的HTML转义版本,比如&会由&来代替。
  • user?upper_case给出user值的大写版本(比如“JOHN DOE”来替代“John Doe”)
  • animal.name?cap_first给出animal.name的首字母大写版本(比如“Mouse”来替代“mouse”)
  • user?length给出user值中字符的数量(对于“John Doe”来说就是8)
  • animals?size给出animals序列中项目的个数
  • 如果在<#list animals as animal>和对应的标签中:
    • animal?index给出了在animals中基于0开始的animal的索引值
    • animal?counter也像index,但是给出的是基于1的索引值
    • animal?item_parity基于当前计数的奇偶性,给出字符串“odd”或“even”。
    • 在给不同行着色时非常有用,比如在中。

一些内建函数需要参数来指定行为,比如:
  • animal.protected?string("Y", "N")基于animal.protected的布尔值来返回字符串“Y”或“N”。
  • animal?item_cycle('lightRow','darkRow')是item_parity更为常用的变体形式。
  • fruits?join(", ")通过连接所有项,将列表转换为字符串,在每个项之间插入参数分隔符(比如“orange,banana”)
  • user?starts_with("J")根据user的首字母是否是“J”返回布尔值true或false。

内建函数应用可以链式操作,比如user?upper_case?html会先转换用户名到大写形式,之后再进行HTML转义,和链式使用.(点)一样。


3.4  空变量
数据模型中经常会有可选的变量(有时并不存在)。
除了一些人为原因导致失误外,FreeMarker不能引用不存在的变量,除非明确地告诉它当变量不存在时如何处理。

如下两种典型的处理方法:
这部分对程序员而言:一个不存在的变量和一个是null值的变量,对于FreeMarker来说是一样的,所以这里所指的“丢失”包含这两种情况。
不论在哪里引用变量,都可以指定一个默认值来避免变量丢失这种情况,通过在变量名后面跟着一个 !(感叹号)和默认值。

像下面的这个例子,当user不存在于数据模型时,模板将会将user的值表示为字符串 “visitor”。(当 user 存在时,模板就会表现出 ${user} 的值):

<h1>Welcome ${user!"visitor"}!h1>
也可以在变量名后面通过放置??来询问一个变量是否存在。将它和if指令合并,那么如果user变量不存在的话将会忽略整个问候的代码段:



<#if user??>
    

Welcome ${user}!</h1>

#if>
关于多级访问的变量,比如 animals.python.price,书写代码:animals.python.price!0当且仅当animals.python永远存在,而仅仅最后一个子变量price可能不存在时是正确的(这种情况下假设价格是0)。如果 animals或python不存在,那么模板处理过程将会以“未定义的变量”错误而停止。为了防止这种情况的发生, 可以如下这样来编写代码 (animals.python.price)!0。这种情况就是说animals或python不存在时,表达式的结果是 0。对于??也是同样用来的处理这种逻辑的;将animals.python.price??对比(animals.python.price)??来看。





你可能感兴趣的:(FreeMarker)