使用POI读写Word doc文件

时间：2022-12-02 22:27:38

使用POI读写word doc文件

目录

1     读word doc文件

1.1     通过WordExtractor读文件

1.2     通过HWPFDocument读文件

2     写word doc文件

Apache poi的hwpf模块是专门用来对word doc文件进行读写操作的。在hwpf里面我们使用HWPFDocument来表示一个word doc文档。在HWPFDocument里面有这么几个概念：

l  Range：它表示一个范围，这个范围可以是整个文档，也可以是里面的某一小节（Section），也可以是某一个段落（Paragraph），还可以是拥有共同属性的一段文本（CharacterRun）。

l  Section：word文档的一个小节，一个word文档可以由多个小节构成。

l  Paragraph：word文档的一个段落，一个小节可以由多个段落构成。

l  CharacterRun：具有相同属性的一段文本，一个段落可以由多个CharacterRun组成。

l  Table：一个表格。

l  TableRow：表格对应的行。

l  TableCell：表格对应的单元格。

Section、Paragraph、CharacterRun和Table都继承自Range。

1       读word doc文件

在日常应用中，我们从word文件里面读取信息的情况非常少见，更多的还是把内容写入到word文件中。使用POI从word doc文件读取数据时主要有两种方式：通过WordExtractor读和通过HWPFDocument读。在WordExtractor内部进行信息读取时还是通过HWPFDocument来获取的。

1.1     通过WordExtractor读文件

在使用WordExtractor读文件时我们只能读到文件的文本内容和基于文档的一些属性，至于文档内容的属性等是无法读到的。如果要读到文档内容的属性则需要使用HWPFDocument来读取了。下面是使用WordExtractor读取文件的一个示例：

  1. public class HwpfTest {
  2. @SuppressWarnings("deprecation")
  3. @Test
  4. public void testReadByExtractor() throws Exception {
  5. InputStream is = new FileInputStream("D:\\test.doc");
  6. WordExtractor extractor = new WordExtractor(is);
  7. //输出word文档所有的文本
  8. System.out.println(extractor.getText());
  9. System.out.println(extractor.getTextFromPieces());
  10. //输出页眉的内容
  11. System.out.println("页眉：" + extractor.getHeaderText());
  12. //输出页脚的内容
  13. System.out.println("页脚：" + extractor.getFooterText());
  14. //输出当前word文档的元数据信息，包括作者、文档的修改时间等。
  15. System.out.println(extractor.getMetadataTextExtractor().getText());
  16. //获取各个段落的文本
  17. String paraTexts[] = extractor.getParagraphText();
  18. for (int i=0; i<paraTexts.length; i++) {
  19. System.out.println("Paragraph " + (i+1) + " : " + paraTexts[i]);
  20. }
  21. //输出当前word的一些信息
  22. printInfo(extractor.getSummaryInformation());
  23. //输出当前word的一些信息
  24. this.printInfo(extractor.getDocSummaryInformation());
  25. this.closeStream(is);
  26. }
  27. /**
  28. * 输出SummaryInfomation
  29. * @param info
  30. */
  31. private void printInfo(SummaryInformation info) {
  32. //作者
  33. System.out.println(info.getAuthor());
  34. //字符统计
  35. System.out.println(info.getCharCount());
  36. //页数
  37. System.out.println(info.getPageCount());
  38. //标题
  39. System.out.println(info.getTitle());
  40. //主题
  41. System.out.println(info.getSubject());
  42. }
  43. /**
  44. * 输出DocumentSummaryInfomation
  45. * @param info
  46. */
  47. private void printInfo(DocumentSummaryInformation info) {
  48. //分类
  49. System.out.println(info.getCategory());
  50. //公司
  51. System.out.println(info.getCompany());
  52. }
  53. /**
  54. * 关闭输入流
  55. * @param is
  56. */
  57. private void closeStream(InputStream is) {
  58. if (is != null) {
  59. try {
  60. is.close();
  61. } catch (IOException e) {
  62. e.printStackTrace();
  63. }
  64. }
  65. }
  66. }

1.2     通过HWPFDocument读文件

HWPFDocument是当前Word文档的代表，它的功能比WordExtractor要强。通过它我们可以读取文档中的表格、列表等，还可以对文档的内容进行新增、修改和删除操作。只是在进行完这些新增、修改和删除后相关信息是保存在HWPFDocument中的，也就是说我们改变的是HWPFDocument，而不是磁盘上的文件。如果要使这些修改生效的话，我们可以调用HWPFDocument的write方法把修改后的HWPFDocument输出到指定的输出流中。这可以是原文件的输出流，也可以是新文件的输出流（相当于另存为）或其它输出流。下面是一个通过HWPFDocument读文件的示例：

  1. public class HwpfTest {
  2. @Test
  3. public void testReadByDoc() throws Exception {
  4. InputStream is = new FileInputStream("D:\\test.doc");
  5. HWPFDocument doc = new HWPFDocument(is);
  6. //输出书签信息
  7. this.printInfo(doc.getBookmarks());
  8. //输出文本
  9. System.out.println(doc.getDocumentText());
  10. Range range = doc.getRange();
  11. //    this.insertInfo(range);
  12. this.printInfo(range);
  13. //读表格
  14. this.readTable(range);
  15. //读列表
  16. this.readList(range);
  17. //删除range
  18. Range r = new Range(2, 5, doc);
  19. r.delete();//在内存中进行删除，如果需要保存到文件中需要再把它写回文件
  20. //把当前HWPFDocument写到输出流中
  21. doc.write(new FileOutputStream("D:\\test.doc"));
  22. this.closeStream(is);
  23. }
  24. /**
  25. * 关闭输入流
  26. * @param is
  27. */
  28. private void closeStream(InputStream is) {
  29. if (is != null) {
  30. try {
  31. is.close();
  32. } catch (IOException e) {
  33. e.printStackTrace();
  34. }
  35. }
  36. }
  37. /**
  38. * 输出书签信息
  39. * @param bookmarks
  40. */
  41. private void printInfo(Bookmarks bookmarks) {
  42. int count = bookmarks.getBookmarksCount();
  43. System.out.println("书签数量：" + count);
  44. Bookmark bookmark;
  45. for (int i=0; i<count; i++) {
  46. bookmark = bookmarks.getBookmark(i);
  47. System.out.println("书签" + (i+1) + "的名称是：" + bookmark.getName());
  48. System.out.println("开始位置：" + bookmark.getStart());
  49. System.out.println("结束位置：" + bookmark.getEnd());
  50. }
  51. }
  52. /**
  53. * 读表格
  54. * 每一个回车符代表一个段落，所以对于表格而言，每一个单元格至少包含一个段落，每行结束都是一个段落。
  55. * @param range
  56. */
  57. private void readTable(Range range) {
  58. //遍历range范围内的table。
  59. TableIterator tableIter = new TableIterator(range);
  60. Table table;
  61. TableRow row;
  62. TableCell cell;
  63. while (tableIter.hasNext()) {
  64. table = tableIter.next();
  65. int rowNum = table.numRows();
  66. for (int j=0; j<rowNum; j++) {
  67. row = table.getRow(j);
  68. int cellNum = row.numCells();
  69. for (int k=0; k<cellNum; k++) {
  70. cell = row.getCell(k);
  71. //输出单元格的文本
  72. System.out.println(cell.text().trim());
  73. }
  74. }
  75. }
  76. }
  77. /**
  78. * 读列表
  79. * @param range
  80. */
  81. private void readList(Range range) {
  82. int num = range.numParagraphs();
  83. Paragraph para;
  84. for (int i=0; i<num; i++) {
  85. para = range.getParagraph(i);
  86. if (para.isInList()) {
  87. System.out.println("list: " + para.text());
  88. }
  89. }
  90. }
  91. /**
  92. * 输出Range
  93. * @param range
  94. */
  95. private void printInfo(Range range) {
  96. //获取段落数
  97. int paraNum = range.numParagraphs();
  98. System.out.println(paraNum);
  99. for (int i=0; i<paraNum; i++) {
  100. //       this.insertInfo(range.getParagraph(i));
  101. System.out.println("段落" + (i+1) + "：" + range.getParagraph(i).text());
  102. if (i == (paraNum-1)) {
  103. this.insertInfo(range.getParagraph(i));
  104. }
  105. }
  106. int secNum = range.numSections();
  107. System.out.println(secNum);
  108. Section section;
  109. for (int i=0; i<secNum; i++) {
  110. section = range.getSection(i);
  111. System.out.println(section.getMarginLeft());
  112. System.out.println(section.getMarginRight());
  113. System.out.println(section.getMarginTop());
  114. System.out.println(section.getMarginBottom());
  115. System.out.println(section.getPageHeight());
  116. System.out.println(section.text());
  117. }
  118. }
  119. /**
  120. * 插入内容到Range，这里只会写到内存中
  121. * @param range
  122. */
  123. private void insertInfo(Range range) {
  124. range.insertAfter("Hello");
  125. }
  126. }

2       写word doc文件

在使用POI写word doc文件的时候我们必须要先有一个doc文件才行，因为我们在写doc文件的时候是通过HWPFDocument来写的，而HWPFDocument是要依附于一个doc文件的。所以通常的做法是我们先在硬盘上准备好一个内容空白的doc文件，然后建立一个基于该空白文件的HWPFDocument。之后我们就可以往HWPFDocument里面新增内容了，然后再把它写入到另外一个doc文件中，这样就相当于我们使用POI生成了word doc文件。

在实际应用中，我们在生成word文件的时候都是生成某一类文件，该类文件的格式是固定的，只是某些字段不一样罢了。所以在实际应用中，我们大可不必将整个word文件的内容都通过HWPFDocument生成。而是先在磁盘上新建一个word文档，其内容就是我们需要生成的word文件的内容，然后把里面一些属于变量的内容使用类似于“${paramName}”这样的方式代替。这样我们在基于某些信息生成word文件的时候，只需要获取基于该word文件的HWPFDocument，然后调用Range的replaceText()方法把对应的变量替换为对应的值即可，之后再把当前的HWPFDocument写入到新的输出流中。这种方式在实际应用中用的比较多，因为它不但可以减少我们的工作量，还可以让文本的格式更加的清晰。下面我们就来基于这种方式做一个示例。

假设我们现在拥有一些变动的信息，然后需要通过这些信息生成如下格式的word doc文件：

使用POI读写Word doc文件

那么根据上面的描述，首先第一步，我们建立一个对应格式的doc文件作为模板，其内容是这样的：

使用POI读写Word doc文件

有了这样一个模板之后，我们就可以建立对应的HWPFDocument，然后替换对应的变量为相应的值，再把HWPFDocument输出到对应的输出流即可。下面是对应的代码。

  1. public class HwpfTest {
  2. @Test
  3. public void testWrite() throws Exception {
  4. String templatePath = "D:\\word\\template.doc";
  5. InputStream is = new FileInputStream(templatePath);
  6. HWPFDocument doc = new HWPFDocument(is);
  7. Range range = doc.getRange();
  8. //把range范围内的${reportDate}替换为当前的日期
  9. range.replaceText("${reportDate}", new SimpleDateFormat("yyyy-MM-dd").format(new Date()));
  10. range.replaceText("${appleAmt}", "100.00");
  11. range.replaceText("${bananaAmt}", "200.00");
  12. range.replaceText("${totalAmt}", "300.00");
  13. OutputStream os = new FileOutputStream("D:\\word\\write.doc");
  14. //把doc输出到输出流中
  15. doc.write(os);
  16. this.closeStream(os);
  17. this.closeStream(is);
  18. }
  19. /**
  20. * 关闭输入流
  21. * @param is
  22. */
  23. private void closeStream(InputStream is) {
  24. if (is != null) {
  25. try {
  26. is.close();
  27. } catch (IOException e) {
  28. e.printStackTrace();
  29. }
  30. }
  31. }
  32. /**
  33. * 关闭输出流
  34. * @param os
  35. */
  36. private void closeStream(OutputStream os) {
  37. if (os != null) {
  38. try {
  39. os.close();
  40. } catch (IOException e) {
  41. e.printStackTrace();
  42. }
  43. }
  44. }
  45. }

（注：本文是基于poi3.9所写）

相关文章