Java操作word實戰

文章目錄

簡介
段落
頁頭與頁腳
頁碼
表格
圖片
批注
文本框
目錄
圖表

簡介

??Word編程最重要的類是org.apache.poi.xwpf.usermodel.XWPFDocument。涉及的東西十分復雜。而且Apache poi操作word的技術非常不成熟。代碼中本身有很多bug。
??Maven的依賴為

<dependency><groupId>org.apache.poi</groupId><artifactId>poi-ooxml</artifactId><version>5.0.0</version>
</dependency>

??以下代碼創建一個空word文檔。

public class EmptyWord {public static void main(String[] args) throws IOException {XWPFDocument document = new XWPFDocument();File file = new File("test.word");document.write(new FileOutputStream(file));}
}

段落

??首先看看段落與字體設置。
??假設有需要生成一個一級標題,利用document創建段落。每個段落又有多個run組成。Run不能繼續拆分，一個run擁有共同的字體。如以下代碼創建一個段落:

final XWPFParagraph paragraph = document.createParagraph();
paragraph.setNumILvl(BigInteger.valueOf(1L));
final XWPFRun run = paragraph.createRun();
run.setText("老了");
run.setFontSize(10);
run.setColor("ffff00");
run.setFontFamily("宋書");

??而段落的大綱級別的設置比較復雜，代碼如下

CTPPr pPr = paragraph.getCTP().getPPr();
if (pPr == null) {pPr = paragraph.getCTP().addNewPPr();
}
final CTDecimalNumber ctDecimalNumber = pPr.addNewOutlineLvl();
ctDecimalNumber.setVal(BigInteger.valueOf(1));
pPr.setOutlineLvl(ctDecimalNumber);

??這里有一個難懂的概念，什么是CTP。
??其效果如下：
在這里插入圖片描述

頁頭與頁腳

??頁頭與頁腳測試時發現生成的頁頭和頁腳只能在WORD中看到，在WPS里看不到。這可能是POI的一個bug。生成頁頭和頁腳都比較簡單。

final XWPFDocument document = new XWPFDocument();
final XWPFHeader header = document.createHeader(HeaderFooterType.DEFAULT);
final XWPFParagraph paragraph = header.createParagraph();
final XWPFRun run = paragraph.createRun();
run.setText("我是頁頭");
run.setFontSize(12);
run.setColor("ff00ff");
System.out.println(header.getText());

??頁腳為：

// 頁腳呢
final XWPFFooter footer = document.createFooter(HeaderFooterType.DEFAULT);
final XWPFParagraph footerParagraph = footer.createParagraph();
final XWPFRun footerParagraphRun = footerParagraph.createRun();
footerParagraphRun.setText("頁腳");
footerParagraphRun.setFontSize(12);

??完整效果如下：
在這里插入圖片描述

頁碼

??生成頁碼的方法比較復雜。但是值得挑戰一下。

final XWPFFooter footer = document.createFooter(HeaderFooterType.DEFAULT);
XWPFParagraph paragraph = footer.createParagraph();
XWPFRun run = paragraph.createRun();
run.setText("第");run = paragraph.createRun();
CTFldChar ctFldChar = run.getCTR().addNewFldChar();
ctFldChar.setFldCharType(STFldCharType.BEGIN);// 又一段
run = paragraph.createRun();
CTText ctText = run.getCTR().addNewInstrText();
ctText.setStringValue("PAGE \\* MERGEFORMAT");
ctText.setSpace(SpaceAttribute.Space.Enum.forString("preserve"));ctFldChar = run.getCTR().addNewFldChar();
ctFldChar.setFldCharType(STFldCharType.END);run = paragraph.createRun();
run.setText("頁 總共");run = paragraph.createRun();
ctFldChar = run.getCTR().addNewFldChar();
ctFldChar.setFldCharType(STFldCharType.BEGIN);run = paragraph.createRun();
ctText = run.getCTR().addNewInstrText();
ctText.setStringValue("NUMPAGES \\* MERGEFORMAT");
ctText.setSpace(SpaceAttribute.Space.Enum.forString("preserve"));ctFldChar = run.getCTR().addNewFldChar();
ctFldChar.setFldCharType(STFldCharType.END);run = paragraph.createRun();
run.setText("頁");

??同樣，兼容word，不兼容WPS。
??效果如下：
在這里插入圖片描述

表格

??Word里插入表格，是非常常見的功能。

final XWPFDocument document = new XWPFDocument();
final XWPFTable table = document.createTable(3, 3);
for (int i = 0; i < 3; i++) {for (int j = 0; j < 3; j++) {table.getRow(i).getCell(j).setText(i+"-"+j);}
}

??表格有點丑，但是勉強可以用哈：
在這里插入圖片描述

圖片

??插入圖片也是必要的功能啊，代碼示例如下：

String imagePath = "image.png"; // 圖片路徑FileInputStream imageStream = new FileInputStream(imagePath);// 設置圖片尺寸（單位：EMU）int width = Units.toEMU(300); // 寬度（約4厘米）int height = Units.toEMU(200); // 高度final XWPFParagraph paragraph = document.createParagraph();final XWPFRun run = paragraph.createRun();// 插入圖片run.addPicture(imageStream,XWPFDocument.PICTURE_TYPE_PNG, // 圖片格式"image.png", // 描述文本width,height);imageStream.close();

??插入圖片效果：
在這里插入圖片描述

批注

??Word編程加批注是十分困難的、十分復雜的。在poi里，有同名的包，不能導錯，以下是正確的包：

import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTComment;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTComments;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTText;

??首先要寫一個輔助類，輔助類倒是比較簡單：

public class MyXWPFCommentsDocument extends POIXMLDocumentPart {private CTComments ctComments;private MyXWPFCommentsDocument(PackagePart part) {super(part);ctComments = CommentsDocument.Factory.newInstance().addNewComments();}public CTComments getCtComments() {return ctComments;}@Overrideprotected void commit() throws IOException {XmlOptions xmlOptions = new XmlOptions(POIXMLTypeLoader.DEFAULT_XML_OPTIONS);xmlOptions.setSaveSyntheticDocumentElement(new QName(CTComments.type.getName().getNamespaceURI(), "comments"));PackagePart part = getPackagePart();OutputStream out = part.getOutputStream();ctComments.save(out, xmlOptions);out.close();}public static MyXWPFCommentsDocument createCommentsDocument(XWPFDocument document) throws Exception {OPCPackage oPCPackage = document.getPackage();PackagePartName partName = PackagingURIHelper.createPartName("/word/comments.xml");PackagePart part = oPCPackage.createPart(partName, "application/vnd.openxmlformats-officedocument.wordprocessingml.comments+xml");MyXWPFCommentsDocument myXWPFCommentsDocument = new MyXWPFCommentsDocument(part);String rId = "rId" + (document.getRelationParts().size()+1);document.addRelation(rId, XWPFRelation.COMMENT, myXWPFCommentsDocument);return myXWPFCommentsDocument;}
}

??以下是加入批注的方法：

 MyXWPFCommentsDocument myXWPFCommentsDocument = MyXWPFCommentsDocument.createCommentsDocument(document);CTComments comments = myXWPFCommentsDocument.getCtComments();CTComment ctComment;XWPFParagraph paragraph;//first commentBigInteger cId = BigInteger.ZERO;ctComment = comments.addNewComment();CTText ctText = ctComment.addNewP().addNewR().addNewT();ctText.setStringValue("The first comment.");ctComment.setAuthor("Axel Ríchter");ctComment.setInitials("AR");ctComment.setId(cId);paragraph = document.createParagraph();paragraph.getCTP().addNewCommentRangeStart().setId(cId);XWPFRun run;run = paragraph.createRun();run.setText("Paragraph with the first comment.");paragraph.getCTP().addNewCommentRangeEnd().setId(cId);paragraph.getCTP().addNewR().addNewCommentReference().setId(cId);

??以下是批注的效果：
在這里插入圖片描述

文本框

??文本框的插入也是比較復雜，代碼如下：

XWPFParagraph paragraph = document.createParagraph();
XWPFRun run=paragraph.createRun();
run.setText("The Body text: ");CTGroup ctGroup = CTGroup.Factory.newInstance();CTShape ctShape = ctGroup.addNewShape();
ctShape.setStyle("width:100pt;height:24pt");
CTTxbxContent ctTxbxContent = ctShape.addNewTextbox().addNewTxbxContent();
ctTxbxContent.addNewP().addNewR().addNewT().setStringValue("The TextBox text...");Node ctGroupNode = ctGroup.getDomNode();
CTPicture ctPicture = CTPicture.Factory.parse(ctGroupNode);
run=paragraph.createRun();
CTR cTR = run.getCTR();
cTR.addNewPict();
cTR.setPictArray(0, ctPicture);

??簡單展示下效果:
在這里插入圖片描述

try (XWPFDocument document = new XWPFDocument()) {document.createTOC();final XWPFParagraph paragraph = document.createParagraph();// 獲取段落屬性，若不存在則新建CTPPr ppr = paragraph.getCTP().isSetPPr() ? paragraph.getCTP().getPPr() : paragraph.getCTP().addNewPPr();// 設置大綱級別為 1CTDecimalNumber outlineLvl = ppr.isSetOutlineLvl() ? ppr.getOutlineLvl() : ppr.addNewOutlineLvl();outlineLvl.setVal(BigInteger.valueOf(1));final XWPFRun run = paragraph.createRun();run.setText("標題一");run.setFontSize(10);run.setFontFamily("宋書");File file = new File("toc.docx");document.write(Files.newOutputStream(file.toPath()));}

??雖然代碼運行不報錯，但是結果是生成不了目錄。以下是效果圖：
在這里插入圖片描述

圖表

??英文叫chart，chart是需要關聯excel表格的。所以這個特別復雜。完整代碼如下：

// create the dataString[] categories = new String[] { "Lang 1", "Lang 2", "Lang 3" };Double[] valuesA = new Double[] { 10d, 20d, 30d };Double[] valuesB = new Double[] { 15d, 25d, 35d };// create the chartXWPFChart chart = doc.createChart(15 * Units.EMU_PER_CENTIMETER, 10 * Units.EMU_PER_CENTIMETER);// create data sourcesint numOfPoints =categories. Length;String categoryDataRange = chart.formatRange(new CellRangeAddress(1, numOfPoints, 0, 0));String valuesDataRangeA = chart.formatRange(new CellRangeAddress(1, numOfPoints, 1, 1));String valuesDataRangeB = chart.formatRange(new CellRangeAddress(1, numOfPoints, 2, 2));XDDFDataSource<String> categoriesData = XDDFDataSourcesFactory.fromArray(categories, categoryDataRange, 0);XDDFNumericalDataSource<Double> valuesDataA = XDDFDataSourcesFactory.fromArray(valuesA, valuesDataRangeA, 1);XDDFNumericalDataSource<Double> valuesDataB = XDDFDataSourcesFactory.fromArray(valuesB, valuesDataRangeB, 2);// create axisXDDFCategoryAxis bottomAxis = chart.createCategoryAxis(AxisPosition.BOTTOM);XDDFValueAxis leftAxis = chart.createValueAxis(AxisPosition.LEFT);leftAxis.setCrosses(AxisCrosses.AUTO_ZERO);// Set AxisCrossBetween, so the left axis crosses the category axis between the categories.// Else first and last category is exactly on cross points and the bars are only half visible.leftAxis.setCrossBetween(AxisCrossBetween.BETWEEN);// create chart dataXDDFChartData data = chart.createData(ChartTypes.BAR, bottomAxis, leftAxis);((XDDFBarChartData) data).setBarDirection(BarDirection.COL);// create series// if only one series do not vary colors for each bar((XDDFBarChartData) data).setVaryColors(false);XDDFChartData.Series series = data.addSeries(categoriesData, valuesDataA);// XDDFChart.setSheetTitle is buggy. It creates a Table but only half way and incomplete.// Excel cannot opening the workbook after creatingg that incomplete Table.// So updating the chart data in Word is not possible.//series.setTitle("a", chart.setSheetTitle("a", 1));series.setTitle("a", setTitleInDataSheet(chart, "a", 1));/*// if more than one series do vary colors of the series((XDDFBarChartData)data).setVaryColors(true);series = data.addSeries(categoriesData, valuesDataB);//series.setTitle("b", chart.setSheetTitle("b", 2));series.setTitle("b", setTitleInDataSheet(chart, "b", 2));
*/// plot chart datachart.plot(data);// create legendXDDFChartLegend legend = chart.getOrAddLegend();legend.setPosition(LegendPosition.LEFT);legend.setOverlay(false);

??還有一個私有方法：

static CellReference setTitleInDataSheet(XWPFChart chart, String title, int column) throws Exception {XSSFWorkbook workbook = chart.getWorkbook();XSSFSheet sheet = workbook.getSheetAt(0);XSSFRow row = sheet.getRow(0);if (row == null)row = sheet.createRow(0);XSSFCell cell = row.getCell(column);if (cell == null)cell = row.createCell(column);cell.setCellValue(title);return new CellReference(sheet.getSheetName(), 0, column, true, true);
}