静态网页化技术之Freemarker

1. 关于网页静态化技术

网页静态化解决方案在实际开发中运用比较多，例如新闻网站，门户网站中的新闻频道或者是文章类的频道。

对于电商网站的商品详细页来说，至少几百万个商品，每个商品又有大量的信息，这样的情况同样也适用于使用网页静态化来解决。

网页静态化技术和缓存技术的共同点都是为了减轻数据库的访问压力，但是具体的应用场景不同，缓存比较适合小规模的数据，而网页静态化比较适合大规模且相对变化不太频繁的数据。另外网页静态化还有利于SEO。

2. 关于Freemarker

FreeMarker 是一个用 Java 语言编写的模板引擎，它基于模板来生成文本输出。FreeMarker与 Web 容器无关，即在 Web 运行时，它并不知道 Servlet 或 HTTP。它不仅可以用作表现层的实现技术，而且还可以用于生成 XML，JSP 或 Java 等。

image.png

3. Freemarker基本使用

3.1. 创建工程并引入依赖

创建Java的Maven工程，同时引入Freemarker依赖，具体引入项如下所示。

 org.freemarker
 freemarker
 2.3.23
 

3.2. 创建模板文件

模板文件中三种基本元素：

1、文本，直接输出的部分
2、注释，即<#--...-->格式不会输出
3、插值（Interpolation）：即${..}部分,将使用数据模型中的部分替代输出 在工程目录下创建模板文件test.ftl（路径可自拟），内容如下：

    
    

<#-- 这是一个注释，不会有任何输出  -->
${name},你好。${message}

3.3. 编写生成文件代码

第一步：创建一个 Configuration 对象，直接 new 一个对象。构造方法的参数就是 freemarker的版本号。
第二步：设置模板文件所在的路径。
第三步：设置模板文件使用的字符集。一般就是 utf-8.
第四步：加载一个模板，创建一个模板对象。
第五步：创建一个模板使用的数据集，可以是 pojo 也可以是 map。一般是 Map。
第六步：创建一个 Writer 对象，一般创建一 FileWriter 对象，指定生成的文件名。
第七步：调用模板对象的 process 方法输出文件。
第八步：关闭流
代码：

@Test
    public void CreateStaticHtml() throws Exception {
        //1.创建配置类
        Configuration configuration=new Configuration(Configuration.getVersion());
        //2.设置模板所在的目录
        configuration.setDirectoryForTemplateLoading(new File("D:\\JavaProjects\\MavenPractice\\manager-standalone\\src\\main\\resources\\templates\\"));
        //3.设置字符集
        configuration.setDefaultEncoding("utf-8");
        //4.加载模板
        Template template = configuration.getTemplate("test.ftl");
        //5.创建数据模型
        Map map=new HashMap();
        map.put("name", "李小良");
        map.put("message", "这是一个Freemarker测试生成的静态页面");
        //6.创建Writer对象
        Writer out =new FileWriter(new File("d:\\test.html"));
        //7.输出
        template.process(map, out);
        //8.关闭Writer对象
        out.close();
    }

3.4. 执行代码生成HTML

执行代码将会在D盘的根目录下生成一个test.html的文件，使用浏览器打开该文件，如下图所示，表示操作成功。

image.png

4. Freemarker的FTL指令

4.1. assign指令

此指令用于在页面上定义一个变量
（1）定义简单类型：

<#assign linkman="李先生">
联系人：${linkman}

（2）定义对象类型：

<#assign info={"mobile":"13011223344",'address':'四川省成都市'} >
电话：${info.mobile} 地址：${info.address}

4.2. include指令

此指令用于模板文件的嵌套
创建模板文件head.ftl

这是一个内嵌模板

我们修改test.ftl，在模板文件中使用include指令引入刚才我们建立的模板

<#include "head.ftl">

4.3. if指令

在模板文件上添加

<#if success=true>
  这是正确的
<#else> 
  这是错误的

在代码中对str变量赋值

map.put("success", true);

在freemarker的判断中，可以使用= 也可以使用==

4.4. list指令

（1）代码中对变量goodsList赋值

        List goodsList=new ArrayList();
        Map goods1=new HashMap();
        goods1.put("name", "苹果");
        goods1.put("price", 5.8);
        Map goods2=new HashMap();
        goods2.put("name", "香蕉");
        goods2.put("price", 2.5);
        Map goods3=new HashMap();
        goods3.put("name", "橘子");
        goods3.put("price", 3.2);
        goodsList.add(goods1);
        goodsList.add(goods2);
        goodsList.add(goods3);
        map.put("goodsList", goodsList);

（2）在模板文件上添加

----商品价格表----

<#list goodsList as goods>
  ${goods_index+1} 商品名称： ${goods.name} 价格：${goods.price}

如果想在循环中得到索引，使用循环变量+_index就可以得到。

5. 内建函数

内建函数语法格式： 变量+?+函数名称

5.1. 获取集合大小

我们通常要得到某个集合的大小，使用size函数来实现，代码如下：

共 ${goodsList?size} 条记录

5.2. 转换JSON字符串为对象

我们通常需要将json字符串转换为对象，那如何处理呢？看代码

    <#assign text="{'bank':'工商银行','account':'10101920201920212'}" />
    <#assign data=text?eval />
    开户行：${data.bank}  账号：${data.account}

5.3. 日期格式化

代码中对变量赋值：

dataModel.put("today", new Date());

在模板文件中加入

当前日期：${today?date} 

当前时间：${today?time} 
   
当前日期+时间：${today?datetime} 
        
日期格式化：  ${today?string("yyyy年MM月")}

运行效果如下：

image.png

5.4. 数字转换为字符串

代码中对变量赋值：

map.put("point", 102920122);

修改模板：

累计积分：${point}

页面显示：

image.png

我们会发现数字会以每三位一个分隔符显示，有些时候我们不需要这个分隔符，就需要将数字转换为字符串,使用内建函数c

累计积分：${point?c}

页面显示效果如下：

image.png

6. 运算符

6.1. 算数运算符

Freemarker表达式中完全支持算术运算，Freemarker支持的算术运算符包括:+, - , * , / , %

6.2. 逻辑运算符

逻辑运算符有如下几个: 逻辑与:&& 逻辑或:|| 逻辑非:! 逻辑运算符只能作用于布尔值,否则将产生错误

6.3. 比较运算符

表达式中支持的比较运算符有如下几个:

=或者==:判断两个值是否相等. 
!=:判断两个值是否不等. 
>或者gt:判断左边值是否大于右边值 
>=或者gte:判断左边值是否大于等于右边值 
<或者lt:判断左边值是否小于右边值 
<=或者lte:判断左边值是否小于等于右边值 

注意: =和!=可以用于字符串,数值和日期来比较是否相等,但=和!=两边必须是相同类型的值,否则会产生错误,而且FreeMarker是精确比较,"x","x ","X"是不等的.其它的运行符可以作用于数字和日期,但不能作用于字符串,大部分的时候,使用gt等字母运算符代替>会有更好的效果,因为 FreeMarker会把>解释成FTL标签的结束字符,当然,也可以使用括号来避免这种情况,如:<#if (x>y)>

6.4. 空值处理运算符

如果你在模板中使用了变量但是在代码中没有对变量赋值，那么运行生成时会抛出异常。但是有些时候，有的变量确实是null，怎么解决这个问题呢？

6.4.1 判断某变量是否存在:“??”

用法为:variable??,如果该变量存在，返回true，否则返回false

<#if aaa??>
  aaa变量存在
<#else>
  aaa变量不存在

6.4.2 缺失变量默认值:“!”

我们除了可以判断是否为空值，也可以使用!对null值做转换处理，在模板文件中加入

 ${aaa!'-'}

在代码中不对aaa赋值，也不会报错了，当aaa为null则返回！后边的内容。

文档下载地址：

https://wenku.baidu.com/view/1ec35155541252d380eb6294dd88d0d233d43c3b