Java操作Word文档的全面指南

2025-07-06 18:50

本文主要是介绍Java操作Word文档的全面指南,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《Java操作Word文档的全面指南》在Java开发中,操作Word文档是常见的业务需求,广泛应用于合同生成、报表输出、通知发布、法律文书生成、病历模板填写等场景,本文将全面介绍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().apythonddNewPPr();
}
final CTDecimalNumber ctDecimalNumber = pPr.addNewOutlineLvl();
ctDecimalNumber.setVal(BigInteger.valueOf(1));
pPr.setOutlineLvl(ctDecimalNumber);

这里有一个难懂的概念,什么是CTP。

其效果如下:

Java操作Word文档的全面指南

页头与页脚

页头与页脚测试时发现生成的页头和页脚只能在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);

完整效果如下:

Java操作Word文档的全面指南

页码

生成页码的方法比较复杂。但是值得挑战一下。

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。

效果如下:

Java操作Word文档的全面指南

表格

Word里插入表格,是非常常见的功能。

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

表格有点丑,但是勉强可以用哈:

Java操作Word文档的全面指南

图片

插入图片也是必要的功能啊,代码示例如下:

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();

插入图片效果:

Java操作Word文档的全面指南

批注

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;
    }

    @Override
    protected 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 comment
        BigInteger cId = BigInteger.ZERO;

        ctComment = comments.addNewComment();
        CTText ctText = ctComment.addNewP().addNewR().addNewT();
        ctText.setStringValue("The first comment.");
        ctComment.setAuthor("Axel Rchter");
        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);

以下是批注的效果:

Java操作Word文档的全面指南

文本框

文本框的插入也是比较复杂,代码如下:

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);

简单展示下效果:

Java操作Word文档的全面指南

目录

目录本来就一句话doc.createTOC(),但是很容易失败。使用CTPPr可以设置段落的大纲级别,以下是代码:

try (XWPFDocument document = new XWPFDocument()) {

            document.createTOC();

            final XWPFParagraph paragraph = document.createParagraph();
            // 获取段落属性,若不存在则新建
            CTPPr ppr = paragraph.getCTP().isSetPPr() ? paragraph.getCTP().getPPr() : paragraph.getCTP().addNewPPr();

            // 设置大纲级别为 1
            CTDecimalNumber 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()));
        }

虽然代码运行不报错,但是结果是生成不了目录。以下是效果图:

Java操作Word文档的全面指南

图表

英文叫chart,chart是需要关联excel表格的。所以这个特别复杂。完整代码如下:

// create the data
     String[] 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 chart
     XWPFChart chart = doc.createChart(15 * Units.EMU_PER_CENTIMETER, 10 * China编程Units.EMU_PER_CENTIMETER);

     // create data sources
     int 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 axis
     XDDFCategoryAxis 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 data
     XDDFChartData 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.setShChina编程eetTitle 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 data
     chart.plot(data);

     // create legend
     XDDFChartLegend 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);
}

运行效果如下:

Java操作Word文档的全面指南

以上就是Java操作Word的全面指南的详细内容,更多关于Java操作word的资料请关注China编程(www.chinasem.cn)其它相关文章!

这篇关于Java操作Word文档的全面指南的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1155310

相关文章

SpringBoot中六种批量更新Mysql的方式效率对比分析

《SpringBoot中六种批量更新Mysql的方式效率对比分析》文章比较了MySQL大数据量批量更新的多种方法,指出REPLACEINTO和ONDUPLICATEKEY效率最高但存在数据风险,MyB... 目录效率比较测试结构数据库初始化测试数据批量修改方案第一种 for第二种 case when第三种

Java docx4j高效处理Word文档的实战指南

《Javadocx4j高效处理Word文档的实战指南》对于需要在Java应用程序中生成、修改或处理Word文档的开发者来说,docx4j是一个强大而专业的选择,下面我们就来看看docx4j的具体使用... 目录引言一、环境准备与基础配置1.1 Maven依赖配置1.2 初始化测试类二、增强版文档操作示例2.

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

Ubuntu 24.04启用root图形登录的操作流程

《Ubuntu24.04启用root图形登录的操作流程》Ubuntu默认禁用root账户的图形与SSH登录,这是为了安全,但在某些场景你可能需要直接用root登录GNOME桌面,本文以Ubuntu2... 目录一、前言二、准备工作三、设置 root 密码四、启用图形界面 root 登录1. 修改 GDM 配

Spring Boot中的路径变量示例详解

《SpringBoot中的路径变量示例详解》SpringBoot中PathVariable通过@PathVariable注解实现URL参数与方法参数绑定,支持多参数接收、类型转换、可选参数、默认值及... 目录一. 基本用法与参数映射1.路径定义2.参数绑定&nhttp://www.chinasem.cnbs

JAVA中安装多个JDK的方法

《JAVA中安装多个JDK的方法》文章介绍了在Windows系统上安装多个JDK版本的方法,包括下载、安装路径修改、环境变量配置(JAVA_HOME和Path),并说明如何通过调整JAVA_HOME在... 首先去oracle官网下载好两个版本不同的jdk(需要登录Oracle账号,没有可以免费注册)下载完

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

Spring Boot 结合 WxJava 实现文章上传微信公众号草稿箱与群发

《SpringBoot结合WxJava实现文章上传微信公众号草稿箱与群发》本文将详细介绍如何使用SpringBoot框架结合WxJava开发工具包,实现文章上传到微信公众号草稿箱以及群发功能,... 目录一、项目环境准备1.1 开发环境1.2 微信公众号准备二、Spring Boot 项目搭建2.1 创建

Java中Integer128陷阱

《Java中Integer128陷阱》本文主要介绍了Java中Integer与int的区别及装箱拆箱机制,重点指出-128至127范围内的Integer值会复用缓存对象,导致==比较结果为true,下... 目录一、Integer和int的联系1.1 Integer和int的区别1.2 Integer和in

SpringSecurity整合redission序列化问题小结(最新整理)

《SpringSecurity整合redission序列化问题小结(最新整理)》文章详解SpringSecurity整合Redisson时的序列化问题,指出需排除官方Jackson依赖,通过自定义反序... 目录1. 前言2. Redission配置2.1 RedissonProperties2.2 Red