一 背景

最近在项目开发中,有数据导出到word的需求。这就涉及代码生成word文档的操作,且有格式要求。 大家用word做过简历的都有了解,做简历时,会使用表格、图片、文字等元素。而且表格也可能有嵌套、合并单元格,以及插入图片到单元格的操作。该怎么做?

二 Java操作Office方案

百度一下Java Office操作,或者再直接一点搜索Java word,就比较容易搜到iText、POI等组件。在文章​Java导出word的几种方式​​ 这篇文章中,提到了包括Jacob、Apache POI、Java2word、iText、FreeMarker五种方式。

通过对比,结合需求要求,最终选择了Apache POI来实现,所以这里先详细介绍POI,以及一个可用的demo,供参考。

三 Apache POI

Apache POI(​​官网​​)是基于Office Open XML标准(OOXML)和Microsoft的OLE 2复合文档格式(OLE2)处理各种文件格式的开源项目。 简而言之,您可以使用Java读写MS Excel文件,可以使用Java读写MS Word和MS PowerPoint文件。

poi的gitee地址:​​gitee​​​。入门教程可以参考 ​​Apache POI Word(docx) 入门示例教程​​。

四 版本信息

poi的最新版本已经到了5.0.0,不过可以找到的大部分demo都是基于3.x版本或4.1版本。为了尽快搭建demo并运行起来,我们也没有使用最新版本,而是选择了4.1.0进行开发。

4.1 引用依赖

<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<poi.version>4.1.0</poi.version>
</properties>


<dependencies>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>${poi.version}</version>
</dependency>

<!-- poi处理xlsx格式,用于处理word中的表格 -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>${poi.version}</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-excelant</artifactId>
<version>${poi.version}</version>
</dependency>

<!-- poi-tl基于poi的word模板引擎 -->
<dependency>
<groupId>com.deepoove</groupId>
<artifactId>poi-tl</artifactId>
<version>1.5.0</version>
</dependency>

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
</dependency>
</dependencies>

4.2 创建word示例代码

4.2.1 创建新的文档

创建word文档比较简单,直接使用new XWPFDocument即可,XWPFDocument是对 ​​.docx​​ 文档操作的高级封装API:

XWPFDocument doc = new XWPFDocument();

4.2.2 表格

即Word文档中的表格。API创建时需要指定行数和列数,示例如下:

//创建一个表格,并指定宽度
XWPFTable table = doc.createTable(4, 4);
TableTools.widthTable(table, MiniTableRenderData.WIDTH_A4_FULL, 4);

//设置第0行数据
List<XWPFTableCell> row0 = table.getRow(0).getTableCells();
row0.get(0).setText("xxxx"); //为第0行第0列设置内容
row0.get(0).setWidth("200");
row0.get(1).setText("aaaa");
row0.get(2).setText("bbbb");
row0.get(3).setText("cccc");

常规的简单表格,我们只要按照上述代码逐行操作即可;但现实中不会这么容易。通常会涉及在单元格插入图片、合并行、合并列,甚至表格嵌套。目前表格嵌套暂未实现,先介绍其他三种情况。

4.2.3 列合并

有两种方法,一种是使用addNewHMerge方法,通过设置合并的起始列和结束列,逐个列进行合并:

List<XWPFTableCell> row2_1 = table.getRow(2).getTableCells();
row2_1.get(0).setText("合并表格"); //为第0行第0列设置内容
//将第一列到第四列合并
for (int i = 1; i <= 3; i++) {
//对单元格进行合并的时候,要标志单元格是否为起点,或者是否为继续合并
if (i == 1)
row2_1.get(i).getCTTc().addNewTcPr().addNewHMerge().setVal(STMerge.RESTART);//这是起点
else
row2_1.get(i).getCTTc().addNewTcPr().addNewHMerge().setVal(STMerge.CONTINUE);//继续合并
}

在业务代码中这样的写法稍显繁琐,我们也可以直接使用TableTools.mergeCellsHorizonal()函数来执行合并:

// 合并第一行的第0列到第8列单元格
TableTools.mergeCellsHorizonal(table, 1, 0, 8);

4.2.4 行合并

如果是要合并某几行,也可以使用TableTools提供的方法:

// 合并第0列的第一行到第九行的单元格
TableTools.mergeCellsVertically(table, 0, 1, 9);

我们看一下TableTools的源码:

public static void mergeCellsVertically(XWPFTable table, int col, int fromRow, int toRow) {
if (toRow > fromRow) {
for(int rowIndex = fromRow; rowIndex <= toRow; ++rowIndex) {
XWPFTableCell cell = table.getRow(rowIndex).getCell(col);
CTTcPr tcPr = getTcPr(cell);
CTVMerge vMerge = tcPr.addNewVMerge();
if (rowIndex == fromRow) {
vMerge.setVal(STMerge.RESTART);
} else {
vMerge.setVal(STMerge.CONTINUE);
}
}

}
}

可以发现,底层还是使用addNewVMerge等方法,也设置了起始和结束位置,只是做了一层封装。

4.2.5 图片插入表格

图片插入表格要麻烦一些,如果大家在百度上搜过插入图片到表格方法,大概率会找到这样的操作:

Java 操作 Office:POI 之 word 生成_java

大部分对应的都是3.9以前的版本,写起来比较复杂,而且在4.x之后,图中super.getRelationId()方法也发生了变化,代码报错。

通过调研,发现XWPFRun中提供了addPicture方法,写起来也简单了很多。一个示例如下:

String imageFile = "/Users/xxx/Downloads/图片 1.png";
InputStream stream = new FileInputStream(imageFile);

//表格中创建段落
XWPFParagraph paragraph = row2_1.get(1).getParagraphs().get(0);
XWPFRun run = paragraph.createRun();
run.addPicture(stream, XWPFDocument.PICTURE_TYPE_PNG, "Generated",
Units.toEMU(364), Units.toEMU(256));

run.addPicture接收的参数依次为:图片的InputStream流,图片类型,图片名称(非文件名),图片宽度、图片高度。通过这个方法,我们就可以把图片插入到指定的表格中,并设置图片的宽高属性。

五 总结

通过上述介绍,大家应该可以简单实现一个表格了。本文的方式还是偏向于硬编码的方式,在很多场景(例如简历、报表等典型场景)可以采用模板的方式,创建word模板,然后用模板内容替换来生成复杂样式的表格。这个在后续文章中再做介绍,大家也可以先搜索相关的实现来学习了解。