Freemarker的使用

来源：互联网发布：淘宝c 编辑：程序博客网时间：2024/06/10 00:32

Freemarker简介
Freemakrer是用于java中通过向已定义好的模板文件中传递map或JavaBean，从而生成<<文本>>文件的一个工具。

网站：http://freemarker.sourceforge.net/
在线文档 ：http://freemarker.sourceforge.net/docs/index.html
当然，网上也有中文版的pdf文档，也很实用。

书写javaBean
由于我想实验传递javaBean，毕竟Map的使用还是有些麻烦。在这个javaBean中将一般常用类型都包含了。

Java代码  
import java.math.BigDecimal;  
import java.sql.Date;  
import java.sql.Time;  
import java.sql.Timestamp;  
  
public class SimpleBean {  
    private boolean bolField;  
    private int intField;  
    private BigDecimal bigDecimal;  
    private String string;  
    private Date date;  
    private Time time;  
    private Timestamp timestamp;  
}  

书写Freemarker的模板文件

其实就是从源码中帖过来小小改动即可。

Java代码  
<@license/>  
  
<#list list as bean>   
static class SimpleBean {  
    private boolean bolField;         <#if bean.bolField>true<#else>false</#if>  ${bean.bolField?string("yes","no")}  
    private int intField;             ${bean.intField}  
    private BigDecimal bigDecimal;    ${bean.bigDecimal!'default value while empty'}  
    private String string;            ${bean.string!}  
    private Date date;                ${bean.date!}  
    private Time time;                ${bean.time!}  
    private Timestamp timestamp;      ${bean.timestamp!}  
}  
</#list>  

自定义的tag标记

请注意，我使用了一个自定义的tag标记，这个实现也很简单，实现TemplateDirectiveModel即可。

Java代码  
public class LicenseDirective implements TemplateDirectiveModel {  
  
    public void execute(Environment env, Map params, TemplateModel[] loopVars,  
            TemplateDirectiveBody body) throws TemplateException, IOException {  
        env.getOut().append("/**\n * @author colin\n */");  
    }  
  
}  

程序主体的代码

Java代码  
public class UsingFreemarker {  
    public static void main(String[] args) throws Exception {  
        Configuration cfg = new Configuration();  
        cfg.setObjectWrapper(new DefaultObjectWrapper());  
        cfg.setClassForTemplateLoading(UsingFreemarker.class, "");  
        cfg.setNumberFormat("0.####");  
        cfg.setDateFormat("yyyy-MM-dd");  
        cfg.setTimeFormat("hh:mm");  
        cfg.setDateTimeFormat("yyyy-MM-dd hh:mm");  
        // cfg.setBooleanFormat("true,false"); // 无效果  
  
        cfg.setSharedVariable("license", new LicenseDirective());  
  
        List list = new ArrayList();  
        list.add(new SimpleBean(false, 0, null, null, null, null, null));  
        long now = new java.util.Date().getTime();  
        list.add(new SimpleBean(true, 1, new BigDecimal("12.345678"),  
                "freemarker", new Date(now), new Time(now), new Timestamp(now)));  
          
        Map root = new HashMap();  
        root.put("list", list);  
          
//      File file = new File("Hello.txt");  
//      FileOutputStream fos = new FileOutputStream(file);  
//      Writer out = new OutputStreamWriter(fos);  
        Writer out = new OutputStreamWriter(System.out);  
          
        Template t = cfg.getTemplate("hello.ftl");  
        t.process(root, out);  
        out.flush();  
    }  
}  

运行

Java代码  
/** 
 * @author colin 
 */  
static class SimpleBean {  
    private boolean bolField;         false  no  
    private int intField;             0  
    private BigDecimal bigDecimal;    default value while empty  
    private String string;              
    private Date date;                  
    private Time time;                  
    private Timestamp timestamp;        
}  
static class SimpleBean {  
    private boolean bolField;         true  yes  
    private int intField;             1  
    private BigDecimal bigDecimal;    12.3457  
    private String string;            freemarker  
    private Date date;                2011-03-13  
    private Time time;                10:22  
    private Timestamp timestamp;      2011-03-13 10:22  
}  

注意事项：

Freemarker对于null的结果会抛异常，需要自己处理。比如：
1. ! 输出空格
2. !'the default while empty' 指定一个为空时候的默认值
Freemarker对于boolean的结果会抛异常，需要自己处理。比如：
1. cfg.setBooleanFormat("true,false"); 在我这边尝试，没有效果，还是需要额外处理boolean的输出
2. <#if bean.bolField>true<#else>false</#if> 用if else 判断一下，输出自定义的值
3. ${bean.bolField?string(“yes”,”no”)} 转义