FreeMarker 是一個用 Java 語言編寫的模板引擎，它基於模板來生成文本輸出。FreeMarker 與 Web 容器無關，即在 Web 運行時，它並不知道 Servlet 或 HTTP。它不僅可以用作表現層的實現技術，而且還可以用於生成 XML，JSP 或 Java 等。 一、Freemarker 的介紹 Freemarker 是一款模板引擎，是一種基於模版生成靜態文件的通用 工具，它是為 java 程序員提供的一個開發包，或者說是一個類庫，它不是面向最終用戶的，而是為程序員提供了一款可以嵌入他們開發產品的應用程序。 Freemarker 是使用純 java 編寫的，為了提高頁面的訪問速度，需要把頁面靜態化， 那么 Freemarker 就是被用來生成 html 頁面。 到目前為止，Freemarker 使用越來越廣泛，不光光只是它強大的生成技術，而且它能夠與 spring 進行很好的集成。 現在開始一層層揭開它的神秘面紗。。 二、Freemarker 的准備條件 freemarker.2.3.16.jar 三、Freemarker 生成靜態頁面的原理 Freemarker 生成靜態頁面，首先需要使用自己定義的模板頁面，這個模板頁面可以是最最普通的 html，也可以是嵌套 freemarker 中的 取值表達式， 標簽或者自定義標簽等等，然后后台讀取這個模板頁面，解析其中的標簽完成相對應的操作， 然后采用鍵值對的方式傳遞參數替換模板中的的取值表達式，做完之后 根據配置的路徑生成一個新的 html 頁面， 以達到靜態化訪問的目的。 四、Freemarker 提供的標簽 Freemarker 提供了很多有用 常用的標簽，Freemarker 標簽都是 <# 標簽名稱> 這樣子命名的，${value} 表示輸出變量名的內容 ，具體如下： list：該標簽主要是進行迭代服務器端傳遞過來的 List 集合，比如： <#list nameList as names> ${names} </#list> name 是 list 循環的時候取的一個循環變量，freemarker 在解析 list 標簽的時候，等價於： for (String names : nameList) { System.out.println(names); } if： 該標簽主要是做 if 判斷用的，比如： <#if (names=="陳靖仇")> 他的武器是: 十五~~ </#if> 這個是條件判斷標簽，要注意的是條件等式必須用括號括起來， 等價於： if(names.equals("陳靖仇")){ System.out.println("他的武器是: 十五~~"); } include：該標簽用於導入文件用的。 <#include "include.html"/> 這個導入標簽非常好用，特別是頁面的重用。 另外在靜態文件中可以使用 ${} 獲取值，取值方式和 el 表達式一樣，非常方便。 下面舉個例子（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}個人，叫做：<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, 可以用！ 來代替為空的值。 其實也可以給一個默認值 value-----${weaponMap[key]?default("null")} 還可以 在輸出前判斷是否為null <#if weaponMap[key]??></#if>都可以 --> <br/> </#list> include導入文件： <br/> <#include "include.html"/> </body> </html> 實際代碼： 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 { //創建一個合適的Configration對象 Configuration configuration = new Configuration(); configuration.setDirectoryForTemplateLoading(new File("D:\\project\\webProject\\WebContent\\WEB-INF\\template")); configuration.setObjectWrapper(new DefaultObjectWrapper()); configuration.setDefaultEncoding("UTF-8"); //這個一定要設置，不然在生成的頁面中 會亂碼 //獲取或創建一個模版。 Template template = configuration.getTemplate("static.html"); Map<String, Object> paramMap = new HashMap<String, Object>(); paramMap.put("description", "我正在學習使用Freemarker生成靜態文件！"); 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", "神農鼎"); 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(); } } } 這樣子基本上可以算的上可以簡單的去做一點簡單的生成了，但是要在實際中去運用，還是差的很遠的，因為 freemarker 給的標簽完全滿足不了我們的需要，這時候就需要自定義標簽來完成我們的需求了。。 五、Freemarker 自定義標簽 Freemarker 自定義標簽就是自己寫標簽，然后自己解析，完全由自己來控制標簽的輸入輸出，極大的為程序員提供了很大的發揮空間。 基於步驟： 以前寫標簽需要在 <后加# ，但是 freemarker 要識別自定義標簽需要在后面加上 @，然后后面可以定義一些參數，當程序執行 template.process(paramMap, out);, 就會去解析整個頁面的所有的 freemarker 標簽。 自定義標簽 需要自定義一個類，然后實現 TemplateDirectiveModel，重寫 execute 方法，完成獲取參數，根據參數 do something 等等。 將自定義標簽與解析類綁定在一起需要在 paramMap 中放入該解析類的實例，存放的 key 與自定義標簽一致即可。 注意：在自定義標簽中，如果標簽內什么也沒有，開始標簽和結束標簽絕對不能再同一行，不然會報錯 freemarker.log.JDK14LoggerFactory$JDK14Logger error 例: 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/> 自定義標簽 <@content name="chenghui" age="120"> ${output} ${append} </@content> </body> </html> static.html 模板解析類： 參數解釋： TemplateDirectiveModel 接口是 freemarker 自定標簽或者自定義指令的核心處理接口。通過實現該接口，用戶可以自定義標簽（指令）進行任意操作， 任意文本寫入模板的輸出。 該接口中只定義了如下方法，當模板頁面遇到用戶自定義的標簽指令時，該方法會被執行。 public void execute(Environment env, Map params, TemplateModel[] loopVars, TemplateDirectiveBody body) throws TemplateException, IOException; @param env：系統環境變量，通常用它來輸出相關內容，如 Writer out = env.getOut(); @param params：自定義標簽傳過來的對象，其 key = 自定義標簽的參數名，value 值是 TemplateModel 類型，而 TemplateModel 是一個接口類型，通常我們都使用 TemplateScalarModel 接口來替代它獲取一個 String 值，如 TemplateScalarModel.getAsString(); 當然還有其它常用的替代接口，如 TemplateNumberModel 獲取 number，TemplateHashModel 等 @param loopVars 循環替代變量 @param body 用於處理自定義標簽中的內容，如 <@myDirective> 將要被處理的內容 /@myDirective；當標簽是 <@myDirective /> 格式時，body=null 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; /** * 自定義標簽解析類 * @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); //接收到參數之后可以根據做具體的操作，然后將數據再在頁面中顯示出來。 if(name!=null){ env.setVariable("output", DEFAULT_WRAPPER.wrap("從ContentDirective解析類中獲得的參數是："+name+", ")); } if(age!=null){ env.setVariable("append", DEFAULT_WRAPPER.wrap("年齡："+age)); } Writer out = env.getOut(); out.write("從這里輸出可以再頁面看到具體的內容，就像document.writer寫入操作一樣。<br/>"); body.render(out); /* 如果細心的話，會發現頁面上是顯示out.write（）輸出的語句，然后再輸出output的內容， 可見 在body在解析的時候會先把參數放入env中，在頁面遇到對應的而來表單時的才會去取值 但是，如果該表單時不存在，就會報錯， 我覺得這里freemarker沒有做好，解析的時候更加會把錯誤暴露在頁面上。 可以這樣子彌補${output!"null"},始終感覺沒有el表達式那樣好。 */ } } /** * 獲取String類型的參數的值 * @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類型的參數 * @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); } } } 然后再前面的實際代碼中加上： paramMap.put("content", new ContentDirective()); 這樣子基本上可以使用，freemarker 完成自定義標簽了，解決一寫簡單的業務邏輯， 但是在實際的項目中不可能這樣子去做，因為還沒有和 spring 進行集成使用，每次都需要在解析的時候把解析類的實例放進去。