使用freemarker利用模板导出文档

本文旨在对在使用freemarker创建模板导出文档是遇到的一些错误及解决方案做个记录。

现在网络上有很多这样的代码，随便一查就有很多。但是为了方便大家使用我这里就在网上随便摘抄一些，方便使用。

1. 首先创建模板。
   1）使用office软件创建一个文档，文档设置好自己的样式、颜色等格式。
   2）在你要插入值的地方定义好占位符，占位符格式：${你的变量}
   ps 这个变量的名字你要记好，这是你在使用模板的时候会使用到。
   如图：
   
   3）将制作好的模板另存为xml格式
   如图：
   
   4）将另存的文件修改后缀为XXX.ftl
   如图：
   
   5）到这一步，模板就做好了。
2. 编写代码

 public void exportSimpleWord() throws Exception{  
       // 要填充的数据, 注意map的key要和word中${xxx}的xxx一致  
      Map<String,String> dataMap = new HashMap<String,String>();  
      dataMap.put("username", "张三");  
      dataMap.put("sex", "男");  
            
    //Configuration用于读取ftl文件  
      Configuration configuration = new Configuration();  
      configuration.setDefaultEncoding("utf-8");  
        
      /*以下是两种指定ftl文件所在目录路径的方式, 注意这两种方式都是 
       * 指定ftl文件所在目录的路径,而不是ftl文件的路径 
       */  
      //指定路径的第一种方式(根据某个类的相对路径指定)  
      //configuration.setClassForTemplateLoading(this.getClass(),"");  
        
      //指定路径的第二种方式,我的路径是C:/a.ftl  
      configuration.setDirectoryForTemplateLoading(new File("C:/"));  
        
        
      // 输出文档路径及名称  
     File outFile = new File("D:/test.doc");  
       
     //以utf-8的编码读取ftl文件  
     Template t =  configuration.getTemplate("a.ftl","utf-8");  
     Writer out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(outFile), "utf-8"),10240);  
        t.process(dataMap, out);  
        out.close();  
   }  

上面 这部分代码摘自https://www.iteye.com/blog/18810098265-2056122

以上整个流程算是完成了，但是在此期间我遇到了一些问题，我在网上找了好久才依稀找到一些解决方法。现在为了方便我把问题及解决方案发出来，便于大家查阅。

1. 常见问题，模板报错
   出现此问题的原因主要是你的模板中有内部出现问题。
   我出现这个问题的原因是：
   
   从图中可以看出我之前写的占位符在这里被拆分了，所有我们要去修改我们的模板（并不是修改原始的都doc或docx，而是我们保存好的ftl也就是xml文件。）直接使用编辑工具（我是用的nodepad++）打开，修改。修改完成以后如图
   
   然后依次将你的所有占位符进行修正。然后再次导出。
   最后贴出来一个方法，对象转Map的方法，因为使用模板的时候用的就一个Map

public static Map simpleObject2Map(Object obj)
			throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, IntrospectionException {
		Map<String, Object> map = new HashMap<String, Object>();
		Class<?> clazz = obj.getClass();
		BeanInfo beanInfo = Introspector.getBeanInfo(clazz);
		PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();
		for (PropertyDescriptor property : propertyDescriptors) {
			String key = property.getName();
			// 过滤class属性
			if (key.equals("class")) {
				continue;
			}
			// 得到property对应的getter方法
			Method getter = property.getReadMethod();
			Object value = getter.invoke(obj);
			map.put(key, value);
		}
		return map;
	}

如果有各位有遇到其他问题及解决方案欢迎评论留言，我将后续更新！