[置顶] POI操作word2010实现多级标题结构

时间:2021-08-23 06:27:50
一、 问题背景:
项目中会生成word的报告,但是直接io流写的报告都是“正文”,没有生成标题,也就没法在大纲结构中方便的查看章节内容了。搜了很多资料也请教了一些同事,终于把这个目录结构的问题搞定了,在此和大家分享一下。

目前我们用的是office2010,因为word2010(2010版本word结构和2007差不多,应该也适用于2007)与word2003的巨大差异,本方法可能不适用过低版本(主要是装卸office太耗时了),有低版本office的同学可以试试这个方法是否可行。


二、 准备工作:
1. JDK1.6或以上(1.8也试过是可以的,1.5的没试过了)。

2. 用的是maven管理配置,pom文件引入:

<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-excelant</artifactId>
<version>3.9</version>
</dependency>

三、 具体实现
1. 构建模板word。
创建一个word文档,例如D:/format.docx 。打开此文档,随便输入一行字符,例如输入: a 。 然后选中这一行,将其设置为“标题1”(或者大纲视图下的“1级”大纲)。保存,关闭format.docx。

2. 代码实现解析format.docx并新建word文档,写入标题到新建文档中。

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;

import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import org.apache.poi.xwpf.usermodel.XWPFStyles;
import org.apache.xmlbeans.XmlException;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyles;

public class WordTitle {
/**
* word整体样式
*/
private static CTStyles wordStyles = null;

/**
* Word整体样式
*/
static {
XWPFDocument template;
try {
// 读取模板文档
template = new XWPFDocument(new FileInputStream("D:/format.docx"));
// 获得模板文档的整体样式
wordStyles = template.getStyle();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (XmlException e) {
e.printStackTrace();
}
}

public static void main(String[] args) throws Exception {
// 新建的word文档对象
XWPFDocument doc = new XWPFDocument();
// 获取新建文档对象的样式
XWPFStyles newStyles = doc.createStyles();
// 关键行// 修改设置文档样式为静态块中读取到的样式
newStyles.setStyles(wordStyles);

// 开始内容输入
// 标题1,1级大纲
XWPFParagraph para1 = doc.createParagraph();
// 关键行// 1级大纲
para1.setStyle("1");
XWPFRun run1 = para1.createRun();
// 标题内容
run1.setText("标题 1");

// 标题2
XWPFParagraph para2 = doc.createParagraph();
// 关键行// 2级大纲
para2.setStyle("2");
XWPFRun run2 = para2.createRun();
// 标题内容
run2.setText("标题 2");

// 正文
XWPFParagraph paraX = doc.createParagraph();
XWPFRun runX = paraX.createRun();
// 正文内容
runX.setText("正文");

// word写入到文件
FileOutputStream fos = new FileOutputStream("D:/myDoc.docx");
doc.write(fos);
fos.close();
}
}

四、 特别说明

1. format.docx中只有标题1,虽然代码中设置了标题2(2级大纲),但是没有生效,“标题2”仍然是正文格式。如果想生效,需要在format.docx中新增一行,并设置为标题2(2级大纲)。

2. 一个奇怪的现象:设置完标题2,解析一次之后,再次将标题2设置为正文格式,或者删除,读取的wordStyles格式仍然能够设置标题2。

3. 大家可以打印下wordStyles,看看“标题1”附近的一些参数值,有助于理解和记忆。


五、 参考资料

参考了*一篇关于POI的问题

最终解决问题,是这个链接给了灵感。老外用的是英文版的word,最终实现上还是和中文版的略有不同。

此外,大家往下看会发现一段代码,没有依赖模板,直接正向实现的。这种方式的实现,需要自己调整标题的字体大小、是否加粗等,个人感觉挺繁琐的。

具体实现如下(注意包的引入):

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.math.BigInteger;

import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import org.apache.poi.xwpf.usermodel.XWPFStyle;
import org.apache.poi.xwpf.usermodel.XWPFStyles;
import org.apache.xmlbeans.XmlException;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTDecimalNumber;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTOnOff;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPPr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTString;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyle;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyles;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STStyleType;

public class WordTitle {
/**
* word整体样式
*/
private static CTStyles wordStyles = null;

/**
* Word整体样式
*/
static {
XWPFDocument template;
try {
// 读取模板文档
template = new XWPFDocument(new FileInputStream("D:/format.docx"));
// 获得模板文档的整体样式
wordStyles = template.getStyle();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (XmlException e) {
e.printStackTrace();
}
}

// 模板方式实现
public static void formatDoc() throws IOException {
// 新建的word文档对象
XWPFDocument doc = new XWPFDocument();
// 获取新建文档对象的样式
XWPFStyles newStyles = doc.createStyles();
// 关键行// 修改设置文档样式为静态块中读取到的样式
newStyles.setStyles(wordStyles);

// 开始内容输入
// 标题1,1级大纲
XWPFParagraph para1 = doc.createParagraph();
// 关键行// 1级大纲
para1.setStyle("1");
XWPFRun run1 = para1.createRun();
// 标题内容
run1.setText("标题 1");

// 标题2
XWPFParagraph para2 = doc.createParagraph();
// 关键行// 2级大纲
para2.setStyle("2");
XWPFRun run2 = para2.createRun();
// 标题内容
run2.setText("标题 2");

// 正文
XWPFParagraph paraX = doc.createParagraph();
XWPFRun runX = paraX.createRun();
// 正文内容
runX.setText("正文");

// word写入到文件
FileOutputStream fos = new FileOutputStream("D:/myDoc.docx");
doc.write(fos);
fos.close();
}

// main
public static void main(String[] args) throws Exception {
// 读取模板方式写word
formatDoc();

// 自定义样式方式写word
writeSimpleDocxFile();
}

/**
* 自定义样式方式写word,参考statckoverflow的源码
*
* @throws IOException
*/
public static void writeSimpleDocxFile() throws IOException {
XWPFDocument docxDocument = new XWPFDocument();

// 老外自定义了一个名字,中文版的最好还是按照word给的标题名来,否则级别上可能会乱
addCustomHeadingStyle(docxDocument, "标题 1", 1);
addCustomHeadingStyle(docxDocument, "标题 2", 2);

// 标题1
XWPFParagraph paragraph = docxDocument.createParagraph();
XWPFRun run = paragraph.createRun();
run.setText("标题 1");
paragraph.setStyle("标题 1");

// 标题2
XWPFParagraph paragraph2 = docxDocument.createParagraph();
XWPFRun run2 = paragraph2.createRun();
run2.setText("标题 2");
paragraph2.setStyle("标题 2");

// 正文
XWPFParagraph paragraphX = docxDocument.createParagraph();
XWPFRun runX = paragraphX.createRun();
runX.setText("正文");

// word写入到文件
FileOutputStream fos = new FileOutputStream("D:/myDoc2.docx");
docxDocument.write(fos);
fos.close();
}

/**
* 增加自定义标题样式。这里用的是*的源码
*
* @param docxDocument 目标文档
* @param strStyleId 样式名称
* @param headingLevel 样式级别
*/
private static void addCustomHeadingStyle(XWPFDocument docxDocument, String strStyleId, int headingLevel) {

CTStyle ctStyle = CTStyle.Factory.newInstance();
ctStyle.setStyleId(strStyleId);

CTString styleName = CTString.Factory.newInstance();
styleName.setVal(strStyleId);
ctStyle.setName(styleName);

CTDecimalNumber indentNumber = CTDecimalNumber.Factory.newInstance();
indentNumber.setVal(BigInteger.valueOf(headingLevel));

// lower number > style is more prominent in the formats bar
ctStyle.setUiPriority(indentNumber);

CTOnOff onoffnull = CTOnOff.Factory.newInstance();
ctStyle.setUnhideWhenUsed(onoffnull);

// style shows up in the formats bar
ctStyle.setQFormat(onoffnull);

// style defines a heading of the given level
CTPPr ppr = CTPPr.Factory.newInstance();
ppr.setOutlineLvl(indentNumber);
ctStyle.setPPr(ppr);

XWPFStyle style = new XWPFStyle(ctStyle);

// is a null op if already defined
XWPFStyles styles = docxDocument.createStyles();

style.setType(STStyleType.PARAGRAPH);
styles.addStyle(style);

}
}

六、 没了
欢迎大家提供新的解决方案!