一、概述
FreeMarker 是一個(gè)模板引擎，一個(gè)基于模板生成文本輸出的通用工具，使用純 Java 編寫，F(xiàn)reeMarker 被設(shè)計(jì)用來生成 HTML Web 頁(yè)面，特別是基于 MVC 模式的應(yīng)用程序，雖然 FreeMarker 具有一些編程的能力，但通常由 Java 程序準(zhǔn)備要顯示的數(shù)據(jù)，由FreeMarker 生成頁(yè)面，通過模板顯示準(zhǔn)備的數(shù)據(jù)（如下圖）
FreeMarker 不是一個(gè) Web 應(yīng)用框架，而適合作為 Web 應(yīng)用框架一個(gè)組件。FreeMarker 與容器無關(guān)，因?yàn)樗⒉恢?HTTP 或 Servlet；FreeMarker 同樣可以應(yīng)用于非Web應(yīng)用程序環(huán)境，F(xiàn)reeMarker 更適合作為 Model2 框架（如 Struts）的視圖組件，你也可以在模板中使用 JSP標(biāo)記庫(kù)。另外，F(xiàn)reeMarker是免費(fèi)的。
二、Freemarker的準(zhǔn)備條件
freemarker.2.3.16.jar，下載地址這里就不貼了..(這個(gè)jar包其實(shí)在struts2里面)
三、Freemarker生成靜態(tài)頁(yè)面的原理
Freemarker 生成靜態(tài)頁(yè)面，首先需要使用自己定義的模板頁(yè)面，這個(gè)模板頁(yè)面可以是最最普通的html，也可以是嵌套freemarker中的 取值表達(dá)式， 標(biāo)簽或者自定義標(biāo)簽等等，然后后臺(tái)讀取這個(gè)模板頁(yè)面，解析其中的標(biāo)簽完成相對(duì)應(yīng)的操作， 然后采用鍵值對(duì)的方式傳遞參數(shù)替換模板中的的取值表達(dá)式，做完之后 根據(jù)配置的路徑生成一個(gè)新的html頁(yè)面， 以達(dá)到靜態(tài)化訪問的目的。
四、Freemarker提供的標(biāo)簽
Freemarker提供了很多有用 常用的標(biāo)簽，F(xiàn)reemarker標(biāo)簽都是<#標(biāo)簽名稱>這樣子命名的，${value} 表示輸出變量名的內(nèi)容 ，具體如下：
1、list：該標(biāo)簽主要是進(jìn)行迭代服務(wù)器端傳遞過來的List集合，比如：
<#list nameList as names> ${names} </#list> name是list循環(huán)的時(shí)候取的一個(gè)循環(huán)變量，freemarker在解析list標(biāo)簽的時(shí)候，等價(jià)于：
for (String names : nameList) { System.out.println(names); } 2、if：該標(biāo)簽主要是做if判斷用的，比如：
<#if (names=="陳靖仇")> 他的武器是: 十五~~ </#if>
這個(gè)是條件判斷標(biāo)簽，要注意的是條件等式必須用括號(hào)括起來， 等價(jià)于：
if(names.equals("陳靖仇")){ System.out.println("他的武器是: 十五~~"); }
3、include：該標(biāo)簽用于導(dǎo)入文件用的。
<#include "include.html"/>
這個(gè)導(dǎo)入標(biāo)簽非常好用，特別是頁(yè)面的重用。
另外在靜態(tài)文件中可以使用${} 獲取值，取值方式和el表達(dá)式一樣，非常方便。
下面舉個(gè)例子（static.html）：
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Insert title here</title> </head> <body> 描述：${description} <br/> 集合大小:${nameList?size} <br/> 迭代list集合： <br/> <#list nameList as names> 這是第${names_index+1}個(gè)人，叫做：<label style="color:red">${names}</label> if判斷： <br/> <#if (names=="陳靖仇")> 他的武器是: 十五~~ <#elseif (names=="宇文拓")> <#--注意這里沒有返回而是在最后面--> 他的武器是: 軒轅劍~? <#else> 她的絕招是：蠱毒~~ </#if> <br/> </#list> 迭代map集合： <br/> <#list weaponMap?keys as key> key--->${key}<br/> value----->${weaponMap[key]!("null")} <#-- fremarker 不支持null, 可以用！ 來代替為空的值。 其實(shí)也可以給一個(gè)默認(rèn)值 value-----${weaponMap[key]?default("null")} 還可以 在輸出前判斷是否為null <#if weaponMap[key]??></#if>都可以 --> <br/> </#list> include導(dǎo)入文件： <br/> <#include "include.html"/> </body> </html> 實(shí)際代碼：
package com.chenghui.test; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStreamWriter; import java.io.Writer; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import freemarker.template.Configuration; import freemarker.template.DefaultObjectWrapper; import freemarker.template.Template; import freemarker.template.TemplateException; public class CreateHtml { public static void main(String[] args) { try { //創(chuàng)建一個(gè)合適的Configration對(duì)象 Configuration configuration = new Configuration(); configuration.setDirectoryForTemplateLoading(new File("D://project//webProject//WebContent//WEB-INF//template")); configuration.setObjectWrapper(new DefaultObjectWrapper()); configuration.setDefaultEncoding("UTF-8"); //這個(gè)一定要設(shè)置，不然在生成的頁(yè)面中 會(huì)亂碼 //獲取或創(chuàng)建一個(gè)模版。 Template template = configuration.getTemplate("static.html"); Map<String, Object> paramMap = new HashMap<String, Object>(); paramMap.put("description", "我正在學(xué)習(xí)使用Freemarker生成靜態(tài)文件！"); List<String> nameList = new ArrayList<String>(); nameList.add("陳靖仇"); nameList.add("玉兒"); nameList.add("宇文拓"); paramMap.put("nameList", nameList); Map<String, Object> weaponMap = new HashMap<String, Object>(); weaponMap.put("first", "軒轅劍"); weaponMap.put("second", "崆峒印"); weaponMap.put("third", "女媧石"); weaponMap.put("fourth", "神農(nóng)鼎"); weaponMap.put("fifth", "伏羲琴"); weaponMap.put("sixth", "昆侖鏡"); weaponMap.put("seventh", null); paramMap.put("weaponMap", weaponMap); Writer writer = new OutputStreamWriter(new FileOutputStream("success.html"),"UTF-8"); template.process(paramMap, writer); System.out.println("恭喜，生成成功~~"); } catch (IOException e) { e.printStackTrace(); } catch (TemplateException e) { e.printStackTrace(); } } }
這樣子基本上可以算的上可以簡(jiǎn)單的去做一點(diǎn)簡(jiǎn)單的生成了，但是要在實(shí)際中去運(yùn)用，還是差的很遠(yuǎn)的，因?yàn)閒reemarker給的標(biāo)簽完全滿足不了我們的需要，這時(shí)候就需要自定義標(biāo)簽來完成我們的需求了。。
五、Freemarker自定義標(biāo)簽
Freemarker自定義標(biāo)簽就是自己寫標(biāo)簽，然后自己解析，完全由自己來控制標(biāo)簽的輸入輸出，極大的為程序員提供了很大的發(fā)揮空間。
基于步驟：
以前寫標(biāo)簽需要在<后加# ，但是freemarker要識(shí)別自定義標(biāo)簽需要在后面加上@，然后后面可以定義一些參數(shù)，當(dāng)程序執(zhí)行template.process(paramMap, out);,就會(huì)去解析整個(gè)頁(yè)面的所有的freemarker標(biāo)簽。
自定義標(biāo)簽 需要自定義一個(gè)類，然后實(shí)現(xiàn)TemplateDirectiveModel，重寫execute方法，完成獲取參數(shù)，根據(jù)參數(shù)do something等等。。
將自定義標(biāo)簽與解析類綁定在一起需要在paramMap中放入該解析類的實(shí)例，存放的key與自定義標(biāo)簽一致即可。。
注意：在自定義標(biāo)簽中，如果標(biāo)簽內(nèi)什么也沒有，開始標(biāo)簽和結(jié)束標(biāo)簽絕對(duì)不能再同一行，不然會(huì)報(bào)錯(cuò)
freemarker.log.JDK14LoggerFactory$JDK14Logger error
我曾經(jīng)上當(dāng)過，這是freemarker 存在的bug。
下面是static.html的例子：
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Insert title here</title> </head> <body> <#--自定義變量--> <#assign num='hehe'/> ${num} <br/> 自定義標(biāo)簽 <@content name="chenghui" age="120"> ${output} ${append} </@content> </body> </html>
下面是上面的static.html模板的解析類：
package com.chenghui.test; import static freemarker.template.ObjectWrapper.DEFAULT_WRAPPER; import java.io.IOException; import java.io.Writer; import java.util.Map; import freemarker.core.Environment; import freemarker.template.TemplateDirectiveBody; import freemarker.template.TemplateDirectiveModel; import freemarker.template.TemplateException; import freemarker.template.TemplateModel; import freemarker.template.TemplateModelException; import freemarker.template.TemplateNumberModel; import freemarker.template.TemplateScalarModel; /** * 自定義標(biāo)簽解析類 * @author Administrator * */ public class ContentDirective implements TemplateDirectiveModel{ private static final String PARAM_NAME = "name"; private static final String PARAM_AGE = "age"; @Override public void execute(Environment env, Map params,TemplateModel[] loopVars, TemplateDirectiveBody body) throws TemplateException, IOException { if(body==null){ throw new TemplateModelException("null body"); }else{ String name = getString(PARAM_NAME, params); Integer age = getInt(PARAM_AGE, params); //接收到參數(shù)之后可以根據(jù)做具體的操作，然后將數(shù)據(jù)再在頁(yè)面中顯示出來。 if(name!=null){ env.setVariable("output", DEFAULT_WRAPPER.wrap("從ContentDirective解析類中獲得的參數(shù)是："+name+", ")); } if(age!=null){ env.setVariable("append", DEFAULT_WRAPPER.wrap("年齡："+age)); } Writer out = env.getOut(); out.write("從這里輸出可以再頁(yè)面看到具體的內(nèi)容，就像document.writer寫入操作一樣。<br/>"); body.render(out); /* 如果細(xì)心的話，會(huì)發(fā)現(xiàn)頁(yè)面上是顯示out.write（）輸出的語句，然后再輸出output的內(nèi)容， 可見 在body在解析的時(shí)候會(huì)先把參數(shù)放入env中，在頁(yè)面遇到對(duì)應(yīng)的而來表單時(shí)的才會(huì)去取值 但是，如果該表單時(shí)不存在，就會(huì)報(bào)錯(cuò)， 我覺得這里freemarker沒有做好，解析的時(shí)候更加會(huì)把錯(cuò)誤暴露在頁(yè)面上。 可以這樣子彌補(bǔ)${output!"null"},始終感覺沒有el表達(dá)式那樣好。 */ } } /** * 獲取String類型的參數(shù)的值 * @param paramName * @param paramMap * @return * @throws TemplateModelException */ public static String getString(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{ TemplateModel model = paramMap.get(paramName); if(model == null){ return null; } if(model instanceof TemplateScalarModel){ return ((TemplateScalarModel)model).getAsString(); }else if (model instanceof TemplateNumberModel) { return ((TemplateNumberModel)model).getAsNumber().toString(); }else{ throw new TemplateModelException(paramName); } } /** * * 獲得int類型的參數(shù) * @param paramName * @param paramMap * @return * @throws TemplateModelException */ public static Integer getInt(String paramName, Map<String, TemplateModel> paramMap) throws TemplateModelException{ TemplateModel model = paramMap.get(paramName); if(model==null){ return null; } if(model instanceof TemplateScalarModel){ String str = ((TemplateScalarModel)model).getAsString(); try { return Integer.valueOf(str); } catch (NumberFormatException e) { throw new TemplateModelException(paramName); } }else if(model instanceof TemplateNumberModel){ return ((TemplateNumberModel)model).getAsNumber().intValue(); }else{ throw new TemplateModelException(paramName); } } } 然后再前面的實(shí)際代碼中加上：
//自定義標(biāo)簽解析 paramMap.put("content", new ContentDirective()); 這樣子基本上可以使用，freemarker完成自定義標(biāo)簽了，解決一寫簡(jiǎn)單的業(yè)務(wù)邏輯， 但是在實(shí)際的項(xiàng)目中不可能這樣子去做，因?yàn)檫€沒有和spring進(jìn)行集成使用，每次都需要在解析的時(shí)候把解析類的實(shí)例放進(jìn)去。。
新聞熱點(diǎn)
疑難解答
圖片精選
