近段时间因为项目比较忙所以很少来javaEye溜转，现在终于忙完了。这期间做了一个word模板填充的功能，觉得应该放上来保存下。
问题的缘由是这样的，项目里面有个功能是下载记录客户明细的一个word，之前的做法是将整个word以流的形式写在类里面，然后将值填充到word流里面需要填充地方，最后使用sturts2的文件机制将word流提供给客户另存为word文件。这里面的问题就是项目里面每增加一个模板就要去在类里面写一次word流，而且需要组装的数据里包含了很多的迭代等操作，所以这块的工作量很大，而且很不好维护。于是老大让我将这一块的word不要在类里面直接去处理word流。
最后我使用的方法是将需要填充的word做成一个通用的模板，里面需要填充数据的地方使用特定的代号去取代，然后将这个这个word放到项目中。基本的思想是当要用到这个模板的时候通过程序将word读取成流的形式，然后在类里面将需要填充的数据组装成一到一个HashMap里，键和通用模板的代号一致，值是将要填充的内容。再写一个类来将HashMap里面的值替换掉word流里对应的键。 最后将组装后的流输出。
这个好像说起来很拗口，也不好解释 下面以图文的形式来解释把：
1.先拿到一个他们现在在用的word，
将word里面需要填充的地方使用[替代码]来替代
2.在类里面进行hashmap的组装
public static void main(String[] args) throws Exception {
DocGenerator gen = new DocGenerator();
Map data = new HashMap();
data.put("[ORDER_TITLE]", "**科技集团差旅管理服务公司酒店预订单（酒店联）");
data.put("[ORDER_NO]", "HB080709101712996");
data.put("[OPTRID]", "IHZYF011");
//子项
List lstValue = new ArrayList();
Map subData = new HashMap();
subData.put("[CUST_NAME]", "张三");
subData.put("[ROOM_STYLE]", "单床房 大床 宽带 免费");
subData.put("[DATE1]", "2008-07-09抵 2008-07-12离");
subData.put("[DATE2]", "2008-07-09 至 2008-07-12 每晚 111 元 (单早)");
subData.put("[DATE3]", "2008-07-09 至 2008-07-12 每晚 1.0 间");
lstValue.add(subData);
subData = new HashMap();
subData.put("[CUST_NAME]", "李四");
subData.put("[ROOM_STYLE]", "双人床房 大床 宽带 免费");
subData.put("[DATE1]", "2008-07-09抵 2008-07-12离");
subData.put("[DATE2]", "2008-07-09 至 2008-07-12 每晚 111 元 (单早)");
subData.put("[DATE3]", "2008-07-09 至 2008-07-12 每晚 1.0 间");
lstValue.add(subData);
data.put("CUSTS", lstValue);
gen.generatorDoc(data, "1");//调用处理方法
}
3.处理类书写
/**
* 模板生成类
* @author chm20081009
*
*/
public class DocGenerator {
/**
* 根据传入的数据和模板ID生成
* @author chm
* @param data
* @param templetid
* @throws Exception
*/
@SuppressWarnings("unchecked")
public static String generatorDoc(Map data, String templetid) throws Exception {
String result = "";
// 根据templetid获取模板
String templet = getTemplet(templetid);
//处理模板
templet =split(data,templet);
//去除没有数据的定义变量
templet = templet.replaceAll("\\[\\w+]", "");
//saveDoc(templet);
return templet;
}
/**
* 拆分模板
* @author chm
* @param data
* @param templet
* @return
*/
private static String split(Map data,String templet){
//
Iterator iter = data.keySet().iterator();
//System.out.println("templet==="+templet);
// templet = "哈哈哈[ORDER_TITLE]测试数据";
while (iter.hasNext()) {
String key = iter.next().toString();
Object value = data.get(key);
//替换模板上的标签
templet = replace(key,value,templet);
}
return templet;
}
/**
* 负责替换
* @return
*/
private static String replace(String key , Object value ,String templet){
if (value instanceof String) {// 单值替换
templet = templet.replaceAll("\\" + key, value.toString());
} else if (value instanceof List) {// 列表
// 从模板中截取迭代定义部分，把整个模板分成3部分
String firstTemplet = templet.substring(0, templet
.indexOf("[ITERATE_BEGIN_" + key + "]"));
String middleTemplet = templet.substring(templet
.indexOf("[ITERATE_BEGIN_" + key + "]")
+ ("[ITERATE_BEGIN_" + key + "]").length(), templet
.indexOf("[ITERATE_END_" + key + "]"));
String lastTemplet = templet.substring(templet
.indexOf("[ITERATE_END_" + key + "]")
+ ("[ITERATE_END_" + key + "]").length());
List lstValue = (List) value;// 里面存放的是Map数据
StringBuffer middleResult = new StringBuffer(100);
/**
* 递归调用
*/
for (int i = 0; i < lstValue.size(); i++) {
Map subData = (Map) lstValue.get(i);
String middleData = middleTemplet;
middleData = split(subData,middleData);
middleResult.append(middleData);
}
//将中间替换的数据和拆分开的前后半部分模板组装起来
templet = firstTemplet + middleResult.toString() + lastTemplet;
}
return templet;
}
/**
* 根据模板ID获取模板的内容
* @param templetid
* @return
* @throws Exception
*/
private static String getTemplet(String templetid) throws Exception {
StringBuffer result = new StringBuffer(100);
/*
*可以根据模板ID先到cache里面进行匹配，匹配到模板，直接从缓存中获取
*/
// String fileName = getTempletName(templetid);//写死的文件路径
String fileName = TempletCache.getTemplet(templetid);//从内存根据id获取模板完全路径
BufferedReader in = null;
try {
// in = new BufferedReader(new InputStreamReader(new FileInputStream(
// fileName), "UTF-8"));
in = new BufferedReader(new InputStreamReader(TempletCache.class
.getClassLoader().getResourceAsStream(fileName), "UTF-8"));
String s = "";
while ((s = in.readLine()) != null) {
result.append(s);
result.append("\n");
}
} finally {
try {
if (in != null) {
in.close();
}
} catch (Exception e) {
}
}
return result.toString();
}
}
4.写了一个缓存类
class TempletCache {
private static final String CONFIG_FILE_NAME = "config.properties";
private static HashMap<String, String> hmTemplet = new HashMap<String, String>();
private static final Properties prop = new Properties();
private static TempletCache instance;
//读取配置文件 模板的路径是存储在config.properties
private static ResourceBundle prop1 = ResourceBundle.getBundle("config");
private TempletCache() {
}
public static synchronized TempletCache getInstance() throws Exception {
if (instance == null) {
instance = new TempletCache();
instance.loadConfig();
}
return instance;
}
/**
* 加载模板配置文件
*
* @return
* @throws Exception
*/
private static void loadConfig() throws Exception {
InputStream fis = null;
try {
fis = TempletCache.class.getClass().getClassLoader().getResourceAsStream(
CONFIG_FILE_NAME);
prop.load(fis);
} finally {
try {
if (fis != null) {
fis.close();
}
} catch (Exception e) {
}
}
}
/**
* 根据模板id获取模板路径
* 策略：从内存中根据模板id获得模板路径，如果内存中没有此id则从配置文件中读取该id读出模板路径同时将模板放入内存中
* @param templetid
* @return
* @throws Exception
*/
public static String getTemplet(String templetid) throws Exception {
String templet = "";
if (hmTemplet.containsKey(templetid)) {
templet = hmTemplet.get(templetid);
} else {
templet = prop1.getString(templetid);
hmTemplet.put(templetid, templet);
}
return templet;
}
这里将模板和对应的模板存放路径放入内存中，当需要去生成一个模板的时候，根据已知模板编号（一个类型传真模板是同一个）去从内存中去获取模板存放的路径，如果内存中无该编号，则到配置文件config.properties中根据模板ID去读取对应的模板路径，同时将该路径和模板编号存放在 hashma中
5.通过DocGenerator.java 里面的递归迭代将模板流中与DATA中key值相同的地方使用该key对应的value替换
这里需要与前面的2做很好的衔接，2做的是组装而这里做的就是解析替换，所有的key必须一致，特别是当模板中有列表的地方
注：当一个word用编辑器打开的时候其代码是很冗长的，我没又没类似Dreamvaver来可视化编辑html一样的工具来编辑word，这是一个头痛的问题，不过如果自己查看，word流也是有他的规律的，什么时候段落是什么时候表格结束什么时候换行，都有他的特定的标识（类似html中<table></table>表示表格，<td></td>表示单元格一样）
6.最终将替换后的流输出保存成文件，就是我们最后的需要的word了
问题的缘由是这样的，项目里面有个功能是下载记录客户明细的一个word，之前的做法是将整个word以流的形式写在类里面，然后将值填充到word流里面需要填充地方，最后使用sturts2的文件机制将word流提供给客户另存为word文件。这里面的问题就是项目里面每增加一个模板就要去在类里面写一次word流，而且需要组装的数据里包含了很多的迭代等操作，所以这块的工作量很大，而且很不好维护。于是老大让我将这一块的word不要在类里面直接去处理word流。
最后我使用的方法是将需要填充的word做成一个通用的模板，里面需要填充数据的地方使用特定的代号去取代，然后将这个这个word放到项目中。基本的思想是当要用到这个模板的时候通过程序将word读取成流的形式，然后在类里面将需要填充的数据组装成一到一个HashMap里，键和通用模板的代号一致，值是将要填充的内容。再写一个类来将HashMap里面的值替换掉word流里对应的键。 最后将组装后的流输出。
这个好像说起来很拗口，也不好解释 下面以图文的形式来解释把：
1.先拿到一个他们现在在用的word，
将word里面需要填充的地方使用[替代码]来替代
2.在类里面进行hashmap的组装
public static void main(String[] args) throws Exception {
DocGenerator gen = new DocGenerator();
Map data = new HashMap();
data.put("[ORDER_TITLE]", "**科技集团差旅管理服务公司酒店预订单（酒店联）");
data.put("[ORDER_NO]", "HB080709101712996");
data.put("[OPTRID]", "IHZYF011");
//子项
List lstValue = new ArrayList();
Map subData = new HashMap();
subData.put("[CUST_NAME]", "张三");
subData.put("[ROOM_STYLE]", "单床房 大床 宽带 免费");
subData.put("[DATE1]", "2008-07-09抵 2008-07-12离");
subData.put("[DATE2]", "2008-07-09 至 2008-07-12 每晚 111 元 (单早)");
subData.put("[DATE3]", "2008-07-09 至 2008-07-12 每晚 1.0 间");
lstValue.add(subData);
subData = new HashMap();
subData.put("[CUST_NAME]", "李四");
subData.put("[ROOM_STYLE]", "双人床房 大床 宽带 免费");
subData.put("[DATE1]", "2008-07-09抵 2008-07-12离");
subData.put("[DATE2]", "2008-07-09 至 2008-07-12 每晚 111 元 (单早)");
subData.put("[DATE3]", "2008-07-09 至 2008-07-12 每晚 1.0 间");
lstValue.add(subData);
data.put("CUSTS", lstValue);
gen.generatorDoc(data, "1");//调用处理方法
}
3.处理类书写
/**
* 模板生成类
* @author chm20081009
*
*/
public class DocGenerator {
/**
* 根据传入的数据和模板ID生成
* @author chm
* @param data
* @param templetid
* @throws Exception
*/
@SuppressWarnings("unchecked")
public static String generatorDoc(Map data, String templetid) throws Exception {
String result = "";
// 根据templetid获取模板
String templet = getTemplet(templetid);
//处理模板
templet =split(data,templet);
//去除没有数据的定义变量
templet = templet.replaceAll("\\[\\w+]", "");
//saveDoc(templet);
return templet;
}
/**
* 拆分模板
* @author chm
* @param data
* @param templet
* @return
*/
private static String split(Map data,String templet){
//
Iterator iter = data.keySet().iterator();
//System.out.println("templet==="+templet);
// templet = "哈哈哈[ORDER_TITLE]测试数据";
while (iter.hasNext()) {
String key = iter.next().toString();
Object value = data.get(key);
//替换模板上的标签
templet = replace(key,value,templet);
}
return templet;
}
/**
* 负责替换
* @return
*/
private static String replace(String key , Object value ,String templet){
if (value instanceof String) {// 单值替换
templet = templet.replaceAll("\\" + key, value.toString());
} else if (value instanceof List) {// 列表
// 从模板中截取迭代定义部分，把整个模板分成3部分
String firstTemplet = templet.substring(0, templet
.indexOf("[ITERATE_BEGIN_" + key + "]"));
String middleTemplet = templet.substring(templet
.indexOf("[ITERATE_BEGIN_" + key + "]")
+ ("[ITERATE_BEGIN_" + key + "]").length(), templet
.indexOf("[ITERATE_END_" + key + "]"));
String lastTemplet = templet.substring(templet
.indexOf("[ITERATE_END_" + key + "]")
+ ("[ITERATE_END_" + key + "]").length());
List lstValue = (List) value;// 里面存放的是Map数据
StringBuffer middleResult = new StringBuffer(100);
/**
* 递归调用
*/
for (int i = 0; i < lstValue.size(); i++) {
Map subData = (Map) lstValue.get(i);
String middleData = middleTemplet;
middleData = split(subData,middleData);
middleResult.append(middleData);
}
//将中间替换的数据和拆分开的前后半部分模板组装起来
templet = firstTemplet + middleResult.toString() + lastTemplet;
}
return templet;
}
/**
* 根据模板ID获取模板的内容
* @param templetid
* @return
* @throws Exception
*/
private static String getTemplet(String templetid) throws Exception {
StringBuffer result = new StringBuffer(100);
/*
*可以根据模板ID先到cache里面进行匹配，匹配到模板，直接从缓存中获取
*/
// String fileName = getTempletName(templetid);//写死的文件路径
String fileName = TempletCache.getTemplet(templetid);//从内存根据id获取模板完全路径
BufferedReader in = null;
try {
// in = new BufferedReader(new InputStreamReader(new FileInputStream(
// fileName), "UTF-8"));
in = new BufferedReader(new InputStreamReader(TempletCache.class
.getClassLoader().getResourceAsStream(fileName), "UTF-8"));
String s = "";
while ((s = in.readLine()) != null) {
result.append(s);
result.append("\n");
}
} finally {
try {
if (in != null) {
in.close();
}
} catch (Exception e) {
}
}
return result.toString();
}
}
4.写了一个缓存类
class TempletCache {
private static final String CONFIG_FILE_NAME = "config.properties";
private static HashMap<String, String> hmTemplet = new HashMap<String, String>();
private static final Properties prop = new Properties();
private static TempletCache instance;
//读取配置文件 模板的路径是存储在config.properties
private static ResourceBundle prop1 = ResourceBundle.getBundle("config");
private TempletCache() {
}
public static synchronized TempletCache getInstance() throws Exception {
if (instance == null) {
instance = new TempletCache();
instance.loadConfig();
}
return instance;
}
/**
* 加载模板配置文件
*
* @return
* @throws Exception
*/
private static void loadConfig() throws Exception {
InputStream fis = null;
try {
fis = TempletCache.class.getClass().getClassLoader().getResourceAsStream(
CONFIG_FILE_NAME);
prop.load(fis);
} finally {
try {
if (fis != null) {
fis.close();
}
} catch (Exception e) {
}
}
}
/**
* 根据模板id获取模板路径
* 策略：从内存中根据模板id获得模板路径，如果内存中没有此id则从配置文件中读取该id读出模板路径同时将模板放入内存中
* @param templetid
* @return
* @throws Exception
*/
public static String getTemplet(String templetid) throws Exception {
String templet = "";
if (hmTemplet.containsKey(templetid)) {
templet = hmTemplet.get(templetid);
} else {
templet = prop1.getString(templetid);
hmTemplet.put(templetid, templet);
}
return templet;
}
这里将模板和对应的模板存放路径放入内存中，当需要去生成一个模板的时候，根据已知模板编号（一个类型传真模板是同一个）去从内存中去获取模板存放的路径，如果内存中无该编号，则到配置文件config.properties中根据模板ID去读取对应的模板路径，同时将该路径和模板编号存放在 hashma中
5.通过DocGenerator.java 里面的递归迭代将模板流中与DATA中key值相同的地方使用该key对应的value替换
这里需要与前面的2做很好的衔接，2做的是组装而这里做的就是解析替换，所有的key必须一致，特别是当模板中有列表的地方
注：当一个word用编辑器打开的时候其代码是很冗长的，我没又没类似Dreamvaver来可视化编辑html一样的工具来编辑word，这是一个头痛的问题，不过如果自己查看，word流也是有他的规律的，什么时候段落是什么时候表格结束什么时候换行，都有他的特定的标识（类似html中<table></table>表示表格，<td></td>表示单元格一样）
6.最终将替换后的流输出保存成文件，就是我们最后的需要的word了
