android使用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读取文件的一个示例：

Java代码  

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

public class HwpfTest {

   @SuppressWarnings("deprecation")
   @Test
   public void testReadByExtractor() throws Exception {
      InputStream is = new FileInputStream("D:\\test.doc");
      WordExtractor extractor = new WordExtractor(is);
      //输出word文档所有的文本
      System.out.println(extractor.getText());
      System.out.println(extractor.getTextFromPieces());
      //输出页眉的内容
      System.out.println("页眉：" + extractor.getHeaderText());
      //输出页脚的内容
      System.out.println("页脚：" + extractor.getFooterText());
      //输出当前word文档的元数据信息，包括作者、文档的修改时间等。
      System.out.println(extractor.getMetadataTextExtractor().getText());
      //获取各个段落的文本
      String paraTexts[] = extractor.getParagraphText();
      for (int i=0; i<paraTexts.length; i++) {
         System.out.println("Paragraph " + (i+1) + " : " + paraTexts[i]);
      }
      //输出当前word的一些信息
      printInfo(extractor.getSummaryInformation());
      //输出当前word的一些信息
      this.printInfo(extractor.getDocSummaryInformation());
      this.closeStream(is);
   }

   /**
    * 输出SummaryInfomation
    * @param info
    */
   private void printInfo(SummaryInformation info) {
      //作者
      System.out.println(info.getAuthor());
      //字符统计
      System.out.println(info.getCharCount());
      //页数
      System.out.println(info.getPageCount());
      //标题
      System.out.println(info.getTitle());
      //主题
      System.out.println(info.getSubject());
   }

   /**
    * 输出DocumentSummaryInfomation
    * @param info
    */
   private void printInfo(DocumentSummaryInformation info) {
      //分类
      System.out.println(info.getCategory());
      //公司
      System.out.println(info.getCompany());
   }

   /**
    * 关闭输入流
    * @param is
    */
   private void closeStream(InputStream is) {
      if (is != null) {
         try {
            is.close();
         } catch (IOException e) {
            e.printStackTrace();
         }
      }
   }

}

 

 

1.2     通过HWPFDocument读文件

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

Java代码  

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

public class HwpfTest {

   @Test
   public void testReadByDoc() throws Exception {
      InputStream is = new FileInputStream("D:\\test.doc");
      HWPFDocument doc = new HWPFDocument(is);
      //输出书签信息
      this.printInfo(doc.getBookmarks());
      //输出文本
      System.out.println(doc.getDocumentText());
      Range range = doc.getRange();
//    this.insertInfo(range);
      this.printInfo(range);
      //读表格
      this.readTable(range);
      //读列表
      this.readList(range);
      //删除range
      Range r = new Range(2, 5, doc);
      r.delete();//在内存中进行删除，如果需要保存到文件中需要再把它写回文件
      //把当前HWPFDocument写到输出流中
      doc.write(new FileOutputStream("D:\\test.doc"));
      this.closeStream(is);
   }

   /**
    * 关闭输入流
    * @param is
    */
   private void closeStream(InputStream is) {
      if (is != null) {
         try {
            is.close();
         } catch (IOException e) {
            e.printStackTrace();
         }
      }
   }

   /**
    * 输出书签信息
    * @param bookmarks
    */
   private void printInfo(Bookmarks bookmarks) {
      int count = bookmarks.getBookmarksCount();
      System.out.println("书签数量：" + count);
      Bookmark bookmark;
      for (int i=0; i<count; i++) {
         bookmark = bookmarks.getBookmark(i);
         System.out.println("书签" + (i+1) + "的名称是：" + bookmark.getName());
         System.out.println("开始位置：" + bookmark.getStart());
         System.out.println("结束位置：" + bookmark.getEnd());
      }
   }

   /**
    * 读表格
    * 每一个回车符代表一个段落，所以对于表格而言，每一个单元格至少包含一个段落，每行结束都是一个段落。
    * @param range
    */
   private void readTable(Range range) {
      //遍历range范围内的table。
      TableIterator tableIter = new TableIterator(range);
      Table table;
      TableRow row;
      TableCell cell;
      while (tableIter.hasNext()) {
         table = tableIter.next();
         int rowNum = table.numRows();
         for (int j=0; j<rowNum; j++) {
            row = table.getRow(j);
            int cellNum = row.numCells();
            for (int k=0; k<cellNum; k++) {
                cell = row.getCell(k);
                //输出单元格的文本
                System.out.println(cell.text().trim());
            }
         }
      }
   }

   /**
    * 读列表
    * @param range
    */
   private void readList(Range range) {
      int num = range.numParagraphs();
      Paragraph para;
      for (int i=0; i<num; i++) {
         para = range.getParagraph(i);
         if (para.isInList()) {
            System.out.println("list: " + para.text());
         }
      }
   }

   /**
    * 输出Range
    * @param range
    */
   private void printInfo(Range range) {
      //获取段落数
      int paraNum = range.numParagraphs();
      System.out.println(paraNum);
      for (int i=0; i<paraNum; i++) {
//       this.insertInfo(range.getParagraph(i));
         System.out.println("段落" + (i+1) + "：" + range.getParagraph(i).text());
         if (i == (paraNum-1)) {
            this.insertInfo(range.getParagraph(i));
         }
      }
      int secNum = range.numSections();
      System.out.println(secNum);
      Section section;
      for (int i=0; i<secNum; i++) {
         section = range.getSection(i);
         System.out.println(section.getMarginLeft());
         System.out.println(section.getMarginRight());
         System.out.println(section.getMarginTop());
         System.out.println(section.getMarginBottom());
         System.out.println(section.getPageHeight());
         System.out.println(section.text());
      }
   }

   /**
    * 插入内容到Range，这里只会写到内存中
    * @param range
    */
   private void insertInfo(Range range) {
      range.insertAfter("Hello");
   }

}

 

 

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文件：

 

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

 

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

Java代码  

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

public class HwpfTest {

   @Test
   public void testWrite() throws Exception {
      String templatePath = "D:\\word\\template.doc";
      InputStream is = new FileInputStream(templatePath);
      HWPFDocument doc = new HWPFDocument(is);
      Range range = doc.getRange();
      //把range范围内的${reportDate}替换为当前的日期
      range.replaceText("${reportDate}", new SimpleDateFormat("yyyy-MM-dd").format(new Date()));
      range.replaceText("${appleAmt}", "100.00");
      range.replaceText("${bananaAmt}", "200.00");
      range.replaceText("${totalAmt}", "300.00");
      OutputStream os = new FileOutputStream("D:\\word\\write.doc");
      //把doc输出到输出流中
      doc.write(os);
      this.closeStream(os);
      this.closeStream(is);
   }

   /**
    * 关闭输入流
    * @param is
    */
   private void closeStream(InputStream is) {
      if (is != null) {
         try {
            is.close();
         } catch (IOException e) {
            e.printStackTrace();
         }
      }
   }

   /**
    * 关闭输出流
    * @param os
    */
   private void closeStream(OutputStream os) {
      if (os != null) {
         try {
            os.close();
         } catch (IOException e) {
            e.printStackTrace();
         }
      }
   }


}

 

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