FreeMarker是一款
模板引擎
: 即一种基于模板和要改变的数据,并用来生成输出文本(
HTML
网页、
电子邮件
、
配置文件
、
源代码
等)的通用工具。它不是面向最终用户的,而是一个Java类库,是一款程序员可以嵌入他们所开发产品的组件。
通过Xdocreport和Freemaker可用来生成docx文件
GitHub:
http://code.google.com/p/xdocreport/
参考文章:http://www.jianshu.com/p/4fe00aa02ea2
需要引入的jar包
fr.opensagres.xdocreport.converter-1.0.4.jar
fr.opensagres.xdocreport.core-1.0.4.jar
fr.opensagres.xdocreport.document.docx-1.0.4.jar
fr.opensagres.xdocreport.document-1.0.4.jar
fr.opensagres.xdocreport.template.freemarker-1.0.4.jar
fr.opensagres.xdocreport.template-1.0.4.jar
在java引用:
import fr.opensagres.xdocreport.document.IXDocReport;
import fr.opensagres.xdocreport.core.XDocReportException;
import fr.opensagres.xdocreport.document.registry.XDocReportRegistry;
import fr.opensagres.xdocreport.template.IContext;
import fr.opensagres.xdocreport.template.TemplateEngineKind;
//倒入模版
InputStream in =this.getClass().getClassLoader().getResourceAsStream("XXX.docx");
//设置模版类型
IXDocReport report = XDocReportRegistry.getRegistry().loadReport(in,TemplateEngineKind.Freemarker);
//创建上下文
IContext context = report.createContext();
//将将输出信息object放入上下文中
context.put("object", object);
//OutputStream输出流,用以输出文件
OutputStream out = new FileOutputStream(new File("XXX.docx"));
//将生成文件
report.process(context,out);
out.flush();
在docx中插入变量的方式:
[#else]/[#elseif ......]
[/#if]
注:当使用大于号时,应用()包起表达式,或者使用gt,否则if语句将提前结束,会报语句不完整报错
(>=或者gte;<或者lt;<=或者lte)
4.switch这些指令显然是分支指令,作用类似于Java的switch语句,switch指令的语法结构如下:
[#switch value]
[#case refValue]...[#break]
[#case refValue]...[#break]
[#default]...
5.assign指令
assign指令在前面已经使用了多次,它用于为该模板页面创建或替换一个顶层变量,assign指令的用法有多种,包含创建或替换一个顶层变量, 或者创建或替换多个变量等,它的最简单的语法如下:<#assign name=value [in namespacehash]>,这个用法用于指定一个名为name的变量,该变量的值为value,
[#assign x = 0]
"[#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as n]"
[#assign x = x+1]
[/#list]
上面的代码将产生如下输出:星期一 星期二 星期三 星期四 星期五 星期六 星期天
虽然assign指定了这种复杂变量值的用法,但是我们也不要滥用这种用法,如下例子:<#assign x>Hello ${user}!,以上代码改为如下写法更合适:<#assign x="Hello ${user}!">
6. setting指令
该指令用于设置FreeMarker的运行环境,该指令的语法格式如下:<#setting name=value>,在这个格式中,name的取值范围包含如下几个:
locale:该选项指定该模板所用的国家/语言选项
number_format:指定格式化输出数字的格式
boolean_format:指定两个布尔值的语法格式,默认值是true,false
date_format,time_format,datetime_format:指定格式化输出日期的格式
time_zone:设置格式化输出日期时所使用的时区
classic_compatible:设置兼容传统模式
7.内置函数
一、Sequence的内置函数
1.sequence?first返回sequence的第一个值。
2.sequence?last返回sequence的最后一个值。
3.sequence?reverse将sequence的现有顺序反转,即倒序排序
4.sequence?size返回sequence的大小
5.sequence?sort将sequence中的对象转化为字符串后顺序排序
6.sequence?sort_by(value)按sequence中对象的属性value进行排序
注意:Sequence不能为null。
二、Hash的内置函数
1.hash?keys返回hash里的所有key,返回结果为sequence
2.hash?values返回hash里的所有value,返回结果为sequence
三、操作字符串函数
1.substring(start,end)从一个字符串中截取子串
start:截取子串开始的索引,start必须大于等于0,小于等于end
end:截取子串的长度,end必须大于等于0,小于等于字符串长度,如果省略该参数,默认为字符串长度。
2.cap_first将字符串中的第一个单词的首字母变为大写。
3.uncap_first将字符串中的第一个单词的首字母变为小写。
4.capitalize将字符串中的所有单词的首字母变为大写
5.date,time,datetime将字符串转换为日期
[#assign date=”2017-11-12”?date(“yyyy-MM-dd”)]
[#assign time=”10:28:20”?time(“HH:mm:ss”)]
注意:如果指定的字符串格式不正确将引发错误。
6.ends_with判断某个字符串是否由某个子串结尾,返回布尔值。
注意:布尔值必须转换为字符串才能输出
8.index_of(substring,start)在字符串中查找某个子串,返回找到子串的第一个字符的索引,如果没有找到子串,则返回-1。
9.length返回字符串的长度${“string”?length}à结果为6
10.lower_case将字符串转为小写
11.upper_case将字符串转为大写
12.contains判断字符中是否包含某个子串。返回布尔值
13.number将字符串转换为数字
14.replace用于将字符串中的一部分从左到右替换为另外的字符串。
15.split使用指定的分隔符将一个字符串拆分为一组字符串
16.trim删除字符串首尾空格
四、操作数字
1.c用于将数字转换为字符串
${123?c}结果为123
2.string用于将数字转换为字符串
Freemarker中预订义了三种数字格式:number,currency(货币)和percent(百分比)其中number为默认的数字格式转换
<#assign tempNum=20>
${tempNum}
${tempNum?string.number}或${tempNum?string(“number”)}à结果为20
${tempNum?string.currency}或${tempNum?string(“currency”)}à结果为¥20.00