一 前言
Java编程生成word文档这种操作一般是常规操作比较常见,主要采用Apache的POI Word 这个库操作的比较多,还有的用Spire.Doc,但是这个库有些稍微难点的功能要收费,看了下费用还不低,周末朋友问起是否有用java操作word加上下标的经验,我是没有的,不过刚好借机研究下。 本文主要聊下POI,毕竟是免费的,更值得研究。
word 格式说明和POI支持情况: HWPF: MS-Word 97-2003(.doc),基于BIFF8格式的JAVA接口。只支持.doc文件简单的操作,读写能力有限。本API为POI项目早期开发,很不幸的 是主要负责HWPF模块开发的工程师-"Ryan Ackley"已经离开Apache组织,现在该模块没有人维护、更新、完善。 XWPF:MS-Word 2007+(.docx),基于OOXML格式的JAVA接口。较HWPF功能完善。
二 安装
都是利用的jar,不存在什么安装,直接配置pom文件即可。 添加POI的word的jar:
<!-- 操作excel的库 注意版本保持一致 poi poi-ooxml poi-scratchpad -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>4.1.2</version>
<scope>compile</scope>
</dependency>
<!--poi-ooxml和*poi-ooxml-schemas*是poi对2007及以上版本的扩充。-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>4.1.2</version>
<scope>compile</scope>
</dependency>
<!--poi-ooxml和*poi-ooxml-schemas*是poi对2007及以上版本的扩充。-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml-schemas</artifactId>
<version>4.1.2</version>
<scope>compile</scope>
</dependency>
<!-- WordToHtml .doc .odcx poi -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-scratchpad</artifactId>
<version>4.1.2</version>
</dependency>
三 基本使用
3.1 核心类
最核心的三个类: XWPFDocument : 文档本身的抽象、代表整个文档; XWPFParagraph: 段落、整个文档可以看做一个个段落组成、简单对应我们文章的段落; XWPFRun: 可以看做一个片段,整个段落由多个Run组成、每个Run可以有自己的文字内容、样式等。
XWPFTable: 表格,和段落平级;
3.2 文档
创建文档
XWPFDocument doc = new XWPFDocument();
或
XWPFDocument doc = new XWPFDocument(new FileInputStream("./deepoove.docx"));
获取文档上的元素、比如段落、表格、图片等。
// 段落
List<XWPFParagraph> paragraphs = doc.getParagraphs();
// 表格
List<XWPFTable> tables = doc.getTables();
// 图片
List<XWPFPictureData> allPictures = doc.getAllPictures();
// 页眉
List<XWPFHeader> headerList = doc.getHeaderList();
// 页脚
List<XWPFFooter> footerList = doc.getFooterList();
生成文档
try (FileOutputStream out = new FileOutputStream("simple.docx")) {
doc.write(out);
}
3.3 段落
创建段落
XWPFParagraph p1 = doc.createParagraph();
段落样式设置:
// 对齐方式
p1.setAlignment(ParagraphAlignment.CENTER);
// 边框
p1.setBorderBottom(Borders.DOUBLE);
p1.setBorderTop(Borders.DOUBLE);
p1.setBorderRight(Borders.DOUBLE);
p1.setBorderLeft(Borders.DOUBLE);
p1.setBorderBetween(Borders.SINGLE);
3.4 基本样式Run
Run是段落的基本组成单元,可以是一段文字、也可以是一张图片、可以设置自己的不同样式风格。
获取段落内容
// 获取文字
String text = paragraph.getText();
// 获取段落内所有XWPFRun
List<XWPFRun> runs = paragraph.getRuns();
创建run
// 段落末尾创建XWPFRun
XWPFRun run = paragraph.createRun();
run.setText("为这个段落追加文本");
// 颜色
run.setColor("00ff00");
// 斜体
run.setItalic(true);
// 粗体
run.setBold(true);
// 字体
run.setFontFamily("Courier");
// 下划线
run.setUnderline(UnderlinePatterns.DOT_DOT_DASH);
获取段落中run和修改run
// 获取文字
String text = paragraph.getText();
// 获取段落内所有XWPFRun
List<XWPFRun> runs = paragraph.getRuns();
// 段落起始插入XWPFRun
XWPFRun insertNewRun = paragraph.insertNewRun(0);
insertNewRun.setText("在段落起始位置插入这段文本");
修改run
List<XWPFRun> runs = paragraph.getRuns();
// setText默认为追加文本,参数0表示设置第0个位置的文本,覆盖上一次设置
runs.get(0).setText("追加文本", 0);
runs.get(0).setText("修改文本", 0);
文本换行
run.addCarriageReturn();
3.5 关于图片
提取文档图片
List<XWPFPictureData> allPictures = doc.getAllPictures();
XWPFPicture pciture = allPictures.get(0);
byte[] data = pciture.getPictureData().getData();
// 接下来就可以将图片字节数组写入输出流
利用XWPFRun创建图片
List<XWPFPictureData> allPictures = doc.getAllPictures();
XWPFPicture pciture = allPictures.get(0);
byte[] data = pciture.getPictureData().getData();
// 接下来就可以将图片字节数组写入输出流
3.6 表格
创建三行三列的表格
XWPFTable table = doc.createTable(3, 3);
设置单元格的文本表格是由表格行XWPFRow构成,每行是由单元格XWPFCell构成,每个单元格内部又是由许多XWPFParagraph段落构成。
table.getRow(1).getCell(1).setText("EXAMPLE OF TABLE");
上面代码和下面代码等价:
XWPFParagraph p1 = table.getRow(0).getCell(0).addParagraph();
XWPFRun r1 = p1.createRun();
r1.setText("EXAMPLE OF TABLE")
设置单元格里面的图片,可以按照上述办法获取到单元格的XWPFRun然后按照run添加图片的办法进行。
设置单元格的样式
XWPFParagraph p1 = table.getRow(0).getCell(0).addParagraph();
XWPFRun r1 = p1.createRun();
r1.setText("EXAMPLE OF TABLE")
四 实例
public class TestFirstDoc {
public static void main(String[] args) throws IOException, InvalidFormatException {
XWPFDocument document = new XWPFDocument();
FileOutputStream out = new FileOutputStream(new File("测试文档.docx"));
XWPFParagraph paragraph = document.createParagraph();
// 基本测试
XWPFRun paragraphOneRunOne = paragraph.createRun();
paragraphOneRunOne.setText("测试第一个Run");
paragraphOneRunOne.setBold(true);
paragraphOneRunOne.setItalic(true);
paragraphOneRunOne.addBreak();
// 样式测试
XWPFRun paragraphRun2 = paragraph.createRun();
paragraphRun2.setText("为这个段落追加文本");
paragraphRun2.setFontSize(20);
paragraphRun2.setColor("00ff00");
paragraphRun2.setFontFamily("Courier");
paragraphRun2.setUnderline(UnderlinePatterns.DOT_DOT_DASH);
// 上下标测试
XWPFRun paragraphRun3 = paragraph.createRun();
paragraphRun3.setText("设置正常文字");
XWPFRun paragraphRun4 = paragraph.createRun();
paragraphRun4.setText("上标");
paragraphRun4.setItalic(true);
paragraphRun4.setSubscript(VerticalAlign.SUPERSCRIPT);
XWPFRun paragraphRun5 = paragraph.createRun();
paragraphRun5.setText("下标");
paragraphRun5.setItalic(true);
paragraphRun5.setSubscript(VerticalAlign.SUBSCRIPT);
// 设置换页,表格和上面内容分开来
XWPFParagraph paragraph2 = document.createParagraph();
paragraph2.setPageBreak(true);
XWPFTable table = document.createTable(3, 3);
table.getRow(0).getCell(0).setText("Head1");
table.getRow(0).getCell(1).setText("Head2");
table.getRow(0).getCell(2).setText("Head3");
table.getRow(1).getCell(0).setText("col1");
table.getRow(1).getCell(1).setText("col2");
table.getRow(1).getCell(2).setText("col3");
XWPFParagraph p1 = table.getRow(2).getCell(0).addParagraph();
XWPFRun r1 = p1.createRun();
InputStream stream = new FileInputStream("D:\\1.jpg");
r1.addPicture(stream, XWPFDocument.PICTURE_TYPE_PNG, "Generated", Units.toEMU(256), Units.toEMU(256));
document.write(out);
out.close();
System.out.println("测试完成");
}
}
效果图:
第二页:
![6893554db56a76faf1243ce5781faab9.png](https://i-blog.csdnimg.cn/blog_migrate/9ea6b62efb5ff6c4c59568ea83fd1c99.png)