- 开发中偶尔会有固定模板导出word的需求，常见的导出通常通过直接修改xml或者通过工具库代码调整样式输出，这些方式开发困难并且不利于后期维护。
- 一些有规则的文档需要人工填写，费时费力，此时配置数据库做模板渲染导出，如数据库设计文档等
officeexport-java基于Apache FreeMarker，遵从模板 + 数据模型 = 输出的理念， 通过极简API实现javaBean即数据源，模板即样式的Word导出，提供以下功能：
- 基本文本的输出，文本占位符样式即输出文本样式。
- 文本行、表格行单行或多行的遍历输出，并能够进行循环嵌套。
- 提供数据处理的插件，通过添加处理器可定制任意输出值，例如：特定项的日期、数字等文本格式转换
- 图片保留样式的输出。
| 方案 | 跨平台 | 易用性 |
|---|---|---|
| Freemarker | 跨平台 | 需要掌握freemarker的语法，配置xml结构，复杂模型导出非常繁琐 |
| Apache POI | Java组件，跨平台 | 需要掌握POIApi，对于复杂样式配置起来很复杂 |
| officeexport | Java组件，跨平台 | 拥有极简API，极简的模板语法，模板样式即输出样式（模板样式直接通过word调整） |
1、直接调整word模板，添加占位符，在word2007 版本前需要导出word2003xml， word2007 版本之后直接调整word 即可。
2、Maven引入jar包，通过api导出
<dependency>
<groupId>com.github.kmood</groupId>
<artifactId>officeexport-java</artifactId>
<version>1.0.3.0-RELEASE</version>
</dependency>
HashMap<String, Object> data = new HashMap<>();
...准备数据
data.put("zxsm",zxsmList);
data.put("sbsm","kmood-导出-商标说明");
DocumentProducer dp = new DocumentProducer(ActualModelPath);
dp.Complie(xmlPath, "filename.xml",true);
dp.produce(map, ExportFilePath); HashMap<String, Object> map = new HashMap<>();
map.put("text", "kmood-文本占位输出");
map.put("text1", "kmood-文本占位输出2");
DocumentProducer dp = new DocumentProducer(ActualModelPath);
String complie = dp.Complie(xmlPath, "text.xml", true);
dp.produce(map, ExportFilePath);
//准备数据
HashMap<String, Object> map = new HashMap<>();
ArrayList<Object> tables = new ArrayList<>();
HashMap<String, Object> map1 = new HashMap<>();
map1.put("text", "kmood-文本占位输出-循环1");
map1.put("text1", "kmood-文本占位输出2-循环1");
tables.add(map1);
HashMap<String, Object> map2 = new HashMap<>();
map2.put("text", "kmood-文本占位输出-循环2");
map2.put("text1", "kmood-文本占位输出2-循环2");
tables.add(map2);
map.put("tables",map);
//编译输出
DocumentProducer dp = new DocumentProducer(ActualModelPath);
String complie = dp.Complie(xmlPath, "textf.xml", true);
dp.produce(map, ExportFilePath);
//准备数据
HashMap<String, Object> map = new HashMap<>();
ArrayList<Object> tables = new ArrayList<>();
HashMap<String, Object> map1 = new HashMap<>();
map1.put("text", "kmood-文本占位输出-循环1");
map1.put("text1", "kmood-文本占位输出2-循环1");
//表格数据
ArrayList<Object> columns1= new ArrayList<>();
HashMap<String, Object> row = new HashMap<>();
row.put("column1", "kmood-table1-column1-row1");
row.put("column2", "kmood-table1-column2-row1");
columns1.add(row);
HashMap<String, Object> row2 = new HashMap<>();
row2.put("column1", "kmood-table1-column1-row2");
row2.put("column2", "kmood-table1-column2-row2");
columns1.add(row2);
map1.put("columns", columns1);
tables.add(map1);
HashMap<String, Object> map2 = new HashMap<>();
map2.put("text", "kmood-文本占位输出-循环2");
map2.put("text1", "kmood-文本占位输出2-循环2");
//表格数据
ArrayList<Object> columns2= new ArrayList<>();
HashMap<String, Object> row3 = new HashMap<>();
row3.put("column1", "kmood-table2-column1-row1");
row3.put("column2", "kmood-table2-column2-row1");
columns2.add(row3);
HashMap<String, Object> row4 = new HashMap<>();
row4.put("column1", "kmood-table2-column1-row2");
row4.put("column2", "kmood-table2-column2-row2");
columns2.add(row4);
map2.put("columns", columns2);
tables.add(map2);
map.put("tables",tables);
//编译输出
DocumentProducer dp = new DocumentProducer(ActualModelPath);
String complie = dp.Complie(xmlPath, "table.xml", true);
dp.produce(map, ExportFilePath);
docx文档中图片占位 : 文本占位： {^mypicture^} ;图片占位:（在图片的可选文字中配置占位符{^mypicture^}）详见wiki
String ActualModelPath = this.getClass().getClassLoader().getResource("./model/").toURI().getPath();
String xmlPath = this.getClass().getClassLoader().getResource("./model").toURI().getPath();
String filePath = this.getClass().getClassLoader().getResource("./picture/exportTestPicture-code.png").toURI().getPath();
String filePath2 = this.getClass().getClassLoader().getResource("./picture/exportTestPicture-intro.png").toURI().getPath();
String filePath3 = this.getClass().getClassLoader().getResource("./picture/exportTestPicture-title.png").toURI().getPath();
String ExportFilePath = this.getClass().getClassLoader().getResource("./export").toURI().getPath() + "/包装说明表（范例A）-export.docx";
HashMap<String, Object> map = new HashMap<>();
map.put("zzdhm", "yangzh-\n制造单\n测试内容测试内容测试内容测试内容测试内容测试内容测试内容测试内容测试内容测试内容");
map.put("ydwcrq", "2024-12-30");
map.put("cpmc", "产品名称");
map.put("jyrq", "2024-12-02");
map.put("sl", "200");
map.put("xs", "100");
ArrayList<Object> zxsmList = new ArrayList<>();
HashMap<String, Object> zxsmmap = new HashMap<>();
zxsmmap.put("xh", "01");
zxsmmap.put("xs", "10\n（箱数²）");
zxsmmap.put("zrl", "100");
zxsmmap.put("zsl", "50");
zxsmmap.put("sm", "2024-12-02");
// 图片方式一（推荐）：图片的绝对路径的地址
Map pictestMap=new HashMap();
pictestMap.put("type","pic");
pictestMap.put("url",filePath3);
Map pictext_loopMap=new HashMap();
pictext_loopMap.put("type","pic");
pictext_loopMap.put("url",filePath3);
zxsmmap.put("pictest", pictestMap);
zxsmmap.put("pictext_loop", pictext_loopMap);
zxsmList.add(zxsmmap);
HashMap<String, Object> zxsmmap1 = new HashMap<>();
zxsmmap1.put("xh", "02");
zxsmmap1.put("xs", "kmood-预定完成日期");
zxsmmap1.put("zrl","kmood-产品名称");
zxsmmap1.put("zsl","kmood-交运日期");
zxsmmap1.put("sm", "kmood-交运日期");
// 图片方式二（不推荐）：base64字符串，图片过大可能会失败
zxsmmap1.put("pictest", Base64.getEncoder().encodeToString(FileUtils.readToBytesByFilepath( filePath)));
zxsmmap1.put("pictext_loop", Base64.getEncoder().encodeToString(FileUtils.readToBytesByFilepath( filePath)));
zxsmList.add(zxsmmap1);
map.put("zxsm", zxsmList);
map.put("sbsm", "yangzh-商标说明");
map.put("mp", "kmood OfficeExport 导出word");
map.put("pictext", Base64.getEncoder().encodeToString(FileUtils.readToBytesByFilepath( filePath2)));
DocumentProducer dp = new DocumentProducer(ActualModelPath);
String complie = dp.Complie(xmlPath, "包装说明表（范例A）.docx", false);
System.out.println(complie);
dp.produce(map, ExportFilePath);
中文文档：https://github.com/kmood/officeexport-java/wiki
变量命名只能使用：字母 数字 $ _ （下划线）
中文也可以用来命名变量，但最好不这样写。
变量第一个字符只能使用：字母 $ _ （下划线）
变量第一个字符不能使用：数字
欢迎在GitHub Issue中提问和交流。有问题可通过微信咨询： 1761104164、18330019132