FreeMarker学习记录(一)--入门

freemaker是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯Java编写。
freemaker被设计用来生成HTML Web页面，特别是基于MVC模式的应用程序
虽然freemaker具有一些编程的能力，但通常由Java程序准备要显示的数据，由freemaker生成页面，通过模板显示准备的数据（如下图）

1.入手案例

1. 首先要导入相应的架包freemaker.jar

2. 创建一个目录存放freemaker文件,在里面建立一个test1.ftl,内容如下

你好啊!${user},hello

3.创建一个普通java类,按照如下流程

import freemaker.template.Configuration;
import freemaker.template.Template;
import freemaker.template.TemplateException;
import java.io.File;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

public class Main {

    public static void main(String[] args) throws IOException, TemplateException {
        //1.创建freemaker配置实例
        Configuration cfg = new Configuration();
        //2.加载freemaker文件夹
        cfg.setDirectoryForTemplateLoading(new File("freemaker"));
        //3.创建数据模型
        Map<String,Object> root = new HashMap<>();
        //4.添加数据
        root.put("user","张三");
        //5.加载模板文件
        Template t1 = cfg.getTemplate("test1.ftl");
        //6.得到要显示目的地的输出流
        Writer out = new OutputStreamWriter(System.out);
        //7.把数据写入到相应的输出流
        t1.process(root,out);
        //刷输出流,并关闭
        out.flush();
        out.close();

    }
}

freemaker就会自动替换user为我们建立的值

2.数据类型

1.基本类型

<meta http-equiv="content-type" content="text/html; charset=UTF-8">


<#-- 定义变量 -->
<#assign myname="Jadyer"/>
${myname}


<#-- 定义数字 -->
<#assign mynum=10/>
${mynum + 20}


<#-- 定义字符串 -->
<#assign mystr="55"/>
${mystr + 20}
<#-- 下面的变量会覆盖上面定义的同名变量，而不会顾及数据类型是否一致 -->
<#assign mystr=55/>
${mystr + 20}
<#-- 下面的两种写法是等价的，它们连接字符串的方式分别为：字符串连接方式和插值连接方式 -->
${"hello,welcome:" + username}
${"hello,welcome:${username}"}


<#-- 定义布尔型 -->
<#-- 如果直接输出${myflag}则会报错，因为freemaker不能直接输出数字或字符串以外的东西，否则都会报错 -->
<#-- 此时需要将其转换为字符串才能输出：使用xxx?string可以完成对字符串的转换。另外??用于判断变量是否存在 -->
<#assign myflag=true/>
${myflag?string}
${myflag?string("isTrue","isFalse")}
${(user.name)???string("user.nameIsTrue","user.nameIsFalse")}


<#-- 日期类型的处理。如果直接输出${currTime}则会报错，此时仍需将其转换为字符串 -->
${currTime?string("yyyy-MM-dd HH:mm:ss")}
<#-- 字符串转换为日期。注意：这样输出${"2012-06-08 22:33:33"?time("HH:mm:ss")}时，会报错 -->
<#assign mydate="2012-06-06"?date("yyy-MM-dd")>
${mydate}
${myTime?date("yyy-MM-dd")}
${"2012-06-08 22:33:33"?time("yyy-MM-dd HH:mm:ss")}
${"2012-06-09 22:44:44"?datetime("yyy-MM-dd HH:mm:ss")}

2.序列和哈希表

<meta http-equiv="content-type" content="text/html; charset=UTF-8">


<#-- 定义序列 -->
<#assign mynums=[11,12,13,14,15,16,17,18,19]/>
<#list mynums as mn>
  ${mn}
</#list>


<#-- 拆分序列 -->
<#-- 这里是将mynums序列中下标从3到6之间的元素拆分出来，组成一个新的序列 -->
<#assign mynum01=mynums[3..6]/>
<#list mynum01 as mn01>
  ${mn01}
</#list>

<#-- 拆分序列的引申:支持字符串的拆分 -->
<#-- 比如说博客文章概要时，可以采用这种方式，它要比CSS方便得多 -->
${"我本将心向明月，奈何明月照沟渠。"[5..9]}....


<#-- 连续序列 -->
<#-- 从55到58：注意此时若写成[55..58]或者[66..68]则会报错 -->
<#assign num01=55..58/>
<#list num01 as num>
  ${num}
</#list>
<#list 66..68 as num>
  ${num}
</#list>



<#-- 定义哈希表 -->
<#-- 注意：freemaker中的哈希表要求其key必须是字符串，包括数据模型中的java.util.HashMap的key也要是字符串，否则报错 -->
<#assign maps={"1":"张起灵", "2":56, "3":"王胖子"}/>
${maps["1"]}
<#assign users={"username":"jadyer", "password":1234}/>
${users.username}----${(users.password)?int}----${users["password"]?string(0)}----${7.5?int}----${7.5?string(0)}


<#-- 遍历哈希表 -->
<#-- 不能直接用list遍历map，需要先将map的key转换为相应的序列 -->
<#assign keys=maps?keys/>
<#list keys as key>
  ${key}----${maps[key]}
</#list>

3.常用操作

• 字符串连接
  字符串连接有两种语法：

(1). 使用${..}或#{..}在字符串常量内插入表达式的值；
(2)  直接使用连接运算符“+”连接字符串。
如，下面两种写法等效：
${"Hello, ${user}"}
${"Hello, " + user + "!"

有一点需要注意： ${..}只能用于文本部分作为插值输出，而不能用于比较等其他用途，如：
<#if ${isBig}>Wow!</#if> 
<#if "${isBig}">Wow!</#if>
应该写成：
<#if isBig>Wow!</#if>

• 截取子串

截取子串
截取子串可以根据字符串的索引来进行，如果指定一个索引值，则取得字符串该索引处的字符；如果指定两个索引值，则截取两个索引中间的字符串子串。如：
<#assign number="01234">
${number[0]} <#-- 输出字符0 -->
${number[0..3]} <#-- 输出子串“0123” -->

• 集合连接操作和Map连接操作

连接集合的运算符为“+”

• 算术运算符

freemaker表达式中支持“+”、“－”、“*”、“/”、“%”运算符。

• 比较运算符
  建议使用字母,因为freemaker会把尖括号当成结束符

1. =（或者==）： 判断两个值是否相等；
2. !=： 判断两个值是否不相等；
注： =和!=可以用作字符串、数值和日期的比较，但两边的数据类型必须相同。而且freemaker的比较是精确比较，不会忽略大小写及空格。
3. >（或者gt）： 大于
4. >=（或者gte）： 大于等于
5. <（或者lt）： 小于
6. <=（或者lte）： 小于等于

• 逻辑运算符

逻辑运算符
1. &&： 逻辑与；
2. ||： 逻辑或；
3. !： 逻辑非
逻辑运算符只能用于布尔值。

• 内建函数

内建函数
freemaker提供了一些内建函数来转换输出，可以在任何变量后紧跟?，?后紧跟内建函数，就可以通过内建函数来转换输出变量。

字符串相关常用的内建函数：
1. html： 对字符串进行HTML编码；
2. cap_first： 使字符串第一个字母大写；
3. lower_case： 将字符串转成小写；
4. upper_case： 将字符串转成大写；

集合相关常用的内建函数：
1. size： 获得集合中元素的个数；

数字值相关常用的内建函数：
1. int： 取得数字的整数部分。

• 空值处理运算符

freemaker的变量必须赋值，否则就会抛出异常。而对于freemaker来说，null值和不存在的变量是完全一样的，因为freemaker无法理解null值。
freemaker提供两个运算符来避免空值：
1. !： 指定缺失变量的默认值；
2. ??：判断变量是否存在。
!运算符有两种用法：variable!或variable!defaultValue。第一种用法不给变量指定默认值，表明默认值是空字符串、长度为0的集合、或长度为0的Map对象。
使用!运算符指定默认值并不要求默认值的类型和变量类型相同。

3.分支与循环

• if语句

root.put("random",new Random().nextInt(100));

<#if random lt 20>
    你好啊!${user}
<#elseif random lt 50>
    你很好啊!${user}
<#else>
    你非常好啊!${user}
</#if>

• foreach语句

        List list = new ArrayList();
        list.add(new Address("中国","北京"));
        list.add(new Address("中国","上海"));
        list.add(new Address("美国","纽约"));
        root.put("lst", list);

freemaker测试

<#list lst as dizhi >
<#--如果想要获取当前变量的顺序,使用_index-->
    <b>${dizhi_index}</b> <br/>
    <b>${dizhi.country}</b> <br/>
</#list>

• include语句
  增加被包含文件

<#include "included.txt" />

• 自定义宏指令

1.
//相当于函数
<#macro m1>   <#--定义指令m1 -->
    <b>aaabbbccc</b>
    <b>dddeeefff</b>
</#macro>

//相当于调用
<@m1 /><@m1 />  <#--调用上面的宏指令 -->

2.
<#macro m2 a b c >
    ${a}--${b}--${c}
</#macro>
<@m2 a="老高" b="老张" c="老马" />

3.
<#macro border> 
  <table border=4 cellspacing=0 cellpadding=4><tr><td> 
    <#nested> 
  </td></tr></table> 
</#macro>
<@border >表格中的内容！</@border>

• 命名空间
  定义b.ftl文件

<#macro copyright date>
  <p>Copyright (C) ${date} 你好.</p> 
</#macro> 
<#assign mail = "demo@163.com">

在a.ftl文件中引入b.ftl，从而可以使用b.ftl中定义的宏和变量：

测试命名空间：
<#import "b.ftl" as bb  />
<@bb.copyright date="2010-2011" />
${bb.mail}
<#assign mail="my@163.com"  />
${mail}
<#assign mail="my@163.com" in bb  />
${bb.mail}

测试命名空间：

<p>Copyright (C) 2010-2011 你好.</p> 
demo@163.com
my@163.com
my@163.com