Freemarker由浅入深01-环境搭建、测试

1. Freemarker是什么？
   FreeMarker 是一款模板引擎：即一种基于模板、用来生成输出文本(任何来自于 HTML格式的文本用来自动生成源代码)的通用工具。它是为 Java 程序员提供的一个开发包，或者说是一个类库。
   FreeMarker 不是 Web 开发的应用程序框架。它是一个适用于 Web 应用程序框架中的组件，但是 FreeMarker 引擎本身并不知道 HTTP 协议或 Java  Servlet 的存在。它仅仅来生成文本内容。
2. Freemarker能做什么？
   使用 FreeMarker 作为视图层的组件，是为了给诸如 Struts 这样的 Model 2 应用框架提供现成的解决方案。比如代替Jsp，生成静态的Html等等；
3. 如何获取Freemarker资源包以及说明书？
   Freemarker 目前最新2.3.20Jar包下载地址：http://jaist.dl.sourceforge.net/project/freemarker/freemarker/2.3.20/freemarker-2.3.20.tar.gz
   Freemarker 中文说明书下载地址： http://nchc.dl.sourceforge.net/project/freemarker/chinese-manual/FreeMarker_Manual_zh_CN.pdf
4. 搭建简易Demo
   (1)这里我使用maven来构建，pom.xml如下；如果使用传统的Eclipse Project，请将下载到的jar包加到lib下去；
   
   [html]  view plain copy

   1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
   2.   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
   3.   <modelVersion>4.0.0</modelVersion>  
   4.   
   5.   <groupId>org.wxp.freemarker</groupId>  
   6.   <artifactId>freemarker01</artifactId>  
   7.   <version>0.0.1-SNAPSHOT</version>  
   8.   <packaging>jar</packaging>  
   9.   
   10.   <name>freemarker01</name>  
   11.   <url>http://maven.apache.org</url>  
   12.   
   13.   <properties>  
   14.     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
   15.   </properties>  
   16.   
   17.   <dependencies>  
   18.     <dependency>  
   19.       <groupId>junit</groupId>  
   20.       <artifactId>junit</artifactId>  
   21.       <version>4.10</version>  
   22.       <scope>test</scope>  
   23.     </dependency>  
   24.       
   25.     <!-- Freemarker -->  
   26.     <dependency>  
   27.         <groupId>org.freemarker</groupId>  
   28.         <artifactId>freemarker</artifactId>  
   29.         <version>2.3.20</version>  
   30.     </dependency>  
   31.               
   32.   </dependencies>  
   33. </project>  
   
   (2)接下来，我们来创建Freemarker根据数据和模型生成Html页面的工具类
   
   [java]  view plain copy

   1. package org.wxp.freemarker;  
   2.   
   3. import java.io.File;  
   4. import java.io.FileWriter;  
   5. import java.io.IOException;  
   6. import java.io.PrintWriter;  
   7. import java.util.Map;  
   8.   
   9. import freemarker.template.Configuration;  
   10. import freemarker.template.Template;  
   11. import freemarker.template.TemplateException;  
   12.   
   13. public class FreemarkerUtil {  
   14.   
   15.     public Template getTemplate(String name) {  
   16.         Template temp = null;  
   17.         try {  
   18.             // 通过Freemarker的Configuration读取相应的Ftl  
   19.             Configuration cfg = new Configuration();  
   20.             // 设定去哪里读取相应的ftl模板  
   21.             cfg.setClassForTemplateLoading(this.getClass(), "/ftl");  
   22.             // 在模板文件目录中寻找名称为name的模板文件  
   23.             temp = cfg.getTemplate(name);  
   24.         } catch (IOException e) {  
   25.             e.printStackTrace();  
   26.         }  
   27.         return temp;  
   28.     }  
   29.   
   30.     /** 
   31.      * 控制台输出文件内容 
   32.      * @param name 
   33.      * @param rootMap 
   34.      */  
   35.     public void print(String name, Map<String, Object> rootMap) {  
   36.         try {  
   37.             // 通过Template类可以将模板文件输出到相应的文件  
   38.             Template temp = this.getTemplate(name);  
   39.             temp.process(rootMap, new PrintWriter(System.out));  
   40.         } catch (TemplateException e) {  
   41.             e.printStackTrace();  
   42.         } catch (IOException e) {  
   43.             e.printStackTrace();  
   44.         }  
   45.     }  
   46.   
   47.     /** 
   48.      * 将替换后的模板内容输出到文件 
   49.      * @param name 
   50.      * @param rootMap 
   51.      * @param outFile 
   52.      */  
   53.     public void fprint(String name, Map<String, Object> rootMap, String outFile) {  
   54.         FileWriter out = null;  
   55.         try {  
   56.             out = new FileWriter(new File("D:\\freemarker\\ftl\\html\\"  
   57.                     + outFile));  
   58.             Template template = this.getTemplate(name);  
   59.             template.process(rootMap, out);  
   60.         } catch (TemplateException e) {  
   61.             e.printStackTrace();  
   62.         } catch (IOException e) {  
   63.             e.printStackTrace();  
   64.         } finally {  
   65.             if (null != out)  
   66.                 try {  
   67.                     out.close();  
   68.                 } catch (IOException e) {  
   69.                     e.printStackTrace();  
   70.                 }  
   71.         }  
   72.     }  
   73. }  
   
   (3)然后，来创建Freemarker的模板文件，名为01.ftl；（其实可以看到，也就是在ftl文件中写html，除过Freemarker自己的标签）
   
   [html]  view plain copy

   1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
   2. <html>  
   3. <head>  
   4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
   5. <title>Insert title here</title>  
   6. </head>  
   7. <body>  
   8.     你好，${username}  
   9. </body>  
   10. </html>  
   
   (4)最后，来写一个测试类；
   
   [java]  view plain copy

   1. package org.wxp.freemarker;  
   2.   
   3. import java.util.ArrayList;  
   4. import java.util.Arrays;  
   5. import java.util.Date;  
   6. import java.util.HashMap;  
   7. import java.util.List;  
   8. import java.util.Map;  
   9.   
   10. import org.junit.Before;  
   11. import org.junit.Test;  
   12. import org.wxp.freemarker.model.User;  
   13.   
   14. public class TestFreemarker {  
   15.     private FreemarkerUtil freemarkerUtil;  
   16.     private Map<String, Object> rootMap = null;  
   17.     @Before  
   18.     public void setUp() {  
   19.         freemarkerUtil = new FreemarkerUtil();  
   20.         rootMap = new HashMap<String, Object>();  
   21.     }  
   22.       
   23.     @Test  
   24.     public void test01() {  
   25.         // 填充数据  
   26.         rootMap.put("username", "王三毛");  
   27.         // 打印到控制台  
   28.         freemarkerUtil.print("01.ftl", rootMap);  
   29.         // 输出到文件  
   30.         freemarkerUtil.fprint("01.ftl", rootMap, "01.html");  
   31.     }  
   32. }  
   
   (5)来看看生成的Html文件；
   
   [html]  view plain copy

   1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
   2. <html>  
   3. <head>  
   4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
   5. <title>Insert title here</title>  
   6. </head>  
   7. <body>  
   8.     你好，王三毛  
   9. </body>  
   10. </html>  
   浏览器展示效果如下：